The following are methods for controlling the chat widget:
Mount or demount the widget from the window.
SinchSdk.Chat.mount({configuration})SinchSdk.Chat.demount()Open or close the chat window or configure it so it can be toggled.
SinchSdk.Chat.open()SinchSdk.Chat.close()SinchSdk.Chat.toggle()Send a message over the chat widget.
SinchSdk.Chat.send("text")Set custom translations for the chat widget. Optionally specify a language code.
SinchSdk.Chat.setTranslation({
typeMessageHere: 'Type your message...',
emojiPickerTitle: 'Emoji',
endChatButton: 'End conversation',
initialScreen: {
title: 'Welcome!',
description: 'How can we help you today?',
startButton: 'Start Chat'
}
}, 'en')Set metadata to be sent with conversation messages. Use once for metadata sent only with the first message, or eachMessage for metadata sent with every message.
SinchSdk.Chat.setConversationMetadata({
once: {
source: 'website',
campaign: 'summer-sale'
},
eachMessage: {
pageUrl: window.location.href
}
})Set the locale for the SDK.
SinchSdk.setLocale('en-US')The user session along with certain configuration parameters is stored in the browser storage. If you want to clear it, use:
SinchSdk.clear()When you are finished with the SDK, clear the SDK memory including the saved token for authorization with the following method:
SinchSdk.terminate()