Options
All
  • Public
  • Public/Protected
  • All
Menu

Module workspaces

Index

Functions

addUserToWorkspace

  • addUserToWorkspace(email: string, strategy: string, workspaceId: string, options?: AddWorkspaceUserOptions): Promise<void>

consumeInviteCode

  • consumeInviteCode(workspaceId: string, inviteCode?: undefined | string): Promise<boolean>
  • Consumes an invite code for the specified workspace.

    Parameters

    • workspaceId: string
    • Optional inviteCode: undefined | string

      an invite code to compare to

    Returns Promise<boolean>

    boolean indicating if code was valid & enough usage were left

getBotWorkspaceId

  • getBotWorkspaceId(botId: string): Promise<string>

getWorkspaceRollout

  • Returns the rollout strategy of the requested workspace. If the workspace ID is unknown, it will be determined from the bot ID

    Parameters

    • workspaceId: string

    Returns Promise<WorkspaceRollout>

Generated using TypeDoc