Describes some mutation More...

Inheritance diagram for KlusterKite.API.Client.ApiMutation:

Public Types
enum	EnType { EnType.Untyped, EnType.ConnectionCreate, EnType.ConnectionUpdate, EnType.ConnectionDelete, EnType.Connection }
	The type of defined mutation More...

Public Member Functions
	ApiMutation ()
	Initializes a new instance of the ApiMutation class. More...

Public Member Functions inherited from KlusterKite.API.Client.ApiField
	ApiField ()
	Initializes a new instance of the ApiField class. More...

void	FillAuthorizationProperties (MemberInfo memberInfo)
	Fills the AuthorizationRules, LogAccessRules, RequireAuthenticatedSession and RequireAuthenticatedUserSession from attributes of related API member More...

bool	CheckAuthorization (RequestContext context, EnConnectionAction action)
	Checks if provided context is authorized to access this field More...

override string	ToString ()

ApiField	Clone ()
	Creates a clone of the current object More...

Static Public Member Functions
static ApiMutation	CreateFromField (ApiField field, EnType type, List< ApiRequest > path)
	Creates the mutation from field More...

Static Public Member Functions inherited from KlusterKite.API.Client.ApiField
static ApiField	Object ([NotNull] string name, [NotNull] string typeName, EnFieldFlags flags=EnFieldFlags.Queryable, IEnumerable< ApiField > arguments=null, string description=null)
	Creates an object containing field More...

static ApiField	Scalar ([NotNull] string name, EnScalarType type, EnFieldFlags flags=EnFieldFlags.Queryable, IEnumerable< ApiField > arguments=null, string description=null)
	Creates a scalar containing field More...

Protected Member Functions
	ApiMutation (string name, EnFieldFlags flags)
	Initializes a new instance of the ApiMutation class. More...

Protected Member Functions inherited from KlusterKite.API.Client.ApiField
	ApiField (string name, EnFieldFlags flags)
	Initializes a new instance of the ApiField class. More...

Properties
List< ApiRequest >	Path `[get, set]`
	Gets or sets the path to the mutation container More...

EnType	Type `[get, set]`
	Gets or sets the type of a mutation More...

Properties inherited from KlusterKite.API.Client.ApiField
List< ApiField >	Arguments `[get, set]`
	Gets or sets the list of arguments (if is set - this field becomes a method) More...

string	Description = new List<ApiField>() `[get, set]`
	Gets or sets the human-readable type description for auto-publishing More...

EnFieldFlags	Flags `[get, set]`
	Gets or sets the list of defined flags More...

string	Name `[get, set]`
	Gets or sets the field name More...

EnScalarType	ScalarType `[get, set]`
	Gets or sets the scalar type of the field More...

string	TypeName `[get, set]`
	Gets or sets the field type name More...

List< AuthorizationRule >	AuthorizationRules `[get, set]`
	Gets or sets the list of authorization requirements More...

List< LogAccessRule >	LogAccessRules `[get, set]`
	Gets or sets the list of log access rules More...

bool	RequireAuthenticatedSession `[get, set]`
	Gets or sets a value indicating whether a valid authenticated session is required for access this field More...

bool	RequireAuthenticatedUserSession `[get, set]`
	Gets or sets a value indicating whether a valid authenticated user session is required for access this field More...

Detailed Description

Describes some mutation

Definition at line 20 of file ApiMutation.cs.

Member Enumeration Documentation

◆ EnType

enum KlusterKite.API.Client.ApiMutation.EnType

strong

The type of defined mutation

Enumerator
Untyped	Some mutation that is not directly related to some node connection
ConnectionCreate	The node creation in the connection
ConnectionUpdate	The node update in the connection
ConnectionDelete	The node deletion in the connection
Connection	The additional connection mutation

Definition at line 48 of file ApiMutation.cs.

Constructor & Destructor Documentation

◆ ApiMutation() [1/2]

KlusterKite.API.Client.ApiMutation.ApiMutation ( )

Initializes a new instance of the ApiMutation class.

Definition at line 27 of file ApiMutation.cs.

◆ ApiMutation() [2/2]

KlusterKite.API.Client.ApiMutation.ApiMutation	(	string	name,
		EnFieldFlags	flags
	)

protected

Initializes a new instance of the ApiMutation class.

Parameters

name	The name.
flags	The flags.

Definition at line 40 of file ApiMutation.cs.

Member Function Documentation

◆ CreateFromField()

static ApiMutation KlusterKite.API.Client.ApiMutation.CreateFromField	(	ApiField	field,
		EnType	type,
		List< ApiRequest >	path
	)

static

Creates the mutation from field

Parameters

field	The field description
type	The mutation type
path	The path to the mutation container.

Returns: The new mutation description

Definition at line 101 of file ApiMutation.cs.

Property Documentation

◆ Path

List<ApiRequest> KlusterKite.API.Client.ApiMutation.Path

getset

Gets or sets the path to the mutation container

Definition at line 79 of file ApiMutation.cs.

◆ Type

EnType KlusterKite.API.Client.ApiMutation.Type

getset

Gets or sets the type of a mutation

Definition at line 84 of file ApiMutation.cs.

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

KlusterKite.API/KlusterKite.API.Client/ApiMutation.cs

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Properties