Class GlobalResource

Hierarchy

BungieResource
- GlobalResource

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new GlobalResource(httpService: HTTPService): GlobalResource

Overrides BungieResource.constructor
- Defined in resources/GlobalResource.ts:8
Parameters
- httpService: HTTPService
Returns GlobalResource

Properties

Protected basePath

basePath: string

Protected httpService

httpService: HTTPService

Protected resourcePath

resourcePath: string

Methods

getAvailableLocales

getAvailableLocales(): Promise<ServerResponse<DictionaryResponse<string>>>

- Defined in resources/GlobalResource.ts:20
List of available localization cultures

async

Returns Promise<ServerResponse<DictionaryResponse<string>>>

When fulfilled returns a list of available localization cultures

getCommonSettings

getCommonSettings(): Promise<ServerResponse<any>>

- Defined in resources/GlobalResource.ts:38
Get the common settings used by the Bungie.Net environment.

async

Returns Promise<ServerResponse<any>>

When fulfilled returns an object containing the common settings

getGlobalAlerts

getGlobalAlerts(): Promise<ServerResponse<GlobalAlert[]>>

- Defined in resources/GlobalResource.ts:56
Gets any active global alert for display in the forum banners, help pages, etc. Usually used for DOC alerts.

async

Returns Promise<ServerResponse<GlobalAlert[]>>

When fulfilled returns an object containing the current Global Alerts