Options
All
  • Public
  • Public/Protected
  • All
Menu

@whiteboards-io/plugins

Index

Interfaces

Type aliases

Functions

Type aliases

CancelCallback

CancelCallback: () => void

Type declaration

    • (): void

    • Returns void

CardData

CardData: { height: number; width: number; x: number; y: number; z?: number }

Type declaration

  • [prop: string]: unknown
  • height: number
  • width: number
  • x: number
  • y: number
  • Optional z?: number

CardId

CardId: string

ExecutionId

ExecutionId: string

JiraIssueData

JiraIssueData: { data: { id: string; key: string } | null | undefined; issueId: number; siteId: string; ts: number | null | undefined }

Type declaration

  • data: { id: string; key: string } | null | undefined
  • issueId: number
  • siteId: string
  • ts: number | null | undefined

LineData

LineData: { end: { x: number; y: number }; endCardId?: string; id: string; start: { x: number; y: number }; startCardId?: string }

Type declaration

  • [prop: string]: unknown
  • end: { x: number; y: number }
    • x: number
    • y: number
  • Optional endCardId?: string
  • id: string
  • start: { x: number; y: number }
    • x: number
    • y: number
  • Optional startCardId?: string

Functions

closeSidebar

  • closeSidebar(): Promise<void>

createCards

getBoardUsers

getCardData

  • getCardData(cardId: string): Promise<null | CardData>

getCardsIndex

  • getCardsIndex(): Promise<string[]>

getCurrentBoardUser

  • getCurrentBoardUser(): Promise<UserData>

getJiraIssueData

  • getJiraIssueData(payload: { issueId: number; siteId: string }): Promise<JiraIssueData>

getJiraSites

getLineData

  • getLineData(lineId: string): Promise<null | LineData>

getLinesIndex

  • getLinesIndex(): Promise<string[]>

getPluginBoardData

  • getPluginBoardData<T>(): Promise<T>

getPluginBoardUserData

  • getPluginBoardUserData<T>(): Promise<T>

getViewport

hidePluginModal

  • hidePluginModal(): Promise<void>

oauthApiRequest

  • oauthApiRequest<T>(siteId: undefined | null | string, path: string, params?: Record<string, unknown>, method?: string, body?: Record<string, unknown>): Promise<T>

  • Type parameters

    • T

    Parameters

    • siteId: undefined | null | string
    • path: string
    • Optional params: Record<string, unknown>
    • Optional method: string
    • Optional body: Record<string, unknown>

    Returns Promise<T>

onCustomCardToolbarClick

  • onCustomCardToolbarClick(callback: (__namedParameters: { cardId: string }) => void): CancelCallback

  • Parameters

    • callback: (__namedParameters: { cardId: string }) => void
        • (__namedParameters: { cardId: string }): void

        • Parameters

          • __namedParameters: { cardId: string }
            • cardId: string

          Returns void

    Returns CancelCallback

onHostToPlugin

onPluginModalAction

  • onPluginModalAction(callback: (__namedParameters: { actionId: string }) => void): CancelCallback

  • Parameters

    • callback: (__namedParameters: { actionId: string }) => void
        • (__namedParameters: { actionId: string }): void

        • Parameters

          • __namedParameters: { actionId: string }
            • actionId: string

          Returns void

    Returns CancelCallback

onPluginToolboxClick

  • onPluginToolboxClick(callback: (__namedParameters: { customCardId: string }) => void): CancelCallback

  • Parameters

    • callback: (__namedParameters: { customCardId: string }) => void
        • (__namedParameters: { customCardId: string }): void

        • Parameters

          • __namedParameters: { customCardId: string }
            • customCardId: string

          Returns void

    Returns CancelCallback

openSidebar

  • openSidebar(props: { contentUrl: string } | { pluginSidebarId: string }): Promise<void>

pluginToHost

  • pluginToHost(action: string, payload?: unknown): string

registerCustomCard

registerSidebarTool

registerTemplate

resizePluginFrame

  • resizePluginFrame(width: string, height: string): Promise<void>

setCardData

  • setCardData(cardId: string, cardData: null | Partial<CardData>): Promise<void>

setLineData

  • setLineData(lineId: string, cardData: null | Partial<LineData>): Promise<void>

setPluginBoardData

  • setPluginBoardData<T>(pluginData: T): Promise<void>

setPluginBoardUserData

  • setPluginBoardUserData<T>(pluginData: T): Promise<void>

setPluginModalActionEnabled

  • setPluginModalActionEnabled(actionId: string, isEnabled: boolean): Promise<void>

setViewport

  • setViewport(viewport: Viewport): Promise<void>

showPluginModal

updateTemplateContent

  • updateTemplateContent(content: null | Record<string, unknown>): Promise<void>

viewportTranslate

waitForExecution

  • waitForExecution<T>(executionId: string, executionTimeout?: null | number): Promise<T>

watchBoardUsers

watchCardData

watchCardsIndex

  • watchCardsIndex(callback: (cardIds: string[]) => void): CancelCallback

watchJiraIssueData

watchLineData

watchLinesIndex

  • watchLinesIndex(callback: (lineIds: string[]) => void): CancelCallback

watchPluginBoardData

  • watchPluginBoardData<T>(callback: (pluginData: T) => void): CancelCallback

watchPluginBoardUserData

  • watchPluginBoardUserData<T>(callback: (pluginData: T) => void): CancelCallback

Generated using TypeDoc