GMBLCommunicationManagerDelegate Protocol Reference
Conforms to | NSObject |
---|---|
Declared in | GMBLCommunicationManager.h |
Overview
The GMBLCommunicationManagerDelegate protocol defines the methods used to receive events for the GMBLCommunicationManager object.
– communicationManager:presentLocalNotificationsForCommunications:forVisit:
Called when a Gimbal Event (for instance Place Arrival) triggers a Gimbal Communication. The communications returned in the array will be scheduled by Gimbal, while others will be ignored.
- (nullable NSArray<GMBLCommunication*> *)communicationManager:(GMBLCommunicationManager *)manager presentLocalNotificationsForCommunications:(NSArray<GMBLCommunication*> *)communications forVisit:(GMBLVisit *)visit
Parameters
manager |
Communication manager sending the event |
---|---|
communications |
Communications retrieved from the Gimbal Manager |
visit |
The visit that triggered the communication |
Return Value
An array containing all the GMBLCommunication objects you would like Gimbal to post a UILocalNotification
Discussion
Called when a Gimbal Event (for instance Place Arrival) triggers a Gimbal Communication. The communications returned in the array will be scheduled by Gimbal, while others will be ignored.
Please note that frequency limit and delay are not honored for communications not returned.
Declared In
GMBLCommunicationManager.h
– communicationManager:prepareNotificationForDisplay:forCommunication:
This method is deprecated starting in iOS 10 (Deprecated: This method is deprecated starting in iOS 10)
- (nullable UILocalNotification *)communicationManager:(GMBLCommunicationManager *)manager prepareNotificationForDisplay:(UILocalNotification *)notification forCommunication:(GMBLCommunication *)communication
Parameters
manager |
Communication manager sending the event |
---|---|
notification |
Default notification for the received communication |
communication |
The communication received creating the notification |
Return Value
The notification to be scheduled
Discussion
Note: Please use UserNotifications communicationManager:prepareNotificationContentForDisplay:forCommunication:forVisit:
Called when a Gimbal Event (for instance Place Arrival) results in Gimbal Communications. Returned UILocalNotification will be scheduled for display. If nil is returned, a default Notification will be displayed using the GMBLCommunication.
Declared In
GMBLCommunicationManager.h
– communicationManager:prepareNotificationContentForDisplay:forCommunication:
This method is depricated in favor of a more complete version (Deprecated: This method is depricated in favor of a more complete version)
- (nullable UNMutableNotificationContent *)communicationManager:(GMBLCommunicationManager *)manager prepareNotificationContentForDisplay:(UNMutableNotificationContent *)notificationContent forCommunication:(GMBLCommunication *)communication
Parameters
manager |
Communication manager sending the event |
---|---|
notificationContent |
Default notification content for the received communication |
communication |
The communication received creating the notification |
Return Value
notificationContent to be added to scheduled UserNotification
Discussion
Note: Please use communicationManager:prepareNotificationContentForDisplay:forCommunication:forVisit:
Called when a Gimbal Event (for instance Place Arrival) results in Gimbal Communications. Returned UNMutableNotificationContent will be scheduled for display. If nil is returned, a default Notification will be displayed using the GMBLCommunication.
Declared In
GMBLCommunicationManager.h
– communicationManager:prepareNotificationContentForDisplay:forCommunication:forVisit:
For use with UserNotifications in iOS 10 and above.
- (nullable UNMutableNotificationContent *)communicationManager:(GMBLCommunicationManager *)manager prepareNotificationContentForDisplay:(UNMutableNotificationContent *)notificationContent forCommunication:(GMBLCommunication *)communication forVisit:(GMBLVisit *)visit
Parameters
manager |
Communication manager sending the event |
---|---|
notificationContent |
Default notification content for the received communication |
communication |
The communication received creating the notification |
visit |
The visit triggering the event |
Return Value
notificationContent to be added to scheduled UserNotification
Discussion
For use with UserNotifications in iOS 10 and above.
Called when a Gimbal Event (for instance Place Arrival) results in Gimbal Communications. Returned UNMutableNotificationContent will be scheduled for display. If nil is returned, a default Notification will be displayed using the GMBLCommunication.
Declared In
GMBLCommunicationManager.h