---
sourceDocument: Yokohama-API-Referenz
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/de-DE/yokohama/api-reference

 Release :

    - yokohama

ft:locale :

    - de-DE

ft:publication_title :

    - Yokohama-API-Referenz

ft:clusterId :

    - crapiref

bundleId :

    - crapiref

workflow :

    - Creator


---

# Now ChatKonfiguration -- iOS

# Now ChatKonfiguration -- iOS {#ariaid-title1}

* Freigeben Version: Yokohama
* 
* Aktualisiert 30. Januar 2025
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 6 Minuten Lesedauer

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?, disabledFeatures: \[Funktion\]? = Nil, Konversationsoptionen: \[Konversationsoption\]? = Nil, uiConfiguration: UIConfiguration? = Null) {#ariaid-title2}

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.
{#NChatOp-NowChatOptions_O_O_B__table_lpt_3lk_kbc__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| ClosePrompt | [Aufforderung schließen?](https://servicenow-prod.fluidtopics.net/9NjW_m28m9Os1jAhYk8Fzg#NChatOp-ClosePrompt_S_S_S_S "Erstellt ein ClosePrompt-Objekt basierend auf den übergebenen Parametern und gibt es zurück. Sie übergeben dieses Objekt dann an Now ChatConfiguration() Konstruktor zum Konfigurieren der Optionen zum Schließen von Prompts in einer Chatsitzung.") | Aufforderung, die angezeigt werden soll, bevor das zugehörige Chatfenster geschlossen wird. Rufen Sie an [Now ChatConfiguration.ClosePrompt()](https://servicenow-prod.fluidtopics.net/9NjW_m28m9Os1jAhYk8Fzg#NChatOp-ClosePrompt_S_S_S_S "Erstellt ein ClosePrompt-Objekt basierend auf den übergebenen Parametern und gibt es zurück. Sie übergeben dieses Objekt dann an Now ChatConfiguration() Konstruktor zum Konfigurieren der Optionen zum Schließen von Prompts in einer Chatsitzung.")strukturieren sie, um den Wert dieses Parameters zu definieren. Zum Beispiel: closePrompt = NowChatConfiguration.ClosePrompt( header = nil, message = "Are you sure you want to leave?", acceptButtonTitle = "Yes", declineButtonTitle = "No" ) Wenn Sie keine Aufforderung zum Schließen anzeigen möchten, lassen Sie die aus closePrompt Argument in Now ChatConfiguration() Rufen Sie an. |
| DeaktiviertFeatures | \[Now ChatConfiguration.​Funktion\]? | Liste der Chatfunktionen, die in der aktuellen Chatsitzung deaktiviert werden sollen. Gültiger Wert: StartNewConversation -- Ausblenden/Deaktivieren von Starten Sie eine neue Konversation Schaltfläche, die in einem Chatfenster angezeigt wird. Die verfügbaren Chatfunktionen sind in definiert Jetzt ChatOptions.Funktion Aufzählungsklasse. Zum Beispiel: let disabledFeatures: [NowChatConfiguration.Feature]? = [.startNewConversation] Wenn Sie keine Funktionen deaktivieren möchten, lassen Sie die aus disabledFeaturesArgument in Now ChatConfiguration() Rufen Sie an. |
| Konversationsoptionen | \[Now ChatConfiguration.​Konversationsoption\]? | Liste der Konversationsoptionen, die auf Now Chat angewendet werden sollen. Gültige Werte: * EndConversationOnExit: Laufende Konversation wird beendet, wenn das Now Chat-Fenster beendet wird. * Erzwingt Neukonversation: Erzwingt eine neue Chatkonversation, wenn Now Chat startet. {#NChatOp-NowChatOptions_O_O_B__ul_qmr_mdc_fdc} Die verfügbaren Konversationsoptionen sind in definiert Now ChatKonfiguration.Konversationsoption Aufzählungsklasse. Zum Beispiel: let conversationOptions: [NowChatConfiguration.ConversationOption]? = [.endConversationOnExit, .forceNewConversation] Wenn Sie keine Funktionen deaktivieren möchten, lassen Sie die aus conversationOptionsArgument in Now ChatConfiguration() Rufen Sie an. |
| UiKonfiguration | [UIKonfiguration?](https://servicenow-prod.fluidtopics.net/9NjW_m28m9Os1jAhYk8Fzg#NChatCnfg-UIConfig_O_O "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.") | UIKonfigurationswerte, die zum Konfigurieren von UI-Komponenten in NowChat verwendet werden sollen. Gültige Werte: * AttachmentUploadButton: Konfiguration für `Schaltfläche „AnhangUpload" `Wird neben der Texteingabe angezeigt, während Sie mit einem Servicemitarbeiter sprechen. * CloseButton: Konfiguration für `Schaltfläche „Schließen" `Wird für die Rücknavigation in der Now Chat-Symbolleiste verwendet. Zum Beispiel: let attachmentUploadButton = NowChatConfiguration.AttachmentUploadButton(isVisible: false) // Default isVisible = true // Configure close button as Text let closeButtonText: NowChatConfiguration.CloseButtonType = .text("Exit") let uiConfigurationWithText = NowChatConfiguration.UIConfiguration(closeButton: closeButtonText) // Configure close button as image let buttonImage = UIImage(systemName: "arrow.left.circle") ?? nil var closeButtonImage: NowChatConfiguration.CloseButtonType? if let buttonImage { closeButtonImage = .image(buttonImage) } let uiConfigurationWithImage = NowChatConfiguration.UIConfiguration(closeButton: closeButtonImage) Wenn Sie anwenderdefinierte Bilder anstelle der bereitgestellten Systembilder verwenden möchten, müssen die Bilder zwischen 22 und 44 Pixel breit und 30 Pixel hoch sein, um eine optimale Auflösung zu erzielen. Dient zur Verwendung des Standards für beide AttachmentUploadButtonOder CloseButtonType, Lassen Sie die zugehörige Schaltfläche aus dem aus UIKonfiguration Argument. Um den Standard für beide Schaltflächen zu verwenden, lassen Sie die aus UIConfigurationParameter in Now ChatConfiguration() Rufen Sie an. |
[Tabelle : 1. Parameter]

{#NChatOp-NowChatOptions_O_O_B__table_lpt_3lk_kbc} {#NChatOp-NowChatOptions_O_O_B__table_mpt_3lk_kbc__entry__2}

| Typ | Beschreibung |
|-|-|
| Now ChatKonfiguration | Gibt ein NowChatConfiguration-Objekt zurück, das Sie beim Aufrufen von übergeben können [Now ChatConfiguration()](https://servicenow-prod.fluidtopics.net/9NjW_m28m9Os1jAhYk8Fzg#NChatOp-NowChatOptions_O_O_B "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.")Methode. |
[Tabelle : 2. Rückgaben]

{#NChatOp-NowChatOptions_O_O_B__table_mpt_3lk_kbc}  
Das folgende Codebeispiel zeigt, wie diese Methode aufgerufen wird, um die Chat-UI zu konfigurieren.

    func makeChatScreen() -> UIViewController? {
      let closePrompt = NowChatConfiguration.ClosePrompt(
        header: nil,
        message: "Are you sure you want to leave?",
        acceptButtonTitle: "Yes",
        declineButtonTitle: "No"
      )

      let disabledFeatures: [NowChatConfiguration.Feature]? = [.startNewConversation]

      let conversationOptions: [NowChatConfiguration.ConversationOption]? = [.endConversationOnExit, .forceNewConversation] 

      let attachmentUploadButton = NowChatConfiguration.AttachmentUploadButton(isVisible: false) 

      // Configure close button as Text
      let closeButtonText: NowChatConfiguration.CloseButtonType = .text("Exit")
      let uiConfigurationWithText = NowChatConfiguration.UIConfiguration(closeButton: closeButtonText, attachmentUploadButton: attachmentUploadButton) 
     
      // Configure close button as image 
      let buttonImage = UIImage(systemName: "arrow.left.circle") ?? nil 

      var closeButtonImage: NowChatConfiguration.CloseButtonType?
      if let buttonImage {
        closeButtonImage = .image(buttonImage)
      }
      let uiConfigurationWithImage = NowChatConfiguration.UIConfiguration(closeButton: closeButtonImage, attachmentUploadButton: attachmentUploadButton)    

      let chatConfiguration = NowChatConfiguration(closePrompt: closePrompt, 
        disabledFeatures: disabledFeatures,
        conversationOptions: conversationOptions,
        uiConfiguration: uiConfigurationWithImage)

      let result = chatService.makeChatUI(theme: CarrascoChatTheme(chatColors: ChatColors()), chatConfiguration: chatConfiguration)  

      switch result { 
        case .success(let chatViewController):
          return chatViewController
        case .failure(let error):
          debugPrint("Chat screen creation failed with error: \(error)")
          return nil
      }
    }

## Now ChatConfiguration -- AttachmentUploadButton(isVisible: Boolescher Wert = wahr) {#ariaid-title3}

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 Struktur von Now ChatKonfiguration Klasse.
{#NChatCnfg-AttachUploadButton_B__table_tym_brc_fdc__entry__3}

| 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. Standard: Wahr |
[Tabelle : 3. Parameter]

{#NChatCnfg-AttachUploadButton_B__table_tym_brc_fdc} {#NChatCnfg-AttachUploadButton_B__table_uym_brc_fdc__entry__2}

| Typ | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 4. Rückgaben]

{#NChatCnfg-AttachUploadButton_B__table_uym_brc_fdc}  
Das folgende Codebeispiel zeigt, wie die Schaltfläche „AttachmentUpload" ausgeblendet wird.

    func makeChatScreen() -> UIViewController? {
      let attachmentUploadButton = NowChatConfiguration.AttachmentUploadButton(isVisible: false)
      let uiConfigurationWithAttachmentButton = NowChatConfiguration.UIConfiguration(attachmentUploadButton: attachmentUploadButton)         

      let chatConfiguration = NowChatConfiguration(uiConfiguration: uiConfigurationWithAttachmentButton) 

      let result = chatService.makeChatUI(theme: CarrascoChatTheme(chatColors: ChatColors()), chatConfiguration: chatConfiguration) 

      switch result {
        case .success(let chatViewController):
          return chatViewController
        case .failure(let error):
          debugPrint("Chat screen creation failed with error: \(error)")
          return nil
      }
    }

## NowChatConfiguration -- ClosePrompt(Header: Zeichenfolge?, Nachricht: Zeichenfolge, akzeptButtonTitle: Zeichenfolge, declineButtonTitle: Zeichenfolge) {#ariaid-title4}

Erstellt ein ClosePrompt-Objekt basierend auf den übergebenen Parametern und gibt es zurück. Sie übergeben dieses Objekt dann an Now ChatConfiguration() Konstruktor zum Konfigurieren der Optionen zum Schließen von Prompts in einer Chatsitzung.
{#NChatOp-ClosePrompt_S_S_S_S__table_xb2_dcl_kbc__entry__3}

| 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. |
[Tabelle : 5. Parameter]

{#NChatOp-ClosePrompt_S_S_S_S__table_xb2_dcl_kbc}  
Das folgende Codebeispiel zeigt, wie diese Funktion aufgerufen wird.

    func makeChatScreen() -> UIViewController? {
      guard let chatService = chatService else { return nil }
      let closePrompt = NowChatOptions.ClosePrompt(
        header: "Close Window",
        message: "Are you sure you want to close the chat window?",
        acceptButtonTitle: "Yes",
        declineButtonTitle: "No")

      let disabledFeatures = [.startNewConversation]
        
      let chatOptions = NowChatOptions(closePrompt: closePrompt,
        disabledFeatures: disabledFeatures,
        forceNewConversation: true)
        
      let result = chatService.makeChatUI(theme: CarrascoChatTheme(chatColors: ChatColors()), chatOptions: chatOptions)
        
      switch result {
      case .success(let chatViewController):
        return chatViewController
      case .failure(let error):
        return nil
      }
    }

## Now ChatConfiguration -- UIConfiguration(closeButton: CloseButtonType? = Nil, attachmentUploadButton: AttachmentUploadButton? = Null) {#ariaid-title5}

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 Struktur von Now ChatKonfiguration Klasse.
{#NChatCnfg-UIConfig_O_O__table_fwq_z3j_fdc__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| Schaltfläche „Schließen" | Schließfeldtyp? | Konfiguration für `Schließfeldtyp `Wird in der Now Chat-Symbolleiste angezeigt und für die Rücknavigation verwendet. Gültige Werte: * Bild (UIImage): Erstellen Sie eine Schaltfläche „Schließen" mit einem Bild. * Text (Zeichenfolge): Erstellen Sie eine Schaltfläche zum Schließen als Text. Verwenden Sie diese Option, um einen anwenderdefinierten Namen für die Schaltfläche „zurück" zu übergeben. Verfügbar `Schließfeldtyp `Optionen sind in definiert Now ChatConfiguration.SchließungButtonType Aufzählungsklasse. Zum Beispiel: func makeChatScreen() -> UIViewController? { // Configure close button as Text let closeButtonText: NowChatConfiguration.CloseButtonType = .text("Exit") let uiConfigurationWithText = NowChatConfiguration.UIConfiguration(closeButton: closeButtonText) // Configure close button as image let buttonImage = UIImage(systemName: "arrow.left.circle") ?? nil var closeButtonImage: NowChatConfiguration.CloseButtonType? if let buttonImage { closeButtonImage = .image(buttonImage) } let uiConfigurationWithImage = NowChatConfiguration.UIConfiguration(closeButton: closeButtonImage) let chatConfiguration = NowChatConfiguration(uiConfiguration: uiConfigurationWithImage) // or // let chatConfiguration = NowChatConfiguration(uiConfiguration: uiConfigurationWithText) |
| AttachmentUploadButton | [Schaltfläche „AnhangUploadButton"?](https://servicenow-prod.fluidtopics.net/9NjW_m28m9Os1jAhYk8Fzg#NChatCnfg-AttachUploadButton_B "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.") | 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)](https://servicenow-prod.fluidtopics.net/9NjW_m28m9Os1jAhYk8Fzg#NChatCnfg-AttachUploadButton_B "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.")Methode zum Definieren des Werts dieses Parameters. Zum Beispiel: let attachmentUploadButton = NowChatConfiguration.AttachmentUploadButton(isVisible: false) let uiConfigurationWithAttachmentButton = NowChatConfiguration.UIConfiguration(attachmentUploadButton: attachmentUploadButton) let chatConfiguration = NowChatConfiguration(uiConfiguration: uiConfigurationWithAttachmentButton) |
[Tabelle : 6. Parameter]

{#NChatCnfg-UIConfig_O_O__table_fwq_z3j_fdc} {#NChatCnfg-UIConfig_O_O__table_gwq_z3j_fdc__entry__2}

| Typ | Beschreibung |
|-|-|
| Objekt | UI-Konfigurationsobjekt |
[Tabelle : 7. Rückgaben]

{#NChatCnfg-UIConfig_O_O__table_gwq_z3j_fdc}  
Das folgende Codebeispiel zeigt, wie aufgerufen wird UIKonfiguration() Unterklasse zum Festlegen der Chat-UI-Konfiguration.

    func makeChatScreen() -> UIViewController? {

      let attachmentUploadButton = NowChatConfiguration.AttachmentUploadButton(isVisible: false)

      // Configure close button as image
      let buttonImage = UIImage(systemName: "arrow.left.circle") ?? nil

      var closeButtonImage: NowChatConfiguration.CloseButtonType?
      if let buttonImage {
        closeButtonImage = .image(buttonImage)
      }
      let uiConfigurationWithImage = NowChatConfiguration.UIConfiguration(closeButton: closeButtonImage, attachmentUploadButton: attachmentUploadButton)         

      let chatConfiguration = NowChatConfiguration(uiConfiguration: uiConfigurationWithImage) 

      let result = chatService.makeChatUI(theme: CarrascoChatTheme(chatColors: ChatColors()), chatConfiguration: chatConfiguration)

      switch result { 
        case .success(let chatViewController):
          return chatViewController
        case .failure(let error):
          debugPrint("Chat screen creation failed with error: \(error)")
          return nil
      }
    }


