NowChatOptions : Android

  • Rversion finale: Xanadu
  • Mis à jour 1 août 2024
  • 3 minutes de lecture
  • La classe NowChatOptions vous permet de configurer des options sur une session de messagerie instantanée, telles que l’affichage d’une invite avant la fermeture d’une fenêtre de messagerie instantanée, la désactivation de fonctionnalités lors de l’utilisation de la messagerie instantanée et le démarrage d’une nouvelle conversation de messagerie instantanée au démarrage du service de messagerie instantanée.

    NowChatOptions - NowChatOptions(closePrompt : ClosePrompt ?, disabledFeatures : List<Feature> ?, forceNewConversation : Boolean ?)

    Configure les options de la session de messagerie instantanée en cours. Cette méthode vous permet d’afficher une invite avant de fermer une fenêtre de messagerie instantanée, de désactiver des fonctionnalités lors de l’utilisation de la messagerie instantanée et de forcer une nouvelle conversation de messagerie instantanée au démarrage du service de messagerie instantanée.

    Tableau 1. Paramètres
    Nom Type Description
    closePrompt (en anglais seulement) Objet ClosePrompt Invite à afficher avant de fermer la fenêtre de messagerie instantanée associée.

    Si vous ne souhaitez pas afficher d’invite de fermeture, transmettez null.

    disabledFeatures List<NowChatOptions.Feature> Liste des fonctionnalités de messagerie instantanée à désactiver dans la session de messagerie instantanée actuelle.
    Valeur valide :
    • START_NEW_CONVERSATION : masquer/désactiver 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 NowChatOptions.Feature .

    Si vous ne souhaitez désactiver aucune fonctionnalité, passez null.

    forceNewConversation Booléen Marqueur indiquant s’il faut forcer une nouvelle conversation de messagerie instantanée au démarrage de la session de messagerie instantanée. Toutes les conversations en cours sont fermées.
    Valeurs valides :
    • true : démarrer une nouvelle conversation de messagerie instantanée ; Une nouvelle fenêtre de messagerie instantanée s’ouvre.
    • false : ne démarrez pas une nouvelle conversation de messagerie instantanée ; Charge le contenu de la conversation de messagerie instantanée précédente.

    Valeur par défaut : false

    Tableau 2. Renvoie
    Type Description
    options de messagerie instantanée Renvoie un objet chatOptions que vous pouvez transmettre dans la NowChatService – start(activity : Activity, themeColors : NowChatTheme = object : NowChatTheme{}, contextData : Map<String, Any> = mapOf(), chatOptions : NowChatOptions ? = null) méthode.

    L’exemple de code suivant montre comment appeler cette méthode.

    suspend fun launchChat() { 
      val chatService = getNowChatService() 
      val chatTheme = object : NowChatTheme { 
        override val brand: NowUIAdaptiveColor 
        get() = NowUIAdaptiveColor(Color.BLUE) 
     
        override val textPrimary: NowUIAdaptiveColor 
        get() = NowUIAdaptiveColor(Color.BLACK) 
     
        // Override remaining theme colors 
     
      } 
      val contextData = mapOf("sys_id" to "123456789", "table" to "wm_task") 
     
      val chatOptions = NowChatOptions( 
        NowChatOptions.ClosePrompt( 
          header = null, 
          message = "Are you sure you want to leave?", 
          acceptButtonTitle = "Yes", 
          declineButtonTitle = "No" 
        ), 
        disabledFeatures = listOf(NowChatOptions.Feature.START_NEW_CONVERSATION), 
        forceNewConversation= true 
      )
     
       chatService?.start(activity, chatTheme, contextData, chatOptions) 
    } 

    NowChatOptions : 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 passés. Vous transmettez ensuite cet objet dans la méthode NowChatOptions() pour configurer les options d’invite de fermeture dans une session de messagerie instantanée.

    Tableau 3. Paramètres
    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 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 (en anglais seulement) Chaîne Texte à afficher sur le bouton secondaire de l’invite qui rejette l’invite.

    Si vous ne souhaitez pas afficher de bouton secondaire, passez null.

    L’exemple de code suivant montre comment appeler cette méthode.

    suspend fun launchChat() { 
      val chatService = getNowChatService() 
      val chatTheme = object : NowChatTheme { 
        override val brand: NowUIAdaptiveColor 
        get() = NowUIAdaptiveColor(Color.BLUE) 
     
        override val textPrimary: NowUIAdaptiveColor 
        get() = NowUIAdaptiveColor(Color.BLACK) 
     
        // Override remaining theme colors 
     
      } 
      val contextData = mapOf("sys_id" to "123456789", "table" to "wm_task") 
     
      val chatOptions = NowChatOptions( 
        NowChatOptions.ClosePrompt( 
          header = null, 
          message = "Are you sure you want to leave?", 
          acceptButtonTitle = "Yes", 
          declineButtonTitle = "No" 
        ), 
        disabledFeatures = listOf(NowChatOptions.Feature.START_NEW_CONVERSATION), 
        forceNewConversation= true 
      )
     
       chatService?.start(activity, chatTheme, contextData, chatOptions) 
    }