NowChatKonfiguration – Android

  • Freigeben Version: Yokohama
  • Aktualisiert 30. Januar 2025
  • 5 Minuten Lesedauer

    • Mit der Klasse NowChatConfiguration können Sie Optionen in einer Chatsitzung konfigurieren, z. B. das Anzeigen einer Eingabeaufforderung vor dem Schließen eines Chatfensters, das Deaktivieren von Funktionen während der Verwendung des Chats, das Anwenden anderer Konversationsoptionen bei der Verwendung des Chats und das Konfigurieren von UI-Komponenten in NowChat.

    NowChatConfiguration: NowChatConfiguration(closePrompt: ClosePrompt? = null, disableFeatures: Liste<Feature> ? = null, Konversationsoptionen: Liste<ConversationOption> ? = null, uiConfiguration: UIConfiguration? = null)

    Konfiguriert Optionen für die aktuelle Chatsitzung. Mit dieser Methode können Sie eine Eingabeaufforderung anzeigen, bevor Sie ein Chatfenster schließen, Funktionen während der Verwendung des Chats deaktivieren, verschiedene Konversationsoptionen anwenden, wenn Sie den Chat verwenden, und UI-Komponenten in NowChat konfigurieren.

    Tabelle : 1. Parameter
    Name Typ Beschreibung
    closePrompt ClosePrompt -Objekt Aufforderung zum Anzeigen vor dem Schließen des zugehörigen Chatfensters.

    Rufen Sie die Unterklasse NowChatConfiguration.ClosePrompt() auf, um den Wert dieses Parameters zu definieren.

    Zum Beispiel:
    closePrompt = NowChatConfiguration.ClosePrompt(
  header = null,
  message = "Are you sure you want to leave?",
  acceptButtonTitle = "Yes",
  declineButtonTitle = "No"
)

    Wenn keine Aufforderung zum Schließen angezeigt werden soll, übergeben Sie NULL.
    disableFeatures Liste

    Funktion>

    		 Liste der Chatfunktionen, die innerhalb der aktuellen Chatsitzung deaktiviert werden sollen

    Gültiger Wert:

    START_NEW_CONVERSATION: Schaltfläche „StartNew Conversation“ in einem Chatfenster ausblenden/deaktivieren

    Die verfügbaren Chatfunktionen sind in der Aufzählungsklasse NowChatConfiguration.Feature definiert.

    Zum Beispiel:
    disabledFeatures = listOf(NowChatConfiguration.Feature.START_NEW_CONVERSATION)

    Wenn Sie keine Funktionen deaktivieren möchten, übergeben Sie NULL.
    Konversationsoptionen Liste

    Option>?

    		 Liste der Konversationsoptionen, die auf NowChat angewendet werden sollen
    Gültige Werte:
    • END_CONVERSATION_ON_EXIT: Die laufende Konversation wird beim Verlassen des NowChat-Fensters beendet.
    • FORCE_NEW_CONVERSATION: Erzwingt eine neue Chatunterhaltung, wenn NowChat gestartet wird.

    Die verfügbaren Konversationsoptionen sind in der Aufzählungsklasse NowChatConfiguration.ConversationOption definiert.

    Zum Beispiel:
    conversationOptions = listOf(NowChatConfiguration.ConversationOption.FORCE_NEW_CONVERSATION),

    Wenn Sie keine Optionen anwenden möchten, übergeben Sie NULL.
    uiConfiguration UI-Konfiguration? UIConfiguration-Werte, die zum Konfigurieren von UI-Komponenten in NowChat verwendet werden.
    Gültige Werte:
    • attachmentUploadButton: Konfiguration für AttachmentUploadButton, das neben der Texteingabe während eines Gesprächs mit einem Servicemitarbeiter angezeigt wird.
    • closeButton: Konfiguration für die Schaltfläche „Schließen“, die für die Zurück-Navigation in der NowChat-Symbolleiste verwendet wird.
    Zum Beispiel:
    uiConfiguration = NowChatConfiguration.UIConfiguration(
  closeButton = NowChatConfiguration.CloseButton(
    icon = myDrawable
  ),
  attachmentUploadButton = NowChatConfiguration.AttachmentUploadButton(isVisible = false)
)

    Um die Standardkonfiguration zu verwenden, übergeben Sie null.
    Tabelle : 2. Rückgaben
    Typ Beschreibung
    NowChatKonfiguration Gibt ein NowChatConfiguration-Objekt zurück, das Sie beim Aufrufen der Methode NowChatService – start(activity: Activity, topicColors: NowChatTheme = Objekt: NowChatTheme{}, contextData: Map<String, Any> = mapOf(), chatConfiguration: NowChatConfiguration? = null) übergeben können.

    Das folgende Codebeispiel zeigt, wie diese Methode aufgerufen wird.

    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: Boolesch = wahr)

    Definiert die UI-Konfigurationen, die auf die Schaltfläche „Anhang hochladen“ angewendet werden sollen, die während eines Gesprächs mit einem Servicemitarbeiter neben der Texteingabe angezeigt wird.

    AttachmentUploadButton ist eine Unterklasse der NowChatConfiguration -Klasse.

    Tabelle : 3. Parameter
    Name Typ Beschreibung
    isVisible Boolean Kennzeichnung, die die Sichtbarkeit der Schaltfläche „Anhang hochladen“ angibt.
    Gültige Werte:
    • „wahr“: Schaltfläche „Anhang hochladen“ ist sichtbar.
    • „falsch“: Schaltfläche „Anhang hochladen“ ist ausgeblendet.

    Standardwert: wahr
    Tabelle : 4. Rückgaben
    Typ Beschreibung
    Objekt UI-Konfigurationsobjekt.

    Das folgende Codebeispiel zeigt, wie AttachmentUploadButton ausgeblendet wird.

    suspend fun launchChat() {
  val chatService = getNowChatService()

  val chatConfiguration = NowChatConfiguration(
    uiConfiguration = NowChatConfiguration.UIConfiguration(
      attachmentUploadButton = NowChatConfiguration.AttachmentUploadButton(isVisible = false)
    )
  )
 
  chatService?.start(activity, chatConfiguration)
}

    NowChatConfiguration – CloseButton(Symbol: Zeichenfähig?)

    Definiert die Konfiguration der Schaltfläche „Schließen“, die für die Zurück-Navigation in der NowChat-Symbolleiste verwendet wird. Anschließend übergeben Sie dieses Objekt an die NowChatConfiguration() -Methode, um die Schaltfläche „Schließen“ für die Verwendung in der Chatsitzung zu konfigurieren.

    CloseButton() ist eine Unterklasse der Klasse NowChatConfiguration.

    Tabelle : 5. Parameter
    Name Typ Beschreibung
    icon Zeichenfähig? Zeichenfähiges Objekt, das für die Schaltfläche „Schließen“ (Zurück) verwendet werden soll.

    Sie können die Methode ContextCompat.getDrawable() verwenden, um dieses zeichnungsfähige Objekt abzurufen.

    Zum Beispiel:
    val myDrawable = ContextCompat.getDrawable(activity, R.drawable.my_drawable)

    Übergeben Sie NULL, um das Standardzeichenelement zu verwenden.

    Standard: NowChat-Schaltfläche „Zurück“.
    Tabelle : 6. Rückgaben
    Typ Beschreibung
    Objekt Konfigurationsobjekt für Schaltfläche „Schließen“.

    Das folgende Codebeispiel zeigt, wie ein anwenderdefiniertes Symbol für die Schaltfläche zum Schließen auf der NowChat-Symbolleiste festgelegt wird.

    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(header: Zeichenfolge, message: Zeichenfolge, akzeptieren Schaltflächentitel: Zeichenfolge, abgelehnt Schaltflächentitel: Zeichenfolge)

    Erstellt ein ClosePrompt-Objekt und gibt es basierend auf den übergebenen Parametern zurück. Anschließend übergeben Sie dieses Objekt an die NowChatConfiguration()- Methode, um die Optionen zum Schließen der Aufforderung innerhalb der Chatsitzung zu konfigurieren.

    Tabelle : 7. Parameter
    Name Typ Beschreibung
    header Zeichenfolge Text, der im Header der Eingabeaufforderung angezeigt werden soll.

    Wenn Sie keinen Eingabeaufforderungsheader anzeigen möchten, übergeben Sie NULL.
    Nachricht Zeichenfolge Text, der als Haupttext der Eingabeaufforderung angezeigt werden soll.
    akzeptierenSchaltflächentitel Zeichenfolge Text, der auf der primären Schaltfläche der Eingabeaufforderung zum Schließen des Chat-Fensters angezeigt werden soll.
    AblehnenSchaltflächeTitel Zeichenfolge Text, der auf der sekundären Schaltfläche der Eingabeaufforderung angezeigt werden soll, die die Eingabeaufforderung schließt.

    Wenn Sie keine sekundäre Schaltfläche anzeigen möchten, übergeben Sie NULL.
    Tabelle : 8. Rückgaben
    Typ Beschreibung
    Objekt Aufforderung zum Anzeigen vor dem Schließen des zugehörigen Chatfensters.

    Das folgende Codebeispiel zeigt, wie diese Methode aufgerufen wird, um die Abschlussaufforderung zu konfigurieren.

    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)

    Erstellt ein UIConfiguration-Objekt auf Grundlage der übergebenen Parameter und gibt es zurück. Anschließend übergeben Sie dieses Objekt an den Konstruktor NowChatConfiguration(), um UI-Komponenten in NowChat zu konfigurieren.

    UIConfiguration ist eine Unterklasse der NowChatConfiguration -Klasse.

    Tabelle : 9. Parameter
    Name Typ Beschreibung
    schließenSchaltfläche Schaltfläche „Schließen“? Konfiguration für die Schaltfläche „Schließen“, die in der NowChat-Symbolleiste angezeigt wird und für die Zurück-Navigation verwendet wird.

    Rufen Sie die Unterklasse NowChatConfiguration – CloseButton(Symbol: Zeichenfähig?) auf, um den Wert dieses Parameters zu definieren.

    Zum Beispiel:
    val chatConfiguration = NowChatConfiguration( 
  uiConfiguration = NowChatConfiguration.UIConfiguration( 
    closeButton = NowChatConfiguration.CloseButton( 
      icon = myDrawable
  )
)
    „attachmentUploadButton“ AttachmentUploadButton? Konfiguration für AttachmentUploadButton, das neben der Texteingabe während eines Gesprächs mit einem Servicemitarbeiter angezeigt wird.

    Rufen Sie die Unterklasse NowChatConfiguration – AttachmentUploadButton(isVisible: Boolesch = wahr) auf, um den Wert dieses Parameters zu definieren.

    Zum Beispiel:
    val chatConfiguration = NowChatConfiguration( 
  uiConfiguration = NowChatConfiguration.UIConfiguration(
    attachmentUploadButton = NowChatConfiguration.AttachmentUploadButton(isVisible = false)
  ) 
)
    Tabelle : 10. Rückgaben
    Typ Beschreibung
    Objekt UI-Konfigurationsobjekt.

    Das folgende Codebeispiel zeigt, wie Sie die Unterklasse UIConfiguration aufrufen, um das Symbol für die Schaltfläche „closeButton“ festzulegen und die Schaltfläche zum Hochladen von Anhängen auszublenden.

    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) 
}