インターフェイス: ChoosePayload

context.chooseAsync のペイロード。友達リストに適用するフィルタと検索パラメータを定義します。

プロパティ

• Optional caption: string | LocalizableContent

call-to-action ボタンのテキスト。指定しない場合、 "今すぐプレイ" がデフォルトとして表示されます。

プラットフォーム：Linkのみ

• Optional data: Record<string, unknown>

このアップデート・メッセージから起動されるセッションに渡されるオブジェクト。 Wortal.session.getEntryPointData() からアクセスが可能です。文字列に変換する場合、文字数は1000文字以下でなければなりません。

プラットフォーム：Linkのみ

• Optional description: string | LocalizableContent

共有用UIのカスタマイズ可能な任意のテキストフィールド。こちらは、ユーザーがシェアすることで獲得できる報酬を説明するために使用できます。

• Optional filters: [ContextFilter]

友達リストに適用するフィルタの配列。現在は最初のフィルタのみ、使用されます。

• Optional hoursSinceInvitation: number

現在のプレイヤーが友達にメッセージを送信してから、フィルタリングされるまでの時間を指定します。このパラメータは、 NEW_INVITATIONS_ONLY フィルタが使用されている場合にのみ、適用されます。指定しない場合、メッセージを送信した友達を除外します。

プラットフォーム：Viberのみ

• Optional image: string

コンタクトに表示される画像。base64 エンコード画像のデータURLを含む文字列。指定しない場合、ゲームのアイコン画像が表示されます。

プラットフォーム：Linkのみ

• Optional maxSize: number

マッチングのためのコンテキストの最大サイズ。

• Optional minSize: number

マッチングのためのコンテキストの最小サイズ。

• Optional text: string | LocalizableContent

コンタクトに表示するメッセージ。指定しない場合、 "SENDER_NAMEと一緒に「GAME_NAME」をプレイしよう！" がデフォルトとして表示されます。

プラットフォーム：Linkのみ