Namespace Meta.InstantGames

Classes

APIError

An API Error returned by the Instant Games SDK

ConnectedPlayer

Represents information about a player who is connected to the current player.

Context

Contains functions and properties related to the current game context.

ContextOptions

An object specifying conditions on the contexts that should be offered.

ContextPlayer

Represents information about a player who is in the context that the current player is playing in.

CreateTournamentConfig

Represents the configurations used in creating an instant tournament.

Represents a custom update for UpdateAsync(CustomUpdatePayload). Note that if localized content is not provided, a Facebook supplied localized string will be used for the call to action and text.The default string should always be in English.

FBInstant

The main entry point to the Facebook Instant Games SDK.

LeaderboardUpdatePayload

Represents a leaderboard update for UpdateAsync(LeaderboardUpdatePayload)..

LocalizableContent

Represents a string with localizations and a default value to fall back on.

LocalizationsDict

Represents a mapping from locales to translations of a given string. Each property is an optional five-character Facebook locale code of the form xx_XX. See https://lookaside.facebook.com/developers/resources/?id=FacebookLocales.xml for a complete list of supported locale codes.

MediaContent

Specify how we could get the content for the media.

MediaParams

Represents the media payload used by custom update and custom share.

Player

Contains functions and properties related to the current player.

ShareTournamentPayload

Represents content used to reshare an Instant Tournament.

SignedPlayerInfo

Represents information about the player along with a signature to verify that it indeed comes from Facebook.

Tournament

An instant game tournament.

Tournaments

Contains functions and properties related to instant tournaments.

Enums

ContextFilter

A filter that may be applied to a Context Choose operation. 'NEW_CONTEXT_ONLY' - Prefer to only surface contexts the game has not been played in before. 'INCLUDE_EXISTING_CHALLENGES' - Include the 'Existing Challenges' section, which surfaces actively played-in contexts that the player is a part of. 'NEW_PLAYERS_ONLY' - In sections containing individuals, prefer people who have not played the game.

ErrorCode

Error codes that may be returned by the Instant Games API

TournamentScoreFormat

The format of the score in the tournament.

TournamentSortOrder

The ordering of which score is best in the tournament.

UpdateAction

Represents the type of the update action to perform. 'CUSTOM' - A custom update, with all content specified by the game. 'LEADERBOARD' - An update associated with an Instant Game leaderboard.

UpdateNotification

Specifies notification setting for the custom update. This can be 'NO_PUSH' or 'PUSH', and defaults to 'NO_PUSH'. Use push notification only for updates that are high-signal and immediately actionable for the recipients. Also note that push notification is not always guaranteed, depending on user setting and platform policies.

UpdateStrategy

Specifies how the update should be delivered. This can be one of the following: 'IMMEDIATE' - The update should be posted immediately. 'LAST' - The update should be posted when the game session ends. The most recent update sent using the 'LAST' strategy will be the one sent. If no strategy is specified, we default to 'IMMEDIATE'.