ViewApiClient Class |
A client to interact with ArangoDB HTTP API endpoints
for views management.
Inheritance HierarchyNamespace: ArangoDBNetStandard.ViewApi
Assembly: ArangoDBNetStandard (in ArangoDBNetStandard.dll) Version: 1.1.0
SyntaxThe ViewApiClient type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | ViewApiClient(IApiClientTransport) |
Create an instance of ViewApiClient
using the provided transport layer and the default JSON serialization.
|
| ViewApiClient(IApiClientTransport, IApiClientSerialization) |
Create an instance of ViewApiClient
using the provided transport and serialization layers.
|
Methods| Name | Description | |
|---|---|---|
| DeleteViewAsync |
Delete / drop a view
DELETE /_api/view/{view-name}
|
 | 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.) |
| GetAllViewsAsync |
Gets a list of all views in a database,
regardless of their type.
GET /_api/view
|
| 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.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| GetViewAsync |
Get information about a view
GET /_api/view/{view-name}
|
| GetViewPropertiesAsync |
Get the properties of a view
GET /_api/view/{view-name}/properties
|
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| PatchViewPropertiesAsync |
Partially changes properties of a view
PATCH /_api/view/{view-name}/properties
|
| PostCreateViewAsync |
Create a new View
POST /_api/view
|
| PutRenameViewAsync |
Renames a view
PUT /_api/view/{view-name}/rename
|
| PutViewPropertiesAsync |
Changes all properties of a view
PUT /_api/view/{view-name}/properties
|
| 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 | |
|---|---|---|
 | _apiPath |
The root path of the API.
|
| _transport |
The transport client used to communicate with the ArangoDB host.
|
See Also