MarketingCloudSDKLocationDelegate

Objective-C

@protocol MarketingCloudSDKLocationDelegate <NSObject>

Swift

protocol MarketingCloudSDKLocationDelegate : NSObjectProtocol

Supporting protocol for the MobilePush SDK’s support for Locations.

Implementation of this protocol is not required for the Location feature to work, although it provides addition control for an application developer.

This protocol allows for awareness into the SDK’s lifecycle for Location tracking and messaging.

  • Method called by the SDK when a Location message is ready to be shown. The delegate implementing this method returns YES or NO.

    YES indicates to the SDK that this message is able to be shown (allowed by the application).

    NO indicates that the SDK should not show this message.

    Declaration

    Objective-C

    - (BOOL)sfmc_shouldShowLocationMessage:(NSDictionary *_Nonnull)message
                                 forRegion:(NSDictionary *_Nonnull)region;

    Swift

    func sfmc_shouldShowLocationMessage(_ message: [AnyHashable : Any], forRegion region: [AnyHashable : Any]) -> Bool

    Parameters

    message

    NSDictionary representing a MobilePush Location message

    region

    NSDictionary representing a MobilePush region (geofence or beacon), which can be converted into a CLRegion object via the method sfmc_regionFromDictionary

    Return Value

    value reflecting application’s behavior