Provides a session token and WorkspaceID for creating a connection to Relativity.
Inheritance Hierarchy
kCura.Relativity.Client.APIOptions
Namespace: kCura.Relativity.Client
Assembly: kCura.Relativity.Client (in kCura.Relativity.Client.dll) Version: 640db774aa42dfbe1785add27fbb41844ec5c7d4
Syntax
The APIOptions type exposes the following members.
Constructors
Name | Description | |
---|---|---|
![]() | APIOptions() |
Instantiates a new APIOptions object.
|
![]() | APIOptions(Int32) |
Instantiates a new APIOptions object.
|
![]() | APIOptions(String) |
Instantiates a new APIOptions object.
|
![]() | APIOptions(APIOptions) |
Copy constructor for APIOptions. This is a deep copy operation.
|
![]() | APIOptions(String, Int32) |
Instantiates a new APIOptions object.
|
Properties
Name | Description | |
---|---|---|
![]() | StrictMode |
Turn on StrictMode to return consistent fields for Read and Query.
|
![]() | Token |
Represents the token identifying the current session.
|
![]() | WorkspaceID |
Indicates the unique identifier for a workspace.
|
Methods
Name | Description | |
---|---|---|
![]() | Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
![]() | GetHashCode | Serves as the default hash function. (Inherited from Object.) |
![]() | GetType | Gets the Type of the current instance. (Inherited from Object.) |
![]() | ToString | Returns a string that represents the current object. (Inherited from Object.) |
Remarks
See Also