The field provider More...

Inheritance diagram for KlusterKite.API.Client.ApiField:

Public Member Functions
	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 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
	ApiField (string name, EnFieldFlags flags)
	Initializes a new instance of the ApiField class. More...

Properties
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

The field provider

Definition at line 26 of file ApiField.cs.

Constructor & Destructor Documentation

◆ ApiField() [1/2]

KlusterKite.API.Client.ApiField.ApiField ( )

Initializes a new instance of the ApiField class.

Definition at line 33 of file ApiField.cs.

◆ ApiField() [2/2]

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

protected

Initializes a new instance of the ApiField class.

Parameters

name	The name.
flags	The flags.

Definition at line 46 of file ApiField.cs.

Member Function Documentation

◆ CheckAuthorization()

bool KlusterKite.API.Client.ApiField.CheckAuthorization	(	RequestContext	context,
		EnConnectionAction	action
	)

Checks if provided context is authorized to access this field

Parameters

context	The request context
action	The performed action.

Returns: Whether context is authorized to access this field

Definition at line 223 of file ApiField.cs.

◆ Clone()

ApiField KlusterKite.API.Client.ApiField.Clone ( )

Creates a clone of the current object

Returns: The cloned instance

Definition at line 299 of file ApiField.cs.

◆ FillAuthorizationProperties()

void KlusterKite.API.Client.ApiField.FillAuthorizationProperties ( MemberInfo memberInfo )

Fills the AuthorizationRules, LogAccessRules, RequireAuthenticatedSession and RequireAuthenticatedUserSession from attributes of related API member

Parameters

memberInfo The related API member

Definition at line 201 of file ApiField.cs.

◆ Object()

static ApiField KlusterKite.API.Client.ApiField.Object	(	[NotNull] string	name,
		[NotNull] string	typeName,
		EnFieldFlags	flags = `EnFieldFlags.Queryable`,
		IEnumerable< ApiField >	arguments = `null`,
		string	description = `null`
	)

static

Creates an object containing field

Parameters

name	The field name
typeName	The field type name
flags	The field flags
arguments	The arguments (if is set - this field becomes a method)
description	The field description

Returns: The new field

Definition at line 130 of file ApiField.cs.

◆ Scalar()

static ApiField KlusterKite.API.Client.ApiField.Scalar	(	[NotNull] string	name,
		EnScalarType	type,
		EnFieldFlags	flags = `EnFieldFlags.Queryable`,
		IEnumerable< ApiField >	arguments = `null`,
		string	description = `null`
	)

static

Creates a scalar containing field

Parameters

name	The field name
type	The field type
flags	The field flags
arguments	The arguments (if is set - this field becomes a method)
description	The field description

Returns: The new field

Definition at line 167 of file ApiField.cs.

◆ ToString()

override string KlusterKite.API.Client.ApiField.ToString ( )

Definition at line 290 of file ApiField.cs.

Property Documentation

◆ Arguments

List<ApiField> KlusterKite.API.Client.ApiField.Arguments

getset

Gets or sets the list of arguments (if is set - this field becomes a method)

Definition at line 57 of file ApiField.cs.

◆ AuthorizationRules

List<AuthorizationRule> KlusterKite.API.Client.ApiField.AuthorizationRules

getset

Gets or sets the list of authorization requirements

Definition at line 92 of file ApiField.cs.

◆ Description

string KlusterKite.API.Client.ApiField.Description = new List<ApiField>()

getset

Gets or sets the human-readable type description for auto-publishing

Definition at line 63 of file ApiField.cs.

◆ Flags

EnFieldFlags KlusterKite.API.Client.ApiField.Flags

getset

Gets or sets the list of defined flags

Definition at line 69 of file ApiField.cs.

◆ LogAccessRules

List<LogAccessRule> KlusterKite.API.Client.ApiField.LogAccessRules

getset

Gets or sets the list of log access rules

Definition at line 97 of file ApiField.cs.

◆ Name

string KlusterKite.API.Client.ApiField.Name

getset

Gets or sets the field name

Definition at line 75 of file ApiField.cs.

◆ RequireAuthenticatedSession

bool KlusterKite.API.Client.ApiField.RequireAuthenticatedSession

getset

Gets or sets a value indicating whether a valid authenticated session is required for access this field

Definition at line 102 of file ApiField.cs.

◆ RequireAuthenticatedUserSession

bool KlusterKite.API.Client.ApiField.RequireAuthenticatedUserSession

getset

Gets or sets a value indicating whether a valid authenticated user session is required for access this field

Definition at line 107 of file ApiField.cs.

◆ ScalarType

EnScalarType KlusterKite.API.Client.ApiField.ScalarType

getset

Gets or sets the scalar type of the field

Definition at line 81 of file ApiField.cs.

◆ TypeName

string KlusterKite.API.Client.ApiField.TypeName

getset

Gets or sets the field type name

Definition at line 87 of file ApiField.cs.

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

KlusterKite.API/KlusterKite.API.Client/ApiField.cs

Public Member Functions

Static Public Member Functions

Protected Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ ApiField() [1/2]

◆ ApiField() [2/2]

Member Function Documentation

◆ CheckAuthorization()

◆ Clone()

◆ FillAuthorizationProperties()

◆ Object()

◆ Scalar()

◆ ToString()

Property Documentation

◆ Arguments

◆ AuthorizationRules

◆ Description

◆ Flags

◆ LogAccessRules

◆ Name

◆ RequireAuthenticatedSession

◆ RequireAuthenticatedUserSession

◆ ScalarType

◆ TypeName