APIOptions Class

Relativity Services API
Provides a session token and WorkspaceID for creating a connection to Relativity.
Inheritance Hierarchy

System.Object
  kCura.Relativity.Client.APIOptions

Namespace:  kCura.Relativity.Client
Assembly:  kCura.Relativity.Client (in kCura.Relativity.Client.dll) Version: 640db774aa42dfbe1785add27fbb41844ec5c7d4
Syntax

public class APIOptions

The APIOptions type exposes the following members.

Constructors

  NameDescription
Public methodAPIOptions()
Instantiates a new APIOptions object.
Public methodAPIOptions(Int32)
Instantiates a new APIOptions object.
Public methodAPIOptions(String)
Instantiates a new APIOptions object.
Public methodAPIOptions(APIOptions)
Copy constructor for APIOptions. This is a deep copy operation.
Public methodAPIOptions(String, Int32)
Instantiates a new APIOptions object.
Top
Properties

  NameDescription
Public propertyStrictMode
Turn on StrictMode to return consistent fields for Read and Query.
Public propertyToken
Represents the token identifying the current session.
Public propertyWorkspaceID
Indicates the unique identifier for a workspace.
Top
Methods

  NameDescription
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
Remarks

The APIOptions object receives a token returned by the Login method that identifies the current session. It also receives the WorkspaceID used to identify a workspace in Relativity. Except for Login, most methods exposed in the Services API take an APIOptions object as a parameter.
See Also

Reference