Communicate

@smokeballdev/smokeball-client-sdk

---

Interface: Api

Entry point for communicate to Smokeball.

Methods

createMessage()

createMessage(request): void

Opens pre-populated communicate message window.

Parameters

request

MessageRequest

the create request.

Returns

void

Example

const request: CreateMessageRequest = {
 // Optional matter id. Defaults to the matter in the current context, if not provided.
 matterId: '410f2b2b-7adf-436e-a5fd-dab1733d3fba',
 // Optional array of contacts to pre-select in communicate message window.
 contactIds: ['0780676a-346f-407e-9d34-2074ebb34c0c','2ee82705-834e-43cb-bcb6-7afe495af10d']
 // Optional array of staff members to pre-select in communicate message window.
 staffIds: ['0346b537-8f4f-405a-a29c-d0f9864f1783']
 // Optional plain text message. The example below shows how to use markdown links in message.
 message: 'Hi this is a communicate message, click [here](https://www.some-test-link.com) to look at stuff'
};
// Opens pre-populated communicate message window.
sdk.communicate.createMessage(request);

---

sendMessage()

sendMessage(request): void

Sends communicate message.

Parameters

request

MessageRequest

the create request.

Returns

void

Example

const request: CreateMessageRequest = {
 // Optional matter id. Defaults to the matter in the current context, if not provided.
 matterId: '410f2b2b-7adf-436e-a5fd-dab1733d3fba',
 // Optional array of contacts to send the message to.
 contactIds: ['0780676a-346f-407e-9d34-2074ebb34c0c','2ee82705-834e-43cb-bcb6-7afe495af10d']
 // Optional array of staff members to send the message to.
 staffIds: ['0346b537-8f4f-405a-a29c-d0f9864f1783']
 // Optional plain text message. The example below shows how to use markdown links in message.
 message: 'Hi this is a communicate message, click [here](https://www.some-test-link.com) to look at stuff'
 // Optional flag to require multi-factor authentication.
 requireMFA: true
};
// Send the communicate message.
sdk.communicate.sendMessage(request);