--- sourceDocument: オーストラリア API リファレンス sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/ja-JP/api-reference Release : - australia ft:locale : - ja-JP ft:publication_title : - オーストラリア API リファレンス ft:clusterId : - crapiref bundleId : - crapiref workflow : - Creator --- # NowChatService クラス : iOS # NowChatService クラス : iOS {#ariaid-title1} * リリースバージョン: Australia * * 更新日 2026年03月12日 * * ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 所要時間：20分 NowChatService クラスは、仮想チャット機能とライブエージェントチャット機能を提供します。 このクラスを使用すると、チャットサービスの開始と停止、チャットセッションの開始、チャットユーザーインターフェイスの作成、未読メッセージの登録/登録解除を行うことができます。 {#NowChatServiceiOSAPI__entry__2} | 名前 | 説明 | |-|-| | 構成 | サービスの初期化時に提供された構成設定。 データタイプ: [NowServiceConfiguration](https://servicenow-prod.fluidtopics.net/uTGNTZYlh7StSnwaCDzTxQ#NowServiceConfigurationiOSStruct "NowServiceConfiguration 構造体は、フィーチャ サービスの構成情報を定義します。") | | インスタンスバージョン | Vancouver や Xanadu など、関連付けられた ServiceNow インスタンスのバージョン。 データタイプ：文字列 | | ネットワークサービス | このチャットサービスに関連付けられたネットワークサービス。 データタイプ:NetworkService | | セッションタイプ | セッションのタイプ。 可能な値： * 認証済み * ゲスト * 代理操作済み * 不明 データタイプ:セッションタイプ | [表 : 1. プロパティ] ## NowChatService - init(configuration: NowServiceConfiguration, delegate: NowChatServiceDelegate?, coreServiceProvider: NowCoreServiceProviding? = nil) {#ariaid-title2} 新しい NowChatService インスタンスを初期化します。 {#NChatServ-init_O_S_S__table_jgv_vqp_npb__entry__3} | 名前 | タイプ | 説明 | |-|-|-| | 構成 | [NowServiceConfiguration](https://servicenow-prod.fluidtopics.net/uTGNTZYlh7StSnwaCDzTxQ#NowServiceConfigurationiOSStruct "NowServiceConfiguration 構造体は、フィーチャ サービスの構成情報を定義します。") | サービスを適切に初期化するために必要な構成情報。 | | 代理人 | NowChatServiceDelegate | オプション。NowChatServiceDelegate プロトコルを実装する NowChat コールバック委任オブジェクト。 デフォルト:nil | | コアサービスプロバイダー | NowCoreServiceProviding | オプション。NowCoreServiceProviding プロトコルを実装するオブジェクト。NowChat サービスへのアクセスを提供します。 デフォルト:nil | [表 : 2. パラメーター] {#NChatServ-init_O_S_S__table_jgv_vqp_npb} 次のコード例は、この関数を呼び出す方法を示しています。 guard let coreService = NowSDK.core() else { // Error with NowServiceError.sdkNotConfigured return } guard let instanceUrl = URL(string: "http://sample.service-now.com"), let serviceConfig = NowSDK.makeServiceConfiguration(for: instanceUrl) else { // Could not create service -- // NowServiceError.serviceConfigurationInvalid return } let chatService = NowChatService(configuration: serviceConfig, delegate: delegate, coreServiceProvider: coreService) ## NowChatService - makeChatUI(theme: NowChatThemeable, chatConfiguration: NowChatConfiguration? = nil) -\> Result\) {#ariaid-title3} チャットユーザーインターフェイスをホストする `UIViewController` を作成します。 この関数はチャット UI を作成しますが、 [startChat()](https://servicenow-prod.fluidtopics.net/3BIGTN_cKzccpzZLGLOcjQ#NChatServ-startChat_O "チャットセッションを開始し、チャットセッションの開始後に完了ブロックを実行します。") 関数を呼び出してチャットセッションを開始する必要があります。チャット UI が表示されたら、この呼び出しを行う必要があります。詳細については、関連するサンプルアプリケーションと [Mobile SDK 開発者ガイド - iOS](https://servicenow-prod.fluidtopics.net/2j~JtVJ9LM91Yswgx2V62w "ServiceNow Mobile SDKを使用すると、スタンドアロンのモバイル iOS アプリケーション内で ServiceNow プラットフォームの機能とリソースを活用できます。")を参照してください。 {#NChatServ-makeChatUI_O__table_lkt_lvj_npb__entry__3} | 名前 | タイプ | 説明 | |-|-|-| | テーマ | [NowChatThemeable プロトコル : iOS](https://servicenow-prod.fluidtopics.net/cm78pf6XZI~faoXQj6Vlkg "NowChatThemeable プロトコルは、ServiceNowインスタンスでホストされているチャットページ内で使用される色を上書きできるプロパティを提供します。") | 作成するチャット UI のテーマ情報。 | | チャット構成 | [NowChatConfiguration?](https://servicenow-prod.fluidtopics.net/aHQRRReZZPyniqPwzyBjFg#NowChatOptionsiOS "NowChatConfiguration クラスを使用すると、チャットウィンドウを閉じる前のプロンプトの表示、チャットの使用中の機能の無効化、チャットの使用中のさまざまな会話オプションの適用、NowChat での UI コンポーネントの構成など、チャットセッションのオプションを構成できます。") | オプション。チャットセッションに適用するオプション。 | [表 : 3. パラメーター] {#NChatServ-makeChatUI_O__table_lkt_lvj_npb} {#NChatServ-makeChatUI_O__table_mkt_lvj_npb__entry__2} | タイプ | 説明 | |-|-| | オブジェクト | 成功:UI ビューコントローラー構成情報を含む UIViewController オブジェクト。 失敗:NowChatServiceError オブジェクト。 考えられるエラー: * チャットサービスが無効です * coreServiceInvalid * guestUserNotAllowed * invalidCredentials * セッションなし * 不明 * サポートされていないサーバー | [表 : 4. 返される内容] {#NChatServ-makeChatUI_O__table_mkt_lvj_npb} 次のコード例は、この関数を呼び出してチャット UI を作成する方法を示しています。 func makeChatScreen() -> UIViewController? { guard let chatService = chatService else { return nil } let closePrompt = NowChatConfiguration.ClosePrompt(header: "Close Window", message: "Are you sure you want to close the chat window?", acceptButtonTitle: "Yes", declineButtonTitle: "No") let attachmentUploadButton = NowChatConfiguration.AttachmentUploadButton(isVisible: false) // default isVisible = true let chatConfiguration = NowChatConfiguration(closePrompt: closePrompt, disabledFeatures: [.startNewConversation], conversationOptions: [.forceNewConversation, .endConversationOnExit], uiConfiguration: NowChatConfiguration.UIConfiguration(closeButton: closeButtonImage(name: "arrow.left"), attachmentUploadButton: attachmentUploadButton)) 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 } } ## NowChatService:shutdown() {#ariaid-title4} アクティブなチャットセッションを含むチャットサービスをシャットダウンします。 この関数を呼び出した後、関連付けられた `NowChatService` は非アクティブになり、再利用することはできません。別のチャットセッションを確立するには、NowChat.makeChatService() 関数を呼び出して新しい `NowChatService` インスタンスを作成します。 {#NChatServ-shutdown__table_zm2_tfk_npb__entry__3} | 名前 | タイプ | 説明 | |-|-|-| | なし | | | [表 : 5. パラメーター] {#NChatServ-shutdown__table_zm2_tfk_npb} {#NChatServ-shutdown__table_an2_tfk_npb__entry__2} | タイプ | 説明 | |-|-| | なし | | [表 : 6. 返される内容] {#NChatServ-shutdown__table_an2_tfk_npb} 次のコード例は、この関数を呼び出す方法を示しています。 private func resetChat() { chatService?.shutdown() chatService = nil initializeChatService() viewState = makeViewState() } func initializeChatService() { NowChat.makeChatService(instanceUrl: instanceUrl, delegate: self) { [weak self] result in guard let self = self else { return } switch result { case .success(let service): self.chatService = service case .failure(let error): debugPrint("Creating the chat service failed with error: \(error)") } self.viewState = self.makeViewState() } func makeViewState() -> ViewState { ViewState(chatEnabled: chatService != nil, menuItems: menuItems) } ## NowChatService - startChat(contextData: \[文字列: 任意\]? = nil, _ completion: @escaping (結果\<無効, NowChatServiceError\>) -\> 無効) {#ariaid-title5} チャットセッションを開始し、チャットセッションの開始後に完了ブロックを実行します。 {#NChatServ-startChat_O__table_tk1_bbk_npb__entry__3} | 名前 | タイプ | 説明 | |-|-|-| | コンテキストデータ | \[文字列:任意\]? | オプション。チャットセッションに渡されるチャットコンテキスト変数を含むディクショナリ。 チャットコンテキスト変数の詳細については、「 [Live agent chat context variables](https://www.servicenow.com/docs/access?context=live-agent-chat-context-vars&version=australia&pubname=australia-conversational-interfaces&ft:locale=en-US)」を参照してください。 | | 完了 | オブジェクト | チャットセッションの開始後に実行する補完ブロック。 | [表 : 7. パラメーター] {#NChatServ-startChat_O__table_tk1_bbk_npb} {#NChatServ-startChat_O__table_uk1_bbk_npb__entry__2} | タイプ | 説明 | |-|-| | void または文字列 | 補完ブロックの戻り値: * 成功:なし * エラー:NowChatServiceError 考えられるエラー: * チャットサービスが無効です * coreServiceInvalid * guestUserNotAllowed * invalidCredentials * セッションなし * 不明 * サポートされていないサーバー {#NChatServ-startChat_O__ul_e1n_lpj_k1c} | [表 : 8. 返される内容] {#NChatServ-startChat_O__table_uk1_bbk_npb} 次のコード例は、コンテキストデータなしでこの関数を呼び出す方法を示しています。 func startChat() { guard let chatService = chatService else { debugPrint("Chat service is invalid") viewState = makeViewState() return } chatService.startChat { [weak self] result in if case .failure(let error) = result { debugPrint("Chat session initialization failed with error: \(error)") self?.resetChat() } } } func makeViewState() -> ViewState { ViewState(chatEnabled: chatService != nil, menuItems: menuItems) } 次のコード例は、コンテキストデータを使用してこの関数を呼び出す方法を示しています。 func startChat() { guard let chatService = chatService else { debugPrint("Chat service is invalid") viewState = makeViewState() return } let contextData = ["sys_id": "123456789", "table_name": "wm_task", "active": true] as [String: Any] chatService.startChat(contextData: contextData) { [weak self] result in if case .failure(let error) = result { debugPrint("Chat session initialization failed with error: \(error)") self?.resetChat() } } } func makeViewState() -> ViewState { ViewState(chatEnabled: chatService != nil, menuItems: menuItems) } ## NowChatService - subscribeToUnreadMessageCount(pollingInterval: TimeInterval, completion: @escaping (Int) -\> Void) {#ariaid-title6} 未読メッセージ数リスナーに登録します。 {#NChatServ-subToUnreadMsgCount_S__table_pv1_3ln_1qb__entry__3} | 名前 | タイプ | 説明 | |-|-|-| | ポーリング間隔 | 時間間隔 | Web サービスをポーリングして未読チャットメッセージ数をポーリングする頻度。 単位：秒 | | 完了 | @escaping (int) -\> void) | 未読チャットメッセージ数を報告するために呼び出す補完ハンドラー。 Int:未読チャットメッセージの数。 | [表 : 9. パラメーター] {#NChatServ-subToUnreadMsgCount_S__table_pv1_3ln_1qb} {#NChatServ-subToUnreadMsgCount_S__table_qv1_3ln_1qb__entry__2} | タイプ | 説明 | |-|-| | なし | | [表 : 10. 返される内容] {#NChatServ-subToUnreadMsgCount_S__table_qv1_3ln_1qb} 次のコード例は、この関数を呼び出す方法を示しています。 ... if viewModel.isPolling { viewModel.unsubscribeFromUnreadMessageCount() viewState.pollingInterval = "" } else { viewModel.subscribeToUnreadMessageCount(pollingInterval: timeInterval) } ... func subscribeToUnreadMessageCount(pollingInterval: TimeInterval) { chatService.subscribeToUnreadMessageCount(pollingInterval: pollingInterval) { [weak self] count in self?.unreadMessageCount = count } isPolling = true } ## NowChatService - unsubscribeFromUnreadMessageCount() {#ariaid-title7} 未読メッセージカウントリスナーの受信を登録解除します。 {#NChatServ-unsubFromUnreadMsgCount__table_inn_ywn_1qb__entry__3} | 名前 | タイプ | 説明 | |-|-|-| | なし | | | [表 : 11. パラメーター] {#NChatServ-unsubFromUnreadMsgCount__table_inn_ywn_1qb} {#NChatServ-unsubFromUnreadMsgCount__table_jnn_ywn_1qb__entry__2} | タイプ | 説明 | |-|-| | なし | | [表 : 12. 返される内容] {#NChatServ-unsubFromUnreadMsgCount__table_jnn_ywn_1qb} 次のコード例は、この関数を呼び出す方法を示しています。 ... if viewModel.isPolling { viewModel.unsubscribeFromUnreadMessageCount() viewState.pollingInterval = "" } else { viewModel.subscribeToUnreadMessageCount(pollingInterval: timeInterval) } ... func unsubscribeFromUnreadMessageCount() { chatService.unsubscribeFromUnreadMessageCount() isPolling = false unreadMessageCount = 0 } ## NowChatService - updateTheme(テーマ: NowChatThemeable) {#ariaid-title8} NowChat UI テーマを指定された UI テーマで更新します。テーマを明から暗に変更する場合など、 makeChatUI() 関数で最初に設定したチャット UI テーマを更新するには、この機能を使用します。 {#NChatServ-updateTheme_O__table_r14_1dw_x2c__entry__3} | 名前 | タイプ | 説明 | |-|-|-| | テーマ | [Now チャットテーマ可能](https://servicenow-prod.fluidtopics.net/cm78pf6XZI~faoXQj6Vlkg "NowChatThemeable プロトコルは、ServiceNowインスタンスでホストされているチャットページ内で使用される色を上書きできるプロパティを提供します。") | チャット UI を更新するテーマ。 | [表 : 13. パラメーター] {#NChatServ-updateTheme_O__table_r14_1dw_x2c} {#NChatServ-updateTheme_O__table_s14_1dw_x2c__entry__2} | タイプ | 説明 | |-|-| | なし | | [表 : 14. 戻り値] {#NChatServ-updateTheme_O__table_s14_1dw_x2c} 次のコード例は、 updateTheme() 関数を使用して、明るい UI テーマを暗い UI テーマに更新する方法を示しています。 struct LightNowChatColoring: NowChatColoring { let nowUIColor: NowUIColoring = LightNowUIColor() let brand = UIColor.now_color(withHexString: "#032D42") let primary = UIColor.now_color(withHexString: "#00566E") let secondary = UIColor.now_color(withHexString: "#002832") let destructive = UIColor.now_color(withHexString: "#E52239") let textPrimary = UIColor.now_color(withHexString: "#10171A") let textSecondary = UIColor.now_color(withHexString: "#232E33") let textTertiary = UIColor.now_color(withHexString: "#37444A") let textActionable = UIColor.now_color(withHexString: "#ffffff") let screenHeaderText = UIColor.now_color(withHexString: "#ffffff") let backgroundPrimary = UIColor.now_color(withHexString: "#ffffff") let backgroundSecondary = UIColor.now_color(withHexString: "#F5F6F7") let backgroundTertiary = UIColor.now_color(withHexString: "#E2E5E7") let backgroundPrimaryActionable = UIColor.now_color(withHexString: "#10171A") let backgroundSecondaryActionable = UIColor.now_color(withHexString: "#232E33") let brandBackground = UIColor.now_color(withHexString: "#BDDEE7") let borderTertiary = UIColor.now_color(withHexString: "#d3d6dc") let separatorPrimary = UIColor.now_color(withHexString: "#859095") let separatorTertiary = UIColor.now_color(withHexString: "#CFD5D7") let alertCritical0 = UIColor.now_color(withHexString: "#F9C8CE") let alertCritical3 = UIColor.now_color(withHexString: "#E52239") let shadow = UIColor.now_color(withHexString: "#10171A") let linkPrimary = UIColor.now_color(withHexString: "#1955BE") let linkSecondary = UIColor.now_color(withHexString: "#113A82") let notification = UIColor.now_color(withHexString: "#E52239") let highlightBlue = UIColor.now_color(withHexString: "#C4DBFE") let highlightGray = UIColor.now_color(withHexString: "#DCDDDE") } struct DarkNowChatColoring: NowChatColoring { let nowUIColor: NowUIColoring = DarkNowUIColor() let brand = UIColor.now_color(withHexString: "#032D42") let primary = UIColor.now_color(withHexString: "#6CBBD0") let secondary = UIColor.now_color(withHexString: "#99C6D2") let destructive = UIColor.now_color(withHexString: "#E46775") let textPrimary = UIColor.now_color(withHexString: "#FFFFFF") let textSecondary = UIColor.now_color(withHexString: "#E2E5E7") let textTertiary = UIColor.now_color(withHexString: "#BCC3C7") let textActionable = UIColor.now_color(withHexString: "#050809") let backgroundPrimary = UIColor.now_color(withHexString: "#050809") let backgroundSecondary = UIColor.now_color(withHexString: "#161F23") let backgroundTertiary = UIColor.now_color(withHexString: "#1D272B") let backgroundPrimaryActionable = UIColor.now_color(withHexString: "#FFFFFF") let backgroundSecondaryActionable = UIColor.now_color(withHexString: "#BCC3C7") let brandBackground = UIColor.now_color(withHexString: "#002934") let separatorPrimary = UIColor.now_color(withHexString: "#97A2A6") let separatorTertiary = UIColor.now_color(withHexString: "#4F5C62") let borderTertiary = UIColor.now_color(withHexString: "#454d5b") let screenHeaderText = UIColor.now_color(withHexString: "#FFFFFF") let alertCritical0 = UIColor.now_color(withHexString: "#7B1D28") let alertCritical3 = UIColor.now_color(withHexString: "#E46775") let shadow = UIColor.now_color(withHexString: "#10171A") let notification = UIColor.now_color(withHexString: "#E46775") let linkPrimary = UIColor.now_color(withHexString: "#339EFC") let linkSecondary = UIColor.now_color(withHexString: "#70BBFD") let highlightBlue = UIColor.now_color(withHexString: "#004652") let highlightGray = UIColor.now_color(withHexString: "#363D3D") } struct LightNowChatTheme: NowChatThemeable { let color: NowChatColoring = LightNowChatColoring() } struct DarkNowChatTheme: NowChatThemeable { let color: NowChatColoring = DarkNowChatColoring() } func chatService(_ chatService: NowChat.NowChatService, systemThemeDidChange traitCollection: UITraitCollection) { // The systemThemeDidChange delegate method can be used to call updateTheme() to apply theme changes when the system theme changes. debugPrint("System Theme did change") chatService.updateTheme(theme: traitCollection.userInterfaceStyle == .dark ? DarkNowChatTheme() : LightNowChatTheme()) }