Skip to main content

openGameCenterLeaderboard

Opens the Toss Game Center leaderboard web view so the user can view rankings. Does nothing and returns undefined when the Toss app version is below the minimum supported version (5.221.0).

Signature​

import { openGameCenterLeaderboard } from '@apps-in-toss/web-framework';

declare function openGameCenterLeaderboard(): Promise<void>;

Parameters​

None.

Returns​

  • Promise<void> — Resolves after the leaderboard web view is opened.
  • Returns undefined without doing anything when the app version is below 5.221.0.

Permission​

No permission required. Account binding is handled by the Toss session.

Examples​

Minimal​

import { openGameCenterLeaderboard } from '@apps-in-toss/web-framework';

await openGameCenterLeaderboard();

Realistic — version gate before opening​

import { isMinVersionSupported, openGameCenterLeaderboard } from '@apps-in-toss/web-framework';

async function handleLeaderboardOpen() {
  if (!isMinVersionSupported('5.221.0')) {
    // Show an update prompt to the user.
    console.warn('Toss app 5.221.0 or later is required.');
    return;
  }
  await openGameCenterLeaderboard();
}

Realistic — open leaderboard after score submission​

import {
  submitGameCenterLeaderBoardScore,
  openGameCenterLeaderboard,
} from '@apps-in-toss/web-framework';

async function submitAndViewLeaderboard(score: string) {
  const result = await submitGameCenterLeaderBoardScore({ score });

  if (result?.statusCode === 'SUCCESS') {
    await openGameCenterLeaderboard();
  } else {
    console.error('Score submission failed:', result?.statusCode);
  }
}

Try it live​

Run the openGameCenterLeaderboard card on the Game page in sdk-example.

Open in sdk-example

External references​