Class CoreSDK

Hierarchy (view full)

EventEmitter<CoreEvents>
- CoreSDK

Constructors

constructor

new CoreSDK(__namedParameters?, bootConfig): CoreSDK
Parameters
- __namedParameters: {
      onReady?: ((sdk) => void);
      projectId?: number;
      publicToken?: string;
  } = {}
  - Optional onReady?: ((sdk) => void)
    - (sdk): void
      Parameters
      sdk: CoreSDK
      Returns void
  - Optional projectId?: number
  - Optional publicToken?: string
- bootConfig: BootConfig
Returns CoreSDK
Overrides EventEmitter.constructor
- Defined in CoreSDK.ts:311

Properties

`Private` #apiClient

#apiClient: default

`Private` #debugConfig

#debugConfig: DebugConfig

`Private` #projectConfig

#projectConfig: PlayerProjectConfig

`Private` #serverTime

#serverTime: number

`Private` _events

_events: EventLite = ...

`Private` _params

_params: URLSearchParams

_pointersManager

_pointersManager: PointersManager

`Private` _services

_services: Omit<Services, "apiClient" | "setupAnalytics">

`Private` _storage

_storage: Storage

achievements

achievements: Achievements

Achievements manager

ads: Ads

Ads manager

analytics

analytics: Analytics

Analytics manager

app

app: default

App manager

avatarGenerator

avatarGenerator: string

Current selected avatar generator

avatarGeneratorTemplate

avatarGeneratorTemplate: string

Current selected avatar generator template URL

channels

channels: default

Channels manager

device

device: default

Provides info about user's device

devtools

devtools: {
    addShortcut(): Promise<boolean>;
    changeLanguage(language): Promise<void>;
    closeSticky(): void;
    purchaseProduct(product): Promise<boolean>;
    requestReview(): Promise<RequestReviewResult>;
    resumeSubscription(product, purchase): Promise<boolean>;
    showCounter(apiReqCounter): void;
    showFullscreen(): Promise<boolean>;
    showPreloader(): Promise<boolean>;
    showRewardedVideo(): Promise<boolean>;
    showSticky(): Promise<boolean>;
    showToast(__namedParameters): void;
    unsubscribe(product, purchase): Promise<boolean>;
}

Devtools manager, only in dev

Type declaration

addShortcut:function
- addShortcut(): Promise<boolean>
- Returns Promise<boolean>
  - Defined in devtools/createDevtools.ts:53
changeLanguage:function
- changeLanguage(language): Promise<void>
- Parameters
  - language: Lang
  Returns Promise<void>
  - Defined in devtools/createDevtools.ts:126
closeSticky:function
- closeSticky(): void
- Returns void
  - Defined in devtools/createDevtools.ts:99
purchaseProduct:function
- purchaseProduct(product): Promise<boolean>
- Parameters
  - product: Product
  Returns Promise<boolean>
  - Defined in devtools/createDevtools.ts:102
requestReview:function
- requestReview(): Promise<RequestReviewResult>
- Returns Promise<RequestReviewResult>
  - Defined in devtools/createDevtools.ts:61
resumeSubscription:function
- resumeSubscription(product, purchase): Promise<boolean>
- Parameters
  - product: Product
  - purchase: PlayerPurchase
  Returns Promise<boolean>
  - Defined in devtools/createDevtools.ts:110
showCounter:function
- showCounter(apiReqCounter): void
- Parameters
  - apiReqCounter: number
  Returns void
  - Defined in devtools/createDevtools.ts:135
showFullscreen:function
- showFullscreen(): Promise<boolean>
- Returns Promise<boolean>
  - Defined in devtools/createDevtools.ts:29
showPreloader:function
- showPreloader(): Promise<boolean>
- Returns Promise<boolean>
  - Defined in devtools/createDevtools.ts:45
showRewardedVideo:function
- showRewardedVideo(): Promise<boolean>
- Returns Promise<boolean>
  - Defined in devtools/createDevtools.ts:37
showSticky:function
- showSticky(): Promise<boolean>
- Returns Promise<boolean>
  - Defined in devtools/createDevtools.ts:88
showToast:function
- showToast(__namedParameters): void
- Parameters
  - __namedParameters: Toast
  Returns void
  - Defined in devtools/createDevtools.ts:69
unsubscribe:function
- unsubscribe(product, purchase): Promise<boolean>
- Parameters
  - product: Product
  - purchase: PlayerPurchase
  Returns Promise<boolean>
  - Defined in devtools/createDevtools.ts:118

documents

documents: Documents

Documents manager

events

events: Events

Events manager

experiments

experiments: Experiments

AB experiments manager

files

files: Files

Images manager

fullscreen

fullscreen: Fullscreen

Fullscreen manager

gamesCollections

gamesCollections: GamesCollections

Games Collections manager

images

images: Images

Images manager

isGameStarted

isGameStarted: boolean = false

Check is game started (load is finished)

isGameplay

isGameplay: boolean = false

Check is in gameplay

isMobile

isMobile: boolean

Is on mobile device

isPaused

isPaused: boolean = false

Check game paused

language

language: Lang

Current selected language

leaderboard

leaderboard: Leaderboard

Leaderboard manager

loader

loader: {
dec(): void;
inc(): void;
}

Global loader manager

Type declaration

dec:function
- dec(): void
- Returns void
  - Defined in components/Loader/createLoader.ts:25
inc:function
- inc(): void
- Returns void
  - Defined in components/Loader/createLoader.ts:20

logger

logger: Logger = logger

Logger

name

name: string = ''

onReady

onReady: ((sdk) => void)

Type declaration

- (sdk): void
- Parameters
  - sdk: CoreSDK
  Returns void

overlay

overlay: {
    changeAvatarGenerator(avatarGenerator): void;
    changeLanguage(lang): Promise<void>;
    close(): Promise<void>;
    closeOrientationOverlay(): void;
    closePreAdCountdownOverlay(): void;
    closePreAdCountdownOverlayFinish(): void;
    closeRewardedFailedOverlay(): void;
    login(options?): Promise<{
        secretCode?: string;
        type: string;
    }>;
    openAchievements(achievementsInfo, __namedParameters?): Promise<void>;
    openChat(channel, channelMessages, personalChannelData?): Promise<void>;
    openDocument(document): Promise<void>;
    openGamesCollections(gamesCollection): Promise<void>;
    openLeaderboard(query, leaderbordInfo): Promise<void>;
    openProductPurchase(product): Promise<void>;
    pickPlayerOnConflict(conflictInfo): Promise<PlayerState>;
    setSizeOffsets(sizeOffsets): void;
    setUnsupportedDeviceOverlay(__namedParameters): void;
    share(shareType, options): Promise<boolean>;
    showIframe(__namedParameters): Promise<any>;
    showOrientationOverlay(orientationRequired): void;
    showPreAdCountdownOverlay(): void;
    showPreAdCountdownOverlayFinish(wasInFullscreen): Promise<any>;
    showRewardedFailedOverlay(): Promise<any>;
    unlockAchievement(achievement): void;
}

Overlay manager

Type declaration

changeAvatarGenerator:function
- changeAvatarGenerator(avatarGenerator): void
- Parameters
  - avatarGenerator: string
  Returns void
  - Defined in app/createOverlay.ts:57
changeLanguage:function
- changeLanguage(lang): Promise<void>
- Parameters
  - lang: Lang
  Returns Promise<void>
  - Defined in app/createOverlay.ts:53
close:function
- close(): Promise<void>
- Returns Promise<void>
  - Defined in app/createOverlay.ts:165
closeOrientationOverlay:function
- closeOrientationOverlay(): void
- Returns void
  - Defined in app/createOverlay.ts:210
closePreAdCountdownOverlay:function
- closePreAdCountdownOverlay(): void
- Returns void
  - Defined in app/createOverlay.ts:218
closePreAdCountdownOverlayFinish:function
- closePreAdCountdownOverlayFinish(): void
- Returns void
  - Defined in app/createOverlay.ts:227
closeRewardedFailedOverlay:function
- closeRewardedFailedOverlay(): void
- Returns void
  - Defined in app/createOverlay.ts:237
login:function
- login(options?): Promise<{
  secretCode?: string;
  type: string;
  }>
- Parameters
  - options: {
    withSecretCode?: boolean;
    } = {}
    - Optional withSecretCode?: boolean
  Returns Promise<{
  secretCode?: string;
  type: string;
  }>
  - Defined in app/createOverlay.ts:40
openAchievements:function
- openAchievements(achievementsInfo, __namedParameters?): Promise<void>
- Parameters
  - achievementsInfo: FetchPlayerAchievementsOutput
  - __namedParameters: {
    scrollTo?: string | number;
    } = {}
    - Optional scrollTo?: string | number
  Returns Promise<void>
  - Defined in app/createOverlay.ts:74
openChat:function
- openChat(channel, channelMessages, personalChannelData?): Promise<void>
- Parameters
  - channel: Channel
  - channelMessages: FetchOutput<ChannelMessage>
  - Optional personalChannelData: PersonalChannelData
  Returns Promise<void>
  - Defined in app/createOverlay.ts:91
openDocument:function
- openDocument(document): Promise<void>
- Parameters
  - document: Document
  Returns Promise<void>
  - Defined in app/createOverlay.ts:113
openGamesCollections:function
- openGamesCollections(gamesCollection): Promise<void>
- Parameters
  - gamesCollection: GamesCollection
  Returns Promise<void>
  - Defined in app/createOverlay.ts:151
openLeaderboard:function
- openLeaderboard(query, leaderbordInfo): Promise<void>
- Parameters
  - query: GetLeaderboardQuery
  - leaderbordInfo: RatingData
  Returns Promise<void>
  - Defined in app/createOverlay.ts:60
openProductPurchase:function
- openProductPurchase(product): Promise<void>
- Parameters
  - product: Product
  Returns Promise<void>
  - Defined in app/createOverlay.ts:128
pickPlayerOnConflict:function
- pickPlayerOnConflict(conflictInfo): Promise<PlayerState>
- Parameters
  - conflictInfo: Omit<PlayerSyncConflict, "__typename">
  Returns Promise<PlayerState>
  - Defined in app/createOverlay.ts:27
setSizeOffsets:function
- setSizeOffsets(sizeOffsets): void
- Parameters
  - sizeOffsets: {
    bottom: number;
    top: number;
    }
    - bottom: number
    - top: number
  Returns void
  - Defined in app/createOverlay.ts:247
setUnsupportedDeviceOverlay:function
- setUnsupportedDeviceOverlay(__namedParameters): void
- Parameters
  - __namedParameters: {
    allowed: TargetOs[];
    detected: TargetOs;
    }
    - allowed: TargetOs[]
    - detected: TargetOs
  Returns void
  - Defined in app/createOverlay.ts:202
share:function
- share(shareType, options): Promise<boolean>
- Parameters
  - shareType: ShareType
  - options: ShareOptions
  Returns Promise<boolean>
  - Defined in app/createOverlay.ts:181
showIframe:function
- showIframe(__namedParameters): Promise<any>
- Parameters
  - __namedParameters: Omit<{
    src: string;
    title: string;
    }, "transaction">
  Returns Promise<any>
  - Defined in app/createOverlay.ts:241
showOrientationOverlay:function
- showOrientationOverlay(orientationRequired): void
- Parameters
  - orientationRequired: GameOrientation
  Returns void
  - Defined in app/createOverlay.ts:195
showPreAdCountdownOverlay:function
- showPreAdCountdownOverlay(): void
- Returns void
  - Defined in app/createOverlay.ts:215
showPreAdCountdownOverlayFinish:function
- showPreAdCountdownOverlayFinish(wasInFullscreen): Promise<any>
- Parameters
  - wasInFullscreen: boolean
  Returns Promise<any>
  - Defined in app/createOverlay.ts:221
showRewardedFailedOverlay:function
- showRewardedFailedOverlay(): Promise<any>
- Returns Promise<any>
  - Defined in app/createOverlay.ts:231
unlockAchievement:function
- unlockAchievement(achievement): void
- Parameters
  - achievement: Achievement
  Returns void
  - Defined in app/createOverlay.ts:143

payments

payments: Payments

Payments manager

platform

platform: Platform

Platform info

player

player: MyPlayer

Player manager

players

players: Players

Players manager

projectId

projectId: number

publicToken

publicToken: string

ready

ready: Promise<CoreSDK>

Resolves when all platform and project data was loaded

platform SDK loaded

rewards

rewards: Rewards

Rewards manager

schedulers

schedulers: Schedulers

Schedulers manager

segments

segments: Segments

Segments manager

setBackground

setBackground: ((__namedParameters) => void) = setBackground

Type declaration

- (__namedParameters): void
- Parameters
  - __namedParameters: Partial<BackgroundSettings>
  Returns void

socials

socials: Socials

Socials manager

storage

storage: default

Storage manager

triggers

triggers: Triggers

Triggers manager

uniques

uniques: default

Unique values manager

variables

variables: GameVariables

Game variables manager

Accessors

_overlaySizeOffsets

get _overlaySizeOffsets(): {
bottom: number;
top: number;
}
Returns {
bottom: number;
top: number;
}
- bottom: number
- top: number
- Defined in CoreSDK.ts:662

isAllowedOrigin

get isAllowedOrigin(): boolean
Is on development origin

Returns boolean
- Defined in CoreSDK.ts:600

isDev

get isDev(): boolean
Is on development origin

Returns boolean
- Defined in CoreSDK.ts:593

isPortrait

get isPortrait(): boolean
Returns boolean
- Defined in CoreSDK.ts:611

locale

get locale(): string
Language locale

Returns string
- Defined in CoreSDK.ts:607

nativeSDK

get nativeSDK(): any
SDK provided by the platform

Returns any
- Defined in CoreSDK.ts:579

serverTime

get serverTime(): string
Server time in ISO 8601 format

Returns string
- Defined in CoreSDK.ts:586

Methods

`Private` #checkDeviceCompatibility

#checkDeviceCompatibility(): Promise<void>
Returns Promise<void>
- Defined in CoreSDK.ts:763

`Private` #initOrientation

#initOrientation(): void
Returns void
- Defined in CoreSDK.ts:735

`Private` #setup

#setup(bootConfig): Promise<void>
Parameters
- bootConfig: BootConfig
Returns Promise<void>
- Defined in CoreSDK.ts:327

changeAvatarGenerator

changeAvatarGenerator(): Promise<void>
Returns Promise<void>
- Defined in CoreSDK.ts:689

changeLanguage

changeLanguage(lang): Promise<void>
Parameters
- lang: Lang
Returns Promise<void>
- Defined in CoreSDK.ts:669

gameStart

gameStart(): Promise<void>
Returns Promise<void>
- Defined in CoreSDK.ts:711

gameplayStart

gameplayStart(): Promise<void>
Returns Promise<void>
- Defined in CoreSDK.ts:719

gameplayStop

gameplayStop(): Promise<void>
Returns Promise<void>
- Defined in CoreSDK.ts:727

generateAvatar

generateAvatar(hash, size): string
Parameters
- hash: any
- size: number
Returns string
- Defined in CoreSDK.ts:693

`Private` init

init(transaction): Promise<void>
Private
Parameters
- transaction: Transaction<CoreSDK>
Returns Promise<void>
- Defined in CoreSDK.ts:618

loadOverlay

loadOverlay(): Promise<void>
You can preload overlay to fast open when required

Returns Promise<void>
- Defined in CoreSDK.ts:651

off

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

on

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

once

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

pause

pause(): void
Returns void
- Defined in CoreSDK.ts:697

resume

resume(): void
Returns void
- Defined in CoreSDK.ts:704

Class CoreSDK

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Optional onReady?: ((sdk) => void)

Parameters

Returns void

Optional projectId?: number

Optional publicToken?: string

Returns CoreSDK

Properties

Private #apiClient

Private #debugConfig

Private #projectConfig

Private #serverTime

Private _events

Private _params

_pointersManager

Private _services

Private _storage

achievements

ads

analytics

app

avatarGenerator

avatarGeneratorTemplate

channels

device

devtools

Type declaration

addShortcut:function

Returns Promise<boolean>

changeLanguage:function

Parameters

Returns Promise<void>

closeSticky:function

Returns void

purchaseProduct:function

Parameters

Returns Promise<boolean>

requestReview:function

Returns Promise<RequestReviewResult>

resumeSubscription:function

Parameters

Returns Promise<boolean>

showCounter:function

Parameters

Returns void

showFullscreen:function

Returns Promise<boolean>

showPreloader:function

Returns Promise<boolean>

showRewardedVideo:function

Returns Promise<boolean>

showSticky:function

Returns Promise<boolean>

showToast:function

Parameters

Returns void

unsubscribe:function

Parameters

Returns Promise<boolean>

documents

events

experiments

files

fullscreen

gamesCollections

images

isGameStarted

isGameplay

isMobile

isPaused

language

`Optional` onReady?: ((sdk) => void)

`Optional` projectId?: number

`Optional` publicToken?: string

`Private` #apiClient

`Private` #debugConfig

`Private` #projectConfig

`Private` #serverTime

`Private` _events

`Private` _params

`Private` _services

`Private` _storage

`Optional` withSecretCode?: boolean

Returns Promise<{
secretCode?: string;
type: string;
}>

`Optional` scrollTo?: string | number