Class Ads

Hierarchy (view full)

EventEmitter<AdsEvents>
- Ads

Constructors

constructor

new Ads(gp, adapter, config): Ads
Parameters
- gp: CoreSDK
- adapter: default
- config: PlayerProjectConfig
Returns Ads
Overrides EventEmitter.constructor
- Defined in core/ads/Ads.ts:58

Properties

`Private` _events

_events: EventLite = ...

`Private` adapter

adapter: default

adsInfo

adsInfo: PlayerAdsInfo

banners

banners: Record<BannerType, Banner>

`Private` `Readonly` config

config: PlayerProjectConfig

fullscreenBanner

fullscreenBanner: Banner

`Private` fullscreenDisplayIntervalId

fullscreenDisplayIntervalId: number = 0

`Private` gp

gp: CoreSDK

isAdblockEnabled

isAdblockEnabled: boolean = false

isFullscreenPlaying

isFullscreenPlaying: boolean = false

isPreloaderPlaying

isPreloaderPlaying: boolean = false

isRewardedPlaying

isRewardedPlaying: boolean = false

isStickyPlaying

isStickyPlaying: boolean = false

preloaderBanner

preloaderBanner: Banner

rewardedVideo

rewardedVideo: Banner

stickyBanner

stickyBanner: Banner

`Private` stickyRefreshIntervalId

stickyRefreshIntervalId: number = 0

Accessors

_stickyBannerOffsets

get _stickyBannerOffsets(): {
bottom: number;
top: number;
}
Returns {
bottom: number;
top: number;
}
- bottom: number
- top: number
- Defined in core/ads/Ads.ts:401

canShowFullscreenBeforeGamePlay

get canShowFullscreenBeforeGamePlay(): boolean
Returns boolean
- Defined in core/ads/Ads.ts:140

isAllowedToResumeGameplay

get isAllowedToResumeGameplay(): boolean
Returns boolean
- Defined in core/ads/Ads.ts:87

isCountdownOverlayEnabled

get isCountdownOverlayEnabled(): boolean
Returns boolean
- Defined in core/ads/Ads.ts:133

isFullscreenAvailable

get isFullscreenAvailable(): boolean
Returns boolean
- Defined in core/ads/Ads.ts:99

isPreloaderAvailable

get isPreloaderAvailable(): boolean
Returns boolean
- Defined in core/ads/Ads.ts:122

isRewardedAvailable

get isRewardedAvailable(): boolean
Returns boolean
- Defined in core/ads/Ads.ts:111

isRewardedFailedOverlayEnabled

get isRewardedFailedOverlayEnabled(): boolean
Returns boolean
- Defined in core/ads/Ads.ts:136

isStickyAvailable

get isStickyAvailable(): boolean
Returns boolean
- Defined in core/ads/Ads.ts:91

needToLeaveFullscreenBeforeAds

get needToLeaveFullscreenBeforeAds(): boolean
Returns boolean
- Defined in core/ads/Ads.ts:83

Methods

_checkLimitsExpired

_checkLimitsExpired(isInit): void
Parameters
- isInit: boolean
Returns void
- Defined in core/ads/Ads.ts:427

_saveAdsInfo

_saveAdsInfo(): void
Returns void
- Defined in core/ads/Ads.ts:453

_trackBannerDisplay

_trackBannerDisplay(bannerType): void
Parameters
- bannerType: BannerType
Returns void
- Defined in core/ads/Ads.ts:411

checkAdblock

checkAdblock(): Promise<boolean>
Returns Promise<boolean>
- Defined in core/ads/Ads.ts:144

closeSticky

closeSticky(): Promise<void>
Returns Promise<void>
- Defined in core/ads/Ads.ts:389

isBannerLimitReached

isBannerLimitReached(bannerType): boolean
Parameters
- bannerType: BannerType
Returns boolean
- Defined in core/ads/Ads.ts:457

isBannerLimitTypeReached

isBannerLimitTypeReached(bannerType, type): boolean
Parameters
- bannerType: BannerType
- type: keyof BannerLimits
Returns boolean
- Defined in core/ads/Ads.ts:465

off

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

refreshSticky

refreshSticky(): Promise<boolean>
Returns Promise<boolean>
- Defined in core/ads/Ads.ts:355

sendShowAdsInfo

sendShowAdsInfo(data): void
Parameters
- data: ShowAdsInfo
Returns void
- Defined in core/ads/Ads.ts:150

showFullscreen

showFullscreen(__namedParameters?): Promise<boolean>
Parameters
- __namedParameters: {
  showCountdownOverlay?: boolean;
  } = {}
  - Optional showCountdownOverlay?: boolean
Returns Promise<boolean>
- Defined in core/ads/Ads.ts:167

showPreloader

showPreloader(): Promise<boolean>
Returns Promise<boolean>
- Defined in core/ads/Ads.ts:280

showRewardedVideo

showRewardedVideo(__namedParameters?): Promise<boolean>
Parameters
- __namedParameters: {
  showRewardedFailedOverlay?: boolean;
  } = {}
  - Optional showRewardedFailedOverlay?: boolean
Returns Promise<boolean>
- Defined in core/ads/Ads.ts:230

showSticky

showSticky(): Promise<boolean>
Returns Promise<boolean>
- Defined in core/ads/Ads.ts:321

Class Ads

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns Ads

Properties

Private _events

Private adapter

adsInfo

banners

Private Readonly config

fullscreenBanner

Private fullscreenDisplayIntervalId

Private gp

isAdblockEnabled

isFullscreenPlaying

isPreloaderPlaying

isRewardedPlaying

isStickyPlaying

preloaderBanner

rewardedVideo

stickyBanner

Private stickyRefreshIntervalId

Accessors

_stickyBannerOffsets

Returns { bottom: number; top: number; }

bottom: number

top: number

canShowFullscreenBeforeGamePlay

Returns boolean

isAllowedToResumeGameplay

Returns boolean

isCountdownOverlayEnabled

Returns boolean

isFullscreenAvailable

Returns boolean

isPreloaderAvailable

Returns boolean

isRewardedAvailable

Returns boolean

isRewardedFailedOverlayEnabled

Returns boolean

isStickyAvailable

Returns boolean

needToLeaveFullscreenBeforeAds

Returns boolean

Methods

_checkLimitsExpired

Parameters

Returns void

_saveAdsInfo

Returns void

_trackBannerDisplay

Parameters

Returns void

checkAdblock

Returns Promise<boolean>

closeSticky

Returns Promise<void>

isBannerLimitReached

Parameters

Returns boolean

isBannerLimitTypeReached

Parameters

Returns boolean

off

Type Parameters

Parameters

Parameters

Returns void

Returns void

on

Type Parameters

Parameters

`Private` _events

`Private` adapter

`Private` `Readonly` config

`Private` fullscreenDisplayIntervalId

`Private` gp

`Private` stickyRefreshIntervalId

Returns {
bottom: number;
top: number;
}

`Optional` showCountdownOverlay?: boolean

`Optional` showRewardedFailedOverlay?: boolean