Class Platform

Static properties and methods related to the platform.

Index

Constructors

Methods

addEventListener getBuildConfig getBuildDate getHFVersion isOnline isV9 openExternalUrl openFileWithExternalApplication removeEventListener

Constructors

constructor

new Platform(): Platform
Returns Platform

Methods

`Static`addEventListener

addEventListener<T extends "networkStatusChanged">(
type: T,
callback: PlatformEventsMapping[T],
): void
Adds an event listener to the platform class.
Type Parameters
- T extends "networkStatusChanged"
Parameters
- type: T
  type of event listener, defined in the PlatformEventsMapping
- callback: PlatformEventsMapping[T]
Returns void

`Static`getBuildConfig

getBuildConfig(): string
Get the build configuration of the current application

Returns string
The build configuration of the current application.

`Static`getBuildDate

getBuildDate(): Date
Get the build date of the current application

Returns Date
The date and time the application was built.

`Static`getHFVersion

getHFVersion(): string
Returns the version of the current application

Returns string
The version of the current application.

`Static`isOnline

isOnline(): boolean
Checks if the device respectively the platform is online.

Returns boolean

`Static`isV9

isV9(): boolean
Checks if current app version is a v9 or higher

Returns boolean
true if current app version is a v9 or higher

`Static`openExternalUrl

openExternalUrl(url: string, target?: string): void
Opens a url with an external application (e.g. browser, email client, phone app ...).
Parameters
- url: string
  Specifies the URL of the page to open.
- Optionaltarget: string
  Specifies the target attribute or the name of the window; default:
Returns void

`Static`openFileWithExternalApplication

openFileWithExternalApplication(
filepath: string,
mimetype: string,
): Promise<void>
Opens a file with an external application, if there is a default program defined for it.
Parameters
- filepath: string
  relative url to the file
- mimetype: string
  the mimetype of the file
Returns Promise<void>

`Static`removeEventListener

removeEventListener<T extends "networkStatusChanged">(
type: T,
callback: PlatformEventsMapping[T],
): void
Always remove previously registered event listeners!
Type Parameters
- T extends "networkStatusChanged"
Parameters
- type: T
  type of event listener, defined in the PlatformEventsMapping
- callback: PlatformEventsMapping[T]
Returns void