Options
All
  • Public
  • Public/Protected
  • All
Menu

Class UserManager

The user API service manager.

Hierarchy

Implements

Index

Constructors

constructor

Properties

Private _connectionFailure

_connectionFailure: any

Private _identity

_identity: any

Private _isReady

_isReady: any

Private _permissions

_permissions: any

Private _pollSpecs

_pollSpecs: any

Private _ready

_ready: any

Private _userChanged

_userChanged: any

Readonly serverSettings

serverSettings: ISettings

The server settings for the manager.

Accessors

connectionFailure

  • get connectionFailure(): ISignal<this, Error>
  • A signal emitted when there is a connection failure.

    Returns ISignal<this, Error>

disposed

  • get disposed(): ISignal<this, void>
  • A signal emitted when the delegate is disposed.

    Returns ISignal<this, void>

identity

  • Get the most recently fetched identity.

    Returns IIdentity

isDisposed

  • get isDisposed(): boolean
  • Test whether the delegate has been disposed.

    Returns boolean

isReady

  • get isReady(): boolean
  • Test whether the manager is ready.

    Returns boolean

permissions

  • get permissions(): ReadonlyJSONObject
  • Get the most recently fetched permissions.

    Returns ReadonlyJSONObject

ready

  • get ready(): Promise<void>
  • A promise that fulfills when the manager is ready.

    Returns Promise<void>

userChanged

  • get userChanged(): ISignal<this, IUser>
  • A signal emitted when the user changes.

    Returns ISignal<this, IUser>

Methods

dispose

  • dispose(): void
  • Dispose of the resources used by the manager.

    Returns void

refreshUser

  • refreshUser(): Promise<void>
  • Force a refresh of the specs from the server.

    Returns Promise<void>

    A promise that resolves when the specs are fetched.

    Notes

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

Protected requestUser

  • requestUser(): Promise<void>
  • Execute a request to the server to poll the user and update state.

    Returns Promise<void>

Generated using TypeDoc