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.

1interface GeofenceMessageResponseListener

Interface for listening to geofence message response events.

1interface ProximityMessageResponseListener

Interface for listening to proximity message response events.

1interface RegionTransitionEventListener

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

1@RequiresPermission(
2    allOf = [
3        Manifest.permission.ACCESS_FINE_LOCATION,
4        Manifest.permission.ACCESS_BACKGROUND_LOCATION
5    ]
6)
7abstract fun enableGeofenceMessaging(): Boolean

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

1abstract fun disableGeofenceMessaging()

Disables geofence messaging.

1abstract fun isGeofenceMessagingEnabled(): Boolean

Indicates whether geofence messaging is enabled.

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

1@RequiresPermission(
2    allOf = [
3        Manifest.permission.ACCESS_FINE_LOCATION,
4        Manifest.permission.ACCESS_BACKGROUND_LOCATION
5    ]
6)
7abstract fun enableProximityMessaging(): Boolean

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

1abstract fun disableProximityMessaging()

Disables proximity messaging.

1abstract fun isProximityMessagingEnabled(): Boolean

Indicates whether proximity messaging is enabled.

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

1abstract fun registerGeofenceMessageResponseListener(
2    @NonNull listener: RegionMessageManager.GeofenceMessageResponseListener
3)

Registers the provided listener for geofence message response events.

Parameters:

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

1abstract fun unregisterGeofenceMessageResponseListener(
2    @NonNull listener: RegionMessageManager.GeofenceMessageResponseListener
3)

Unregisters the provided listener for geofence message response events.

Parameters:

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

1abstract fun registerProximityMessageResponseListener(
2    @NonNull listener: RegionMessageManager.ProximityMessageResponseListener
3)

Registers the provided listener for proximity message response events.

Parameters:

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

1abstract fun unregisterProximityMessageResponseListener(
2    @NonNull listener: RegionMessageManager.ProximityMessageResponseListener
3)

Unregisters the provided listener for proximity message response events.

Parameters:

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

1abstract fun registerRegionTransitionEventListener(
2    @NonNull listener: RegionMessageManager.RegionTransitionEventListener
3)

Registers the provided listener for region transition events.

Parameters:

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

1abstract fun unregisterRegionTransitionEventListener(
2    @NonNull listener: RegionMessageManager.RegionTransitionEventListener
3)

Unregisters the provided listener for region transition events.

Parameters:

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