Declare method as published to api More...
Public Member Functions | |
| DeclareFieldAttribute () | |
| Initializes a new instance of the DeclareFieldAttribute class. More... | |
| DeclareFieldAttribute (string description) | |
| Initializes a new instance of the DeclareFieldAttribute class. More... | |
 Public Member Functions inherited from KlusterKite.API.Attributes.ApiDescriptionAttribute | |
| ApiDescriptionAttribute () | |
| Initializes a new instance of the ApiDescriptionAttribute class. More... | |
| ApiDescriptionAttribute (string description) | |
| Initializes a new instance of the ApiDescriptionAttribute class. More... | |
| string | GetName (MemberInfo member) |
| Creates name for the type field More... | |
| string | GetName (Type type) |
| Creates name for the type More... | |
Properties | |
| bool | IsKey [get, set] |
| Gets or sets a value indicating whether current property is entity identification key. More... | |
| Type | Converter [get, set] |
| Gets or sets the converter type. It will be used to transfer property / method value to the API representable values More... | |
| EnAccessFlag | Access [get, set] |
| Gets or sets the field access type. This is not checked for methods as all published methods are considered EnAccessFlag.Queryable More... | |
| Properties inherited from KlusterKite.API.Attributes.PublishToApiAttribute | |
| Type | ReturnType [get, set] |
| Gets or sets the return type to be described for an api More... | |
| Properties inherited from KlusterKite.API.Attributes.ApiDescriptionAttribute | |
| string | Description [get, set] |
| Gets or sets the description to publish More... | |
| string | Name [get, set] |
| Gets or sets the published property / method name More... | |
Additional Inherited Members | |
| Static Public Member Functions inherited from KlusterKite.API.Attributes.PublishToApiAttribute | |
| static string | GetMemberName (MemberInfo memberInfo) |
| Gets the declared member name More... | |
| Static Public Member Functions inherited from KlusterKite.API.Attributes.ApiDescriptionAttribute | |
| static Type | CheckType (Type type, Type typeToCheck) |
| Checks the interface implementation More... | |
| static string | GetParameterName (ParameterInfo parameter) |
| Creates name for the method parameter More... | |
| static string | GetTypeName (Type type) |
| Creates name for the type More... | |
| static string | ToCamelCase (string name) |
| Converts string to camel case More... | |
| Protected Member Functions inherited from KlusterKite.API.Attributes.PublishToApiAttribute | |
| PublishToApiAttribute () | |
| Initializes a new instance of the PublishToApiAttribute class. More... | |
| PublishToApiAttribute (string description) | |
| Initializes a new instance of the PublishToApiAttribute class. More... | |
Detailed Description
Declare method as published to api
Definition at line 18 of file DeclareFieldAttribute.cs.
Constructor & Destructor Documentation
◆ DeclareFieldAttribute() [1/2]
| KlusterKite.API.Attributes.DeclareFieldAttribute.DeclareFieldAttribute | ( | ) |
Initializes a new instance of the DeclareFieldAttribute class.
Definition at line 23 of file DeclareFieldAttribute.cs.
◆ DeclareFieldAttribute() [2/2]
| KlusterKite.API.Attributes.DeclareFieldAttribute.DeclareFieldAttribute | ( | string | description | ) |
Initializes a new instance of the DeclareFieldAttribute class.
- Parameters
-
description The description.
Definition at line 33 of file DeclareFieldAttribute.cs.
Property Documentation
◆ Access
|
getset |
Gets or sets the field access type. This is not checked for methods as all published methods are considered EnAccessFlag.Queryable
Definition at line 54 of file DeclareFieldAttribute.cs.
◆ Converter
|
getset |
Gets or sets the converter type. It will be used to transfer property / method value to the API representable values
Only implementations of IValueConverter<T> can be used
Definition at line 49 of file DeclareFieldAttribute.cs.
◆ IsKey
|
getset |
Gets or sets a value indicating whether current property is entity identification key.
Definition at line 41 of file DeclareFieldAttribute.cs.
The documentation for this class was generated from the following file:
- KlusterKite.API/KlusterKite.API.Attributes/DeclareFieldAttribute.cs
