Options
All
  • Public
  • Public/Protected
  • All
Menu

Class BoardApiClient

collboard-system

Hierarchy

Implements

  • IClosePreventable
  • IDestroyable
  • IArtVersioningSystem

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • new BoardApiClient(systems: ISystemsExtended, apiUrl: URL, uriId: string): BoardApiClient

Properties

Private apiUrl

apiUrl: any

Readonly artsObservable

artsObservable: Observable<AbstractArt>

Readonly atLeastOnceConnected

atLeastOnceConnected: Promise<unknown>

Private atLeastOnceConnectedReject

atLeastOnceConnectedReject: any

Private atLeastOnceConnectedResolve

atLeastOnceConnectedResolve: any

Private boardApiIdentity

boardApiIdentity: any

Protected closePreventionSystem

closePreventionSystem: IClosePreventionSystem

Readonly commitsObservable

commitsObservable: Observable<Commit>

commitsPool

commitsPool: ICommitData[]

Private connected

connected: any

Readonly cornerstoneArts

cornerstoneArts: BehaviorSubject<CornerstoneArt>

Private createIdentity

createIdentity: any

Private establishConnection

establishConnection: any

Private keepConnectionAlive

keepConnectionAlive: any

TODO: ColldevSyncer does not need keepConnectionAlive so probbably BoardApiClient wont either

Readonly moduleSignature

moduleSignature: IModuleSignature

permissions

permissions: IPermissions

Private pushToQueue

pushToQueue: any

Private queue

queue: any

Readonly ready

ready: Promise<void>

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

Private sendFromQueueToServer

sendFromQueueToServer: any

Private socketClient

socketClient: any

Private syncLoopLocalObjectsToServer

syncLoopLocalObjectsToServer: any

Protected Readonly systems

systems: ISystemsExtended

Private takeFromQueue

takeFromQueue: any

Private uriId

uriId: any

Accessors

arts

  • Returns AbstractArt[]

artsPlaced

  • Returns AbstractPlacedArt[]

canBeClosed

  • get canBeClosed(): boolean

  • Returns boolean

clientId

  • get clientId(): uuid

  • Returns uuid

commits

  • get commits(): ICommitData[]

  • Returns ICommitData[]

commitsPlaced

  • get commitsPlaced(): ICommitData[]

  • Returns ICommitData[]

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

lastCommit

  • get lastCommit(): null | ICommitData

  • Returns null | ICommitData

lastCommitId

  • get lastCommitId(): number

  • Returns number

sortCommitsByOperationId

  • get sortCommitsByOperationId(): ICommitData[][]

  • Note: This is just a debug class

    Returns ICommitData[][]

Methods

addSubdestroyable

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

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

createOperation

  • createOperation(operationName: string): Operation

  • Parameters

    • operationName: string

    Returns Operation

createPrimaryOperation

  • createPrimaryOperation(): Operation

destroy

  • destroy(): Promise<void>

findCommitById

  • findCommitById(commitId: undefined | null | uuid): null | ICommitData

  • Parameters

    • commitId: undefined | null | uuid

      when null or undefined returns null

    Returns null | ICommitData

findCommitsByOperationId

  • findCommitsByOperationId(operationId: uuid): ICommitData[]

findLastCommitOfArt

  • findLastCommitOfArt(art: AbstractArt): null | ICommitData

findNextCommit

  • findNextCommit(commit: ICommitData): null | ICommitData

  • Parameters

    • commit: ICommitData

    Returns null | ICommitData

findNextCommits

  • findNextCommits(commit: ICommitData): ICommitData[]

  • Parameters

    • commit: ICommitData

    Returns ICommitData[]

findOriginCommit

  • findOriginCommit(commit: ICommitData): ICommitData

  • Parameters

    • commit: ICommitData

    Returns ICommitData

findPreviousCommit

  • findPreviousCommit(commit: ICommitData): null | ICommitData

  • Parameters

    • commit: ICommitData

    Returns null | ICommitData

hasNextCommits

  • hasNextCommits(commit: ICommitData): boolean

  • Parameters

    • commit: ICommitData

    Returns boolean

Protected init

  • init(): Promise<void>

isLastInItsTree

  • isLastInItsTree(commit: ICommitData): boolean

  • Parameters

    • commit: ICommitData

    Returns boolean

Protected pushCommitsToVersioningSystem

  • pushCommitsToVersioningSystem(...commits: ICommitData[]): Promise<void>

setCommitWasPersisted

  • setCommitWasPersisted(commitId: uuid, id: number): void

signAs

Static isDestroyable

  • isDestroyable(obj: any): obj is IDestroyable

  • Chcek whether the given object is destroyable

    Parameters

    • obj: any

    Returns obj is IDestroyable