priority property

int? priority
getter/setter pair

When running the service with Config.foregroundService: true, Android requires a persistent notification in the Notification Bar. This will control the priority of that notification as well as the position of the notificaiton-bar icon.

The following priority values defined as static constants upon the Config object:

Value Description
Config.NOTIFICATION_PRIORITY_DEFAULT Notification weighted to top of list; notification-bar icon weighted left
Config.NOTIFICATION_PRIORITY_HIGH Notification strongly weighted to top of list; notification-bar icon strongly weighted to left
Config.NOTIFICATION_PRIORITY_LOW Notification weighted to bottom of list; notification-bar icon weighted right
Config.NOTIFICATION_PRIORITY_MAX Same as NOTIFICATION_PRIORITY_HIGH
Config.NOTIFICATION_PRIORITY_MIN Notification strongly weighted to bottom of list; notification-bar icon hidden

Example

BackgroundGeolocation.ready(Config(
  notification: Notification(
    priority: Config.NOTIFICATION_PRIORITY_MIN
  )
));

Implementation

int? priority;