RegionMessageManager

Package: com.salesforce.marketingcloud.messages

Type: Interface

An interface for managing region-based messaging (geofence and proximity) in the Salesforce Marketing Cloud SDK. This interface provides methods to enable/disable geofence and proximity messaging, check their status, and register/unregister listeners for message responses and region transition events.

Interface for listening to geofence message response events.

Interface for listening to proximity message response events.

Interface to use to listen for region (Geofence/Proximity) transition (enter/exit) events.

Enables geofence messaging.

Returns: Boolean - true if geofence messaging was successfully enabled, false otherwise.

Required Permissions:

  • Manifest.permission.ACCESS_FINE_LOCATION
  • Manifest.permission.ACCESS_BACKGROUND_LOCATION

Disables geofence messaging.

Indicates whether geofence messaging is enabled.

Returns: Boolean - true if geofence messaging is enabled, false otherwise.

Enables proximity messaging.

Returns: Boolean - true if proximity messaging was successfully enabled, false otherwise.

Required Permissions:

  • Manifest.permission.ACCESS_FINE_LOCATION
  • Manifest.permission.ACCESS_BACKGROUND_LOCATION

Disables proximity messaging.

Indicates whether proximity messaging is enabled.

Returns: Boolean - true if proximity messaging is enabled, false otherwise.

Registers the provided listener for geofence message response events.

Parameters:

  • listener - The GeofenceMessageResponseListener to register (must not be null)

Unregisters the provided listener for geofence message response events.

Parameters:

  • listener - The GeofenceMessageResponseListener to unregister (must not be null)

Registers the provided listener for proximity message response events.

Parameters:

  • listener - The ProximityMessageResponseListener to register (must not be null)

Unregisters the provided listener for proximity message response events.

Parameters:

  • listener - The ProximityMessageResponseListener to unregister (must not be null)

Registers the provided listener for region transition events.

Parameters:

  • listener - The RegionTransitionEventListener to register (must not be null)

Unregisters the provided listener for region transition events.

Parameters:

  • listener - The RegionTransitionEventListener to unregister (must not be null)