Class ActionApiDescriptionModel

Inheritance

object

ActionApiDescriptionModel

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 ActionApiDescriptionModel

Constructors

ActionApiDescriptionModel()

Declaration

public ActionApiDescriptionModel()

Properties

AllowAnonymous

Declaration

public bool? AllowAnonymous { get; set; }

Property Value

Type	Description
bool?

HttpMethod

Declaration

public string? HttpMethod { get; set; }

Property Value

Type	Description
string

ImplementFrom

Declaration

public string? ImplementFrom { get; set; }

Property Value

Type	Description
string

Name

Declaration

public string Name { get; set; }

Property Value

Type	Description
string

Parameters

Declaration

public IList<ParameterApiDescriptionModel> Parameters { get; set; }

Property Value

Type	Description
IList<ParameterApiDescriptionModel>

ParametersOnMethod

Declaration

public IList<MethodParameterApiDescriptionModel> ParametersOnMethod { get; set; }

Property Value

Type	Description
IList<MethodParameterApiDescriptionModel>

ReturnValue

Declaration

public ReturnValueApiDescriptionModel ReturnValue { get; set; }

Property Value

Type	Description
ReturnValueApiDescriptionModel

SupportedVersions

Declaration

public IList<string>? SupportedVersions { get; set; }

Property Value

Type	Description
IList<string>

UniqueName

Declaration

public string UniqueName { get; set; }

Property Value

Type	Description
string

Url

Declaration

public string Url { get; set; }

Property Value

Type	Description
string

Methods

AddParameter(ParameterApiDescriptionModel)

Declaration

public ParameterApiDescriptionModel AddParameter(ParameterApiDescriptionModel parameter)

Parameters

Type	Name	Description
ParameterApiDescriptionModel	parameter

Returns

Type	Description
ParameterApiDescriptionModel

Create(string, MethodInfo, string, string?, IList<string>, bool?, string?)

Declaration

public static ActionApiDescriptionModel Create(string uniqueName, MethodInfo method, string url, string? httpMethod, IList<string> supportedVersions, bool? allowAnonymous = null, string? implementFrom = null)

Parameters

Type	Name	Description
string	uniqueName
MethodInfo	method
string	url
string	httpMethod
IList<string>	supportedVersions
bool?	allowAnonymous
string	implementFrom

Returns

Type	Description
ActionApiDescriptionModel

GetHttpMethod()

Declaration

public HttpMethod GetHttpMethod()

Returns

Type	Description
HttpMethod

ToString()

Declaration

public override string ToString()

Returns

Type	Description
string

Overrides

object.ToString()

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>)