Class Socials

Hierarchy

EventEmitter<SocialsEvents>
- Socials

Constructors

constructor

new Socials(adapter: default, gp: GamePush, config: PlayerProjectConfig): Socials

Overrides EventEmitter.constructor
- Defined in core/socials/Socials.ts:15
Parameters
- adapter: default
- gp: GamePush
- config: PlayerProjectConfig
Returns Socials

Properties

Private _events

_events: EventLite = ...

Accessors

Private #communityLinkByLang

get #communityLinkByLang(): string

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

Private #communityLinkOnlyPlatformByLang

get #communityLinkOnlyPlatformByLang(): string

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

canJoinCommunity

get canJoinCommunity(): boolean

- Defined in core/socials/Socials.ts:64
Check to platform can invite player in community or group

Returns boolean

communityLink

get communityLink(): string

- Defined in core/socials/Socials.ts:71
Generated community or group link

Returns string

isSupportShareParams

get isSupportShareParams(): boolean

- Defined in core/socials/Socials.ts:50
Check to platform supports share params

Returns boolean

isSupportsNativeCommunityJoin

get isSupportsNativeCommunityJoin(): boolean

- Defined in core/socials/Socials.ts:57
Check to platform supports native invites in community or group

Returns boolean

isSupportsNativeInvite

get isSupportsNativeInvite(): boolean

- Defined in core/socials/Socials.ts:43
Check to platform supports native invite friends methods

Returns boolean

isSupportsNativePosts

get isSupportsNativePosts(): boolean

- Defined in core/socials/Socials.ts:36
Check to platform supports native post in player's feed methods

Returns boolean

isSupportsNativeShare

get isSupportsNativeShare(): boolean

- Defined in core/socials/Socials.ts:29
Check to platform supports native share

Returns boolean

isSupportsShare

get isSupportsShare(): boolean

- Defined in core/socials/Socials.ts:22
Check to platform supports share

Returns boolean

shareParams

get shareParams(): Record<string, string | number | boolean>

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

Methods

Private _getShareOptions

_getShareOptions(options: ShareOptions): Promise<ShareOptions>

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

Private _shareByOverlay

_shareByOverlay(type: ShareType, options: ShareOptions): Promise<any>

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

addShareParamsToUrl

addShareParamsToUrl(url: string, params?: Record<string, string | number | boolean>): string

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

getShareParam

getShareParam(key: string): string | number | boolean

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

invite

invite(options?: Pick<ShareOptions, "text">): Promise<any>

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

joinCommunity

joinCommunity(): Promise<boolean>

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

makeShareUrl

makeShareUrl(params?: Record<string, string | number | boolean>): string | false

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

off

off<ET>(type: ET, handler: ((event: SocialsEvents[ET]) => void)): void

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

on

on<ET>(type: ET, handler: ((event: SocialsEvents[ET]) => void)): void

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

once

once<ET>(type: ET, handler: ((event: SocialsEvents[ET]) => void)): void

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

post

post(options?: ShareOptions): Promise<any>

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

share

share(options?: ShareOptions): Promise<any>

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

Generated using TypeDoc