System Messages

Table of contents

• Overview
• Messages types
  • Fixed messages
  • Removable messages
• Injecting System messages
• Customization
  • Customize by overriding layout resouce
  • Customize by overriding SystemUIProvider factory

Overview

System originated messages, used for indicating chat state,notify of errors, providing the user with instructions, etc.
There are fixed messages and removable messages.

Messages types

Fixed messages

Appears in the chat and will stay there, Those messages are also passed on the ChatElementListener for history preservation.

Removable messages

Messages that are displyed in the chat for a period of time, until a fulfillment of some condition is met, usually during specific chat state), than automatically are removed. Those messages are not passed to the ChatElementListener and will not appear when chat gets restored from history.

✍️ e.g. Wait message, appears on chat start, while the user waits for his live chat to be accepted by an agent.

Injecting System messages

The hosting app can inject system messages after the chat was created, using the ChatController.post API.

chatController.post(SystemStatement(message))

Customization

Currently system messages display, can only be customized by override.

• Customize by overriding layout resouce

  Create your own layout resources with the following names:

  • Regular messages: system_message_regular (inner textview should keep SDK known id: message_textview)
  • Removable messages: system_message_removable (inner textview should keep SDK known id: message_textview)

• Customize by overriding SystemUIProvider factory

  1. Implement SystemFactory:
     • Override the removableSystemInfo method, to change the removable system messages layout.
     • Override the info method to change the regular messages display.

  2. Set SystemUIProvider.overrideFactory with your implementation.

      class MySystemMessageFactory: SystemFactory{
          override fun info():ViewInfo{
              return ....
          }
          override fun removableSystemInfo():ViewInfo{
              return ....
          }
      }
             
      val chatUI = ChatUIProvider(context).apply {
          this.chatElementsUIProvider.systemUIProvider.overrideFactory = mySystemMessageFactory
      }
     
      ChatController.Builder(context).apply{
              //... do some initiations
              chatUIProvider(chatUI)
          }