@@ -290,25 +290,39 @@ export class Platform {
290
290
// called by engines (the browser)that do not provide them
291
291
292
292
/**
293
- * @private
293
+ * The `exitApp` method is useful when running from a native platform,
294
+ * such as Cordova. This adds the ability to place the Cordova app
295
+ * in the background.
294
296
*/
295
297
exitApp ( ) { }
296
298
297
299
// Events meant to be triggered by the engine
298
300
// **********************************************
299
301
300
302
/**
301
- * @private
303
+ * The back button event is emitted when the user presses the native
304
+ * platform's back button, also referred to as the "hardware" back button.
305
+ * This event is only emitted within Cordova apps running on Android and
306
+ * Windows platforms. This event is not fired on iOS since iOS doesn't come
307
+ * with a hardware back button in the same sense an Android or Windows device
308
+ * does. It's important to note that this event does not emit when the Ionic
309
+ * app's back button within the navbar is clicked, but this event is only
310
+ * referencing the platform's hardward back button.
302
311
*/
303
312
backButton : EventEmitter < any > = new EventEmitter ( ) ;
304
313
305
314
/**
306
- * @private
315
+ * The pause event emits when the native platform puts the application
316
+ * into the background, typically when the user switches to a different
317
+ * application. This event would emit when a Cordova app is put into
318
+ * the background, however, it would not fire on a standard web browser.
307
319
*/
308
320
pause : EventEmitter < any > = new EventEmitter ( ) ;
309
321
310
322
/**
311
- * @private
323
+ * The resume event emits when the native platform pulls the application
324
+ * out from the background. This event would emit when a Cordova app comes
325
+ * out from the background, however, it would not fire on a standard web browser.
312
326
*/
313
327
resume : EventEmitter < any > = new EventEmitter ( ) ;
314
328
0 commit comments