Class Platform

Hierarchy

Platform

Index

Constructors

Methods

addEventListener getBuildConfig getBuildDate getHFVersion isOnline isV9 openExternalUrl openFileWithExternalApplication removeEventListener

Constructors

constructor

new Platform(): Platform
Returns Platform

Methods

`Static` addEventListener

addEventListener(type: "networkStatusChanged", callback: ((ev: any) => void)): void
Adds an event listener to the platform class.
Parameters
- type: "networkStatusChanged"
  
  type of event listener, defined in the PlatformEventsEnum
- callback: ((ev: any) => void)
  - - (ev: any): void
    - Parameters
      
      ev: any
      
      Returns void
Returns void

`Static` getBuildConfig

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

Returns
The build configuration of the current application.

Returns string

`Static` getBuildDate

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

Returns
The date and time the application was built.

Returns Date

`Static` getHFVersion

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

Returns
The version of the current application.

Returns string

`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
true if current app version is a v9 or higher

Returns boolean

`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
- Optional target: string
  
  [optional] 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(type: "networkStatusChanged", callback: ((ev: any) => void)): void
Always remove previously registered event listeners!
Parameters
- type: "networkStatusChanged"
  
  type of event listener, defined in the PlatformEventsEnum
- callback: ((ev: any) => void)
  - - (ev: any): void
    - Parameters
      
      ev: any
      
      Returns void
Returns void

Generated using TypeDoc