GamesServicesPlatform class abstract

Inheritance
  • Object
  • PlatformInterface
  • GamesServicesPlatform

Constructors

GamesServicesPlatform()
Constructs a GamesServicesPlatform.

Properties

hashCode → int
The hash code for this object.
no setterinherited
player → Stream<PlayerData?>
Stream of the currently authenticated player. If not null, the player is signed in & games_services functionality is available.
no setter
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

deleteGame({required String name}) → Future<String?>
Delete game with name.
fetchIdentityVerificationSignature() → Future<IdentityVerificationSignature?>
Fetch identity verification signature from Game Center (iOS and MacOS). Returns identity verification data including public key URL, signature, salt, and timestamp. Only available on iOS and MacOS, returns null on other platforms.
getAuthCode(String clientID, {bool forceRefreshToken = false}) → Future<String?>
Retrieve Google Play Games server_auth_code to be used by an auth provider, such as Firebase, to authenticate the user. null on other platforms.
getPlayerHiResImage() → Future<String?>
Get the current player's hi-res profile image as a base64 encoded String.
getPlayerScore({dynamic iOSLeaderboardID = "", dynamic androidLeaderboardID = ""}) → Future<int?>
Get the current player's score for a specific leaderboard.
getPlayerScoreObject({dynamic iOSLeaderboardID = "", dynamic androidLeaderboardID = "", required PlayerScope scope, required TimeScope timeScope}) → Future<String?>
Get leaderboard scores as a json data for current player. To show the prebuilt system screen use showLeaderboards.
getSavedGames({bool forceRefresh = false}) → Future<String?>
Get all saved games.
hideAccessPoint() → Future<String?>
Hide the Game Center Access Point.
increment({required Achievement achievement}) → Future<String?>
Increment an achievement. Achievement takes two parameters: androidID the achievement ID for Google Play Games. steps If the achievement is of the incremental type you can use this method to increment the steps.
loadAchievements({bool forceRefresh = false, bool ignoreImages = false}) → Future<String?>
Get achievements as json data. To show the device's default achievements screen use showAchievements.
loadGame({required String name}) → Future<String?>
Load game with name.
loadLeaderboardScores({dynamic iOSLeaderboardID = "", dynamic androidLeaderboardID = "", bool playerCentered = false, required PlayerScope scope, required TimeScope timeScope, required int maxResults, bool forceRefresh = false}) → Future<String?>
Get leaderboard scores as json data. To show the device's default leaderboards screen use showLeaderboards.
loadPreviousOccurrence({dynamic iOSLeaderboardID = "", dynamic androidLeaderboardID = "", required TimeScope timeScope}) → Future<String?>
Load the previous occurrence of the player's score from a leaderboard. Returns the score data that precedes the player's current best score. iOSLeaderboardID the leaderboard ID for Game Center. androidLeaderboardID the leaderboard ID for Google Play Games. timeScope the time scope for the leaderboard.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
resetAchievements() → Future<String?>
Reset achievements.
saveGame({required String data, required String name}) → Future<String?>
Save game with data and a unique name. The name must be between 1 and 100 non-URL-reserved characters (a-z, A-Z, 0-9, or the symbols "-", ".", "_", or "~").
showAccessPoint(AccessPointLocation location) → Future<String?>
Show the Game Center Access Point for the current player.
showAchievements() → Future<String?>
Open the device's default achievements screen.
showLeaderboards({dynamic iOSLeaderboardID = "", dynamic androidLeaderboardID = ""}) → Future<String?>
Open the device's default leaderboards screen. If a leaderboard ID is provided, it will display the specific leaderboard, otherwise it will show the list of all leaderboards.
signIn() → Future<String?>
Sign the user into Game Center or Google Play Games. This must be called before taking any action (such as submitting a score or unlocking an achievement).
submitScore({required Score score}) → Future<String?>
Submit a score to a specific leaderboard. Score takes three parameters: androidLeaderboardID the leaderboard ID for Google Play Games. iOSLeaderboardID the leaderboard ID for Game Center. value the score.
toString() → String
A string representation of this object.
inherited
unlock({required Achievement achievement}) → Future<String?>
Unlock an achievement. Achievement takes three parameters: androidID the achievement ID for Google Play Games. iOSID the achievement ID for Game Center. percentComplete the completion percentage of the achievement, this parameter is optional on iOS/macOS.

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Properties

instance ↔ GamesServicesPlatform
The default instance of GamesServicesPlatform to use. Defaults to MethodChannelGamesServices.
getter/setter pair