コンテンツにスキップ

インターフェイス: SharePayload

context.shareAsync のペイロード。コンテキストに送信するメッセージを定義します。

目次

プロパティ

プロパティ

cta

• Optional cta: string | LocalizableContent

call-to-action ボタンのテキスト。

data

• Optional data: Record<string, unknown>

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

description

• Optional description: string | LocalizableContent

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

filters

• Optional filters: [ContextFilter]

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

hoursSinceInvitation

• Optional hoursSinceInvitation: number

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

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

image

• image: string

表示する base64 エンコード画像のデータURL。こちらは、ペイロードを送信するために必要です。

intent

• Optional intent: "INVITE" | "REQUEST" | "CHALLENGE" | "SHARE"

表示されるメッセージフォーマット。使用可能なオプションの中に明白な違いはありません。

minShare

• Optional minShare: number

シェアする際に選択できるプレーヤーの最小人数を定義します。

playerIds

• Optional playerIds: string[]

オプションのプロパティであり、確認のためのプロンプトから複数のプレーヤーに対してシェアメッセージを直接送信します。こちらのプロパティが設定されている場合、選択型 UI はスキップされます。

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

shareDestination

• Optional shareDestination: ShareDestination[]

シェアダイアログの共有先を設定する任意の配列。指定しない場合、すべての共有先が表示されます。

プラットフォーム: Facebookのみ

switchContext

• Optional switchContext: boolean

シェアの際に作成された新しいコンテキストにユーザーを切り替えるかどうかを示すフラグ。

プラットフォーム: Facebookのみ

text

• text: string | LocalizableContent

テキストメッセージ、若しくはデフォルトのテキストを ”default” の値とするオブジェクトや、ロケールのキーをマッピングした ”localizations” の値とする別のオブジェクト。

ui

• Optional ui: "DEFAULT" | "MULTIPLE"

共有用UIモードを切り替える任意のプロパティ。

  • DEFAULT: 共有ボタンとスキップボタンを備えた友達リスト。（友達はひとりずつ表示されます
  • MULTIPLE: 選択可能なコンタクトリスト。