Classe NowChatConfiguration : Android
La classe NowChatConfiguration vous permet de configurer des options sur une session de messagerie instantanée, telles que l’affichage d’une invite avant de fermer une fenêtre de messagerie instantanée, la désactivation de fonctionnalités lors de l’utilisation de la messagerie instantanée, l’application de différentes options de conversation lors de l’utilisation de la messagerie instantanée et la configuration des composants d’interface utilisateur dans Now Chat.
NowChatConfiguration : NowChatConfiguration(closePrompt : ClosePrompt ? = null, disabledFeatures : List<Feature> ? = null, conversationOptions : List<ConversationOption> ? = null, uiConfiguration : UIConfiguration ? = null)
Configure les options pour la session de messagerie instantanée actuelle. Cette méthode vous permet d’afficher une invite avant de fermer une fenêtre de messagerie instantanée, de désactiver les fonctionnalités lors de l’utilisation de la messagerie instantanée, d’appliquer différentes options de conversation lors de l’utilisation de la messagerie instantanée et de configurer des composants d’interface utilisateur dans Now Chat.
| Nom | Type | Description |
|---|---|---|
| closePrompt | Objet ClosePrompt | Invite à afficher avant de fermer la fenêtre de messagerie instantanée associée. Appelez la sous-classe NowChatConfiguration.ClosePrompt() pour définir la valeur de ce paramètre. Par exemple : Si vous ne souhaitez pas afficher une invite de fermeture, transmettez la valeur null. |
| Fonctionnalités désactivées | List<NowChatConfiguration (Configuration de la liste Now Chat). Fonctionnalité > |
Liste des fonctionnalités de messagerie instantanée à désactiver dans la session de messagerie instantanée actuelle. Valeur valide : START_NEW_CONVERSATION : masquez/désactivez le bouton StartNew Conversation qui apparaît dans une fenêtre de messagerie instantanée. Les fonctionnalités de messagerie instantanée disponibles sont définies dans la classe d’énumération NowChatConfiguration.Feature . Par exemple : Si vous ne souhaitez désactiver aucune fonctionnalité, transmettez null. |
| conversationOptions | Liste<conversation Option> ? |
Liste des options de conversation à appliquer à Now Chat. Valeurs valides :
Les options de conversation disponibles sont définies dans la classe d’énumération NowChatConfiguration.ConversationOption . Par exemple : Si vous ne souhaitez appliquer aucune option, transmettez la valeur null. |
| uiConfiguration | UIConfiguration ? | Valeurs UIConfiguration à utiliser pour configurer les composants d’interface utilisateur dans Now Chat. Valeurs valides :
Par exemple : Pour utiliser la configuration par défaut, transmettez null. |
| Type | Description |
|---|---|
| Configuration de la messagerie instantanée Now | Renvoie un objet NowChatConfiguration que vous pouvez transmettre lors de l’appel de la NowChatService - start(activity : Activity, themeColors : NowChatTheme = object : NowChatTheme{}, contextData : Map<String, Any> = mapOf(), chatConfiguration : NowChatConfiguration ? = null) méthode. |
L’exemple de code suivant montre comment appeler cette méthode.
suspend fun launchChat() {
val chatService = getNowChatService()
//Drawable to use instead of the default NowChat back button.
val myDrawable = ContextCompat.getDrawable(activity, R.drawable.my_drawable)
val chatConfiguration = NowChatConfiguration(
closePrompt = NowChatConfiguration.ClosePrompt(
header = null,
message = "Are you sure you want to leave?",
acceptButtonTitle = "Yes",
declineButtonTitle = "No"
),
disabledFeatures = listOf(NowChatConfiguration.Feature.START_NEW_CONVERSATION),
conversationOptions = listOf(NowChatConfiguration.ConversationOption.FORCE_NEW_CONVERSATION),
uiConfiguration = NowChatConfiguration.UIConfiguration(
closeButton = NowChatConfiguration.CloseButton(
icon = myDrawable
),
attachmentUploadButton = NowChatConfiguration.AttachmentUploadButton(isVisible = false)
)
)
chatService?.start(activity, chatConfiguration)
}NowChatConfiguration : AttachmentUploadButton(isVisible : booléen = vrai)
Définit les configurations d’interface utilisateur à appliquer au bouton Charger la pièce jointe qui s’affiche à côté de la saisie de texte lors d’une conversation avec un agent actif.
AttachmentUploadButton est une sous-classe de la classe NowChatConfiguration .
| Nom | Type | Description |
|---|---|---|
| isVisible | Booléen | Marqueur indiquant la visibilité du bouton Télécharger la pièce jointe. Valeurs valides :
Par défaut : true |
| Type | Description |
|---|---|
| Objet | Objet de configuration de l’interface utilisateur. |
L’exemple de code suivant montre comment masquer le AttachmentUploadButton.
suspend fun launchChat() {
val chatService = getNowChatService()
val chatConfiguration = NowChatConfiguration(
uiConfiguration = NowChatConfiguration.UIConfiguration(
attachmentUploadButton = NowChatConfiguration.AttachmentUploadButton(isVisible = false)
)
)
chatService?.start(activity, chatConfiguration)
}NowChatConfiguration : CloseButton(icône : dessinable ?)
Définit la configuration du bouton Fermer utilisé pour la navigation arrière sur la barre d’outils NowChat. Vous transmettez ensuite cet objet dans la méthode NowChatConfiguration() pour configurer le bouton fermer à utiliser dans la session de messagerie instantanée.
CloseButton() est une sous-classe de la classe NowChatConfiguration .
| Nom | Type | Description |
|---|---|---|
| icône | Dessinable ? | Objet pouvant être dessiné à utiliser pour le bouton Fermer (retour). Vous pouvez utiliser la méthode ContextCompat.getDrawable() pour obtenir cet objet drawable. Par exemple : Pour utiliser le drawable par défaut, passez null. Par défaut : bouton de retour NowChat |
| Type | Description |
|---|---|
| Objet | Objet de configuration du bouton Fermer. |
L’exemple de code suivant montre comment définir une icône personnalisée pour le bouton fermer sur la barre d’outils NowChat.
suspend fun launchChat() {
val chatService = getNowChatService()
//Drawable to use instead of the default NowChat back button.
val myDrawable = ContextCompat.getDrawable(activity, R.drawable.my_drawable)
val chatConfiguration = NowChatConfiguration(
uiConfiguration = NowChatConfiguration.UIConfiguration(
closeButton = NowChatConfiguration.CloseButton(
icon = myDrawable
)
)
)
chatService?.start(activity, chatConfiguration)
}NowChatConfiguration : ClosePrompt(en-tête : chaîne, message : chaîne, acceptButtonTitle : chaîne, declineButtonTitle : chaîne)
Crée et renvoie un objet ClosePrompt en fonction des paramètres transmis. Vous transmettez ensuite cet objet dans la méthode NowChatConfiguration() pour configurer les options de fermeture de l’invite dans la session de messagerie instantanée.
| Nom | Type | Description |
|---|---|---|
| header | Chaîne | Texte à afficher dans l’en-tête de l’invite. Si vous ne souhaitez pas afficher d’en-tête d’invite, transmettez la valeur null. |
| message | Chaîne | Texte à afficher en tant que texte principal de l’invite. |
| acceptButtonTitle | Chaîne | Texte à afficher sur le bouton primaire de l’invite pour fermer la fenêtre de messagerie instantanée. |
| declineButtonTitle | Chaîne | Texte à afficher sur le bouton secondaire de l’invite qui ignore l’invite. Si vous ne souhaitez pas afficher de bouton secondaire, transmettez null. |
| Type | Description |
|---|---|
| Objet | Invite à afficher avant de fermer la fenêtre de messagerie instantanée associée. |
L’exemple de code suivant montre comment appeler cette méthode pour configurer l’invite de fermeture.
suspend fun launchChat() {
val chatService = getNowChatService()
val chatConfiguration = NowChatConfiguration(
closePrompt = NowChatConfiguration.ClosePrompt(
header = null,
message = "Are you sure you want to leave?",
acceptButtonTitle = "Yes",
declineButtonTitle = "No"
)
)
chatService?.start(activity, chatConfiguration)
}NowChatConfiguration : UIConfiguration(closeButton : CloseButton ? = null, attachmentUploadButton : AttachmentUploadButton ? = null)
Crée et renvoie un objet UIConfiguration en fonction des paramètres transmis. Vous transmettez ensuite cet objet dans le constructeur NowChatConfiguration() pour configurer les composants d’interface utilisateur dans NowChat.
UIConfiguration est une sous-classe de la classe NowChatConfiguration .
| Nom | Type | Description |
|---|---|---|
| closeButton | Bouton Fermer ? | Configuration du CloseButton qui apparaît dans la barre d’outils NowChat et est utilisé pour la navigation arrière.Appelez la NowChatConfiguration : CloseButton(icône : dessinable ?) sous-classe pour définir la valeur de ce paramètre. Par exemple : |
| Bouton de chargement attachmentUploadButton | Bouton de téléchargement de pièce jointe ? | Configuration du AttachmentUploadButton qui s’affiche à côté de l’entrée de texte lors d’une conversation avec un agent actif.Appelez la NowChatConfiguration : AttachmentUploadButton(isVisible : booléen = vrai) sous-classe pour définir la valeur de ce paramètre. Par exemple : |
| Type | Description |
|---|---|
| Objet | Objet de configuration de l’interface utilisateur. |
L’exemple de code suivant montre comment appeler la sous-classe UIConfiguration pour définir l’icône du closeButton et masquer le bouton de chargement de pièce jointe.
suspend fun launchChat() {
val chatService = getNowChatService()
//Drawable to use instead of the default NowChat back button.
val myDrawable = ContextCompat.getDrawable(activity, R.drawable.my_drawable)
val chatConfiguration = NowChatConfiguration(
uiConfiguration = NowChatConfiguration.UIConfiguration(
closeButton = NowChatConfiguration.CloseButton(
icon = myDrawable
),
attachmentUploadButton = NowChatConfiguration.AttachmentUploadButton(isVisible = false)
)
)
chatService?.start(activity, chatConfiguration)
}