Now ChatConfiguration-Klasse – Android
Die Now ChatKonfiguration 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 Now Chat.
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 Now Chat konfigurieren.
| Name | Typ | Beschreibung |
|---|---|---|
| ClosePrompt | Aufforderung schließen Objekt | Aufforderung, die angezeigt werden soll, bevor das zugehörige Chatfenster geschlossen wird. Rufen Sie an Now ChatConfiguration.ClosePrompt() Unterklasse zum Definieren des Werts dieses Parameters. Zum Beispiel: Wenn Sie keine Aufforderung zum Schließen anzeigen möchten, übergeben Sie null. |
| DeaktiviertFeatures | Liste<NowChatKonfiguration. 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 Now ChatConfiguration.Feature Aufzählungsklasse. Zum Beispiel: Wenn Sie keine Funktionen deaktivieren möchten, übergeben Sie null. |
| Konversationsoptionen | Liste<Konversation Option>? |
Liste der Konversationsoptionen, die auf Now Chat angewendet werden sollen. Gültige Werte:
Die verfügbaren Konversationsoptionen sind in definiert Now ChatKonfiguration.Konversationsoption Aufzählungsklasse. Zum Beispiel: Wenn Sie keine Optionen anwenden möchten, übergeben Sie null. |
| UiKonfiguration | UIKonfiguration? | UIKonfigurationswerte, die zum Konfigurieren von UI-Komponenten in NowChat verwendet werden sollen. Gültige Werte:
Zum Beispiel: Übergeben Sie null, um die Standardkonfiguration zu verwenden. |
| Typ | Beschreibung |
|---|---|
| Now ChatKonfiguration | 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)
}
Now ChatConfiguration – AttachmentUploadButton(isVisible: Boolescher Wert = 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.
Schaltfläche „AnhangUpload“ Ist eine Unterklasse von Now ChatKonfiguration 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 „AttachmentUpload“ ausgeblendet wird.
suspend fun launchChat() {
val chatService = getNowChatService()
val chatConfiguration = NowChatConfiguration(
uiConfiguration = NowChatConfiguration.UIConfiguration(
attachmentUploadButton = NowChatConfiguration.AttachmentUploadButton(isVisible = false)
)
)
chatService?.start(activity, chatConfiguration)
}
Now ChatConfiguration – CloseButton(Symbol: Ziehbar?)
Definiert die Konfiguration der Schaltfläche „Schließen“, die für die Rücknavigation in der Now Chat-Symbolleiste verwendet wird. Sie übergeben dieses Objekt dann an Now ChatConfiguration() Methode zum Konfigurieren der Schaltfläche „Schließen“ zur Verwendung in der Chatsitzung.
Schaltfläche schließen() Ist eine Unterklasse von Now ChatKonfiguration Klasse.
| Name | Typ | Beschreibung |
|---|---|---|
| icon | Ziehbar? | Ziehbares 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 „Now Chat zurück“ |
| Typ | Beschreibung |
|---|---|
| Objekt | Konfigurationsobjekt für Schaltfläche „Schließen“. |
Das folgende Codebeispiel zeigt, wie ein anwenderdefiniertes Symbol für die Schaltfläche „Schließen“ in der Now Chat-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, akzeptButtonTitle: Zeichenfolge, declineButtonTitle: Zeichenfolge)
Erstellt ein ClosePrompt-Objekt basierend auf den übergebenen Parametern und gibt es zurück. Sie übergeben dieses Objekt dann an Now ChatConfiguration() Methode zum Konfigurieren der Optionen zum Schließen der Eingabeaufforderung in der Chatsitzung.
| Name | Typ | Beschreibung |
|---|---|---|
| header | Zeichenfolge | Text, der im Header des Prompts 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. |
| Accept ButtonTitle | Zeichenfolge | Text, der auf der primären Schaltfläche des Prompts zum Schließen des Chatfensters angezeigt werden soll. |
| DelineButtonTitle | Zeichenfolge | Text, der auf der sekundären Schaltfläche des Prompts angezeigt werden soll, die den Prompt verschließt. 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 den Prompt 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)
}
Now ChatConfiguration – UIConfiguration(closeButton: CloseButton? = null, attachmentUploadButton: AttachmentUploadButton? = Null)
Erstellt und gibt ein UIKonfigurationsobjekt basierend auf den übergebenen Parametern zurück. Sie übergeben dieses Objekt dann an Now ChatConfiguration() Konstruktor zum Konfigurieren von UI-Komponenten in NowChat.
UIKonfiguration Ist eine Unterklasse von Now ChatKonfiguration Klasse.
| Name | Typ | Beschreibung |
|---|---|---|
| Schaltfläche „Schließen“ | Schaltfläche schließen? | Konfiguration für Schaltfläche „Schließen“ Wird in der Now Chat-Symbolleiste angezeigt und für die Rücknavigation verwendet.Rufen Sie an Now ChatConfiguration – CloseButton(Symbol: Ziehbar?) Unterklasse zum Definieren des Werts dieses Parameters. Zum Beispiel: |
| AttachmentUploadButton | Schaltfläche „AnhangUploadButton“? | Konfiguration für Schaltfläche „AnhangUpload“ Wird neben der Texteingabe angezeigt, während Sie mit einem Servicemitarbeiter sprechen.Rufen Sie an Now ChatConfiguration – AttachmentUploadButton(isVisible: Boolescher Wert = wahr) Unterklasse zum Definieren des Werts dieses Parameters. Zum Beispiel: |
| Typ | Beschreibung |
|---|---|
| Objekt | UI-Konfigurationsobjekt. |
Das folgende Codebeispiel zeigt, wie 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)
}