Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ApiClient

ApiClient provides API calls to the remote server.

collboard-system

Hierarchy

  • AbstractSystem
    • ApiClient

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • new ApiClient(systems: ISystemsExtended, apiUrl: URL): ApiClient

  • Parameters

    • systems: ISystemsExtended
    • apiUrl: URL

    Returns ApiClient

Properties

Private apiClientCache

apiClientCache: any

Private apiUrl

apiUrl: any

Private get

get: any

Private post

post: any

Private processResponse

processResponse: any

Readonly ready

ready: Promise<void>

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

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[]): ApiClient

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

    Parameters

    • Rest ...subdestroyable: ITeardownLogic[]

    Returns ApiClient

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

connectToBoard

createNewBoard

  • createNewBoard(options: Omit<ICreateBoardOptions, "redirect">): Promise<{ links: { edit: string; view: string }; uriId: string }>
  • deprecated

    Use boardSystem.createNewBoard instead

    Parameters

    • options: Omit<ICreateBoardOptions, "redirect">

    Returns Promise<{ links: { edit: string; view: string }; uriId: string }>

destroy

  • destroy(): Promise<void>

  • Returns Promise<void>

getAbout

  • getAbout(): Promise<{ remoteInstanceId: string; version: string }>

  • Returns Promise<{ remoteInstanceId: string; version: string }>

getMyBoards

  • getMyBoards(): Observable<IGetMyBoardsResponse>

  • Returns Observable<IGetMyBoardsResponse>

Protected init

  • init(): Promise<void>

  • Returns Promise<void>

missingTranslateMessage

  • missingTranslateMessage(missingTranslateMessage: ITranslateMessage): Promise<unknown>

  • Parameters

    • missingTranslateMessage: ITranslateMessage

    Returns Promise<unknown>

translateMessages

  • translateMessages(language: string_translate_language): Promise<ITranslateMessage[]>

  • Parameters

    • language: string_translate_language

    Returns Promise<ITranslateMessage[]>

Static isDestroyable

  • isDestroyable(obj: any): obj is IDestroyable

  • Chcek whether the given object is destroyable

    Parameters

    • obj: any

    Returns obj is IDestroyable