Namespace Meta.InstantGames.v8

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.

ContextSizeResponse

An object returned from Context.IsSizeBetween. The answer field is true if the current context size is between the minSize and maxSize values that are specified in the object, and false otherwise.

CreateTournamentConfig

Represents the configurations used in creating an instant tournament.

FBInstant

The main entry point to the Facebook Instant Games SDK.

LocalizableContent

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

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.

Payments

Contains functions and properties related to payments and purchases of game products.

Player

Contains functions and properties related to the current player.

Product

Represents a game's product information.

Purchase

Represents an individual purchase of a game product.

PurchaseConfig

The configuration of a purchase request for a product registered to the game.

ShareTournamentPayload

Represents content used to reshare an Instant Tournament.

SignedASID

Represents the Application-Scoped ID of the current player along with a signature to verify that it comes from Facebook.

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.

ContextType

Type of the current game context returned from a Context.GetType operation.

ErrorCode

Error codes that may be returned by the Instant Games API

PurchasePlatform

Purchase Platforms that may be returned by subscriptions API, representing the platform by which the user made the purchase

TournamentScoreFormat

The format of the score in the tournament.

TournamentSortOrder

The ordering of which score is best in the tournament.

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.