Class PreferenceManager

Provides functionality to retrieve and set preferences for the currently logged on user. There is only one object of this type available in the application. This instance is registered as a top-level service and can be accessed through one of the service provider methods. New instances of this type cannot be created.

Since

2.0

Hierarchy (view full)

Methods

Cast Equals GetHashCode ToString TryCast Equals

Default capability

GetPreference PreferenceExists

Methods

Cast

  • Cast<T1, T2>(this, type): T1

  • Casts this object to the specified type. Throws error on failure.

    Type Parameters

    • T1

      The target type of the cast.

    • T2

      The type of the object to cast.

    Parameters

    Returns T1

Equals

  • Equals(obj): boolean

  • Determines whether the specified object is equal to the current object.

    Parameters

    • obj: any

      The object to compare with the current object.

    Returns boolean

    true if the specified object is equal to the current object; otherwise, false.

GetHashCode

  • GetHashCode(): number

  • Serves as the default hash function.

    Returns number

    A hash code for the current object.

ToString

  • ToString(): string

  • Returns a string that represents the current object.

    Returns string

    A string that represents the current object.

TryCast

  • TryCast<T1, T2>(this, type): null | T1

  • Casts this object to the specified type. Returns null on failure.

    Type Parameters

    • T1

      The target type of the cast.

    • T2

      The type of the object to cast.

    Parameters

    Returns null | T1

StaticEquals

  • Equals(objA, objB): boolean

  • Determines whether the specified object instances are considered equal.

    Parameters

    • objA: any

      The first object to compare.

    • objB: any

      The second object to compare.

    Returns boolean

    true if the objects are considered equal; otherwise, false. If both objA and objB are null, the method returns true.

Default capability

GetPreference

  • GetPreference<T>(typeT): JsType<T>

  • Gets a preference that has been registered with the framework. Note that a preference must always have been registered during the initialization phase of an add-in for it to be returned by this method.

    Type Parameters

    Parameters

    Returns JsType<T>

    The instance of the preference class corresponding to T.

    Since

    2.0

PreferenceExists

  • PreferenceExists<T>(typeT): boolean

  • Determines whether or not a preferences of type T exists, that is, has been registered with the framework.

    Type Parameters

    Parameters

    Returns boolean

    true if a preference of type T exists, otherwise false.

    Since

    2.0

Settings

Member Visibility

On This Page

Methods
Default capability