---
sourceDocument: Xanadu API リファレンス
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/ja-JP/xanadu/api-reference

 Release :

    - xanadu

ft:locale :

    - ja-JP

ft:publication_title :

    - Xanadu API リファレンス

ft:clusterId :

    - crapiref

bundleId :

    - crapiref

workflow :

    - Creator


---

# NowChatOptions: iOS

# NowChatOptions: iOS {#ariaid-title1}

* リリースバージョン: Xanadu
* 
* 更新日 2024年08月01日
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 所要時間：5分

NowChatOptions クラスを使用すると、チャット セッションで、チャット ウィンドウを閉じる前にプロンプトを表示したり、チャットの使用中に機能を無効にしたりするなどのオプションを構成できます。

## NowChatOptions - ClosePrompt(header: String?, message: String, acceptButtonTitle: String, declineButtonTitle: String) {#ariaid-title2}

渡されたパラメーターに基づいて ClosePrompt オブジェクトを作成して返します。次に、このオブジェクトを NowChatOptions() メソッドに渡して、チャットセッション内のプロンプトを閉じるオプションを設定します。
{#NChatOp-ClosePrompt_S_S_S_S__table_xb2_dcl_kbc__entry__3}

| 名前 | タイプ | 説明 |
|-|-|-|
| header | 文字列 | プロンプトのヘッダーに表示するテキスト。 プロンプトヘッダーを表示したくない場合は、"nil" を渡します。 |
| メッセージ | 文字列 | プロンプトのメインテキストとして表示するテキスト。 |
| acceptButtonTitle | 文字列 | チャットウィンドウを閉じるためにプロンプトのプライマリボタンに表示するテキスト。 |
| 拒否ボタンのタイトル | 文字列 | プロンプトを却下するためにプロンプトのセカンダリボタンに表示するテキスト。 |
[表 : 1. パラメーター]

{#NChatOp-ClosePrompt_S_S_S_S__table_xb2_dcl_kbc}  
次のコード例は、この関数を呼び出す方法を示しています。

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

## NowChatOptions - NowChatOptions(closePrompt: ClosePrompt?, disabledFeatures: \[Feature\]?, forceNewConversation: Bool) {#ariaid-title3}

現在のチャットセッションのオプションを設定します。このメソッドを使用すると、チャットウィンドウを閉じる前にプロンプトを表示したり、チャットの使用中に機能を無効にしたり、チャットサービスの開始時に新しいチャット会話を強制したりできます。
{#NChatOp-NowChatOptions_O_O_B__table_lpt_3lk_kbc__entry__3}

| 名前 | タイプ | Description (説明) |
|-|-|-|
| closePrompt | [ClosePrompt](https://servicenow-prod.fluidtopics.net/MBGuSsgZh_m4wLIsCkGb2g#NChatOp-ClosePrompt_S_S_S_S "渡されたパラメーターに基づいて ClosePrompt オブジェクトを作成して返します。次に、このオブジェクトを NowChatOptions() メソッドに渡して、チャットセッション内のプロンプトを閉じるオプションを設定します。") オブジェクト | 関連するチャットウィンドウを閉じる前に表示するプロンプト。 クローズプロンプトを表示したくない場合は、"nil" を渡します。 |
| disabledFeatures | \[特徴\] | 現在のチャットセッション内で無効にするチャット機能のリスト。 有効な値: * startNewConversation:チャットウィンドウに表示される \[StartNew Conversation \] ボタンを非表示/無効にします。 使用可能なチャット機能は、 NowChatOptions.Feature 列挙型クラスで定義されています。 どの機能も無効にしたくない場合は、"nil" を渡します。 |
| forceNewConversation | ブーリアン | チャットセッションの開始時に新しいチャット会話を強制するかどうかを示すフラグ。現在の会話はすべてクローズされます。 有効な値： * true:新しいチャット会話を開始します。新しいチャットウィンドウが開きます。 * false:新しいチャット会話を開始しません。既存のチャットウィンドウを使用します。 デフォルト値：false |
[表 : 2. パラメーター]

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

| タイプ | Description (説明) |
|-|-|
| チャットオプション | [NowChatService - makeChatUI(theme: NowChatThemeable, chatOptions: NowChatOptions? = nil) -\> Result\<UIViewController, NowChatServiceError\>)](https://servicenow-prod.fluidtopics.net/uK_YWAqQnCmvhjbRtyg3Bw#NChatServ-makeChatUI_O "チャット ユーザー インターフェイスをホストする UIViewController を作成します。") メソッドで渡すことができる chatOptions オブジェクトを返します。 |
[表 : 3. 返される内容]

{#NChatOp-NowChatOptions_O_O_B__table_mpt_3lk_kbc}  
次のコード例は、この関数を呼び出す方法を示しています。

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