Interface IClient

The client actions interface.

Hierarchy

IClient

Implemented by

Client

Properties

context

Methods

Properties

Readonly context

context: IContext

Methods

alert

alert(title: string, content: string): Promise<void>

Show an alert with Ok button.

Parameters
- title: string
  
  the dialog title
- content: string
  
  the dialog content
Returns Promise<void>

captureGeoLocation

captureGeoLocation(options: GeoLocationOptions): Promise<GeoLocationResult>

Capture the user's current location.

Parameters
- options: GeoLocationOptions
  
  the geo location options
Returns Promise<GeoLocationResult>

confirm

confirm(title: string, content: string): Promise<boolean>

Show an alert with Ok and Cancel buttons.

Parameters
- title: string
  
  the dialog title
- content: string
  
  the dialog content
Returns Promise<boolean>

navigateBack

navigateBack(): Promise<void>

navigate back to the previous page in the app

Returns Promise<void>

navigateTo

navigateTo(options: NavigationOptions): Promise<void>

navigate to another page in the app

Parameters
- options: NavigationOptions
  
  the navigation options
Returns Promise<void>

openBrowser

openBrowser(options: OpenBrowserOptions): Promise<void>

open in-app browser

Parameters
- options: OpenBrowserOptions
  
  the open web site options
Returns Promise<void>

openFilePicker

openFilePicker(options: FilePickerOptions): Promise<FilePickerResult>

open filePicker using the oparation systemm

Parameters
- options: FilePickerOptions
  
  open URL options
Returns Promise<FilePickerResult>

openURI

openURI(options: OpenURIOptions): Promise<OpenURIResult>

open URL using the oparation systemm

Parameters
- options: OpenURIOptions
  
  open URL options
Returns Promise<OpenURIResult>

scanBarcode

scanBarcode(): Promise<ScanBarcodeResult>

prompt the user to scan a barcode.

Returns Promise<ScanBarcodeResult>

showDialog

showDialog(options: DialogOptions): Promise<any>

Show a dialog.

Parameters
- options: DialogOptions
  
  the dialog options
Returns Promise<any>

showHUD

showHUD(options: ShowHUDOptions): Promise<ShowHUDResult>

show a progress HUD.

Parameters
- options: ShowHUDOptions
  
  the hud options
Returns Promise<ShowHUDResult>

showModal

showModal(options: ModalOptions): Promise<any>

Show Addon Block As Modal

Parameters
- options: ModalOptions
  
  the modal options (Addon Block option)
Returns Promise<any>

Generated using TypeDoc