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:
| Name | Type | Description |
|---|---|---|
name | string | - |
info | object | - |
info.description? | string | - |
info.maxConcurrency? | number | maximum total number of concurrent conversation allowed for all applications in a group |
options? | object | - |
options.account? | Account | an 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:
| Name | Type | Description |
|---|---|---|
name | string | - |
options? | object | - |
options.account? | Account | an account to use; if not set, defaults to the current account |
options.quiet? | boolean | if true, does not throw if the group does not exist |
Returns: Promise<void>
getGroupByName
Get group properties by its name.
Parameters:
| Name | Type | Description |
|---|---|---|
name | string | - |
options? | object | - |
options.account? | Account | an 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:
| Name | Type | Description |
|---|---|---|
options? | object | - |
options.account? | Account | an account to use; if not set, defaults to the current account |
options.includeTemporary? | boolean | whether 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:
| Name | Type | Description |
|---|---|---|
name | string | - |
info | object | - |
info.description? | string | null | - |
info.maxConcurrency? | number | null | maximum total number of concurrent conversation allowed for all applications in a group |
options? | object | - |
options.account? | Account | an account to use; if not set, defaults to the current account |
Returns: Promise<GroupInfo>