AndroidApplication | API

ApplicationCommon

AndroidApplication

Summary

Properties

Accessors

6 accessors inherited from ApplicationCommon

Click to expand

Methods

getNativeApplication

getRegisteredBroadcastReceiver

registerBroadcastReceiver

unregisterBroadcastReceiver

Properties

activityBackPressedEvent

Readonly

activityBackPressedEvent: "activityBackPressed" = AndroidApplication.activityBackPressedEvent

defined in @nativescript/core/application/application.d.ts:62:10

activityCreatedEvent

Readonly

activityCreatedEvent: "activityCreated" = AndroidApplication.activityCreatedEvent

defined in @nativescript/core/application/application.d.ts:54:10

activityDestroyedEvent

Readonly

activityDestroyedEvent: "activityDestroyed" = AndroidApplication.activityDestroyedEvent

defined in @nativescript/core/application/application.d.ts:55:10

activityNewIntentEvent

Readonly

activityNewIntentEvent: "activityNewIntent" = AndroidApplication.activityNewIntentEvent

defined in @nativescript/core/application/application.d.ts:63:10

activityPausedEvent

Readonly

activityPausedEvent: "activityPaused" = AndroidApplication.activityPausedEvent

defined in @nativescript/core/application/application.d.ts:57:10

activityRequestPermissionsEvent

Readonly

activityRequestPermissionsEvent: "activityRequestPermissions" = AndroidApplication.activityRequestPermissionsEvent

defined in @nativescript/core/application/application.d.ts:64:10

activityResultEvent

Readonly

activityResultEvent: "activityResult" = AndroidApplication.activityResultEvent

defined in @nativescript/core/application/application.d.ts:61:10

activityResumedEvent

Readonly

activityResumedEvent: "activityResumed" = AndroidApplication.activityResumedEvent

defined in @nativescript/core/application/application.d.ts:58:10

activityStartedEvent

Readonly

activityStartedEvent: "activityStarted" = AndroidApplication.activityStartedEvent

defined in @nativescript/core/application/application.d.ts:56:10

activityStoppedEvent

Readonly

activityStoppedEvent: "activityStopped" = AndroidApplication.activityStoppedEvent

defined in @nativescript/core/application/application.d.ts:59:10

saveActivityStateEvent

Readonly

saveActivityStateEvent: "saveActivityState" = AndroidApplication.saveActivityStateEvent

defined in @nativescript/core/application/application.d.ts:60:10

activityBackPressedEvent

StaticReadonly

activityBackPressedEvent: "activityBackPressed" = 'activityBackPressed'

defined in @nativescript/core/application/application.d.ts:44:17

activityCreatedEvent

StaticReadonly

activityCreatedEvent: "activityCreated" = 'activityCreated'

defined in @nativescript/core/application/application.d.ts:12:17

activityDestroyedEvent

StaticReadonly

activityDestroyedEvent: "activityDestroyed" = 'activityDestroyed'

defined in @nativescript/core/application/application.d.ts:16:17

activityNewIntentEvent

StaticReadonly

activityNewIntentEvent: "activityNewIntent" = 'activityNewIntent'

defined in @nativescript/core/application/application.d.ts:48:17

activityPausedEvent

StaticReadonly

activityPausedEvent: "activityPaused" = 'activityPaused'

defined in @nativescript/core/application/application.d.ts:24:17

activityRequestPermissionsEvent

StaticReadonly

activityRequestPermissionsEvent: "activityRequestPermissions" = 'activityRequestPermissions'

defined in @nativescript/core/application/application.d.ts:52:17

activityResultEvent

StaticReadonly

activityResultEvent: "activityResult" = 'activityResult'

defined in @nativescript/core/application/application.d.ts:40:17

activityResumedEvent

StaticReadonly

activityResumedEvent: "activityResumed" = 'activityResumed'

defined in @nativescript/core/application/application.d.ts:28:17

activityStartedEvent

StaticReadonly

activityStartedEvent: "activityStarted" = 'activityStarted'

defined in @nativescript/core/application/application.d.ts:20:17

activityStoppedEvent

StaticReadonly

activityStoppedEvent: "activityStopped" = 'activityStopped'

defined in @nativescript/core/application/application.d.ts:32:17

saveActivityStateEvent

StaticReadonly

saveActivityStateEvent: "saveActivityState" = 'saveActivityState'

defined in @nativescript/core/application/application.d.ts:36:17

Accessors

backgrounded

get backgrounded(): boolean

defined in @nativescript/core/application/application.d.ts:103:1

Returns boolean

context

get context(): Context

defined in @nativescript/core/application/application.d.ts:98:1

Returns Context

foregroundActivity

get foregroundActivity(): AppCompatActivity

defined in @nativescript/core/application/application.d.ts:93:1

The currently active (loaded) [android Activity](http://developer.android.com/reference/android/app/Activity.html). This property is automatically updated upon Activity events.

Returns AppCompatActivity

nativeApp

get nativeApp(): Application

defined in @nativescript/core/application/application.d.ts:76:1

The [android Application](http://developer.android.com/reference/android/app/Application.html) object instance provided to the init of the module.

Returns Application

packageName

get packageName(): string

defined in @nativescript/core/application/application.d.ts:81:1

Returns string

paused

get paused(): boolean

defined in @nativescript/core/application/application.d.ts:108:1

Returns boolean

startActivity

get startActivity(): AppCompatActivity

defined in @nativescript/core/application/application.d.ts:86:1

The main (start) Activity for the application.

Returns AppCompatActivity

Methods

getNativeApplication

getNativeApplication(): Application

defined in @nativescript/core/application/application.d.ts:66:1

Returns Application

getRegisteredBroadcastReceiver

getRegisteredBroadcastReceiver(intentFilter: string): BroadcastReceiver

defined in @nativescript/core/application/application.d.ts:129:1

Get a registered BroadcastReceiver, then you can get the result code of BroadcastReceiver in onReceiveCallback method.

Parameter	Default	Description
`intentFilter`		`string` A string containing the intent filter.

Returns BroadcastReceiver

on

on(
  event: "activityCreated",
  callback: (args: AndroidActivityBundleEventData) => void,
  thisArg?: any
): void

defined in @nativescript/core/application/application.d.ts:131:1

Parameter	Default	Description
`event`		`"activityCreated"`
`callback`		`(args: AndroidActivityBundleEventData) => void`
`thisArg`		`any`

Returns void

on(
  event: "activityDestroyed",
  callback: (args: AndroidActivityEventData) => void,
  thisArg?: any
): void

defined in @nativescript/core/application/application.d.ts:132:1

This event is raised when application css is changed.

Parameter	Default	Description
`event`		`"activityDestroyed"`
`callback`		`(args: AndroidActivityEventData) => void`
`thisArg`		`any`

Returns void

on(
  event: "activityStarted",
  callback: (args: AndroidActivityEventData) => void,
  thisArg?: any
): void

defined in @nativescript/core/application/application.d.ts:133:1

Event raised then livesync operation is performed.

Parameter	Default	Description
`event`		`"activityStarted"`
`callback`		`(args: AndroidActivityEventData) => void`
`thisArg`		`any`

Returns void

on(
  event: "activityPaused",
  callback: (args: AndroidActivityEventData) => void,
  thisArg?: any
): void

defined in @nativescript/core/application/application.d.ts:134:1

This event is raised when application css is changed.

Parameter	Default	Description
`event`		`"activityPaused"`
`callback`		`(args: AndroidActivityEventData) => void`
`thisArg`		`any`

Returns void

on(
  event: "activityResumed",
  callback: (args: AndroidActivityEventData) => void,
  thisArg?: any
): void

defined in @nativescript/core/application/application.d.ts:135:1

This event is raised on application launchEvent.

Parameter	Default	Description
`event`		`"activityResumed"`
`callback`		`(args: AndroidActivityEventData) => void`
`thisArg`		`any`

Returns void

on(
  event: "activityStopped",
  callback: (args: AndroidActivityEventData) => void,
  thisArg?: any
): void

defined in @nativescript/core/application/application.d.ts:136:1

This event is raised after the application has performed most of its startup actions. Its intent is to be suitable for measuring app startup times.

Parameter	Default	Description
`event`		`"activityStopped"`
`callback`		`(args: AndroidActivityEventData) => void`
`thisArg`		`any`

Returns void

on(
  event: "saveActivityState",
  callback: (args: AndroidActivityBundleEventData) => void,
  thisArg?: any
): void

defined in @nativescript/core/application/application.d.ts:137:1

This event is raised when the Application is suspended.

Parameter	Default	Description
`event`		`"saveActivityState"`
`callback`		`(args: AndroidActivityBundleEventData) => void`
`thisArg`		`any`

Returns void

on(
  event: "activityResult",
  callback: (args: AndroidActivityResultEventData) => void,
  thisArg?: any
): void

defined in @nativescript/core/application/application.d.ts:138:1

This event is raised when the Application is resumed after it has been suspended.

Parameter	Default	Description
`event`		`"activityResult"`
`callback`		`(args: AndroidActivityResultEventData) => void`
`thisArg`		`any`

Returns void

on(
  event: "activityBackPressed",
  callback: (args: AndroidActivityBackPressedEventData) => void,
  thisArg?: any
): void

defined in @nativescript/core/application/application.d.ts:139:1

This event is raised when the Application is about to exit.

Parameter	Default	Description
`event`		`"activityBackPressed"`
`callback`		`(args: AndroidActivityBackPressedEventData) => void`
`thisArg`		`any`

Returns void

on(
  event: "activityNewIntent",
  callback: (args: AndroidActivityNewIntentEventData) => void,
  thisArg?: any
): void

defined in @nativescript/core/application/application.d.ts:140:1

This event is raised when there is low memory on the target device.

Parameter	Default	Description
`event`		`"activityNewIntent"`
`callback`		`(args: AndroidActivityNewIntentEventData) => void`
`thisArg`		`any`

Returns void

on(
  event: "activityRequestPermissions",
  callback: (args: AndroidActivityRequestPermissionsEventData) => void,
  thisArg?: any
): void

defined in @nativescript/core/application/application.d.ts:141:1

This event is raised when an uncaught error occurs while the application is running.

Parameter	Default	Description
`event`		`"activityRequestPermissions"`
`callback`		`(args: AndroidActivityRequestPermissionsEventData) => void`
`thisArg`		`any`

Returns void

registerBroadcastReceiver

registerBroadcastReceiver(
  intentFilter: string,
  onReceiveCallback: (context: Context, intent: Intent) => void
): void

defined in @nativescript/core/application/application.d.ts:116:1

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'

Parameter	Default	Description
`intentFilter`		`string` A string containing the intent filter.
`onReceiveCallback`		`(context: Context, intent: Intent) => void` A callback function that will be called each time the receiver receives a broadcast.

Returns void

unregisterBroadcastReceiver

unregisterBroadcastReceiver(intentFilter: string): void

defined in @nativescript/core/application/application.d.ts:123:1

Unregister a previously registered BroadcastReceiver. For more information, please visit 'http://developer.android.com/reference/android/content/Context.html#unregisterReceiver(android.content.BroadcastReceiver)'

Parameter	Default	Description
`intentFilter`		`string` A string containing the intent filter with which the receiver was originally registered.

Returns void

Summary ​

Properties

Accessors

Methods

Properties ​

activityBackPressedEvent ​

activityCreatedEvent ​

activityDestroyedEvent ​

activityNewIntentEvent ​

activityPausedEvent ​

activityRequestPermissionsEvent ​

activityResultEvent ​

activityResumedEvent ​

activityStartedEvent ​

activityStoppedEvent ​

saveActivityStateEvent ​

activityBackPressedEvent ​

activityCreatedEvent ​

activityDestroyedEvent ​

activityNewIntentEvent ​

activityPausedEvent ​

activityRequestPermissionsEvent ​

activityResultEvent ​

activityResumedEvent ​

activityStartedEvent ​

activityStoppedEvent ​

saveActivityStateEvent ​

Accessors ​

backgrounded ​

context ​

foregroundActivity ​

nativeApp ​

packageName ​

paused ​

startActivity ​

Methods ​

getNativeApplication ​

getRegisteredBroadcastReceiver ​

on ​

registerBroadcastReceiver ​

unregisterBroadcastReceiver ​

Summary

Properties

activityBackPressedEvent

activityCreatedEvent

activityDestroyedEvent

activityNewIntentEvent

activityPausedEvent

activityRequestPermissionsEvent

activityResultEvent

activityResumedEvent

activityStartedEvent

activityStoppedEvent

saveActivityStateEvent

activityBackPressedEvent

activityCreatedEvent

activityDestroyedEvent

activityNewIntentEvent

activityPausedEvent

activityRequestPermissionsEvent

activityResultEvent

activityResumedEvent

activityStartedEvent

activityStoppedEvent

saveActivityStateEvent

Accessors

backgrounded

context

foregroundActivity

nativeApp

packageName

paused

startActivity

Methods

getNativeApplication

getRegisteredBroadcastReceiver

on

registerBroadcastReceiver

unregisterBroadcastReceiver