Module workspaces

Index

Functions

Functions

addUserToWorkspace

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

- Defined in botpress.d.ts:2270
Parameters
- email: string
- strategy: string
- workspaceId: string
- Optional options: AddWorkspaceUserOptions
Returns Promise<void>

consumeInviteCode

consumeInviteCode(workspaceId: string, inviteCode?: string): Promise<boolean>

- Defined in botpress.d.ts:2288
Parameters
- workspaceId: string
- Optional inviteCode: string
Returns Promise<boolean>

boolean indicating if code was valid & enough usage were left

getBotWorkspaceId

getBotWorkspaceId(botId: string): Promise<string>

- Defined in botpress.d.ts:2269
Parameters
- botId: string
Returns Promise<string>

getWorkspaceRollout

getWorkspaceRollout(workspaceId: string): Promise<WorkspaceRollout>

- Defined in botpress.d.ts:2281
Parameters
- workspaceId: string
Returns Promise<WorkspaceRollout>

getWorkspaceUsers

getWorkspaceUsers(workspaceId: string, options?: Partial<GetWorkspaceUsersOptions>): Promise<WorkspaceUser[] | WorkspaceUserWithAttributes[]>

- Defined in botpress.d.ts:2298
Parameters
- workspaceId: string
- Optional options: Partial<GetWorkspaceUsersOptions>
Returns Promise<WorkspaceUser[] | WorkspaceUserWithAttributes[]>

All users in desired workspace with specified attributes.

Generated using TypeDoc