C# Class Arango.Client.DictionaryExtensions

Show file Open project: yojimbo87/ArangoDB-NET

Public Methods

Method	Description
From ( object>.this dictionary, string id ) : object>.Dictionary	Stores `_from` field value.
From ( object>.this dictionary ) : string	Retrieves value of `_from` field. If the field is missing or has invalid format null value is returned.
HasFrom ( object>.this dictionary ) : bool	Checks if `_from` field is present and has valid format.
HasID ( object>.this dictionary ) : bool	Checks if `_id` field is present and has valid format.
HasKey ( object>.this dictionary ) : bool	Checks if `_key` field is present and has valid format.
HasRev ( object>.this dictionary ) : bool	Checks if `_rev` field is present and has valid format.
HasTo ( object>.this dictionary ) : bool	Checks if `_to` field is present and has valid format.
ID ( object>.this dictionary, string id ) : object>.Dictionary	Stores `_id` field value.
ID ( object>.this dictionary ) : string	Retrieves value of `_id` field. If the field is missing or has invalid format null value is returned.
IsID ( object>.this dictionary, string fieldPath ) : bool	Checks if specified field path has valid document ID value in the format of `collection/key`.
IsKey ( object>.this dictionary, string fieldPath ) : bool	Checks if specified field path has valid document key value.
Key ( object>.this dictionary, string key ) : object>.Dictionary	Stores `_key` field value.
Key ( object>.this dictionary ) : string	Retrieves value of `_key` field. If the field is missing or has invalid format null value is returned.
Rev ( object>.this dictionary, string rev ) : object>.Dictionary	Stores `_rev` field value.
Rev ( object>.this dictionary ) : string	Retrieves value of `_rev` field. If the field is missing or has invalid format null value is returned.
To ( object>.this dictionary, string id ) : object>.Dictionary	Stores `_to` field value.
To ( object>.this dictionary ) : string	Retrieves value of `_to` field. If the field is missing or has invalid format null value is returned.

Method Details

From() public static method

Stores `_from` field value.

Specified id value has invalid format.

public static From ( object>.this dictionary, string id ) : object>.Dictionary
dictionary	object>.this
id	string
return	object>.Dictionary

From() public static method

Retrieves value of `_from` field. If the field is missing or has invalid format null value is returned.

public static From ( object>.this dictionary ) : string
dictionary	object>.this
return	string

HasFrom() public static method

Checks if `_from` field is present and has valid format.

public static HasFrom ( object>.this dictionary ) : bool
dictionary	object>.this
return	bool

HasID() public static method

Checks if `_id` field is present and has valid format.

public static HasID ( object>.this dictionary ) : bool
dictionary	object>.this
return	bool

HasKey() public static method

Checks if `_key` field is present and has valid format.

public static HasKey ( object>.this dictionary ) : bool
dictionary	object>.this
return	bool

HasRev() public static method

Checks if `_rev` field is present and has valid format.

public static HasRev ( object>.this dictionary ) : bool
dictionary	object>.this
return	bool

HasTo() public static method

Checks if `_to` field is present and has valid format.

public static HasTo ( object>.this dictionary ) : bool
dictionary	object>.this
return	bool

ID() public static method

Stores `_id` field value.

Specified id value has invalid format.

public static ID ( object>.this dictionary, string id ) : object>.Dictionary
dictionary	object>.this
id	string
return	object>.Dictionary

ID() public static method

Retrieves value of `_id` field. If the field is missing or has invalid format null value is returned.

public static ID ( object>.this dictionary ) : string
dictionary	object>.this
return	string

IsID() public static method

Checks if specified field path has valid document ID value in the format of `collection/key`.

public static IsID ( object>.this dictionary, string fieldPath ) : bool
dictionary	object>.this
fieldPath	string
return	bool

IsKey() public static method

Checks if specified field path has valid document key value.

public static IsKey ( object>.this dictionary, string fieldPath ) : bool
dictionary	object>.this
fieldPath	string
return	bool

Key() public static method

Stores `_key` field value.

Specified key value has invalid format.

public static Key ( object>.this dictionary, string key ) : object>.Dictionary
dictionary	object>.this
key	string
return	object>.Dictionary

Key() public static method

Retrieves value of `_key` field. If the field is missing or has invalid format null value is returned.

public static Key ( object>.this dictionary ) : string
dictionary	object>.this
return	string

Rev() public static method

Stores `_rev` field value.

Specified rev value has invalid format.

public static Rev ( object>.this dictionary, string rev ) : object>.Dictionary
dictionary	object>.this
rev	string
return	object>.Dictionary

Rev() public static method

Retrieves value of `_rev` field. If the field is missing or has invalid format null value is returned.

public static Rev ( object>.this dictionary ) : string
dictionary	object>.this
return	string

To() public static method

Stores `_to` field value.

Specified id value has invalid format.

public static To ( object>.this dictionary, string id ) : object>.Dictionary
dictionary	object>.this
id	string
return	object>.Dictionary

To() public static method

Retrieves value of `_to` field. If the field is missing or has invalid format null value is returned.

public static To ( object>.this dictionary ) : string
dictionary	object>.this
return	string