java.lang.Object | |
↳ | com.salesforce.android.chat.ui.ChatUIConfiguration.Builder |
Build a new ChatUIConfiguration
instance.
Public Constructors | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Builder() |
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
ChatUIConfiguration |
build()
Build a
ChatUIConfiguration instance using the provided parameters. | ||||||||||
ChatUIConfiguration.Builder |
chatBotAvatar(int chatBotAvatarDrawableId)
**OPTIONAL** Sets a custom avatar for chat bots when messages from a bot are shown in the chat feed.
| ||||||||||
ChatUIConfiguration.Builder |
chatConfiguration(ChatConfiguration chatConfiguration)
Specify a
ChatConfiguration instance that contains information used by ChatUI to
manage Chat sessions. | ||||||||||
ChatUIConfiguration.Builder |
defaultToMinimized(boolean enabled)
Defines whether the user interface is presented in minimized mode following prechat submission.
| ||||||||||
ChatUIConfiguration.Builder |
disablePreChatView(boolean disablePreChatView)
**OPTIONAL** Flag that determines whether we will skip the prechat view when starting a new session.
| ||||||||||
ChatUIConfiguration.Builder |
enableChatBotBanner(int chatBotBannerLayoutId)
**OPTIONAL** Enables the display of a banner shown when starting a chat session with a chat bot.
| ||||||||||
ChatUIConfiguration.Builder |
enableHyperlinkPreview(boolean enabled)
**OPTIONAL** Flag that enables/disables the preview of hyperlinks within the chat-feed.
| ||||||||||
ChatUIConfiguration.Builder |
hideQueuePosition(boolean hideQueuePosition)
**OPTIONAL** Hides the display of the customer's queue position while waiting for an Agent to connect.
| ||||||||||
ChatUIConfiguration.Builder |
photoDirectoryName(String photoDirectoryName)
**OPTIONAL** Specify a directory name that will be used to store photos taken with the device camera
during a Chat session.
|
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From class
java.lang.Object
|
Build a ChatUIConfiguration
instance using the provided parameters.
ChatUIConfiguration
instance
**OPTIONAL** Sets a custom avatar for chat bots when messages from a bot are shown in the chat feed.
Specify a ChatConfiguration
instance that contains information used by ChatUI to
manage Chat sessions.
chatConfiguration | A ChatConfiguration instance
|
---|
Defines whether the user interface is presented in minimized mode following prechat submission.
**OPTIONAL** Flag that determines whether we will skip the prechat view when starting a new session. Set this to true if you wish to pass in a preconfigured list of fields without prompting the user to change their values.
If you wish to display your own UI to collect this information you would generally enable this flag to prevent the chat UI library from presenting it's own view.
**OPTIONAL** Enables the display of a banner shown when starting a chat session with a chat bot.
**OPTIONAL** Flag that enables/disables the preview of hyperlinks within the chat-feed. Set this flag to disable hyperlink preview messages in the chat-feed.
**OPTIONAL** Hides the display of the customer's queue position while waiting for an Agent to connect.
**OPTIONAL** Specify a directory name that will be used to store photos taken with the device camera during a Chat session. Do not specify the full path, as photos will be automatically written to external storage. If a photo directory name is not specified then images will be stored in the root External Storage directory.
photoDirectoryName | The name of the folder in external storage to write photos to. |
---|