KlusterKite.API.Client.ApiDescription Class Reference
The generic provided api description More...
Inheritance diagram for KlusterKite.API.Client.ApiDescription:
Public Member Functions | |
| ApiDescription () | |
| Initializes a new instance of the ApiDescription class. More... | |
| ApiDescription (string apiName, string version, IEnumerable< ApiType > types, IEnumerable< ApiField > fields=null, IEnumerable< ApiMutation > mutations=null) | |
| Initializes a new instance of the ApiDescription class. More... | |
 Public Member Functions inherited from KlusterKite.API.Client.ApiObjectType | |
| ApiObjectType () | |
| Initializes a new instance of the ApiObjectType class. More... | |
| ApiObjectType (string typeName, IEnumerable< ApiField > fields=null) | |
| Initializes a new instance of the ApiObjectType class. More... | |
| ApiField | CreateField (string name, EnFieldFlags flags=EnFieldFlags.Queryable, string description=null) |
| Creates a field of this type More... | |
| Public Member Functions inherited from KlusterKite.API.Client.ApiType | |
| override string | ToString () |
Properties | |
| string | ApiName [get, set] |
| Gets or sets the api name More... | |
| List< ApiMutation > | Mutations [get, set] |
| Gets or sets the list of mutation methods More... | |
| List< ApiType > | Types = new List<ApiMutation>() [get, set] |
| Gets or sets the list of registered types More... | |
| Version | Version = new List<ApiType>() [get, set] |
| Gets or sets the api version. Usually this the defining assembly version More... | |
| Properties inherited from KlusterKite.API.Client.ApiObjectType | |
| List< ApiField > | Fields [get, set] |
| Gets or sets the list of fields More... | |
| List< ApiField > | DirectMutations = new List<ApiField>() [get, set] |
| Gets or sets the list of direct mutations More... | |
| Properties inherited from KlusterKite.API.Client.ApiType | |
| string | Description [get, set] |
| Gets or sets the human-readable type description for auto-publishing More... | |
| string | TypeName [get, set] |
| Gets or sets the type name for the api More... | |
Detailed Description
The generic provided api description
Definition at line 20 of file ApiDescription.cs.
Constructor & Destructor Documentation
◆ ApiDescription() [1/2]
| KlusterKite.API.Client.ApiDescription.ApiDescription | ( | ) |
Initializes a new instance of the ApiDescription class.
Definition at line 25 of file ApiDescription.cs.
◆ ApiDescription() [2/2]
| KlusterKite.API.Client.ApiDescription.ApiDescription | ( | string | apiName, |
| string | version, | ||
| IEnumerable< ApiType > | types, | ||
| IEnumerable< ApiField > | fields = null, |
||
| IEnumerable< ApiMutation > | mutations = null |
||
| ) |
Initializes a new instance of the ApiDescription class.
- Parameters
-
apiName The api name. version The version. types The types. fields The fields. mutations The list of mutations.
Definition at line 47 of file ApiDescription.cs.
Property Documentation
◆ ApiName
|
getset |
Gets or sets the api name
Definition at line 64 of file ApiDescription.cs.
◆ Mutations
|
getset |
Gets or sets the list of mutation methods
Definition at line 71 of file ApiDescription.cs.
◆ Types
|
getset |
Gets or sets the list of registered types
Definition at line 78 of file ApiDescription.cs.
◆ Version
|
getset |
Gets or sets the api version. Usually this the defining assembly version
Definition at line 84 of file ApiDescription.cs.
The documentation for this class was generated from the following file:
- KlusterKite.API/KlusterKite.API.Client/ApiDescription.cs
