Pebble Foundation Classes  0.2.0
C++ for Pebble
Launch Reason

API for checking what caused the application to launch. More...

Collaboration diagram for Launch Reason:

Enumerations

enum  AppLaunchReason {
  APP_LAUNCH_SYSTEM = 0, APP_LAUNCH_USER, APP_LAUNCH_PHONE, APP_LAUNCH_WAKEUP,
  APP_LAUNCH_WORKER, APP_LAUNCH_QUICK_LAUNCH, APP_LAUNCH_TIMELINE_ACTION, APP_LAUNCH_SMARTSTRAP
}
 

Functions

AppLaunchReason launch_reason (void)
 
uint32_t launch_get_args (void)
 

Detailed Description

API for checking what caused the application to launch.

This includes the system, launch by user interaction (User selects the application from the launcher menu), launch by the mobile or a mobile companion application, or launch by a scheduled wakeup event for the specified application.

Enumeration Type Documentation

◆ AppLaunchReason

AppLaunchReason is used to inform the application about how it was launched

Note
New launch reasons may be added in the future. As a best practice, it is recommended to only handle the cases that the app needs to know about, rather than trying to handle all possible launch reasons.
Enumerator
APP_LAUNCH_SYSTEM 

App launched by the system.

APP_LAUNCH_USER 

App launched by user selection in launcher menu.

APP_LAUNCH_PHONE 

App launched by mobile or companion app.

APP_LAUNCH_WAKEUP 

App launched by wakeup event.

APP_LAUNCH_WORKER 

App launched by worker calling worker_launch_app()

APP_LAUNCH_QUICK_LAUNCH 

App launched by user using quick launch.

APP_LAUNCH_TIMELINE_ACTION 

App launched by user opening it from a pin.

APP_LAUNCH_SMARTSTRAP 

App launched by a smartstrap.

Function Documentation

◆ launch_get_args()

uint32_t launch_get_args ( void  )

Get the argument passed to the app when it was launched.

Note
Currently the only way to pass arguments to apps is by using an openWatchApp action on a pin.
Returns
The argument passed to the app, or 0 if the app wasn't launched from a Launch App action

◆ launch_reason()

AppLaunchReason launch_reason ( void  )

Provides the method used to launch the current application.

Returns
The method or reason the current application was launched