Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SC2

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

account

account: (args: AccountOptions, headers?: Headers) => ResourceResponse<any> = ...

Type declaration

    • (args: AccountOptions, headers?: Headers): ResourceResponse<any>

    • Parameters

      • args: AccountOptions
      • Optional headers: Headers

      Returns ResourceResponse<any>

axios

axios: AxiosInstance = ...

defaults

defaults: { key: string; locale: Locales; origin: Origins; secret: string; token?: string }

Type declaration

  • key: string
  • locale: Locales
  • origin: Origins
  • secret: string
  • Optional token?: string

ladder

ladder: (args: LadderOptions, headers?: Headers) => ResourceResponse<any> = ...

Type declaration

    • (args: LadderOptions, headers?: Headers): ResourceResponse<any>

    • Parameters

      • args: LadderOptions
      • Optional headers: Headers

      Returns ResourceResponse<any>

league

league: (args: LeagueOptions, headers?: Headers) => ResourceResponse<any> = ...

Type declaration

    • (args: LeagueOptions, headers?: Headers): ResourceResponse<any>

    • Parameters

      • args: LeagueOptions
      • Optional headers: Headers

      Returns ResourceResponse<any>

legacyAchievements

legacyAchievements: (args: LegacyAchievementsOptions, headers?: Headers) => ResourceResponse<any> = ...

Type declaration

    • (args: LegacyAchievementsOptions, headers?: Headers): ResourceResponse<any>

    • Parameters

      • args: LegacyAchievementsOptions
      • Optional headers: Headers

      Returns ResourceResponse<any>

legacyLadder

legacyLadder: (args: LegacyLadderOptions, headers?: Headers) => ResourceResponse<any> = ...

Type declaration

    • (args: LegacyLadderOptions, headers?: Headers): ResourceResponse<any>

    • Parameters

      • args: LegacyLadderOptions
      • Optional headers: Headers

      Returns ResourceResponse<any>

legacyProfile

legacyProfile: (args: LegacyProfileOptions, headers?: Headers) => ResourceResponse<any> = ...

Type declaration

    • (args: LegacyProfileOptions, headers?: Headers): ResourceResponse<any>

    • Parameters

      • args: LegacyProfileOptions
      • Optional headers: Headers

      Returns ResourceResponse<any>

legacyRewards

legacyRewards: (args: LegacyRewardsOptions, headers?: Headers) => ResourceResponse<any> = ...

Type declaration

    • (args: LegacyRewardsOptions, headers?: Headers): ResourceResponse<any>

    • Parameters

      • args: LegacyRewardsOptions
      • Optional headers: Headers

      Returns ResourceResponse<any>

metadata

metadata: (args: MetaDataOptions, headers?: Headers) => ResourceResponse<any> = ...

Type declaration

    • (args: MetaDataOptions, headers?: Headers): ResourceResponse<any>

    • Parameters

      • args: MetaDataOptions
      • Optional headers: Headers

      Returns ResourceResponse<any>

profile

profile: (args: ProfileOptions, headers?: Headers) => ResourceResponse<any> = ...

Type declaration

    • (args: ProfileOptions, headers?: Headers): ResourceResponse<any>

    • Parameters

      • args: ProfileOptions
      • Optional headers: Headers

      Returns ResourceResponse<any>

profileLadder

profileLadder: (args: ProfileLadderOptions, headers?: Headers) => ResourceResponse<any> = ...

Type declaration

    • (args: ProfileLadderOptions, headers?: Headers): ResourceResponse<any>

    • Parameters

      • args: ProfileLadderOptions
      • Optional headers: Headers

      Returns ResourceResponse<any>

ua

ua: string = ...

version

version: string = '4.2.0'

Methods

createClientResourceRequest

  • createClientResourceRequest<T>(fn: ResourceInterface<T, any>): (args: T, headers?: Headers) => ResourceResponse<any>

getApplicationToken

  • getApplicationToken(args?: { key?: string; origin?: string; secret?: string }): Promise<AxiosResponse<AccessToken, any>>

getClientResource

  • getClientResource<T>(url: string, config?: AxiosRequestConfig<any>): Promise<AxiosResponse<T, any>>

prepareResourceRequest

  • prepareResourceRequest(resource: Resource<{}>, args?: Partial<ClientOptions>, headers?: Headers): [string, AxiosRequestConfig<any>]

refreshApplicationToken

  • refreshApplicationToken(args?: { key?: string; origin?: string; secret?: string }): Promise<AxiosResponse<AccessToken, any>>

setApplicationToken

  • setApplicationToken(token: string): void

validateApplicationToken

  • validateApplicationToken(args?: { origin?: string; token?: string }): Promise<AxiosResponse<{ authorities: { authority: string }[]; client_id: string; exp: number; scope?: string[] }, any>>

Generated using TypeDoc