Class UserManager

constructor

• new UserManager(options?: UserManager.IOptions): UserManager

• Create a new user manager.

  Parameters

  • options: UserManager.IOptions = {}

  Returns UserManager

ReadonlyserverSettings

connectionFailure

• get connectionFailure(): ISignal<this, Error>

• A signal emitted when there is a connection failure.

  Returns ISignal<this, Error>

identity

• get identity(): null | IIdentity

• Get the most recently fetched identity.

  Returns null | IIdentity

isReady

• get isReady(): boolean

• Test whether the manager is ready.

  Returns boolean

permissions

• get permissions(): null | ReadonlyJSONObject

• Get the most recently fetched permissions.

  Returns null | 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>

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.