IInstanceSettingsBundle Interface

Relativity API
A unified group of Instance Setting values. All values returned from this interface are snapshots of the latest Instance Settings data. You should call this interface every time you need to retrieve a value.

Namespace:  Relativity.API
Assembly:  Relativity.API (in Relativity.API.dll) Version: 17.0.1.1 588f15fd7550dbf54835f3417a0142d4ea37dbb5
Syntax

public interface IInstanceSettingsBundle

The IInstanceSettingsBundle type exposes the following members.

Methods

  NameDescription
Public methodForceRefresh
Forces all Instance Setting values to be reloaded from the data store for the next read.
Public methodGetBool
Reads an Instance Setting value as a boolean.
Public methodGetBoolAsync
Asynchronously reads an Instance Setting value as a boolean.
Public methodGetInt
Reads an Instance Setting value as an integer.
Public methodGetIntAsync
Asynchronously reads an Instance Setting value as an integer.
Public methodGetLong
Reads an Instance Setting value as a 64-bit integer.
Public methodGetLongAsync
Asynchronously reads an Instance Setting value as a 64-bit integer.
Public methodGetRawValues
Parses all Instance Setting values places them into a dictionary.
Public methodGetRawValuesAsync
Asynchronously parses all Instance Setting values places them into a dictionary.
Public methodGetString
Reads an Instance Setting value as a string.
Public methodGetStringAsync
Asynchronously reads an Instance Setting value as a string.
Public methodGetUInt
Reads an Instance Setting value as an unsigned integer.
Public methodGetUIntAsync
Asynchronously reads an Instance Setting value as an unsigned integer.
Public methodGetULong
Reads an Instance Setting value as an unsigned 64-bit integer.
Public methodGetULongAsync
Asynchronously reads an Instance Setting value as an unsigned 64-bit integer.
Top
See Also

Reference