Namespace Meta.InstantGames

Classes

APIError

An API Error returned by the Instant Games SDK

AddToGamingSquadPayload

Represents parameters used to configure the Add to Squad dialog.

Community

Contains functions and properties related to the gaming community.

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.

CreateGamingSquadPayload

Represents parameters used to configure a gaming squad.

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.

GamingSquad

Representation of a group of players playing together in a Messenger thread.

GamingSquads

Contains functions and properties related to gaming squads.

GraphApi

Contains functions and properties related to Graph APIs.

InvitePayload

Represents content to be shared in invitations sent by the user.

InviteSection

Represents a section in the Invite dialog that contains suggested matches. The sections display in the order they're included in the array, and the last section contains as many results as possible.

JoinGamingSquadPayload

Represents parameters used to configure the Join dialog.

Leaderboard

Represents an Instant Game leaderboard.

LeaderboardEntry

Represents a score entry for an Instant Game leaderboard.

LeaderboardPlayer

Represents details about the player associated with a score entry.

LeaderboardUpdatePayload

Represents a leaderboard update for UpdateAsync(LeaderboardUpdatePayload)..

LeaveGamingSquadPayload

Represents parameters used to configure the "Leave" dialog.

LiveMatch

An instant game live match that is played in a Messenger Rooms call simultaneously by all the participants.

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.
Important: This type is deprecated and will be removed in a future version.

MediaParams

Represents the media payload used by custom update and custom share.
Important: This type is deprecated and will be removed in a future version.

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.

Room

Contains functions and properties related to the Messenger Rooms environment.

ScreenshotPayload

Represents screenshot content provided by the game that later on can be shared by the user.

SharePayload

Represents the content a user can share.

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 ChooseAsync(ContextOptions) operation.

ContextType

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

ErrorCode

Error codes that may be returned by the Instant Games API

InstantGameTimedLeaderboardTournamentExternalType

The type for an Instant Game leaderboard tournament.

InviteFilter

A filter you can apply to the InviteAsync(InvitePayload) operation. If no results return with the filter, then the filter isn't applied.

InviteSectionType

Represents the type of section to include. All section types may include both new and existing contexts and players.

Platform

Represents the current platform that the user is playing on.

PurchasePlatform

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

ShareDestination

Specifies the share destination in the share dialog. Provide this value in the payload when calling ShareAsync(SharePayload).

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 update action to perform.

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 is delivered.