Class ModuleApiDescriptionModel

Inheritance

object

ModuleApiDescriptionModel

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Volo.Abp.Http.Modeling

Assembly: Volo.Abp.Http.dll

Syntax

public class ModuleApiDescriptionModel

Constructors

ModuleApiDescriptionModel()

Declaration

public ModuleApiDescriptionModel()

Fields

DefaultRemoteServiceName

Declaration

public const string DefaultRemoteServiceName = "Default"

Field Value

Type	Description
string

DefaultRootPath

Declaration

public const string DefaultRootPath = "app"

Field Value

Type	Description
string

Properties

Controllers

Declaration

public IDictionary<string, ControllerApiDescriptionModel> Controllers { get; set; }

Property Value

Type	Description
IDictionary<string, ControllerApiDescriptionModel>

RemoteServiceName

Declaration

public string RemoteServiceName { get; set; }

Property Value

Type	Description
string

RootPath

Declaration

public string RootPath { get; set; }

Property Value

Type	Description
string

Methods

AddController(ControllerApiDescriptionModel)

Declaration

public ControllerApiDescriptionModel AddController(ControllerApiDescriptionModel controller)

Parameters

Type	Name	Description
ControllerApiDescriptionModel	controller

Returns

Type	Description
ControllerApiDescriptionModel

Create(string, string)

Declaration

public static ModuleApiDescriptionModel Create(string rootPath, string remoteServiceName)

Parameters

Type	Name	Description
string	rootPath
string	remoteServiceName

Returns

Type	Description
ModuleApiDescriptionModel

CreateSubModel(string[]?, string[]?)

Declaration

public ModuleApiDescriptionModel CreateSubModel(string[]? controllers, string[]? actions)

Parameters

Type	Name	Description
string[]	controllers
string[]	actions

Returns

Type	Description
ModuleApiDescriptionModel

GetOrAddController(string, string?, bool, bool, string?, Type, HashSet<Type>?)

Declaration

public ControllerApiDescriptionModel GetOrAddController(string name, string? groupName, bool isRemoteService, bool isIntegrationService, string? apiVersion, Type type, HashSet<Type>? ignoredInterfaces = null)

Parameters

Type	Name	Description
string	name
string	groupName
bool	isRemoteService
bool	isIntegrationService
string	apiVersion
Type	type
HashSet<Type>	ignoredInterfaces

Returns

Type	Description
ControllerApiDescriptionModel

Extension Methods

AbpObjectExtensions.As<T>(object)

AbpObjectExtensions.To<T>(object)

LockExtensions.Locking(object, Action)

LockExtensions.Locking<TResult>(object, Func<TResult>)

AbpObjectExtensions.If<T>(T, bool, Action<T>)

AbpObjectExtensions.If<T>(T, bool, Func<T, T>)

AbpObjectExtensions.IsIn<T>(T, IEnumerable<T>)

AbpObjectExtensions.IsIn<T>(T, params T[])

AbpQueryableExtensions.OrderByIf<T, TQueryable>(TQueryable, bool, string)

AbpQueryableExtensions.PageBy<T, TQueryable>(TQueryable, int, int)

AbpQueryableExtensions.WhereIf<T, TQueryable>(TQueryable, bool, Expression<Func<T, bool>>)

AbpQueryableExtensions.WhereIf<T, TQueryable>(TQueryable, bool, Expression<Func<T, int, bool>>)

AbpOpenIddictQueryableExtensions.SkipIf<T, TQueryable>(TQueryable, bool, int?)

AbpOpenIddictQueryableExtensions.TakeIf<T, TQueryable>(TQueryable, bool, int?)

LockExtensions.Locking<T>(T, Action<T>)

LockExtensions.Locking<T, TResult>(T, Func<T, TResult>)