Class Socials

Hierarchy (view full)

EventEmitter<SocialsEvents>
- Socials

Constructors

constructor

new Socials(adapter, gp, config): Socials
Parameters
- adapter: default
- gp: CoreSDK
- config: PlayerProjectConfig
Returns Socials
Overrides EventEmitter.constructor
- Defined in core/socials/Socials.ts:15

Properties

`Private` _events

_events: EventLite = ...

`Private` adapter

adapter: default

`Private` config

config: PlayerProjectConfig

`Private` gp

Accessors

`Private` #communityLinkByLang

get #communityLinkByLang(): string
Returns string
- Defined in core/socials/Socials.ts:83

`Private` #communityLinkOnlyPlatformByLang

get #communityLinkOnlyPlatformByLang(): string
Returns string
- Defined in core/socials/Socials.ts:75

canJoinCommunity

get canJoinCommunity(): boolean
Check to platform can invite player in community or group

Returns boolean
- Defined in core/socials/Socials.ts:64

communityLink

get communityLink(): string
Generated community or group link

Returns string
- Defined in core/socials/Socials.ts:71

isSupportShareParams

get isSupportShareParams(): boolean
Check to platform supports share params

Returns boolean
- Defined in core/socials/Socials.ts:50

isSupportsNativeCommunityJoin

get isSupportsNativeCommunityJoin(): boolean
Check to platform supports native invites in community or group

Returns boolean
- Defined in core/socials/Socials.ts:57

isSupportsNativeInvite

get isSupportsNativeInvite(): boolean
Check to platform supports native invite friends methods

Returns boolean
- Defined in core/socials/Socials.ts:43

isSupportsNativePosts

get isSupportsNativePosts(): boolean
Check to platform supports native post in player's feed methods

Returns boolean
- Defined in core/socials/Socials.ts:36

isSupportsNativeShare

get isSupportsNativeShare(): boolean
Check to platform supports native share

Returns boolean
- Defined in core/socials/Socials.ts:29

isSupportsShare

get isSupportsShare(): boolean
Check to platform supports share

Returns boolean
- Defined in core/socials/Socials.ts:22

shareParams

get shareParams(): Record<string, string | number | boolean>
Returns Record<string, string | number | boolean>
- Defined in core/socials/Socials.ts:92

Methods

`Private` _getShareOptions

_getShareOptions(options): Promise<ShareOptions>
Parameters
- options: ShareOptions
Returns Promise<ShareOptions>
- Defined in core/socials/Socials.ts:96

`Private` _shareByOverlay

_shareByOverlay(type, options): Promise<any>
Parameters
- type: ShareType
- options: ShareOptions
Returns Promise<any>
- Defined in core/socials/Socials.ts:105

addShareParamsToUrl

addShareParamsToUrl(url, params?): string
Parameters
- url: string
- params: Record<string, string | number | boolean> = {}
Returns string
- Defined in core/socials/Socials.ts:194

getShareParam

getShareParam(key): string | number | boolean
Parameters
- key: string
Returns string | number | boolean
- Defined in core/socials/Socials.ts:209

invite

invite(options?): Promise<any>
Parameters
- options: Pick<ShareOptions, "text"> = {}
Returns Promise<any>
- Defined in core/socials/Socials.ts:163

joinCommunity

joinCommunity(): Promise<boolean>
Returns Promise<boolean>
- Defined in core/socials/Socials.ts:177

makeShareUrl

makeShareUrl(params?): string | false
Parameters
- params: Record<string, string | number | boolean> = {}
Returns string | false
- Defined in core/socials/Socials.ts:198

off

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

post

post(options?): Promise<any>
Parameters
- options: ShareOptions = {}
Returns Promise<any>
- Defined in core/socials/Socials.ts:149

share

share(options?): Promise<any>
Parameters
- options: ShareOptions = {}
Returns Promise<any>
- Defined in core/socials/Socials.ts:134