Skip to main content

Interface: SharePayload

Hierarchy

  • MessageOptions

    SharePayload

Properties

caption

Optional caption: string | LocalizableContent

Text of the call to action button. If not specified, "今すぐプレイ" will be used by default.

Inherited from

MessageOptions.caption

Defined in

types/message-options.ts:20


data

Optional data: Record<string, unknown>

Object passed to any session launched from this update message. It can be accessed from LinkGame.getEntryPointData(). Its size must be <=1000 chars when stringified.

Inherited from

MessageOptions.data

Defined in

types/message-options.ts:26


image

Optional image: string

Image which will be displayed to contact. A string containing data URL of a base64 encoded image. If not specified, game's icon image will be used by default.

Inherited from

MessageOptions.image

Defined in

types/message-options.ts:10


text

Optional text: string | LocalizableContent

Message which will be displayed to contact. If not specified, "SENDER_NAMEと一緒に「GAME_NAME」をプレイしよう!" will be used by default.

Inherited from

MessageOptions.text

Defined in

types/message-options.ts:15