Skip to content

Interface: LinkSharePayload

Payload for context.shareLinkAsync. Represents a custom link to be shared by the user.

Table of contents




data: Record<string, unknown>

A blob of data to associate with the shared link. All game sessions launched from the share will be able to access this blob through Wortal.session.getEntryPointData().


Optional image: string

A base64 encoded image to be shown for the link preview. The image is recommended to either be a square or of the aspect ratio 1.91:1


Optional text: string

A text description for the link preview. Recommended to be less than 44 characters