@byvik/capacitor-play-games 0.0.0-stage → 0.1.0

package/dist/docs.json

@@ -0,0 +1,763 @@
+{
+  "api": {
+    "name": "PlayGamesPlugin",
+    "slug": "playgamesplugin",
+    "docs": "",
+    "tags": [],
+    "methods": [
+      {
+        "name": "isAuthenticated",
+        "signature": "() => Promise<AuthResult>",
+        "parameters": [],
+        "returns": "Promise<AuthResult>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.1.0"
+          }
+        ],
+        "docs": "Whether a player is signed in. Shows no UI and never rejects.\n\nThe SDK tries a silent sign-in when the app starts, so this is the call\nto make before drawing anything that depends on the session.",
+        "complexTypes": [
+          "AuthResult"
+        ],
+        "slug": "isauthenticated"
+      },
+      {
+        "name": "signIn",
+        "signature": "() => Promise<AuthResult>",
+        "parameters": [],
+        "returns": "Promise<AuthResult>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.1.0"
+          }
+        ],
+        "docs": "Ask the player to sign in. This is the only call that shows Google's\nsign-in UI, so make it from a button the player pressed. Never rejects:\na cancelled or failed sign-in resolves with `isAuthenticated: false`.",
+        "complexTypes": [
+          "AuthResult"
+        ],
+        "slug": "signin"
+      },
+      {
+        "name": "getCurrentPlayer",
+        "signature": "() => Promise<Player>",
+        "parameters": [],
+        "returns": "Promise<Player>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.1.0"
+          }
+        ],
+        "docs": "The signed-in player. Rejects when nobody is signed in.",
+        "complexTypes": [
+          "Player"
+        ],
+        "slug": "getcurrentplayer"
+      },
+      {
+        "name": "openPlayGamesApp",
+        "signature": "() => Promise<void>",
+        "parameters": [],
+        "returns": "Promise<void>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.1.0"
+          }
+        ],
+        "docs": "Open the Play Games app, or its store listing when it is not installed.\n\nUseful when `signIn()` cannot succeed because the device has no Google\naccount or the player has no Play Games profile: both are created there.",
+        "complexTypes": [],
+        "slug": "openplaygamesapp"
+      },
+      {
+        "name": "submitScore",
+        "signature": "(options: SubmitScoreOptions) => Promise<void>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "SubmitScoreOptions"
+          }
+        ],
+        "returns": "Promise<void>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.1.0"
+          }
+        ],
+        "docs": "Submit a score to a leaderboard.",
+        "complexTypes": [
+          "SubmitScoreOptions"
+        ],
+        "slug": "submitscore"
+      },
+      {
+        "name": "getLeaderboardStanding",
+        "signature": "(options: LeaderboardStandingOptions) => Promise<LeaderboardStanding>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "LeaderboardStandingOptions"
+          }
+        ],
+        "returns": "Promise<LeaderboardStanding>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.1.0"
+          }
+        ],
+        "docs": "The player's rank and score, and the number of scores in the\nleaderboard, read together for one time span and collection.",
+        "complexTypes": [
+          "LeaderboardStanding",
+          "LeaderboardStandingOptions"
+        ],
+        "slug": "getleaderboardstanding"
+      },
+      {
+        "name": "showLeaderboard",
+        "signature": "(options: LeaderboardOptions) => Promise<void>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "LeaderboardOptions"
+          }
+        ],
+        "returns": "Promise<void>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.1.0"
+          }
+        ],
+        "docs": "Open Google's UI for one leaderboard. Resolves when the UI opens.",
+        "complexTypes": [
+          "LeaderboardOptions"
+        ],
+        "slug": "showleaderboard"
+      },
+      {
+        "name": "showAllLeaderboards",
+        "signature": "() => Promise<void>",
+        "parameters": [],
+        "returns": "Promise<void>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.1.0"
+          }
+        ],
+        "docs": "Open Google's UI listing every leaderboard of the game.",
+        "complexTypes": [],
+        "slug": "showallleaderboards"
+      },
+      {
+        "name": "unlockAchievement",
+        "signature": "(options: AchievementOptions) => Promise<void>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "AchievementOptions"
+          }
+        ],
+        "returns": "Promise<void>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.1.0"
+          }
+        ],
+        "docs": "Unlock an achievement. Queued by the SDK when offline.",
+        "complexTypes": [
+          "AchievementOptions"
+        ],
+        "slug": "unlockachievement"
+      },
+      {
+        "name": "revealAchievement",
+        "signature": "(options: AchievementOptions) => Promise<void>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "AchievementOptions"
+          }
+        ],
+        "returns": "Promise<void>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.1.0"
+          }
+        ],
+        "docs": "Reveal a hidden achievement. Queued by the SDK when offline.",
+        "complexTypes": [
+          "AchievementOptions"
+        ],
+        "slug": "revealachievement"
+      },
+      {
+        "name": "incrementAchievement",
+        "signature": "(options: AchievementStepsOptions) => Promise<void>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "AchievementStepsOptions"
+          }
+        ],
+        "returns": "Promise<void>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.1.0"
+          }
+        ],
+        "docs": "Add steps to an incremental achievement. Queued by the SDK when offline.",
+        "complexTypes": [
+          "AchievementStepsOptions"
+        ],
+        "slug": "incrementachievement"
+      },
+      {
+        "name": "setAchievementSteps",
+        "signature": "(options: AchievementStepsOptions) => Promise<void>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "AchievementStepsOptions"
+          }
+        ],
+        "returns": "Promise<void>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.1.0"
+          }
+        ],
+        "docs": "Set the absolute progress of an incremental achievement. Play ignores a\nvalue lower than the one it already has, which makes this the safe choice\nwhen your own save holds the real counter.",
+        "complexTypes": [
+          "AchievementStepsOptions"
+        ],
+        "slug": "setachievementsteps"
+      },
+      {
+        "name": "showAchievements",
+        "signature": "() => Promise<void>",
+        "parameters": [],
+        "returns": "Promise<void>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.1.0"
+          }
+        ],
+        "docs": "Open Google's achievements UI. Resolves when the UI opens.",
+        "complexTypes": [],
+        "slug": "showachievements"
+      },
+      {
+        "name": "saveGame",
+        "signature": "(options: SaveGameOptions) => Promise<void>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "SaveGameOptions"
+          }
+        ],
+        "returns": "Promise<void>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.1.0"
+          }
+        ],
+        "docs": "Write a saved game to the player's Google account, creating it if needed.\nConflicts between devices are resolved by keeping the most recently\nmodified copy.",
+        "complexTypes": [
+          "SaveGameOptions"
+        ],
+        "slug": "savegame"
+      },
+      {
+        "name": "loadGame",
+        "signature": "(options: LoadGameOptions) => Promise<LoadGameResult>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "LoadGameOptions"
+          }
+        ],
+        "returns": "Promise<LoadGameResult>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.1.0"
+          }
+        ],
+        "docs": "Read a saved game. Resolves with `data: null` when it does not exist and\nrejects when it could not be read.",
+        "complexTypes": [
+          "LoadGameResult",
+          "LoadGameOptions"
+        ],
+        "slug": "loadgame"
+      }
+    ],
+    "properties": []
+  },
+  "interfaces": [
+    {
+      "name": "AuthResult",
+      "slug": "authresult",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "isAuthenticated",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Whether a player is signed in to Play Games Services.",
+          "complexTypes": [],
+          "type": "boolean"
+        },
+        {
+          "name": "errorCode",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Google API status code. Only present when the SDK reported an error.\n\n`10` (DEVELOPER_ERROR) means the app is misconfigured: the SHA-1 of this\nbuild or its package name is missing from the OAuth credentials in the\nPlay Console. `16` and `12501` mean the player cancelled.",
+          "complexTypes": [],
+          "type": "number | undefined"
+        },
+        {
+          "name": "errorMessage",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Error message from the SDK. Only present when the SDK reported an error.",
+          "complexTypes": [],
+          "type": "string | undefined"
+        }
+      ]
+    },
+    {
+      "name": "Player",
+      "slug": "player",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "playerId",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "displayName",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The name the player shows in Play Games.",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "title",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The player's Play Games title, if they have one.",
+          "complexTypes": [],
+          "type": "string | undefined"
+        }
+      ]
+    },
+    {
+      "name": "SubmitScoreOptions",
+      "slug": "submitscoreoptions",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "leaderboardId",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "score",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Raw score, an integer. For time leaderboards it is in milliseconds and for\ncurrency leaderboards in 1/1,000,000ths of the main unit.",
+          "complexTypes": [],
+          "type": "number"
+        },
+        {
+          "name": "immediate",
+          "tags": [
+            {
+              "text": "false",
+              "name": "default"
+            },
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Wait for the server to confirm the score.\n\nWith `false` the SDK queues the score, even offline, and the call resolves\nstraight away. With `true` the call resolves once the server has the score\nand rejects when it cannot be reached; use it when you read the standing\nright after submitting.",
+          "complexTypes": [],
+          "type": "boolean | undefined"
+        }
+      ]
+    },
+    {
+      "name": "LeaderboardStanding",
+      "slug": "leaderboardstanding",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "rank",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The player's rank, or `null` when unknown (for example, no score in this\ntime span).",
+          "complexTypes": [],
+          "type": "number | null"
+        },
+        {
+          "name": "score",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The player's raw score, or `null` when unknown.",
+          "complexTypes": [],
+          "type": "number | null"
+        },
+        {
+          "name": "numScores",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "How many scores the leaderboard has in this time span and collection, or\n`null` when unknown.",
+          "complexTypes": [],
+          "type": "number | null"
+        }
+      ]
+    },
+    {
+      "name": "LeaderboardStandingOptions",
+      "slug": "leaderboardstandingoptions",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "forceReload",
+          "tags": [
+            {
+              "text": "false",
+              "name": "default"
+            },
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Skip the local cache and ask the server. The cached number of scores can\nbe stale, but Google rate-limits forced reloads: keep it for moments when\nfresh data matters.",
+          "complexTypes": [],
+          "type": "boolean | undefined"
+        }
+      ]
+    },
+    {
+      "name": "LeaderboardOptions",
+      "slug": "leaderboardoptions",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "leaderboardId",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "timeSpan",
+          "tags": [
+            {
+              "text": "'allTime'",
+              "name": "default"
+            },
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "",
+          "complexTypes": [
+            "LeaderboardTimeSpan"
+          ],
+          "type": "LeaderboardTimeSpan"
+        },
+        {
+          "name": "collection",
+          "tags": [
+            {
+              "text": "'public'",
+              "name": "default"
+            },
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "",
+          "complexTypes": [
+            "LeaderboardCollection"
+          ],
+          "type": "LeaderboardCollection"
+        }
+      ]
+    },
+    {
+      "name": "AchievementOptions",
+      "slug": "achievementoptions",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "achievementId",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "",
+          "complexTypes": [],
+          "type": "string"
+        }
+      ]
+    },
+    {
+      "name": "AchievementStepsOptions",
+      "slug": "achievementstepsoptions",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "achievementId",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "steps",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "",
+          "complexTypes": [],
+          "type": "number"
+        }
+      ]
+    },
+    {
+      "name": "SaveGameOptions",
+      "slug": "savegameoptions",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "name",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Unique name of the saved game: 1 to 100 characters from `a-z`, `A-Z`,\n`0-9`, `-`, `.`, `_` and `~`.",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "data",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The contents, stored as UTF-8. Play allows up to 3 MB per saved game.",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "description",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Description shown in the Play Games saved games UI.",
+          "complexTypes": [],
+          "type": "string | undefined"
+        }
+      ]
+    },
+    {
+      "name": "LoadGameResult",
+      "slug": "loadgameresult",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "data",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The saved contents, or `null` when no saved game with that name exists.",
+          "complexTypes": [],
+          "type": "string | null"
+        }
+      ]
+    },
+    {
+      "name": "LoadGameOptions",
+      "slug": "loadgameoptions",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "name",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "",
+          "complexTypes": [],
+          "type": "string"
+        }
+      ]
+    }
+  ],
+  "enums": [],
+  "typeAliases": [
+    {
+      "name": "LeaderboardTimeSpan",
+      "slug": "leaderboardtimespan",
+      "docs": "",
+      "types": [
+        {
+          "text": "'daily'",
+          "complexTypes": []
+        },
+        {
+          "text": "'weekly'",
+          "complexTypes": []
+        },
+        {
+          "text": "'allTime'",
+          "complexTypes": []
+        }
+      ]
+    },
+    {
+      "name": "LeaderboardCollection",
+      "slug": "leaderboardcollection",
+      "docs": "",
+      "types": [
+        {
+          "text": "'public'",
+          "complexTypes": []
+        },
+        {
+          "text": "'friends'",
+          "complexTypes": []
+        }
+      ]
+    }
+  ],
+  "pluginConfigs": []
+}