Class MyPlayer

Hierarchy (view full)

Player
- MyPlayer

Index

Constructors

constructor

Accessors

#shouldAddTagToContext _authInfo _isRequredAvatarUpdate _isRequredDataUpdate avatar id isStub name score

Constructors

constructor

new MyPlayer(playerState?, fields, playerAdapter, coreSDk, syncManager, updatePlayerData): MyPlayer
Parameters
- playerState: Partial<PlayerState> = {}
- fields: ModelField[]
- playerAdapter: AbstractPlayerAdapter
- coreSDk: CoreSDK
- syncManager: SyncManager
- updatePlayerData: ((data) => void)
  - - (data): void
    - Parameters
      data: Record<string, string>
      Returns void
Returns MyPlayer
Overrides Player.constructor
- Defined in core/player/MyPlayer.ts:76

Properties

`Private` #clearedGuestsOnAccount

#clearedGuestsOnAccount: Record<string, boolean> = {}

`Private` #fieldsMap

#fieldsMap: Record<string, ModelField> = {}

`Private` #guestContext

#guestContext: string = ''

`Private` #hasCredentialsOnInitContext

#hasCredentialsOnInitContext: boolean = false

`Private` #isAutoSyncEnabled

#isAutoSyncEnabled: Partial<Record<SyncStorage, (() => void)>> = {}

`Private` #lastSyncTime

#lastSyncTime: Partial<Record<SyncStorage, string>> = {}

`Private` #limitsFields

#limitsFields: ModelField[] = []

`Private` #load

#load: ((this) => Promise<void>) = ...

Type declaration

- (this): Promise<void>
- Parameters
  - this: MyPlayer
  Returns Promise<void>

`Private` #secretCode

#secretCode: string = ''

`Private` #sync

#sync: ((this, options?) => Promise<void>) = ...

Type declaration

- (this, options?): Promise<void>
- Parameters
  - this: MyPlayer
  - options: PlayerSyncOptions = {}
  Returns Promise<void>

`Private` #syncManager

#syncManager: SyncManager

`Private` #unsubscribeEverySecond

#unsubscribeEverySecond: (() => void) = ...

Type declaration

- (): void
- Returns void

`Private` #updatePlayerData

#updatePlayerData: ((data) => void)

Type declaration

- (data): void
- Parameters
  - data: Record<string, string>
  Returns void

`Private` _events

_events: EventLite = ...

_firstReqHash

_firstReqHash: string

`Private` _hasFirstSync

_hasFirstSync: boolean = false

_platformData

_platformData: any = {}

_wasReset

_wasReset: boolean = false

`Private` coreSDk

coreSDk: CoreSDK

credentials

credentials: string = ''

fields

fields: ModelField[]

`Private` gp

gp: CoreSDK

hasAnyCredentials

hasAnyCredentials: boolean = false

`Private` isFirstRequest

isFirstRequest: boolean = false

isLoggedIn

isLoggedIn: boolean = false

isLoggedInByPlatform

isLoggedInByPlatform: boolean = false

isPublicFieldsDirty

isPublicFieldsDirty: boolean = false

modifiedAt

modifiedAt: string = ''

`Private` playerAdapter

playerAdapter: AbstractPlayerAdapter

ready

ready: Promise<void>

saveFormat

saveFormat: ProgressSaveFormat = ...

`Private` secretCode

secretCode: string = ''

stats

stats: PlayerStats = ...

`Private` tempSecredCode

tempSecredCode: string = ''

updateTime

updateTime: number

Accessors

`Private` #shouldAddTagToContext

get #shouldAddTagToContext(): boolean
Returns boolean
- Defined in core/player/MyPlayer.ts:72

_authInfo

get _authInfo(): any
Returns any
- Defined in core/player/MyPlayer.ts:130

_isRequredAvatarUpdate

get _isRequredAvatarUpdate(): boolean
Returns boolean
- Defined in core/player/MyPlayer.ts:117

_isRequredDataUpdate

get _isRequredDataUpdate(): boolean
Returns boolean
- Defined in core/player/MyPlayer.ts:114

avatar

get avatar(): string
Returns string
Overrides Player.avatar
- Defined in core/player/MyPlayer.ts:107
set avatar(value): void
Parameters
- value: string
Returns void
Overrides Player.avatar
- Defined in core/player/MyPlayer.ts:110

id

get id(): number
Returns number
Inherited from Player.id
- Defined in core/player/Player.ts:68

isStub

get isStub(): boolean
Returns boolean
Inherited from Player.isStub
- Defined in core/player/Player.ts:93

name

get name(): string
Returns string
Inherited from Player.name
- Defined in core/player/Player.ts:79
set name(value): void
Parameters
- value: string
Returns void
Inherited from Player.name
- Defined in core/player/Player.ts:82

score

get score(): number
Returns number
Inherited from Player.score
- Defined in core/player/Player.ts:72
set score(value): void
Parameters
- value: number
Returns void
Inherited from Player.score
- Defined in core/player/Player.ts:75

Methods

`Private` #checkLoggedIn

#checkLoggedIn(playerState): Promise<void>
Parameters
- playerState: PlayerState
Returns Promise<void>
- Defined in core/player/MyPlayer.ts:834

`Private` #getPlayerState

#getPlayerState(localPlayer, player): PlayerState
Parameters
- localPlayer: PlayerState
- player: PlayerState
Returns PlayerState
- Defined in core/player/MyPlayer.ts:144

`Private` #handleSync

#handleSync(result, progressSaveFormat): Promise<void>
Parameters
- result: PlayerOutput
- progressSaveFormat: ProgressSaveFormat
Returns Promise<void>
- Defined in core/player/MyPlayer.ts:637

`Private` #initContext

#initContext(): Promise<void>
Returns Promise<void>
- Defined in core/player/MyPlayer.ts:190

`Private` #isNeedToKeepGuest

#isNeedToKeepGuest(newCredentials, newId, oldCredentials, oldId): Promise<boolean>
Parameters
- newCredentials: string
- newId: number
- oldCredentials: string
- oldId: number
Returns Promise<boolean>
- Defined in core/player/MyPlayer.ts:885

`Private` #resolvePlayerInfo

#resolvePlayerInfo(silent, isAuthModal): Promise<void>
Parameters
- silent: boolean
- isAuthModal: boolean
Returns Promise<void>
- Defined in core/player/MyPlayer.ts:410

`Private` #setFields

#setFields(fields): void
Parameters
- fields: ModelField[]
Returns void
Inherited from Player.#setFields
- Defined in core/player/Player.ts:338

`Private` #setSecretCode

#setSecretCode(secretCode): void
Parameters
- secretCode: string
Returns void
- Defined in core/player/MyPlayer.ts:859

`Private` #setToken

#setToken(token): void
Parameters
- token: string
Returns void
- Defined in core/player/MyPlayer.ts:877

`Private` #updatePlayerInfo

#updatePlayerInfo(playerInfo, silent): Promise<void>
Parameters
- playerInfo: PlatformPlayerState | {
  name: string;
  photoLarge: string;
  }
- silent: boolean
Returns Promise<void>
- Defined in core/player/MyPlayer.ts:431

`Private` _convert

_convert(key, value): string | number | boolean
Private
Parameters
- key: string
- value: string | number | boolean
Returns string | number | boolean
Inherited from Player._convert
- Defined in core/player/Player.ts:283

_init

_init(transaction): Promise<void>
Parameters
- transaction: Transaction<void>
Returns Promise<void>
- Defined in core/player/MyPlayer.ts:338

_onLogout

_onLogout(success): Promise<void>
Parameters
- success: boolean
Returns Promise<void>
- Defined in core/player/MyPlayer.ts:826

_syncIncrementVariable

_syncIncrementVariable(): void
Returns void
Inherited from Player._syncIncrementVariable
- Defined in core/player/Player.ts:334

add

add(key, value): void
Parameters
- key: string
- value: string | number | boolean
Returns void
Inherited from Player.add
- Defined in core/player/Player.ts:258

disableAutoSync

disableAutoSync(__namedParameters?): void
Parameters
- __namedParameters: {
  storage?: SyncStorage;
  } = {}
  - Optional storage?: SyncStorage
Returns void
- Defined in core/player/MyPlayer.ts:400

enableAutoSync

enableAutoSync(__namedParameters?): void
Parameters
- __namedParameters: {
      interval: number;
      override?: boolean;
      storage?: SyncStorage;
  } = ...
  - interval: number
  - Optional override?: boolean
  - Optional storage?: SyncStorage
Returns void
- Defined in core/player/MyPlayer.ts:367

fetchFields

fetchFields(): Promise<void>
Returns Promise<void>
- Defined in core/player/MyPlayer.ts:353

fromJSON

fromJSON(state): void
Parameters
- state: Partial<PlayerState>
Returns void
Inherited from Player.fromJSON
- Defined in core/player/Player.ts:101

get

get(key): string | number | boolean
Parameters
- key: string
Returns string | number | boolean
Overrides Player.get
- Defined in core/player/MyPlayer.ts:134

getField

getField(key): ModelField
Parameters
- key: string
Returns ModelField
Inherited from Player.getField
- Defined in core/player/Player.ts:158

getFieldName

getFieldName(key): string
Parameters
- key: string
Returns string
Inherited from Player.getFieldName
- Defined in core/player/Player.ts:169

getFieldVariantName

getFieldVariantName(key, value): string
Parameters
- key: string
- value: string | number
Returns string
Inherited from Player.getFieldVariantName
- Defined in core/player/Player.ts:173

getMaxValue

getMaxValue(key): string | number | boolean
Parameters
- key: string
Returns string | number | boolean
Inherited from Player.getMaxValue
- Defined in core/player/Player.ts:186

getMinValue

getMinValue(key): string | number | boolean
Parameters
- key: string
Returns string | number | boolean
Inherited from Player.getMinValue
- Defined in core/player/Player.ts:177

has

has(key): boolean
Parameters
- key: string
Returns boolean
Inherited from Player.has
- Defined in core/player/Player.ts:266

load

load(): Promise<void>
Returns Promise<void>
- Defined in core/player/MyPlayer.ts:601

`Private` loadProgress

loadProgress(tempContexts, context): Promise<void>
Parameters
- tempContexts: string[]
- context: string
Returns Promise<void>
- Defined in core/player/MyPlayer.ts:158

login

login(options?): Promise<boolean>
Parameters
- options: {
  withSecretCode?: boolean;
  } = {}
  - Optional withSecretCode?: boolean
Returns Promise<boolean>
- Defined in core/player/MyPlayer.ts:737

logout

logout(): Promise<void>
Returns Promise<void>
- Defined in core/player/MyPlayer.ts:806

off

off<ET>(type, handler): void
Type Parameters
- ET extends keyof MyPlayerEvents
Parameters
- type: ET
- handler: ((event, ...args) => void)
  - - (event, ...args): void
    - Parameters
      event: MyPlayerEvents[ET]
      Rest ...args: any
      Returns void
Returns void
Inherited from Player.off
- Defined in core/events/EventEmitter.ts:12

on

on<ET>(type, handler): void
Type Parameters
- ET extends keyof MyPlayerEvents
Parameters
- type: ET
- handler: ((event, ...args) => void)
  - - (event, ...args): void
    - Parameters
      event: MyPlayerEvents[ET]
      Rest ...args: any
      Returns void
Returns void
Inherited from Player.on
- Defined in core/events/EventEmitter.ts:9

once

once<ET>(type, handler): void
Type Parameters
- ET extends keyof MyPlayerEvents
Parameters
- type: ET
- handler: ((event, ...args) => void)
  - - (event, ...args): void
    - Parameters
      event: MyPlayerEvents[ET]
      Rest ...args: any
      Returns void
Returns void
Inherited from Player.once
- Defined in core/events/EventEmitter.ts:15

remove

remove(): void
Returns void
Inherited from Player.remove
- Defined in core/player/Player.ts:275

reset

reset(): void
Returns void
Inherited from Player.reset
- Defined in core/player/Player.ts:270

resetCredentials

resetCredentials(): void
Returns void
- Defined in core/player/MyPlayer.ts:865

set

set(key, value): void
Parameters
- key: string
- value: string | number | boolean
Returns void
Inherited from Player.set
- Defined in core/player/Player.ts:199

sync

sync(opts?): Promise<void>
Parameters
- opts: PlayerSyncOptions = {}
Returns Promise<void>
- Defined in core/player/MyPlayer.ts:363

toJSON

toJSON(): PlayerState
Returns PlayerState
Inherited from Player.toJSON
- Defined in core/player/Player.ts:149

toggle

toggle(key): void
Parameters
- key: string
Returns void
Inherited from Player.toggle
- Defined in core/player/Player.ts:262

Class MyPlayer

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Parameters

Returns void

Returns MyPlayer

Properties

Private #clearedGuestsOnAccount

Private #fieldsMap

Private #guestContext

Private #hasCredentialsOnInitContext

Private #isAutoSyncEnabled

Private #lastSyncTime

Private #limitsFields

Private #load

Type declaration

Parameters

Returns Promise<void>

Private #secretCode

Private #sync

Type declaration

Parameters

Returns Promise<void>

Private #syncManager

Private #unsubscribeEverySecond

Type declaration

Returns void

Private #updatePlayerData

Type declaration

Parameters

Returns void

Private _events

_firstReqHash

Private _hasFirstSync

_platformData

_wasReset

Private coreSDk

credentials

fields

Private gp

hasAnyCredentials

Private isFirstRequest

isLoggedIn

isLoggedInByPlatform

isPublicFieldsDirty

modifiedAt

Private playerAdapter

ready

saveFormat

Private secretCode

stats

Private tempSecredCode

updateTime

Accessors

Private #shouldAddTagToContext

Returns boolean

_authInfo

Returns any

_isRequredAvatarUpdate

Returns boolean

_isRequredDataUpdate

Returns boolean

avatar

Returns string

Parameters

Returns void

id

Returns number

isStub

Returns boolean

name

Returns string

Parameters

`Private` #clearedGuestsOnAccount

`Private` #fieldsMap

`Private` #guestContext

`Private` #hasCredentialsOnInitContext

`Private` #isAutoSyncEnabled

`Private` #lastSyncTime

`Private` #limitsFields

`Private` #load

`Private` #secretCode

`Private` #sync

`Private` #syncManager

`Private` #unsubscribeEverySecond

`Private` #updatePlayerData

`Private` _events

`Private` _hasFirstSync

`Private` coreSDk

`Private` gp

`Private` isFirstRequest

`Private` playerAdapter

`Private` secretCode

`Private` tempSecredCode

`Private` #shouldAddTagToContext

`Private` #checkLoggedIn

`Private` #getPlayerState

`Private` #handleSync

`Private` #initContext

`Private` #isNeedToKeepGuest

`Private` #resolvePlayerInfo

`Private` #setFields

`Private` #setSecretCode

`Private` #setToken

`Private` #updatePlayerInfo

`Private` _convert

`Optional` storage?: SyncStorage

`Optional` override?: boolean

`Optional` storage?: SyncStorage