CursorApiClient Class |
ArangoDB Cursor API.
Inheritance HierarchyNamespace: ArangoDBNetStandard.CursorApi
Assembly: ArangoDBNetStandard (in ArangoDBNetStandard.dll) Version: 1.1.0
SyntaxThe CursorApiClient type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | CursorApiClient(IApiClientTransport) |
Creates an instance of CursorApiClient
using the provided transport layer and the default JSON serialization.
|
| CursorApiClient(IApiClientTransport, IApiClientSerialization) |
Creates an instance of CursorApiClient
using the provided transport and serialization layers.
|
Methods| Name | Description | |
|---|---|---|
| DeleteCursorAsync |
Deletes an existing cursor and frees the resources associated with it.
DELETE /_api/cursor/{cursor-identifier}
|
 | DeserializeJsonFromStreamT | (Inherited from ApiClientBase.) |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| GetApiErrorException |
Gets an ApiErrorException from the provided error response.
(Inherited from ApiClientBase.) |
| GetContentT | (Inherited from ApiClientBase.) |
| GetContentStringT | (Inherited from ApiClientBase.) |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetHeaderCollection |
Method to get the header collection.
|
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| PostCursorAsyncT(PostCursorBody, CursorHeaderProperties) |
Execute an AQL query, creating a cursor which can be used to page query results.
|
| PostCursorAsyncT(String, DictionaryString, Object, PostCursorOptions, NullableBoolean, NullableInt64, NullableBoolean, NullableInt64, NullableInt32, String) |
Execute an AQL query, creating a cursor which can be used to page query results.
|
| PutCursorAsyncT |
Advances an existing query cursor and gets the next set of results.
|
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
| ValidateDocumentId |
Checks whether the provided document ID is in the correct form
of "{collection}/{key}".
(Inherited from ApiClientBase.) |
Fields| Name | Description | |
|---|---|---|
 | _client |
The transport client used to communicate with the ArangoDB host.
|
| _cursorApiPath |
The root path of the API.
|
See Also