AndroidApplication | NativeScript

The abstraction of an Android-specific application object.

Hierarchy

Observable

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new AndroidApplication(): AndroidApplication

Inherited from Observable.constructor

Returns AndroidApplication

Properties

_isViewBase

_isViewBase: boolean

context

context: any

The application's android Context object instance.

foregroundActivity

foregroundActivity: any

The currently active (loaded) android Activity. This property is automatically updated upon Activity events.

init

init: function

Initialized the android-specific application object with the native android.app.Application instance. This is useful when creating custom application types.

param: the android.app.Application instance that started the app.

Type declaration

- (nativeApp: any): void
- Parameters
  - nativeApp: any
  Returns void

nativeApp

nativeApp: any

The android Application object instance provided to the init of the module.

orientation

orientation: "portrait" | "landscape" | "unknown"

Gets the orientation of the application. Available values: "portrait", "landscape", "unknown".

packageName

packageName: string

The name of the application package.

paused

paused: boolean

True if the main application activity is not running (suspended), false otherwise.

startActivity

startActivity: any

The main (start) Activity for the application.

systemAppearance

systemAppearance: "dark" | "light"

Gets the system appearance. Available values: "dark", "light".

Static activityBackPressedEvent

activityBackPressedEvent: string

String value used when hooking to activityBackPressed event.

Static activityCreatedEvent

activityCreatedEvent: string

String value used when hooking to activityCreated event.

Static activityDestroyedEvent

activityDestroyedEvent: string

String value used when hooking to activityDestroyed event.

Static activityNewIntentEvent

activityNewIntentEvent: string

String value used when hooking to activityNewIntent event.

Static activityPausedEvent

activityPausedEvent: string

String value used when hooking to activityPaused event.

Static activityRequestPermissionsEvent

activityRequestPermissionsEvent: string

String value used when hooking to requestPermissions event.

Static activityResultEvent

activityResultEvent: string

String value used when hooking to activityResult event.

Static activityResumedEvent

activityResumedEvent: string

String value used when hooking to activityResumed event.

Static activityStartedEvent

activityStartedEvent: string

String value used when hooking to activityStarted event.

Static activityStoppedEvent

activityStoppedEvent: string

String value used when hooking to activityStopped event.

Static propertyChangeEvent

propertyChangeEvent: string

Static saveActivityStateEvent

saveActivityStateEvent: string

String value used when hooking to saveActivityState event.

Methods

_createPropertyChangeData

_createPropertyChangeData(propertyName: string, value: any, oldValue?: any): PropertyChangeData

Inherited from Observable._createPropertyChangeData
- Defined in data/observable/index.ts:309
Parameters
- propertyName: string
- value: any
- Optional oldValue: any
Returns PropertyChangeData

_emit

_emit(eventNames: string): void

Inherited from Observable._emit
- Defined in data/observable/index.ts:319
Parameters
- eventNames: string
Returns void

addEventListener

addEventListener(eventNames: string, callback: function, thisArg?: any): void

Inherited from Observable.addEventListener
- Defined in data/observable/index.ts:105
Parameters
- eventNames: string
- callback: function
  - - (data: EventData): void
    - Parameters
      - data: EventData
      Returns void
- Optional thisArg: any
Returns void

get

get(name: string): any

Inherited from Observable.get
- Defined in data/observable/index.ts:52
Parameters
- name: string
Returns any

hasListeners

hasListeners(eventName: string): boolean

Inherited from Observable.hasListeners
- Defined in data/observable/index.ts:305
Parameters
- eventName: string
Returns boolean

notify

notify<T>(data: T): void

Inherited from Observable.notify
- Defined in data/observable/index.ts:270
Type parameters
- T: NotifyData<T>
Parameters
- data: T
Returns void

notifyPropertyChange

notifyPropertyChange(name: string, value: any, oldValue?: any): void

Inherited from Observable.notifyPropertyChange
- Defined in data/observable/index.ts:301
Parameters
- name: string
- value: any
- Optional oldValue: any
Returns void

off

off(eventNames: string, callback?: any, thisArg?: any): void

Inherited from Observable.off
- Defined in data/observable/index.ts:101
Parameters
- eventNames: string
- Optional callback: any
- Optional thisArg: any
Returns void

on

on(eventNames: string, callback: function, thisArg?: any): any
on(event: "activityCreated", callback: function, thisArg?: any): any
on(event: "activityDestroyed", callback: function, thisArg?: any): any
on(event: "activityStarted", callback: function, thisArg?: any): any
on(event: "activityPaused", callback: function, thisArg?: any): any
on(event: "activityResumed", callback: function, thisArg?: any): any
on(event: "activityStopped", callback: function, thisArg?: any): any
on(event: "saveActivityState", callback: function, thisArg?: any): any
on(event: "activityResult", callback: function, thisArg?: any): any
on(event: "activityBackPressed", callback: function, thisArg?: any): any
on(event: "activityNewIntent", callback: function, thisArg?: any): any
on(event: "activityRequestPermissions", callback: function, thisArg?: any): any

Overwrites Observable.on
- Defined in application/index.d.ts:497
A basic method signature to hook an event listener (shortcut alias to the addEventListener method).

Parameters
- eventNames: string
  
  String corresponding to events (e.g. "propertyChange"). Optionally could be used more events separated by , (e.g. "propertyChange", "change").
- callback: function
  
  Callback function which will be executed when event is raised.
  - - (data: AndroidActivityEventData): void
    - Parameters
      - data: AndroidActivityEventData
      Returns void
- Optional thisArg: any
  
  An optional parameter which will be used as this context for callback execution.
Returns any
- Defined in application/index.d.ts:502
This event is raised on android application ActivityCreated.

Parameters
- event: "activityCreated"
- callback: function
  - - (args: AndroidActivityBundleEventData): void
    - Parameters
      - args: AndroidActivityBundleEventData
      Returns void
- Optional thisArg: any
Returns any
- Defined in application/index.d.ts:507
This event is raised on android application ActivityDestroyed.

Parameters
- event: "activityDestroyed"
- callback: function
  - - (args: AndroidActivityEventData): void
    - Parameters
      - args: AndroidActivityEventData
      Returns void
- Optional thisArg: any
Returns any
- Defined in application/index.d.ts:512
This event is raised on android application ActivityStarted.

Parameters
- event: "activityStarted"
- callback: function
  - - (args: AndroidActivityEventData): void
    - Parameters
      - args: AndroidActivityEventData
      Returns void
- Optional thisArg: any
Returns any
- Defined in application/index.d.ts:517
This event is raised on android application ActivityPaused.

Parameters
- event: "activityPaused"
- callback: function
  - - (args: AndroidActivityEventData): void
    - Parameters
      - args: AndroidActivityEventData
      Returns void
- Optional thisArg: any
Returns any
- Defined in application/index.d.ts:522
This event is raised on android application ActivityResumed.

Parameters
- event: "activityResumed"
- callback: function
  - - (args: AndroidActivityEventData): void
    - Parameters
      - args: AndroidActivityEventData
      Returns void
- Optional thisArg: any
Returns any
- Defined in application/index.d.ts:527
This event is raised on android application ActivityStopped.

Parameters
- event: "activityStopped"
- callback: function
  - - (args: AndroidActivityEventData): void
    - Parameters
      - args: AndroidActivityEventData
      Returns void
- Optional thisArg: any
Returns any
- Defined in application/index.d.ts:532
This event is raised on android application SaveActivityState.

Parameters
- event: "saveActivityState"
- callback: function
  - - (args: AndroidActivityBundleEventData): void
    - Parameters
      - args: AndroidActivityBundleEventData
      Returns void
- Optional thisArg: any
Returns any
- Defined in application/index.d.ts:537
This event is raised on android application ActivityResult.

Parameters
- event: "activityResult"
- callback: function
  - - (args: AndroidActivityResultEventData): void
    - Parameters
      - args: AndroidActivityResultEventData
      Returns void
- Optional thisArg: any
Returns any
- Defined in application/index.d.ts:542
This event is raised on the back button is pressed in an android application.

Parameters
- event: "activityBackPressed"
- callback: function
  - - (args: AndroidActivityBackPressedEventData): void
    - Parameters
      - args: AndroidActivityBackPressedEventData
      Returns void
- Optional thisArg: any
Returns any
- Defined in application/index.d.ts:547
This event is raised when the Android app was launched by an Intent with data.

Parameters
- event: "activityNewIntent"
- callback: function
  - - (args: AndroidActivityNewIntentEventData): void
    - Parameters
      - args: AndroidActivityNewIntentEventData
      Returns void
- Optional thisArg: any
Returns any
- Defined in application/index.d.ts:552
This event is raised when the Android activity requests permissions.

Parameters
- event: "activityRequestPermissions"
- callback: function
  - - (args: AndroidActivityRequestPermissionsEventData): void
    - Parameters
      - args: AndroidActivityRequestPermissionsEventData
      Returns void
- Optional thisArg: any
Returns any

once

once(event: string, callback: function, thisArg?: any): void

Inherited from Observable.once
- Defined in data/observable/index.ts:88
Parameters
- event: string
- callback: function
  - - (data: EventData): void
    - Parameters
      - data: EventData
      Returns void
- Optional thisArg: any
Returns void

registerBroadcastReceiver

registerBroadcastReceiver(intentFilter: string, onReceiveCallback: function): void

- Defined in application/index.d.ts:615
Register a BroadcastReceiver to be run in the main activity thread. The receiver will be called with any broadcast Intent that matches filter, in the main application thread. For more information, please visit 'http://developer.android.com/reference/android/content/Context.html#registerReceiver%28android.content.BroadcastReceiver,%20android.content.IntentFilter%29'

Parameters
- intentFilter: string
  
  A string containing the intent filter.
- onReceiveCallback: function
  
  A callback function that will be called each time the receiver receives a broadcast.
  - - (context: any, intent: any): void
    - Parameters
      - context: any
      - intent: any
      Returns void
Returns void

removeEventListener

removeEventListener(eventNames: string, callback?: any, thisArg?: any): void

Inherited from Observable.removeEventListener
- Defined in data/observable/index.ts:126
Parameters
- eventNames: string
- Optional callback: any
- Optional thisArg: any
Returns void

set

set(name: string, value: any): void

Inherited from Observable.set
- Defined in data/observable/index.ts:56
Parameters
- name: string
- value: any
Returns void

setProperty

setProperty(name: string, value: any): void

Inherited from Observable.setProperty
- Defined in data/observable/index.ts:68
Parameters
- name: string
- value: any
Returns void

unregisterBroadcastReceiver

unregisterBroadcastReceiver(intentFilter: string): void

- Defined in application/index.d.ts:622
Unregister a previously registered BroadcastReceiver. For more information, please visit 'http://developer.android.com/reference/android/content/Context.html#unregisterReceiver(android.content.BroadcastReceiver)'

Parameters
- intentFilter: string
  
  A string containing the intent filter with which the receiver was originally registered.
Returns void

Static addEventListener

addEventListener(eventName: string, callback: any, thisArg?: any): void

Inherited from Observable.addEventListener
- Defined in data/observable/index.ts:231
Parameters
- eventName: string
- callback: any
- Optional thisArg: any
Returns void

Static off

off(eventName: string, callback?: any, thisArg?: any): void

Inherited from Observable.off
- Defined in data/observable/index.ts:179
Parameters
- eventName: string
- Optional callback: any
- Optional thisArg: any
Returns void

Static on

on(eventName: string, callback: any, thisArg?: any): void

Inherited from Observable.on
- Defined in data/observable/index.ts:156
Parameters
- eventName: string
- callback: any
- Optional thisArg: any
Returns void

Static once

once(eventName: string, callback: any, thisArg?: any): void

Inherited from Observable.once
- Defined in data/observable/index.ts:160
Parameters
- eventName: string
- callback: any
- Optional thisArg: any
Returns void

Static removeEventListener

removeEventListener(eventName: string, callback?: any, thisArg?: any): void

Inherited from Observable.removeEventListener
- Defined in data/observable/index.ts:183
Parameters
- eventName: string
- Optional callback: any
- Optional thisArg: any
Returns void

Class AndroidApplication

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Returns AndroidApplication

Properties

_isViewBase

context

foregroundActivity

init

Type declaration

Parameters

nativeApp: any

Returns void

nativeApp

orientation

packageName

paused

startActivity

systemAppearance

Static activityBackPressedEvent

Static activityCreatedEvent

Static activityDestroyedEvent

Static activityNewIntentEvent

Static activityPausedEvent

Static activityRequestPermissionsEvent

Static activityResultEvent

Static activityResumedEvent

Static activityStartedEvent

Static activityStoppedEvent

Static propertyChangeEvent

Static saveActivityStateEvent

Methods

_createPropertyChangeData

Parameters

propertyName: string

value: any

Optional oldValue: any

Returns PropertyChangeData

_emit

Parameters

eventNames: string

Returns void

addEventListener

Parameters

eventNames: string

callback: function

Parameters

data: EventData

Returns void

Optional thisArg: any

Returns void

get

Parameters

name: string

Returns any

hasListeners

Parameters

eventName: string

Returns boolean

notify

Type parameters

T: NotifyData<T>

Parameters

data: T

Returns void

notifyPropertyChange

Parameters

name: string

value: any

Optional oldValue: any

Returns void

off

Parameters

eventNames: string

Optional callback: any