Interface: SharePayload

share.SharePayload

Represents content to be shared by the user.

Properties

cta

• Optional cta: string

Text of the cta button. defaults to “Play” Platforms: Viber

---

data

• Optional data: any

A blob of data to attach to the share. All game sessions launched from the share will be able to access this blob through client getEntryPointData().

---

description

• Optional description: string

Optional customizable text field in the share UI. This can be used to describe the incentive a user can get from sharing. Platforms: Viber

---

filters

• Optional filters: ContextFilter[]

An array of filters to be applied to the friend list. (Please note that filter combinations are not supported. Only the first filter is respected, the later ones are simply just ignored.) Platforms: Viber

---

hoursSinceInvitation

• Optional hoursSinceInvitation: number

Specify how long a friend should be filtered out after the curent player sends him/her 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. Platforms: Viber

---

image

• image: string

A base64 encoded image to be shared.

---

intent

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

Indicates the intent of the share.

---

minShare

• Optional minShare: number

Defining the minimum number of players to be selected to start sharing. Platforms: Viber

---

text

• text: string

A text message to be shared.

---

ui

• Optional ui: "DEFAULT" | "MULTIPLE"

Optional property to switch share UI mode. DEFAULT: Serial contact card with share and skip button. MULTIPLE: Selectable contact list. Platforms: Viber