Interface: ChoosePayload
Payload for context.chooseAsync. Defines the filters and search parameters to apply to the friend list.
Table of contents
Properties
Properties
caption
• Optional caption: string | LocalizableContent
Text of the call-to-action button. If not specified, "今すぐプレイ" will be used by default.
PLATFORM NOTE: Link only.
data
• Optional data: Record<string, unknown>
Object passed to any session launched from this update message.
It can be accessed from Wortal.session.getEntryPointData().
Its size must be <=1000 chars when stringified.
PLATFORM NOTE: Link only.
description
• Optional description: string | LocalizableContent
Optional customizable text field in the share UI. This can be used to describe the incentive a user can get from sharing.
filters
• Optional filters: [ContextFilter]
An array of filters to be applied to the friend list. Only the first filter is currently used.
hoursSinceInvitation
• Optional hoursSinceInvitation: number
Specify how long a friend should be filtered out after the current player sends them a message.
This parameter only applies when NEW_INVITATIONS_ONLY filter is used.
When not specified, it will filter out any friend who has been sent a message.
PLATFORM NOTE: Viber only.
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.
PLATFORM NOTE: Link only.
maxSize
• Optional maxSize: number
Context maximum size for matching.
minSize
• Optional minSize: number
Context minimum size for matching.
text
• Optional text: string | LocalizableContent
Message which will be displayed to contact. If not specified, "SENDER_NAMEと一緒に「GAME_NAME」をプレイしよう！" will be used by default.
PLATFORM NOTE: Link only.