Options
All
  • Public
  • Public/Protected
  • All
Menu

IdentitySystem identifies the User by a pseudonym.

collboard-system

Hierarchy

  • AbstractSystem
    • IdentitySystem

Index

Constructors

  • Parameters

    • systems: ISystemsExtended

    Returns IdentitySystem

Properties

_browserId: any
_sessionId: any
instanceId: uuid
ready: Promise<void>

Promise which is resolved when the system is initialized and ready to use.

storage: any
systems: ISystemsExtended
track: any

Accessors

  • get browserId(): uuid
  • Returns uuid

  • get isDestroyed(): boolean
  • Is this object destroyed?

    Returns boolean

  • get isReady(): boolean
  • Checks if the system is initialized and ready to use.

    Returns boolean

  • get sessionId(): uuid
  • Returns uuid

Methods

  • addSubdestroyable(...subdestroyable: ITeardownLogic[]): IdentitySystem
  • Binds new registration with itself. This registration/destroyable will be destroyed with this.

    Parameters

    • Rest ...subdestroyable: ITeardownLogic[]

    Returns IdentitySystem

  • checkIsReady(): void
  • Checks if the system is initialized and ready to use. If not, throws an error. If it is, do nothing.

    Returns void

  • checkWhetherNotDestroyed(errorMessage?: string, runBeforeError?: () => void): void
  • Checks, whether the object is not destroyed

    Parameters

    • Optional errorMessage: string

      Message that will replace default one before error

    • Optional runBeforeError: () => void

      Callback runed before error is thrown; typically this can be some logging

        • (): void
        • Returns void

    Returns void

  • createBoardApiIdentity(): IBoardApiIdentity
  • Returns IBoardApiIdentity

  • createConnectionIdentity(boardApiIdentity: IBoardApiIdentity): IConnectionIdentity
  • Parameters

    • boardApiIdentity: IBoardApiIdentity

    Returns IConnectionIdentity

  • createInstanceIdentity(): IInstanceIdentity
  • Returns IInstanceIdentity

  • destroy(): Promise<void>
  • Returns Promise<void>

  • init(): Promise<void>
  • Returns Promise<void>

  • isDestroyable(obj: any): obj is IDestroyable
  • Chcek whether the given object is destroyable

    Parameters

    • obj: any

    Returns obj is IDestroyable