アプリケーション開発設定
Androidチャネル用のアプリの開発に使用できる設定への参照を次に示します。
ネットワーク構成
プロパティ名 | 説明 | 必須? | デフォルトの値 |
---|---|---|---|
channelId |
Oracle AndroidチャネルのID。 | はい | N/A |
userId |
ユーザーの一意の識別子。この値が指定されていない場合、SDKによって初期化されます。 | いいえ | ランダム生成値 |
authTokenProvider |
AuthenticationTokenProviderのインスタンス。SDKがクライアント認証対応チャネルを使用して新しい接続を確立する必要がある場合や、既存のトークンが期限切れになった場合に新しいトークンを生成するために使用されます。 | はい | N/A |
機能フラグ
プロパティ | 説明 | 必須? | デフォルトの値 | |
---|---|---|---|---|
actionsLayout |
ローカル・アクション、グローバル・アクション、カード・アクションおよびフォーム・アクションのレイアウト方向を設定するActionsLayout タイプのオブジェクト。
|
いいえ | new ActionsLayout(LayoutOrientation.VERTICAL, LayoutOrientation.VERTICAL, LayoutOrientation.VERTICAL, LayoutOrientation.VERTICAL) |
|
disablePastActions |
ユーザーがすでに対話したメッセージのボタン・クリックを無効化するフィールド。許可される値は、all 、none およびpostback です。このプロパティによって有効になる動作は、過去のアクションの選択を無効化するデジタル・アシスタント・レベルの構成とは関係ありません。2つを別々に設定する必要があります。
|
いいえ | all |
|
displayPreviousMessages |
SDKの再初期化後の前のメッセージの表示を有効または無効にします。false に設定すると、SDKの再初期化後には、以前のメッセージがユーザーに表示されません。
|
いいえ | true |
|
enableAgentSneakPreview |
ユーザー入力テキストと入力ステータスをエージェントに送信します。 | いいえ | false |
|
enableArrowsForHorizontalCards |
true に設定すると、水平カード・ビューのナビゲーション矢印が有効になりますが、false に設定すると無効になります。
|
いいえ | false |
|
enableAttachment |
チャット・ビューでのアタッチメントの共有を有効化します。true に設定すると、shareMenuItems を使用して「共有」メニュー・ポップアップで使用可能なアイテムを制限できます。
この設定は、リリース22.02で非推奨になりました。かわりに |
いいえ | true |
|
enableAttachmentSecurity |
true に設定すると、追加のヘッダーが添付アップロード・リクエストに渡されます。これにより、有効な署名付きのJWTトークンを認可ヘッダーとして渡さない場合は、添付をダウンロードできないようになります。
ノート: スキルが接続するODAインスタンスがバージョン20.08の場合、または20.08より前のバージョンで実行されている場合は、この設定を有効にしないでください。このプロパティは、ODAプラットフォームのバージョン20.12以降へのクライアント認証対応接続にのみ適用されます。 |
いいえ | false |
|
enableClearMessage |
チャット・ビューのヘッダーにあるメッセージのクリア・ボタンを有効化します。 | いいえ | false |
|
enableDefaultClientResponse |
true に設定すると、スキル・レスポンスが遅延した場合、またはスキルからのレスポンスがない場合、クライアントはデフォルトのレスポンスを表示します。
|
いいえ | false |
|
enableEndConversation |
ユーザーが会話を終了し、チャット・セッションをリセットできるようにします。また、ローカルの会話履歴をクリアし、チャット・サーバーから切断してアクティビティを閉じます。 | いいえ | true |
|
enableNotification |
チャット・アプリケーションがバックグラウンドで実行されている場合、SDKからの新しいメッセージ通知を有効または無効にします。このフラグをfalse に設定すると、SDKは通知を提供しません。
|
いいえ | true |
|
enableNotificationSound |
チャット・ビューが開いているときに、新規スキル・メッセージの通知音を有効化します。この機能は、enableNotificationSoundSetting がfalse に設定されている場合にのみ適用されます。
|
いいえ | true |
|
enableNotificationSoundSetting |
チャット・ビュー・ヘッダーの通知音設定ボタンを有効化します。 | いいえ | false |
|
enableSendTypingStatus |
ライブエージェントにユーザーの入力ステータスを送信します。 | いいえ | false |
|
enableSpeechRecognition |
音声認識サービスでユーザーの音声をテキスト・メッセージに変換できるようにします。enableSpeechRecognitionAutoSend プロパティを使用するには、このプロパティをtrue に設定します。
|
いいえ | false |
|
enableSpeechRecognitionAutoSend |
enableSpeechRecognitionAutoSend がtrue (デフォルト)に設定されている場合、ユーザーの音声レスポンスはチャット・サーバーに自動的に送信されます(送信メッセージとしてチャット・ウィンドウに表示されます)。false に設定されている場合、ユーザーの音声レスポンスは、チャット・サーバーに送信される前にメッセージ・テキスト・フィールドにレンダリングされるため、手動で送信する前に変更したり、メッセージを削除したりできます。
この機能は、 |
いいえ | true |
|
enableSpeechSynthesis |
チャット・ビューのヘッダーにあるスキルのオーディオ・レスポンス・ボタンを有効化します。ボタンがミュート解除状態の場合は、スキルのレスポンスが読み上げられます。 | いいえ | false |
|
enableTimestamp |
メッセージのタイムスタンプを有効化します。 | いいえ | true |
|
googleMapsApiKey |
ロケーション・メッセージのロケーション・プレビュー・イメージの表示に使用されるGoogle Maps APIキー。 | いいえ | N/A | |
initSpeechSynthesisMuted |
このフラグは、enableSpeechSynthesis がtrue の場合にのみ適用され、スキルのオーディオ・レスポンス・ボタンを最初にデフォルトでアクティブ(ミュート解除)にするか、ミュートにするかを決定します。デフォルトでは、true に設定され、ボタンはミュートになります。
|
いいえ | true |
|
initUserHiddenMessage |
会話を開始するために使用されるユーザー・テキスト・メッセージ。このメッセージは、チャット・ビューの準備が完了すると送信され、実際にはチャットに表示されません。 | いいえ | N/A | |
initUserProfile |
会話が開始する前にユーザー・プロファイルを初期化します。プロファイル・ペイロードのタイプは、User である必要があります。プロファイルは、initUserHiddenMessage の値を送信する前に更新されます。
|
いいえ | N/A | |
linkHandler |
Webビューまたはブラウザでリンクを開くリンク・ハンドラの設定に使用するフィールド。WebviewLinkHandlerType は、2つの値BROWSER とWEBVIEW がある列挙値です。
|
いいえ | WebviewLinkHandlerType.BROWSER |
|
messageModifierDelegate |
MessageModifierDelegate タイプのインスタンス。会話で特定のイベントの前にコールバックを受信するために使用されます。
|
いいえ | N/A | |
multiLangChat |
チャット・ウィジェットがユーザーの言語を検出できると同時に、ヘッダーのドロップダウン・メニューでユーザーに優先言語を選択してもらえるようになります。複数言語チャットで、このメニューの作成方法について説明します。 | いいえ | ||
notificationCustomizer |
NotificationCustomizer クラスのインスタンス。SDKから受信した通知をカスタマイズするために使用されます。
|
いいえ | N/A | |
reconnectMaxAttempts |
初期接続が失敗したときにチャット・ウィジェットが再接続を試行した回数。 | いいえ | 5 |
|
saveClickedImagesInGallery |
true (デフォルト)に設定すると、カメラを使用してスキル・ユーザーが取得したイメージがギャラリに保存され、スキルに添付として直接アップロードされます。イメージをギャラリに保存しない場合は、saveClickedImagesInGallery をfalse に設定します。
|
いいえ | true |
|
shareMenuItems |
共有メニュー・アイテムに表示されるアイテムを制限し、メニューのアイコンおよびラベルをカスタマイズします。これらのアイテムを構成するには、オブジェクトのArrayListをshareMenuItems に渡します。Arraylistオブジェクトとして使用できるのは、共有メニュー・アイテムにマップされたShareMenuItem 列挙値、またはShareMenuCustomItem オブジェクトのいずれかです。このフラグを使用するには、enableAttachment をtrue に設定する必要があります。
|
いいえ | N/A | |
showBotAvatar |
スキル・メッセージの近くにスキルのアバター・アイコンを表示できるようにします。 | いいえ | false |
|
showConnectionStatus |
チャット・ビュー・ヘッダーに接続ステータスを表示できるようにします。 | いいえ | false |
|
showPersonAvatar |
スキルのメッセージの横および通知にスキルのアバター・アイコンを表示できるようにします。スキルにライブ・エージェント統合がある場合、このフラグをtrue に設定すると、エージェントのメッセージの横および通知にエージェントのアバター・アイコンが表示されます。
|
いいえ | false |
|
showTypingIndicator |
スキルのレスポンスを待機中に入力インジケータを表示できます。 | いいえ | true |
|
showUserAvatar |
ユーザー・メッセージの近くにユーザー・アバター・アイコンを表示できるようにします。 | いいえ | false |
|
speechLocale |
音声認識に使用されるユーザーの音声の想定されたロケール。サポートされるロケールは、英語(オーストラリア) (en-au )、英語(英国) (en-gb )、フランス語(fr-fr )、ドイツ語(de-de )、インド・ヒンディー語(インド) (hi-in )、英語(インド) (en-in )、イタリア語(it-it )、ポルトガル語(ブラジル) (pt-br )、スペイン語(es-es )およびデフォルトの英語(米国) (en-us )です。Bots.setSpeechLocale(<locale>) APIをコールして、音声のロケールを動的に設定します。サポートされていないロケールが渡された場合、音声認識は機能しません。
|
いいえ | "en-us" |
|
speechSynthesisService |
テキストを音声(TTS)サービスに注入するために使用されるSpeechSynthesisServiceのインスタンス。enableSpeechSynthesis がtrue に設定されている場合にのみ適用されます。
|
いいえ | N/A | |
speechSynthesisVoicePreferences |
SpeechSynthesisSetting タイプのインスタンス・リストをパラメータとして取得することにより、スキルのメッセージを読み上げる言語および音声を構成します。デバイスで優先音声がサポートされない場合は、かわりに優先言語のデフォルト音声が使用されます。優先音声も優先言語もサポートされない場合は、デフォルトの音声と言語が使用されます。
|
いいえ | N/A | |
subtitle |
チャット・ビューのsubtitle を設定し、チャット・ビュー・ヘッダーのタイトルの下に表示します。subtitle フラグが設定され、showConnectionStatus またはshowTypingIndicator (あるいはその両方)がtrue に設定されている場合、接続ステータスまたは入力インジケータのかわりにサブタイトルが表示されます。
|
いいえ | N/A | |
timestampFormat |
メッセージに表示されるタイムスタンプをフォーマットします。'mm:ss:a' などのフォーマット・トークンの文字列を受け入れることができます。有効なタイムスタンプ・パターンの詳細は、Androidのドキュメントを参照してください
|
いいえ | N/A | |
timestampType |
enableTimestamp をtrue に設定してタイムスタンプを有効にした場合、timestampType: 'relative' を設定すると、最新のメッセージにのみ表示される相対タイムスタンプを設定できます。
|
N/A | ||
title |
チャット・ビューのヘッダーのタイトルを設定します。 | いいえ | N/A | |
typingIndicatorTimeout |
チャット・ビューがまだレスポンスを受信していない場合に、入力インジケータが自動的に削除されるまでの秒数を設定します。 | いいえ | 30 | |
typingStatusInterval |
ライブ・エージェントに送信される入力ステータスを抑制する間隔を秒単位で設定します。 | いいえ | 3 |
|
WebViewConfig |
ウィジェット内Webビューの属性(サイズ(一部または完全)やクリア・ボタンのカスタマイズなど)を設定します。Webビュー内のクリア・ボタンのカスタマイズも実行できます。 | いいえ | Webビューの構成を設定します。 | |
youtubeApiKey |
YouTube APIキーを設定することにより、YouTubeビデオのストリーミングをサポートします。 | いいえ | N/A |
カスタム色
res/values/colors.xml
ファイルの<color>
要素にname
属性を定義します。次のスニペットは、スキルのメッセージの背景に使用される色(odaas_primary
)と、スキルのメッセージで使用されるテキストの色(odaas_on_primary
)を変更する一方、その他のリソースではデフォルトの色を維持する方法を示しています。<resources>
<color name="odaas_primary">#6699FF</color>
<color name="odaas_on_primary">#000000</color>
</resources>
SDKのバージョン20.8.1では、以前のバージョンの色がリセットされます。たとえば、既存の実装のアクション・ボタンの背景色が
#418980
の場合、これはodaas_action_background
(20.8.1で導入)のデフォルトの色である#FFFFFF
に変更されます。20.8.1より前のバージョンを使用して作成された実装では、アプリケーションのres/values/colors.xml
ファイルを更新することで、カスタム・カラーを設定できます。例:<resources>
<color name="odaas_action_background">#418980</color>
</resources>
キー | 説明 | デフォルトの値 |
---|---|---|
odaas_action_background |
アクション・ボタンおよびグローバル・アクション・ボタンの背景色。 | #FFFFFF |
odaas_agent_avatar_background_color |
エージェント・アバターが使用できず、エージェント名のイニシャルがかわりに表示される場合に、アバター・レイアウトに使用される背景色。 | #A890B6 |
odaas_agent_avatar_text_color |
エージェント・アバター・レイアウト内に表示されるエージェント名のイニシャルに使用されるテキストの色。 | #FFFFFF |
odaas_agent_name_text_color |
エージェント・メッセージの上に表示されるエージェント名に使用されるテキストの色。 | #A6161513 |
odaas_background |
ビューの背景色。 | #F5F4F2 |
odaas_bot_avatar_background |
スキルのアバターに使用される背景色。 | #bdbdbd |
odaas_bot_avatar_background |
スキル・アバターの背景色。 | #bdbdbd |
odaas_card_background |
カード・メッセージとそのアクション・ボタンの背景色。 | FFFFFF |
odaas_dialog_accent |
メッセージのクリア前およびアタッチメントのアップロード中に表示されるダイアログ・ウィンドウのボタンおよび進捗バーに使用される色。 | 161513 |
odaas_dialog_background |
メッセージのクリア前およびアタッチメントのアップロード中に表示されるダイアログ・ウィンドウの背景色。 | #FFFFFF |
odaas_dialog_box_negative_button_background |
警告ダイアログボックスに表示される拒否ボタンの背景色。 | @android:color/transparent |
odaas_dialog_box_negative_button_text_color |
警告ダイアログボックスに表示される拒否ボタンのテキスト色。 | #161513 |
odaas_dialog_box_positive_button_background |
アラート・ダイアログ・ボックスに表示される確認ボタンの背景色。 | #161513 |
odaas_dialog_box_positive_button_text_color |
警告ダイアログボックスに表示される確認ボタンのテキスト色。 | #FFFFFF |
odaas_error |
エラー・メッセージで使用されるテキストの色。 | @android:color/white |
odaas_footer_accent |
フッターの入力フィールドの枠線およびカーソルの色。 | #01579B |
odaas_footer_attach_button |
添付ボタンの色。 | #161513 |
odaas_footer_background |
フッターの背景色。 | #FFFFFF |
odaas_footer_buttons |
送信ボタンを除く、フッターの対話型ボタンの背景色。 | 161513 |
odaas_footer_inline_send_button |
enableSpeechRecognitionAutoSend がtrue に設定されている場合に入力フィールド内に表示されるインライン送信ボタンの色。
|
#161513 |
odaas_footer_input_background |
フッターの入力フィールドの背景色。 | #FFFFFF |
odaas_footer_mic_button |
マイ・ボタンの色。 | #161513 |
odaas_footer_send_button |
送信ボタンの色。 | #FFFFFF |
odaas_footer_send_button_background |
送信ボタンの背景色。 | #161513 |
odaas_header_buttons |
ヘッダーの対話型ボタンの背景色。 | #FFFFFF |
odaas_on_action_background |
odaas_action_backgroundの色とともに使用されるテキストの色。 | @android:color/black |
odaas_on_background |
odaas_background の色で使用されるテキストの色。
|
@android:color/black |
odaas_on_card_action_text |
カードのアクション・ボタンのテキストの色。 | @android:color/black |
odaas_on_card_description_text |
カードの説明に使用されるテキストの色。 | @android:color/white |
odaas_on_card_title_text |
カードのタイトルに使用されるテキストの色。 | @android:color/white |
odaas_on_dialog_background |
ダイアログ・ウィンドウのodaas_dialog_background の色とともに使用されるテキストの色。
|
@android:color/black |
odaas_on_footer_input_background |
フッターのodaas_footer_input_background の色とともに使用されるテキストの色。
|
@android:color/black |
odaas_on_multichat_spinner_background |
ポップアップ・ウィンドウが開く前の複数言語チャット・ドロップダウン・メニューの背景色。 | #F1EFED |
odaas_on_multichat_spinner_popup_background |
ポップアップ・ウィンドウが開いた後の複数言語チャット・ドロップダウン・メニューの背景色。 | #FFFFFF |
odaas_on_multichat_spinner_popup_border |
ポップアップ・ウィンドウが開いた後の複数言語チャット・ドロップダウン・メニューの枠線の色。 | #BDBDBD |
odaas_on_multichat_spinner_popup_text_color |
複数言語チャット・ドロップダウン・メニューのアイテムに使用されるテキストの色。 | @android:color/black |
odaas_on_multichat_spinner_text_color |
複数言語チャット・ドロップダウン・メニューの選択したアイテムのテキストの色。 | #161513 |
odaas_on_primary |
odaas_primary の色で使用されるテキストの色。
|
#161513 |
odaas_on_primary_variant_dark |
odaas_primary_variant_dark の色で使用されるテキストの色。
|
#161513 |
odaas_on_primary_variant_light |
odaas_primary_variant_light の色で使用されるテキストの色。
|
@android:color/black |
odaas_on_secondary |
odaas_secondary の色で使用されるテキストの色。
|
#161513 |
odaas_on_secondary_variant_light |
odaas_secondary_variant_light の色で使用されるテキストの色。
|
@android:color/black |
odaas_on_speech_view_background |
音声モードのodaas_speech_view_background の色とともに使用されるテキストの色。
|
@android:color/white |
odaas_on_status_bar_transparent |
Webビューが開いているときのステータス・バーの背景色。 | @android:color/transparent |
odaas_on_webview_header_background_redwood |
レッドウッド・テーマ・モードでのウィジェット内Webビュー・ヘッダーの背景色 | #201E1C |
odaas_person_avatar_background |
ユーザー・アバターの背景色。 | #bdbdbd |
odaas_primary |
スキル・メッセージの背景およびフッターの対話型ボタンの背景で使用されるプライマリ・ブランディング色。 | #FFFFFF |
odaas_primary_status_bar |
ステータス・バーで使用される色。 | #DCD7D1 |
odaas_primary_variant_dark |
アプリケーション・バーおよび通知で使用されるプライマリ色の暗いバリアント。 | #F1EFED |
odaas_primary_variant_light |
スキルのアタッチメント・メッセージの背景で使用されるプライマリ色の明るいバリアント。 | #E4E1DD |
odaas_rating_star |
ユーザーが評価フィードバック・ボタンをまだ選択していないことを示す色。 | @android:color/white |
odaas_rating_star_fill |
ユーザーが評価フィードバック・ボタンを選択したことを示す色。 | #DAA520 |
odaas_secondary |
ユーザー・メッセージの背景およびスキルのアクション・ボタンの背景で使用されるセカンダリ・ブランディング色。 | #E4E1DD |
odaas_secondary_variant_dark |
ユーザー・アタッチメント・メッセージの背景で使用されるセカンダリ色の暗いバリアント。 | #CCCCCC |
odaas_secondary_variant_light |
無効化されたアクション・ボタンの背景で使用されるセカンダリ色の明るいバリアント。 | #BDBDBD |
odaas_selected_text_highlighted_color |
コピーまたは共有操作で強調表示されているテキストの色。 | #B6AFAF |
odaas_speech_view_background |
音声モードのフッターの背景色。 | #FFFFFF |
odaas_speech_view_button |
音声モードの取消ボタンの色。 | #161513 |
odaas_speech_visualizer_background |
音声モードの音声ビジュアライザの背景色。 | #12000000 |
odaas_speech_visualizer_color |
音声モードの音声ビジュアライザのバーの色。 | #5C926D |
odaas_timestamp_font_color |
相対タイムスタンプ・モードでodaas_timestamp_header_background 色とともに使用されるテキストの色。
|
#5b5652 |
odaas_timestamp_header_background |
相対タイムスタンプ・モードのタイムスタンプ・ヘッダーで使用される背景色。 | #d3d3d3 |
カスタム
res/value/strings.xml
ファイルにある<string>
要素のname
属性を定義します。たとえば、チャット・ビューのタイトルを変更するには、odaas_bot_chat_title
キーを定義します:<resources>
<string name="odaas_bot_chat_title">Support</string>
</resources>
この例では、チャット・タイトルのみが変更されています。その他の文字列リソースは、デフォルト値を維持します。 キー | 説明 | デフォルトの値 |
---|---|---|
odaas_bot_chat_title |
チャット・ビュー・ヘッダーに表示されるチャット・ビューのタイトル。このリソースは、title 機能フラグが設定されていない場合にのみ使用されます。
|
Digital Assistant |
odaas_bot_status_connected |
チャット・ビューとOracle Chat Server間の接続が確立されたときに表示されるステータス・テキスト。 | Connected |
odaas_bot_status_connecting |
チャット・ビューがOracle Chat Serverに接続している間に表示されるステータス・テキスト。 | Connecting |
odaas_bot_status_disconnected |
チャット・ビューとOracle Chat Server間の接続がクローズされたときに表示されるステータス・テキスト。 | Disconnected |
odaas_bot_status_responding |
ユーザーがスキルのレスポンスを待機している間に表示されるステータス・テキスト。
この文字列はリリース22.06で非推奨になりました。 |
Responding... |
odaas_button_clear_label |
Webビューのクリア・ボタンのテキスト。 | DONE |
odaas_capture_photo |
アタッチメントとしてサーバーにアップロードされるデバイスのカメラによってキャプチャされた写真の送信に使用される、アタッチメント・ポップアップのメニュー・アイテム・テキスト。 | Capture Photo |
odaas_captured_image_folder |
クリックされた画像が保存されるPicturesディレクトリ内のフォルダの名前。カスタマイズが指定されていない場合、デフォルトでは、クリックされたイメージはDCIMのCameraフォルダ内に保存されます。 | N/A |
odaas_clear_messages_dialog_button_no |
否定アクション用にメッセージのクリア・ポップアップに表示されるアクション・テキスト。 | No |
odaas_clear_messages_dialog_button_yes |
肯定アクション用にメッセージのクリア・ポップアップに表示されるアクション・テキスト。 | Yes |
odaas_content_desc_attachment_loaded |
アタッチメントを正常にロードした後のアタッチメント・メッセージのコンテンツの説明。 | Open attachment |
odaas_content_desc_attachment_loading |
アタッチメントをロードしている間のアタッチメント・メッセージのコンテンツの説明。 | Loading attachment |
odaas_content_desc_attachment_loading_error |
アタッチメントのロードに失敗したときのアタッチメント・メッセージのコンテンツの説明。 | Error in loading attachment |
odaas_content_desc_audio_pause |
オーディオ・プレーヤの一時停止ボタンのコンテンツの説明。 | Pause audio |
odaas_content_desc_audio_play |
オーディオ・プレーヤの再生ボタンのコンテンツの説明。 | Play audio |
odaas_content_desc_button_attach |
アタッチメント・ボタンで長押しジェスチャが検出されたときに表示されるツールチップ。および、アタッチメント・ボタンのコンテンツの説明。 | Upload Attachment |
odaas_content_desc_button_audio_response_off |
オーディオ・レスポンスのミュート・ボタンで長押しジェスチャが検出されたときに表示されるツールチップ。および、オーディオ・レスポンスのミュート・ボタンのコンテンツの説明。 | Unmute |
odaas_content_desc_button_audio_response_on |
オーディオ・レスポンスのミュート解除ボタンで長押しジェスチャが検出されたときに表示されるツールチップ。および、オーディオ・レスポンスのミュート解除ボタンのコンテンツの説明。 | Mute |
odaas_content_desc_button_back |
チャット・ビュー・ヘッダーの戻るボタンで長押しジェスチャが検出されたときに表示されるツールチップ。および、戻るボタンのコンテンツの説明。 | Navigate Up |
odaas_content_desc_button_cancel |
ユーザーの音声メッセージの記録中に表示されるキーボード・ボタンで長押しジェスチャが検出されたときに表示されるツールチップ。および、キーボード・ボタンのコンテンツの説明。 | Cancel |
odaas_content_desc_button_clear |
クリア・ボタンで長押しジェスチャが検出されたときに表示されるツールチップ。および、クリア・ボタンのコンテンツの説明。 | Clear Chat |
odaas_content_desc_button_download |
ダウンロード・ボタンで長押しジェスチャが検出されたときに表示されるツールチップ。および、ダウンロード・ボタンのコンテンツの説明。 | Download |
odaas_content_desc_button_end_conversation |
「会話の終了」ボタンのコンテンツの説明。 | End Conversation |
odaas_content_desc_button_notification_sound_off |
通知音のミュート・ボタンで長押しジェスチャが検出されたときに表示されるツールチップ。および、通知音のミュート・ボタンのコンテンツの説明。 | Turn On Notification Sound |
odaas_content_desc_button_notification_sound_on |
通知音のミュート解除ボタンで長押しジェスチャが検出されたときに表示されるツールチップ。および、通知音のミュート解除ボタンのコンテンツの説明。 | Turn Off Notification Sound |
odaas_content_desc_button_send |
送信ボタンで長押しジェスチャが検出されたときに表示されるツールチップ。および、送信ボタンのコンテンツの説明。 | Send |
odaas_content_desc_button_speak |
マイクロフォン・ボタンで長押しジェスチャが検出されたときに表示されるツールチップ。および、マイクロフォン・ボタンのコンテンツの説明。 | Speak |
odaas_content_desc_location_loaded |
ロケーション・プレビュー・イメージを正常にロードした後のロケーション・メッセージのコンテンツの説明。 | Open Location in Maps |
odaas_content_desc_location_loading |
ロケーション・プレビュー・イメージをロードしている間のロケーション・メッセージのコンテンツの説明。 | Loading location preview image |
odaas_content_desc_location_loading_error |
ロケーション・プレビュー・イメージのロードに失敗したときのロケーション・メッセージのコンテンツの説明。 | Error in loading location preview image. Tap to reload image. |
odaas_content_desc_multi_lang_chat |
オーバーフロー・メニューの言語検出アイコンとともに表示されるテキスト。 | Select Language |
odaas_content_desc_read_status |
既読メッセージのティック・マーク('✓' )のコンテンツの説明。この文字列は、enableTimestamp がtrue に設定されている場合にのみ表示されます。
|
Read |
odaas_content_desc_video_pause |
ビデオ・プレーヤの一時停止ボタンのコンテンツの説明。 | Pause video |
odaas_content_desc_video_play |
ビデオ・プレーヤの再生ボタンのコンテンツの説明。 | Play video |
odaas_content_timestamp_a_few_moments_ago |
相対タイムスタンプ。メッセージが受信された10秒後から、最後のメッセージが受信されてから60秒経過するまで表示されます。 | a few moments ago |
odaas_content_timestamp_day |
直前のメッセージが受信されてから毎日表示される相対タイムスタンプ。%1$s は、経過した日数で置き換えられます。
|
%1$sd ago |
odaas_content_timestamp_hour |
直前のメッセージの受信後24時間に毎時間表示される相対タイムスタンプ。%1$s は、経過した時間数で置き換えられます。
|
%1$shr ago |
odaas_content_timestamp_min |
最後のメッセージが受信されてから毎分表示される相対タイムスタンプ。%1$s は、経過した分数で置き換えられます。
|
%1$smin ago |
odaas_content_timestamp_month |
直前のメッセージが受信されてから毎月表示される相対タイムスタンプ。%1$s は、経過した月数で置き換えられます。
|
%1$smth ago |
odaas_content_timestamp_now |
新規メッセージに表示される相対タイムスタンプ。 | Now |
odaas_content_timestamp_year |
直前のメッセージが受信されてから毎年表示される相対タイムスタンプ。%1$s は、経過した年数で置き換えられます。
|
%1$syr ago |
odaas_default_greeting_message |
defaultGreetingTimeout で設定された秒数内にスキル・レスポンスが受信されなかった場合に表示されるデフォルトのクライアント・グリーティング・レスポンス。
|
Hey, Nice to meet you! Allow me a moment to get back to you. |
odaas_default_greeting_timeout |
デフォルトのタイムアウト(秒)。このタイムアウト後、デフォルトのグリーティング・メッセージが表示されます。 | 5 |
odaas_default_sorry_message |
スキル・レスポンスがtypingIndicatorTimeout で設定された秒数内にメッセージを受信しなかった場合のデフォルトのクライアント・レスポンス。
|
`I'm sorry, but I can't get the right content right now. Please try again.` |
odaas_default_wait_message |
実際のスキル・レスポンスが受信されなかった間隔で表示されるデフォルトのレスポンス。この間隔は、defaultWaitMessageInterval によって秒単位で設定されます。
|
I'm still working on your request. Thank you for your patience! |
odaas_default_wait_message_interval |
デフォルトの待機メッセージが表示されるデフォルトの間隔(秒)。 | 5 |
odaas_dialog_text_clear_messages |
メッセージをクリアする前にユーザーに確認を求めるポップアップ内に表示されるテキスト。 | Clear messages? |
odaas_download_dialog_message |
ユーザーがウィジェット内Webビューからダウンロードを開始したときに表示されるダウンロード・ダイアログのポップアップのメッセージ。 | Do you want to save |
odaas_download_dialog_negative_button |
ウィジェット内Webビュー内からユーザーが開始したダウンロードを取り消す、ダウンロード・ダイアログの否定ボタンのテキスト。 | Cancel |
odaas_download_dialog_positive_button |
ウィジェット内Webビュー内からユーザーが開始したダウンロードを確認する、ダウンロード・ダイアログの否定ボタンのテキスト。 | Yes |
odaas_download_dialog_title |
ユーザーがウィジェット内Webビューからダウンロードを開始したときに表示されるダウンロード・ダイアログのポップアップのタイトル。 | Download |
odaas_end_conversation_action_yes |
セッション終了確認プロンプトの「確認」ボタンのテキスト。 | Yes |
odaas_end_conversation_alert_message |
会話終了確認プロンプトのメッセージ本文。 | This will also clear your conversation history. |
odaas_end_conversation_alert_no |
セッション終了確認プロンプトの「拒否」ボタンのテキスト。 | No |
odaas_end_conversation_alert_title |
会話終了確認プロンプトのタイトル。 | Are you sure you want to end the conversation? |
odaas_error_in_capturing_photo |
デバイスのカメラから写真をキャプチャ中にエラーが発生した場合に表示されるエラー・メッセージ。 | Error in capturing photo. |
odaas_error_in_recording_audio |
Oracle音声サーバーへの接続を確立している間にエラーが発生したときに表示されるエラー・メッセージ。 | Error in recording audio. Please try again later. |
odaas_error_in_speech_recognition |
音声に入力がない場合、または入力が多すぎる場合に表示されるエラー・メッセージ。 | Speech Recognition Error. |
odaas_error_speech_unsupported_locale |
音声記録が試行されていて、サポートされていない音声ロケールが音声認識に対して構成されている場合に表示されるエラー・メッセージ。 | The set speech locale is not supported. Can not start recording. |
odaas_file_uploading_in_progress |
ユーザーのアタッチメントをOracle Serverにアップロードしている間にポップアップ内に表示されるテキスト。 | Uploading file to server..... |
odaas_hint_edit_text_user_message |
ユーザー入力フィールドに表示されるプレースホルダ・テキスト。 | Type your message |
odaas_hint_text_view_speech_mode |
ユーザーが話し始める前に音声モードのテキスト・ビューに表示されるプレースホルダ・テキスト。 | Speak your message |
odaas_no_messages_to_clear |
クリアするメッセージがない場合に表示されるメッセージ。 | No messages to clear |
odaas_no_speech_error |
ユーザー入力が検出されなかったためにチャット・サーバーが音声を認識できない場合に表示されるステータス・テキスト。 | Could not detect the voice, no message sent. |
odaas_notification_attachment_message |
スキルから受信されたアタッチメント・メッセージの通知に表示されるメッセージ。%1$s のテキストは、SDK (ODAおよびOMCダウンロード・ページから入手可能)で説明されているNotificationCustomizer クラスを使用して定義されたNotification title に設定されます。
|
%1$s has sent you an Attachment Message. |
odaas_notification_card_message |
スキルから受信されたカード・メッセージの通知に表示されるメッセージ。%1$s のテキストは、SDK (ODAおよびOMCダウンロード・ページから入手可能)で説明されているNotificationCustomizer クラスを使用して定義されたNotification title に設定されます。
|
%1$s has sent you a Card Message. |
odaas_notification_card_message |
スキルから受信されたカード・メッセージの通知に表示されるメッセージ。 | |
odaas_notification_fallback_message |
スキルから受信されたメッセージの通知に表示されるフォールバック・メッセージ。%1$s のテキストは、SDK (ODAおよびOMCダウンロード・ページから入手可能)で説明されているNotificationCustomizer クラスを使用して定義されたNotification title に設定されます。
|
%1$s has sent you a Message. |
odaas_notification_fallback_message |
スキルから受信されたメッセージの通知に表示されるフォールバック・メッセージ。 | |
odaas_notification_intent |
SDKから受信された通知をユーザーがタップしたときに開かれるアクティビティ。%1$s のテキストは、SDK (ODAおよびOMCダウンロード・ページから入手可能)で説明されているNotificationCustomizer クラスを使用して定義されたNotification title に設定されます。
|
oracle.cloud.bots.mobile.ui.ConversationActivity |
odaas_notification_location_message |
スキルから受信されたロケーション・メッセージの通知に表示されるメッセージ。%1$s のテキストは、SDK (ODAおよびOMCダウンロード・ページから入手可能)で説明されているNotificationCustomizer クラスを使用して定義されたNotification title に設定されます。
|
%1$s has sent you a Location Message. |
odaas_page_loading |
Webビューにページがロードされている最中のポップアップ内のテキスト。 | Please Wait...Page is Loading. |
odaas_require_audio_recording_permission |
ユーザーがオーディオの録音権限を拒否したときに表示されるエラー・メッセージ。 | Audio recording permission is needed to record audio |
odaas_require_download_to_storage_access_permission |
ユーザーがダウンロード・ファイルを保存するためのストレージ・アクセス権限を拒否したときに表示されるエラー・メッセージ。 | Storage access permission is needed to download file |
odaas_require_location_permission |
ユーザーがロケーションへのアクセス権限を拒否したときに表示されるエラー・メッセージ。 | Location access permission is needed to track location |
odaas_require_storage_access_permission |
ストレージへのアクセスが拒否されたときに表示されるエラー・メッセージ。 | Storage access permission is needed to attach files |
odaas_share_audio |
オーディオ・ファイルの共有に使用されるアタッチメント・ポップアップのメニュー・アイテム・テキスト。 | Share Audio |
odaas_share_file |
汎用ファイルの共有に使用されるアタッチメント・ポップアップのメニュー・アイテム・テキスト。 | Share File |
odaas_share_message_chooser_title |
ユーザーが「共有」アクションをクリックしたときに表示されるアプリケーション・チューザのタイトル。 | Share using: |
odaas_share_visual |
イメージまたはビデオ・ファイルの共有に使用されるアタッチメント・ポップアップのメニュー・アイテム・テキスト。 | Share Image/Video |
odaas_skill_message |
スクリーン・リーダーのスキル・メッセージ・インジケータ。スキル・レスポンスの前にスクリーン・リーダーによって読み上げられます。このテキストはチャット・ビューには表示されません。 | Skill says: |
odaas_speech_to_text_dialog_placeholder |
ユーザーが発言を開始する前に音声認識ポップアップに表示されるプレースホルダ・テキスト。このプロパティは、リリース20.8.1では非推奨です。そのリリース以降、このプロパティの設定は無視されます。 | Listening..... |
odaas_star_rating |
ユーザーがアクセシビリティ・モード中にユーザー評価ボタンがクリックされた場合に読み上げられるメッセージ。 | Rate %1$s star |
odaas_too_much_speech_error |
ユーザーが用意したボイス・メッセージが長すぎて認識できない場合に表示されるエラー・メッセージ。 | Too much voice input to recognize. Can not generate recognized text. |
odaas_user_message |
スクリーン・リーダーのユーザー・メッセージ・インジケータ。ユーザー・メッセージの前にスクリーン・リーダーによって読み上げられます。 | I say: |
ローカリゼーション
res/values-<your-language-code>/strings.xml
ファイルにある<string>
要素のname
属性を定義します。たとえば、チャット・ビューのタイトルを英語でローカライズするには、res/value-en/strings.xml
というファイルで次を定義します:<resources>
<string name="odaas_bot_chat_title">Support</string>
</resources>
タイトルをフランス語でローカライズするには、res/value-fr/strings.xml
というファイルに次を追加します:<resources>
<string name="odaas_bot_chat_title">Soutien</string>
</resources>
res/value/strings.xml
の値は、デフォルトで、res/values-<your-language-code>/strings.xml
で見つからないキーに対して使用されます。これらの2つの例では、res/value-fr/strings.xml
またはres/value-en/strings.xml
ファイルに定義されていないリソースに対して、デフォルト値が使用されます。
カスタム・アイコン
res/drawable
フォルダに必要なイメージまたはベクトル・アセットを追加して、ドローアブルを構成します。
名前 | 説明 |
---|---|
ic_odaas_agent_avatar |
ライブ・エージェントからのメッセージのアバター・アイコン。このアイコンは、showBotAvatar 機能フラグがtrue に設定されている場合にのみ通知に表示されます。
|
ic_odaas_bot_avatar |
スキルのメッセージのアバター・アイコン。このアイコンは、showBotAvatar 機能フラグがtrue に設定されている場合にのみ通知に表示されます。
|
ic_odaas_download |
スキルによって送信される添付メッセージに表示されるダウンロード・アイコン。 |
ic_odaas_image_zoom |
スキルによって送信されるイメージ添付メッセージに表示されるズーム・コントロールのアイコン。 |
ic_odaas_notification_app_icon |
ステータス・バーおよびSDKライブラリから受信された通知に表示されるアプリケーション・アイコン。 |
ic_odaas_person_avatar |
ユーザー・メッセージのアバター・アイコン。 |
ic_odaas_rating |
フィードバック評価ボタンに使用されるアイコン。 |
機能フラグの設定
BotsConfiguration.BotsConfigurationBuilder
クラスを使用して、BotsConfiguration
クラスを初期化します。
BotsConfiguration.BotsConfigurationBuilder(String chatServerUrl, boolean clientAuthEnabled, Context context)
パラメータ:chatServerUrl
– Oracle Chat and Attachment ServerのURL。これはnullにできません。clientAuthEnabled
- チャネルのクライアント認証設定を有効にするか無効にするかを決定します。context
– アプリケーション・コンテキスト。これはnullにできません。
BotsConfiguration botsConfiguration = new BotsConfiguration.BotsConfigurationBuilder(<SERVER_URI>, false, getApplicationContext())
BotsConfiguration.BotsConfigurationBuilder(String chatServerUrl, Context context)
– これは、クライアント認証を有効にしたチャネルへの接続を確立するために使用できます。パラメータ:chatServerUrl
– Oracle Chat and Attachment ServerのURL。これはnullにできません。context
– アプリケーション・コンテキスト。これはnullにできません。
BotsConfiguration botsConfiguration = new BotsConfiguration.BotsConfigurationBuilder(<SERVER_URI>, getApplicationContext())
SDKの初期化
public static void init(Application application, BotsConfiguration botsConfiguration)
public static void init(Application application, BotsConfiguration botsConfiguration, BotsCallback botsCallback)
public static void init(Application application, String chatServerUrl, String channelId, String userId, BotsCallback botsCallback)
public static void init(Application application, String chatServerUrl, AuthenticationTokenProvider authTokenProvider, BotsCallback botsCallback)
public static void init(Application application, BotsConfiguration botsConfiguration)
public static void init(Application application, BotsConfiguration botsConfiguration)
メソッドは、ユーザーから渡されたBotsConfiguration
インスタンスに基づいてすべてのサービスを初期化し、Oracle Chat ServerへのWebSocket接続を確立します。
application
– アプリケーション・インスタンス。これはnullにできません。botsConfiguration
– ライブラリの機能の制御に使用されるBotsConfiguration
オブジェクト。これはnullにできません。
Bots.init(getApplication(),
botsConfiguration);
public static void init(Application application, BotsConfiguration botsConfiguration, BotsCallback botsCallback)
public static void init(Application application, BotsConfiguration botsConfiguration, BotsCallback botsCallback)
メソッドは、ユーザーから渡されたBotsConfiguration
インスタンスに基づいてすべてのサービスを初期化し、Oracle Chat ServerへのWebSocket接続を確立します。
application
– アプリケーション・インスタンス。これはnullにできません。botsConfiguration
– ライブラリの機能の制御に使用されるBotsConfiguration
オブジェクト。これはnullにできません。botsCallback
– 接続の確立中に受信されたコールバック。
Bots.init(getApplication(), botsConfiguration, new BotsCallback() {
@Override
public void onSuccess(Response paramResponse) {}
@Override
public void onFailure(Response paramResponse) {}
});
public static void init(Application application, String chatServerUrl, String channelId, String userId, BotsCallback botsCallback)
public static void init(Application application, String chatServerUrl, String channelId, String userId, BotsCallback botsCallback)
メソッドは、デフォルト構成ですべてのサービスを初期化します。このメソッドを起動すると、クライアント認証が無効なチャネルに接続できます。
application
– アプリケーション・インスタンス。これはnullにできません。chatServerUrl
– Oracle Chat ServerのURL。これはnullにできません。channelId
– スキルまたはデジタル・アシスタントにルーティングされるOracle Androidチャネルに属するチャネルID。これはnullにできません。userId
– ユーザーの一意の識別子。この値が指定されていない場合、SDKによって初期化されます。botsCallback
– Oracle Chat Serverへの接続の確立中に受信されたコールバック。
Bots.init(getApplication(), chatServerUrl, authTokenProvider, new BotsCallback() {
@Override
public void onSuccess(Response paramResponse) {}
@Override
public void onFailure(Response paramResponse) {}
});
public static void init(Application application, String chatServerUrl, AuthenticationTokenProvider authTokenProvider, BotsCallback botsCallback)
public static void init(Application application, String chatServerUrl, AuthenticationTokenProvider authTokenProvider, BotsCallback botsCallback
メソッドを起動して、クライアント認証が有効なチャネルに接続します。このメソッドは、デフォルト構成ですべてのサービスを初期化します。
application
– アプリケーション・インスタンス。これはnullにできません。chatServerUrl
– Oracle Chat ServerのURL。これはnullにできません。authTokenProvider
–AuthenticationTokenProvider
のインスタンス。必要に応じて認証トークンを生成するために使用します。botsCallback
– 接続の確立中に受信されたコールバック。
BotsConfiguration botsConfiguration = new BotsConfiguration.BotsConfigurationBuilder(<SERVER_URI>, getApplicationContext())
インタフェースAuthenticationTokenProvider
public String getAuthToken
メソッドは、生成されたトークンの文字列を返します。
authTokenProvider
プロパティに渡すことで、認証されたチャネル接続を確立するために新しい認証トークンが必要になった場合にSDKで生成できます。このインタフェースを実装する場合、public String getAuthToken
メソッドをオーバーライドします。private class AuthTokenProvider implements AuthenticationTokenProvider {
@Override
public String getAuthToken() {
// Generate a new JWT Token and return
}
}
インタフェースBotsCallback
void onSuccess(Response paramResponse)
– このメソッドは、Webソケット接続が正常に確立されたときにコールされます。void onFailure(Response paramResponse)
– このメソッドは、ライブラリの初期化中に障害が発生したときにコールされます。
会話アクティビティの表示
public static void show(Context context)
を起動して会話ビューを表示します。このメソッドのcontext
パラメータは、アクティビティの開始元のコンテキストです。ConversationActivity.show(getApplicationContext())
通知のカスタマイズ
NotificationCustomizer
クラスをインスタンス化し、インスタンスをnotificationCustomizer
プロパティに渡すことで、スキルのメッセージに対して受信された通知をカスタマイズできます。コンストラクタは:
NotificationCustomizer()
– デフォルト構成で通知チャネルを初期化します。NotificationCustomizer(String channelId)
– 指定されたチャネルIDで通知チャネルを初期化します。channelId
パラメータは、通知が送信される通知チャネルのIDです。-
NotificationCustomizer(String channelId, String channelName, String description, String title)
– 指定されたパラメータで通知チャネルを初期化します:channelID
– 通知が送信される通知チャネルのID。channelName
– 通知が送信される通知チャネルの名前。description
– 通知が送信される通知チャネルの説明。title
– 通知に表示されるタイトル。
new BotsConfiguration.NotificationCustomizer(<NOTIFICATION_CHANNEL_ID>,
<NOTIFICATION_CHANNEL_NAME>, <NOTIFICATION_CHANNEL_DESCRIPTION>, <NOTIFICATION_TITLE>);