インターフェイス: InvitePayload
context.inviteAsync のペイロード。ユーザーから送信される招待によって共有されるコンテンツを表します。
目次
プロパティ
プロパティ
cta
• Optional cta: string | LocalizableContent
call-to-action ボタンのテキスト。
data
• Optional data: Record<string, unknown>
このコンテキスト・メッセージから起動されるセッションに渡されるオブジェクト。文字列に変換する場合、文字数は1000文字以下でなければなりません。 また、Wortal.session.getEntryPointData() からアクセスが可能です。
dialogTitle
• Optional dialogTitle: string | LocalizableContent
一般的なタイトルの代わりに招待ダイアログの上部に表示する任意のタイトル。このパラメータはメッセージの一部として送信されるのではなく、ダイアログのヘッダに表示されます。タイトルは、文字列、若しくはデフォルトのテキストを ”default” の値とするオブジェクトや、ロケールのキーをマッピングした ”localizations” の値とする別のオブジェクト。
プラットフォーム：Facebookのみ
filters
• Optional filters: InviteFilter[]
サジェストに適用するフィルタのセット。複数のフィルタを適用できます。フィルタが適用された際に結果が返されない場合、結果はフィルタなしで生成されます。
image
• image: string
表示する base64 エンコード画像のデータURL。こちらは、ペイロードを送信するために必要です。
sections
• Optional sections: InviteSection[]
ダイアログに含まれるセクションのセット。各セクションには、返される結果の最大数を指定することが可能（最大10まで）。最大数を指定しなかった場合、デフォルトの最大値が適用されます。セクションを含む際、配列の順序の通りに並びます。最後のセクションには、より大きな結果の最大数が含まれ、また、maxResults を指定した場合、それは無視されます。この配列が空の場合、デフォルトのセクションが使用されます。
プラットフォーム：Facebookのみ
text
• text: string | LocalizableContent
テキストメッセージ、若しくはデフォルトのテキストを ”default” の値とするオブジェクトや、ロケールのキーをマッピングした ”localizations” の値とする別のオブジェクト。