Options
All
  • Public
  • Public/Protected
  • All
Menu

Class BoardSystem

ApiClient provides API calls to the remote server.

collboard-system

Hierarchy

  • AbstractSystem
    • BoardSystem

Implements

  • unknown

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • new BoardSystem(systems: ISystemsExtended): BoardSystem

  • Parameters

    • systems: ISystemsExtended

    Returns BoardSystem

Properties

currentBoard

currentBoard: BehaviorSubject<{ isLoaded: boolean; uriId: null | string }>

Current board with information if this board is fully loaded or in phase of switching the boards

Readonly ready

ready: Promise<void>

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

Private switchBoardQueue

switchBoardQueue: any

Protected Readonly systems

systems: ISystemsExtended

Accessors

isDestroyed

  • get isDestroyed(): boolean

  • Is this object destroyed?

    Returns boolean

isReady

  • get isReady(): boolean

  • Checks if the system is initialized and ready to use.

    Returns boolean

Methods

addSubdestroyable

  • addSubdestroyable(...subdestroyable: ITeardownLogic[]): BoardSystem

  • Binds new registration with itself. This registration/destroyable will be destroyed with this.

    Parameters

    • Rest ...subdestroyable: ITeardownLogic[]

    Returns BoardSystem

Protected checkIsReady

  • checkIsReady(): void

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

    Returns void

Protected checkWhetherNotDestroyed

  • 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

createNewBoard

  • createNewBoard(options: any): Promise<any>

  • Creates a new board and navigate to it

    Parameters

    • options: any

      for creating the new board

    Returns Promise<any>

    information of the newly created board A Promise which will be resolved when the board is created and fully navigated

destroy

  • destroy(): Promise<void>

  • Returns Promise<void>

Protected init

  • init(): Promise<void>

  • Returns Promise<void>

navigateBoard

  • navigateBoard(uriId: null | string): Promise<void>

  • Navigate to the board

    Parameters

    • uriId: null | string

      string to navigate to board OR null to go to welcome page

    Returns Promise<void>

    A Promise which will be resolved when the board is fully navigated

Static isDestroyable

  • isDestroyable(obj: any): obj is IDestroyable

  • Chcek whether the given object is destroyable

    Parameters

    • obj: any

    Returns obj is IDestroyable