Technical Guide

Configurations

settings

Include in the settings object in the Launcher Configuration file:

Field	Value
useSiteInfoService	boolean Set to true.
defaultLocation	string Set a placeholder string. This will display if a site location is not found automatically, allowing the user to manually override and select a site.

emsSupportTool

Include in the emsSupportTool object in the Launcher Configuration file:

Field	Value
orgId	string Set to the company's organization ID, as displayed on the BlueFletch Portal Admin - Organization page here.

bfChat

Include in the bfChat object in the Launcher Configuration file:

Field	Value
apiKey	string Set to the organization's API key. The API key can be found in the BlueFletch Portal; it is actively managed on the Admin - API Keys page or displayed statically in Manage Organization settings on the Organization page.
autoPlayAudio	boolean If true, audio recordings will automatically play when received and will be stored for playback in the Chat conversation. If false, audio recordings will only be available through playback in the Chat conversation.
allowAttachments	boolean If true, sending attachments in Chat is enabled. If false, the attachment button will be disabled in Chat, preventing the user from sending attachments.
callTimeout	integer The number of seconds a voice/video call will be allowed to ring before the call is ended. Default is 20.
notificationSoundIndividual	string Used this to override the default notification sound for chat messages received by individuals. Either a file reference or Launcher asset. Introduced in Chat release 2.0.17.
notificationSoundGroup	string Used this to override the default notification sound for chat messages received by groups. Either a file reference or Launcher asset. Introduced in Chat release 2.0.17.
voiceMessageLimitInSeconds	integer Used to set the recording length for voice messages. Default is 30 seconds. Introduced in Chat release 2.2.7.
disablePttUsageInBackground	boolean When set to true, Chat will start recording audio in response to PTT button press while user is in the Chat application. Default is false. Introduced in Chat release 2.2.7.
autoSendPttToDefaultChannel	boolean When set to true, if a PTT audio message is recorded while Chat Application is not visible, and there is a default Channel name, the audio message will be sent to that default channel. Default is false. Introduced in Chat release 2.3.20.
defaultChannelName	string Used in conjunction with autoSendPttToDefaultChannel; defines the default channel to send PTT Audio messages. Introduced in Chat release 2.3.20.
logLevel	string The logging level for the Chat application. Default is 'info'. Introduced in Chat release 2.2.7.
dataHost	string Host URL for getting the user contacts for a site.
chatHost	string Host URL for the Messaging service that is used to publish messages to chat recipients.
fileHost	string Host URL for File Upload (such as images, voice recordings) to Google Cloud.

login

Include in the login array within intents object in the Launcher Configuration file:

Field	Value
action	string Set to "com.bluefletch.chat.ACTION_LOGIN".
package	string Set to "com.bluefletch.chat".
flags	integer Set to 1.
typeIntent	string Set to "a".

logout

Include in the logout array within intents object in the Launcher Configuration file:

Field	Value
action	string Set to "com.bluefletch.chat.ACTION_LOGOUT".
package	string Set to "com.bluefletch.chat".
flags	integer Set to 1.
typeIntent	string Set to "a".

Example Configuration

{
    ...
    "settings": {
        "useSiteInfoService": true,
        ...
    },
    "emsSupportTool": {
        "orgId": "ORG ID HERE",
        ...
    },
    "bfChat": {
        "apiKey": "ORG API KEY HERE",
        "autoPlayAudio": true,
        "notificationSoundIndividual": "assets:exampleSound",
        "dataHost": "DATA HOST URL HERE",
        "chatHost": "CHAT HOST URL HERE",
        "fileHost": "FILE HOST URL HERE",
        ...
    },
    "intents": {
        "login": [
            {
                "action": "com.bluefletch.chat.ACTION_LOGIN",
                "package": "com.bluefletch.chat",
                "flags": 1,
                "typeIntent": "a"
            }
        ],
        "logout": [
            {
                "action": "com.bluefletch.chat.ACTION_LOGOUT",
                "package": "com.bluefletch.chat",
                "flags": 1,
                "typeIntent": "a"
            }
        ]
    },
    ...
}