NowChatConfiguration – Android
Die NowChatConfiguration Mit der Klasse 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 verschiedener Konversationsoptionen bei Verwendung des Chats und das Konfigurieren von UI-Komponenten in NowChat.
NowChatConfiguration: NowChatConfiguration(closePrompt: ClosePrompt? = null, disabledFeatures: List<Feature>? = null, Konversationsoptionen: List<ConversationOption>? = null, uiConfiguration: UIConfiguration? = null)
Konfiguriert Optionen für die aktuelle Chatsitzung. Mit dieser Methode können Sie vor dem Schließen eines Chatfensters eine Eingabeaufforderung anzeigen, Funktionen während der Verwendung des Chats deaktivieren, verschiedene Konversationsoptionen bei Verwendung des Chats anwenden und UI-Komponenten in NowChat konfigurieren.
| Name | Typ | Beschreibung |
|---|---|---|
| ClosePrompt | Aufforderung schließen Objekt | Aufforderung, die angezeigt werden soll, bevor das zugehörige Chatfenster geschlossen wird. Rufen Sie an NowChatConfiguration.ClosePrompt() Unterklasse zum Definieren des Werts dieses Parameters. Zum Beispiel: Wenn Sie keine Abschlussaufforderung anzeigen möchten, übergeben Sie null. |
| DeaktiviertFeatures | Liste<NowChatConfiguration. Funktion> |
Liste der Chatfunktionen, die in der aktuellen Chatsitzung deaktiviert werden sollen. Gültiger Wert: START_NEW_CONVERSATION: Ausblenden/deaktivieren Starten Sie eine neue Konversation Schaltfläche, die in einem Chatfenster angezeigt wird. Die verfügbaren Chatfunktionen sind in definiert NowChatConfiguration.Feature Aufzählungsklasse. Zum Beispiel: Wenn Sie keine Funktionen deaktivieren möchten, übergeben Sie null. |
| Konversationsoptionen | Liste<Konversation Option>? |
Liste der Konversationsoptionen, die auf NowChat angewendet werden sollen. Gültige Werte:
Die verfügbaren Konversationsoptionen sind in definiert NowChatConfiguration.ConversationOption Aufzählungsklasse. Zum Beispiel: Wenn Sie keine Optionen anwenden möchten, übergeben Sie null. |
| UiConfiguration | UIKonfiguration? | UIConfiguration-Werte, die zum Konfigurieren von UI-Komponenten in NowChat verwendet werden sollen. Gültige Werte:
Zum Beispiel: Um die Standardkonfiguration zu verwenden, übergeben Sie null. |
| Typ | Beschreibung |
|---|---|
| NowChatConfiguration | Gibt ein NowChatConfiguration-Objekt zurück, das Sie beim Aufrufen von übergeben können NowChatService – Start(activity: Activity, themeColors: NowChatTheme = object: NowChatTheme{}, contextData: Map<String, Any> = mapOf(), chatConfiguration: NowChatConfiguration? = null) Methode. |
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: Boolean = wahr)
Definiert die UI-Konfigurationen, die auf die Schaltfläche „Anhang hochladen“ angewendet werden sollen, die neben der Texteingabe angezeigt wird, während Sie mit einem Servicemitarbeiter sprechen.
AttachmentUploadButton Ist eine Unterklasse von NowChatConfiguration Klasse.
| Name | Typ | Beschreibung |
|---|---|---|
| isVisible | Boolean | Kennzeichnung, die die Sichtbarkeit der Schaltfläche „Anhang hochladen“ angibt. Gültige Werte:
Standardwert: wahr |
| Typ | Beschreibung |
|---|---|
| Objekt | UI-Konfigurationsobjekt. |
Das folgende Codebeispiel zeigt, wie die Schaltfläche „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: Ziehbar?)
Definiert die Konfiguration der Schaltfläche „Schließen“, die für die Rücknavigation in der NowChat-Symbolleiste verwendet wird. Sie übergeben dieses Objekt dann an NowChatConfiguration() Methode zum Konfigurieren der Schaltfläche „Schließen“ zur Verwendung in der Chatsitzung.
CloseButton() Ist eine Unterklasse von NowChatConfiguration Klasse.
| Name | Typ | Beschreibung |
|---|---|---|
| icon | Abziehbar? | Abziehbares Objekt, das für die Schaltfläche „Schließen“ (zurück) verwendet werden soll. Sie können verwenden ContextCompat.getDrawable() Methode zum Abrufen dieses abziehbaren Objekts. Zum Beispiel: Um das standardmäßige ziehbare Element zu verwenden, übergeben Sie null. Standard: Schaltfläche „NowChat zurück“ |
| Typ | Beschreibung |
|---|---|
| Objekt | Konfigurationsobjekt „Schaltfläche schließen“. |
Das folgende Codebeispiel zeigt, wie ein anwenderdefiniertes Symbol für die Schaltfläche „Schließen“ in 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, Nachricht: Zeichenfolge, accept ButtonTitle: Zeichenfolge, declineButtonTitle: Zeichenfolge)
Erstellt ein ClosePrompt-Objekt basierend auf den übergebenen Parametern und gibt es zurück. Sie übergeben dieses Objekt dann an NowChatConfiguration() Methode zum Konfigurieren der Optionen zum Schließen der Eingabeaufforderung in der Chatsitzung.
| Name | Typ | Beschreibung |
|---|---|---|
| header | Zeichenfolge | Text, der im Header der Eingabeaufforderung angezeigt werden soll. Wenn Sie keinen Prompt-Header anzeigen möchten, übergeben Sie null. |
| Nachricht | Zeichenfolge | Text, der als Haupttext der Eingabeaufforderung angezeigt werden soll. |
| AcceptButtonTitle | Zeichenfolge | Text, der auf der primären Schaltfläche des Prompts zum Schließen des Chatfensters angezeigt werden soll. |
| DeclineButtonTitle | Zeichenfolge | Text, der auf der sekundären Schaltfläche des Prompts angezeigt werden soll, die den Prompt verwirft. Wenn Sie keine sekundäre Schaltfläche anzeigen möchten, übergeben Sie null. |
| Typ | Beschreibung |
|---|---|
| Objekt | Aufforderung, die angezeigt werden soll, bevor das zugehörige Chatfenster geschlossen wird. |
Das folgende Codebeispiel zeigt, wie diese Methode aufgerufen wird, um die Aufforderung zum Schließen 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 basierend auf den übergebenen Parametern und gibt es zurück. Sie übergeben dieses Objekt dann an NowChatConfiguration() Konstruktor zum Konfigurieren von UI-Komponenten in NowChat.
UIKonfiguration Ist eine Unterklasse von NowChatConfiguration Klasse.
| Name | Typ | Beschreibung |
|---|---|---|
| Schaltfläche „close“ | Schaltfläche schließen? | Konfiguration für Schaltfläche „Schließen“ Wird in der NowChat-Symbolleiste angezeigt und für die Navigation zurück verwendet.Rufen Sie an NowChatConfiguration – CloseButton(Symbol: Ziehbar?) Unterklasse zum Definieren des Werts dieses Parameters. Zum Beispiel: |
| AttachmentUploadButton | AttachmentUploadButton? | Konfiguration für AttachmentUploadButton Wird neben der Texteingabe angezeigt, während Sie mit einem Servicemitarbeiter sprechen.Rufen Sie an NowChatConfiguration – AttachmentUploadButton(isVisible: Boolean = wahr) Unterklasse zum Definieren des Werts dieses Parameters. Zum Beispiel: |
| Typ | Beschreibung |
|---|---|
| Objekt | UI-Konfigurationsobjekt. |
Das folgende Codebeispiel zeigt, wie der aufgerufen wird UIKonfiguration Unterklasse zum Festlegen des Symbols für die closeButton und zum Ausblenden der Schaltfläche zum Hochladen von Anhängen.
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)
}