Class ControllerApiDescriptionModel

Inheritance
object
ControllerApiDescriptionModel
Inherited Members
object.GetType()
object.MemberwiseClone()
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 ControllerApiDescriptionModel

Constructors

ControllerApiDescriptionModel()

Declaration
public ControllerApiDescriptionModel()

Properties

Actions

Declaration
public Dictionary<string, ActionApiDescriptionModel> Actions { get; set; }
Property Value
Type Description
System.Collections.Generic.Dictionary<TKey, TValue><string, ActionApiDescriptionModel>

ApiVersion

Declaration
public string ApiVersion { get; set; }
Property Value
Type Description
string

ControllerGroupName

Declaration
public string ControllerGroupName { get; set; }
Property Value
Type Description
string

ControllerName

Declaration
public string ControllerName { get; set; }
Property Value
Type Description
string

Interfaces

Declaration
public List<ControllerInterfaceApiDescriptionModel> Interfaces { get; set; }
Property Value
Type Description
System.Collections.Generic.List<T><ControllerInterfaceApiDescriptionModel>

IsIntegrationService

Declaration
public bool IsIntegrationService { get; set; }
Property Value
Type Description
bool

IsRemoteService

Declaration
public bool IsRemoteService { get; set; }
Property Value
Type Description
bool

Type

Declaration
public string Type { get; set; }
Property Value
Type Description
string

Methods

AddAction(string, ActionApiDescriptionModel)

Declaration
public ActionApiDescriptionModel AddAction(string uniqueName, ActionApiDescriptionModel action)
Parameters
Type Name Description
string uniqueName
ActionApiDescriptionModel action
Returns
Type Description
ActionApiDescriptionModel

Create(string, string, bool, bool, string, Type, HashSet<Type>)

Declaration
public static ControllerApiDescriptionModel Create(string controllerName, string groupName, bool isRemoteService, bool isIntegrationService, string apiVersion, Type type, HashSet<Type> ignoredInterfaces = null)
Parameters
Type Name Description
string controllerName
string groupName
bool isRemoteService
bool isIntegrationService
string apiVersion
System.Type type
System.Collections.Generic.HashSet<T><System.Type> ignoredInterfaces
Returns
Type Description
ControllerApiDescriptionModel

CreateSubModel(string[])

Declaration
public ControllerApiDescriptionModel CreateSubModel(string[] actions)
Parameters
Type Name Description
string[] actions
Returns
Type Description
ControllerApiDescriptionModel

Implements(Type)

Declaration
public bool Implements(Type interfaceType)
Parameters
Type Name Description
System.Type interfaceType
Returns
Type Description
bool

ToString()

Declaration
public override string ToString()
Returns
Type Description
string
Overrides
object.ToString()

Extension Methods