Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface GamePlayEvent

GamePlayEvent occurs after a person played a round of Instant Games.

subscription

messaging_game_plays

guides

Check official reference.

Hierarchy

  • EventObject<"action", "game_play">
  • EventBase
  • GamePlay
    • GamePlayEvent

Index

Properties

[toStringTag]: "MessengerEvent"
category: "action"
channel: MessengerChat
contextId: string

ID of the context if not a SOLO type. This ID is in the Instant Game name-space

contextType: "SOLO" | "THREAD" | "GROUP"

Type of the social context a game is played in

data: undefined | string

JSON encoded payload data, set using FBInstant.setSessionData(). Only available to game with Rich Games Feature enabled

gameId: string

App ID of the game

isEcho: boolean

Indicate whether the event is an echo.

isStandby: boolean

Indicate whether the event is sent to a standby channel.

payload: any
platform: "messenger"
playerId: string

ID of the user in the Instant Game name-space. By linking this ID to the PSID received in the sender field, the bot can send messages to a user after a game play

score: undefined | number

Best score achieved by this user in this game round. Only available to Classic score based games

The user that triggered the webhook event.

timestamp: number
type: "game_play"

Generated using TypeDoc