Skip to content

beamable-sdk / services / PlayerService

Class: PlayerService

Defined in: src/services/PlayerService.ts:11

A service for managing player-related data and operations.

Accessors

account

Get Signature

get account(): AccountPlayerView

Defined in: src/services/PlayerService.ts:59

Retrieves the current player's account information.

Returns

AccountPlayerView


announcements

Get Signature

get announcements(): AnnouncementView[]

Defined in: src/services/PlayerService.ts:77

Retrieves the current player's announcements.

Returns

AnnouncementView[]


id

Get Signature

get id(): string

Defined in: src/services/PlayerService.ts:64

Retrieves the current player's ID.

Returns

string


leaderboards

Get Signature

get leaderboards(): Record<string, LeaderBoardView>

Defined in: src/services/PlayerService.ts:90

Retrieves the current player's leaderboards.

Returns

Record<string, LeaderBoardView>


stats

Get Signature

get stats(): Record<string, string>

Defined in: src/services/PlayerService.ts:137

Retrieves the current player's stats.

Returns

Record<string, string>

Methods

hasThirdPartyAssociation()

hasThirdPartyAssociation(provider): boolean

Defined in: src/services/PlayerService.ts:44

Checks if the current player has an association with the given third-party provider.

Parameters

provider

ThirdPartyAuthProvider

Returns

boolean

true if the player has an association with the given third-party provider, false otherwise.

Example

const hasGoogle = beam.player.hasThirdPartyAssociation(ThirdPartyAuthProvider.Google);