KlusterKite  0.0.0
A framework to create scalable and redundant services based on awesome Akka.Net project.
KlusterKite.API.Client.ApiObjectType Class Reference

The api provided type of object with fields More...

Inheritance diagram for KlusterKite.API.Client.ApiObjectType:
KlusterKite.API.Client.ApiType KlusterKite.API.Client.ApiDescription

Public Member Functions

 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

List< ApiFieldFields [get, set]
 Gets or sets the list of fields More...
 
List< ApiFieldDirectMutations = 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 api provided type of object with fields

Definition at line 19 of file ApiObjectType.cs.

Constructor & Destructor Documentation

◆ ApiObjectType() [1/2]

KlusterKite.API.Client.ApiObjectType.ApiObjectType ( )

Initializes a new instance of the ApiObjectType class.

Definition at line 24 of file ApiObjectType.cs.

◆ ApiObjectType() [2/2]

KlusterKite.API.Client.ApiObjectType.ApiObjectType ( string  typeName,
IEnumerable< ApiField fields = null 
)

Initializes a new instance of the ApiObjectType class.

Parameters
typeNameThe type name.
fieldsThe fields.

Definition at line 37 of file ApiObjectType.cs.

Member Function Documentation

◆ CreateField()

ApiField KlusterKite.API.Client.ApiObjectType.CreateField ( string  name,
EnFieldFlags  flags = EnFieldFlags.Queryable,
string  description = null 
)

Creates a field of this type

Parameters
nameThe field name
flagsThe list of field flags
descriptionThe field description
Returns
The api filed

Definition at line 67 of file ApiObjectType.cs.

Property Documentation

◆ DirectMutations

List<ApiField> KlusterKite.API.Client.ApiObjectType.DirectMutations = new List<ApiField>()
getset

Gets or sets the list of direct mutations

Definition at line 58 of file ApiObjectType.cs.

◆ Fields

List<ApiField> KlusterKite.API.Client.ApiObjectType.Fields
getset

Gets or sets the list of fields

Definition at line 51 of file ApiObjectType.cs.


The documentation for this class was generated from the following file: