Class AirshipLocale

Manages locale used by Airship messaging.

Hierarchy

AirshipLocale

Index

Constructors

Properties

Methods

clearLocaleOverride getLocale setLocaleOverride

Constructors

constructor

new AirshipLocale(plugin: AirshipPluginWrapper): AirshipLocale
Parameters
- plugin: AirshipPluginWrapper
Returns AirshipLocale
- Defined in AirshipLocale.ts:7

Properties

`Private` `Readonly` plugin

plugin: AirshipPluginWrapper

Methods

clearLocaleOverride

clearLocaleOverride(): Promise<void>
Clears the locale override.

Returns
A promise.

Returns Promise<void>
- Defined in AirshipLocale.ts:22

getLocale

getLocale(): Promise<string>
Gets the current locale.

Returns
A promise with the result.

Returns Promise<string>
- Defined in AirshipLocale.ts:30

setLocaleOverride

setLocaleOverride(localeIdentifier: string): Promise<void>
Sets the locale override.

Returns
A promise.
Parameters
- localeIdentifier: string
  
  The locale identifier.
Returns Promise<void>
- Defined in AirshipLocale.ts:14

Generated using TypeDoc