GeoTriggerEvent
@objc
public class GeoTriggerEvent : NSObject
extension GeoTriggerEvent: JsonString
An event triggered by GeoTriggering service when a trigger (zone entry or exit) happens.
This event is being sent to application via BDPGeoTriggeringEventDelegate.didEnterZone(_:)
and BDPGeoTriggeringEventDelegate.didExitZone(_:)
.
-
The installation reference of this Point SDK enabled App. Same as
BDLocationManager/installRef
Declaration
Swift
@objc public let installRef: UUID
-
The projectId SDK initialized with
Declaration
Swift
@objc public let projectId: String
-
Device infomation e.g. model, os
Declaration
Swift
@objc public let deviceInfo: DeviceInfo
-
The unique ID of the trigger chain. A trigger chain includes an Entry event (if zone setting in Canvas is Exit-disabled), or a pair of Entry and Exit events (if zone setting in Canvas is Exit-enabled)
Declaration
Swift
@objc public let triggerChainId: UUID
-
Declaration
Swift
@objc public let notificationType: NotificationType
-
Details of the zone triggering the event
Declaration
Swift
@objc public let zoneInfo: ZoneInfo
-
Application-related detail. Note that the PointSDK’s
customEventMetaData
is included in thisappInfo
Declaration
Swift
@objc public let appInfo: AppInfo
-
A list of trigger events included in this GeoTriggerEvent.
- An entry event will include only 1 item of type
FenceEntered
. - An exit event will include 2 items: the
FenceEntered
event and theFenceExited
event linking to the same zone.
Declaration
Swift
@objc public let triggerEvents: [TriggerEvent]
- An entry event will include only 1 item of type
-
A
FenceEntered
event causing the zone entry trigger, same as the first event intriggerEvents
. For exit trigger event, this returns theFenceEntered
event linked to theFenceExited
in the sametriggerChainId
Declaration
Swift
@objc public var entryEvent: FenceEntered? { get }
-
A
FenceExited
event causing the zone exit trigger, same as the last event intriggerEvents
.nil
if this GeoTriggerEvent is an entry event.Declaration
Swift
@objc public var exitEvent: FenceExited? { get }
-
Convert to JSON string
This function throws an error if JSON encoding process fails
Declaration
Swift
@objc(toJson:) public func toJson() throws -> String