Interface IManager

Object which manages user's identity.

Notes

The manager is responsible for maintaining the state of the user.

Hierarchy

Implemented by

Properties

connectionFailure disposed identity isActive isDisposed isReady permissions ready serverSettings userChanged

Methods

dispose refreshUser

Properties

connectionFailure

connectionFailure: ISignal<IManager, NetworkError>

A signal emitted when there is a connection failure.

Readonly disposed

disposed: ISignal<User.IManager, void>

A signal emitted when the object is disposed.

Readonly identity

identity: IIdentity

User's identity.

Notes

The value will be null until the manager is ready.

Readonly isActive

isActive: boolean

Whether the manager is active.

Readonly isDisposed

isDisposed: boolean

Test whether the object has been disposed.

Notes

This property is always safe to access.

Readonly isReady

isReady: boolean

Whether the manager is ready.

Readonly permissions

permissions: ReadonlyJSONObject

User's permissions.

Notes

The value will be null until the manager is ready.

Readonly ready

ready: Promise<void>

A promise that resolves when the manager is initially ready.

Readonly serverSettings

serverSettings: ServerConnection.ISettings

The server settings for the manager.

userChanged

userChanged: ISignal<User.IManager, IUser>

A signal emitted when the user changes.

Methods

dispose

  • Dispose of the resources held by the object.

    Notes

    If the object's dispose method is called more than once, all calls made after the first will be a no-op.

    Undefined Behavior

    It is undefined behavior to use any functionality of the object after it has been disposed unless otherwise explicitly noted.

    Returns void

refreshUser

  • Force a refresh of user's identity from the server.

    Returns Promise<void>

    A promise that resolves when the identity is fetched.

    Notes

    This is intended to be called only in response to a user action, since the manager maintains its internal state.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc