groups

Table of contents

Interfaces

Functions

createGroup

createGroup(name: string, info: { description?: string ; maxConcurrency?: number }, options?: { account?: Account }): Promise<GroupInfo>

Create a new application group.

Parameters:

NameTypeDescription
namestring-
infoobject-
info.description?string-
info.maxConcurrency?numbermaximum total number of concurrent conversation allowed for all applications in a group
options?object-
options.account?Accountan account to use; if not set, defaults to the current account

Returns: Promise<GroupInfo>

the properties of a newly-created group


deleteGroup

deleteGroup(name: string, options?: { account?: Account ; quiet?: boolean }): Promise<void>

Delete an application group from the platform.

Parameters:

NameTypeDescription
namestring-
options?object-
options.account?Accountan account to use; if not set, defaults to the current account
options.quiet?booleanif true, does not throw if the group does not exist

Returns: Promise<void>


getGroupByName

getGroupByName(name: string, options?: { account?: Account }): Promise<GroupInfo>

Get group properties by its name.

Parameters:

NameTypeDescription
namestring-
options?object-
options.account?Accountan account to use; if not set, defaults to the current account

Returns: Promise<GroupInfo>


listGroups

listGroups(options?: { account?: Account ; includeTemporary?: boolean }): Promise<{ [name: string]: GroupInfo; }>

List all the groups available to an account.

Parameters:

NameTypeDescription
options?object-
options.account?Accountan account to use; if not set, defaults to the current account
options.includeTemporary?booleanwhether to include temporary groups created by calling deploy without a group name.

Returns: Promise<{ [name: string]: GroupInfo; }>

a dictionary of GroupInfo objects by group name


updateGroup

updateGroup(name: string, info: { description?: string | null ; maxConcurrency?: number | null }, options?: { account?: Account }): Promise<GroupInfo>

Update some or all of the group's properties. Pass null to reset to default values.

Parameters:

NameTypeDescription
namestring-
infoobject-
info.description?string | null-
info.maxConcurrency?number | nullmaximum total number of concurrent conversation allowed for all applications in a group
options?object-
options.account?Accountan account to use; if not set, defaults to the current account

Returns: Promise<GroupInfo>

Found a mistake? Email us, and we'll send you a free t-shirt!

Enroll in beta

Request invite to our private Beta program for developers to join the waitlist. No spam, we promise.