Constructor
# new ConsumerWebsocketConnection()
Methods
# async protected _consumerRequestConversation(args) → {Promise.<uuid>}
Represents how consumers create conversation
Parameters:
| Name | Type | Description |
|---|---|---|
args |
||
skillId |
||
context |
conversationId of the created conversation
Promise.<uuid>
# async createConversation(argsopt) → {Promise.<Conversation>}
Makes a request to UMS for a new conversation. Constructs a conversation object with the response information.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
args |
object |
<optional> |
|
skillId |
string |
<optional> |
creates this conversation in the specified skillId |
context |
object |
<optional> |
this data will be passed back in the notifications as conversationDetails.context |
- the conversation object
Promise.<Conversation>
# async getToken() → {Promise.<(string|null)>}
Returns the token from this connection
JWT token
Promise.<(string|null)>
# async mockStepUp(authConnectorId, customerName)
Trigger a mock step up on this connection. Only available in test environments.
Parameters:
| Name | Type | Description |
|---|---|---|
authConnectorId |
the authenticated connectorId |
|
customerName |
the name to be included in the auth SDEs |
# async setUserProfile(data) → {Promise.<void>}
Allows an update of a subset of user profile fields
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
data |
object | ||
firstName |
string |
<optional> |
|
lastName |
string |
<optional> |
|
nickName |
string |
<optional> |
Promise.<void>
# async stepUp(authConnectorId, jwtClaimsSet)
Trigger a mock step up on this connection. Only available in test environments.
Parameters:
| Name | Type | Description |
|---|---|---|
authConnectorId |
the authenticated connectorId |
|
jwtClaimsSet |
Object | jwtClaimsSet created by createJwtClaimsSet |