KGNotificationPayload Class Reference
| Inherits from | NSObject |
| Declared in | KGNotificationPayload.h |
Overview
KGNotificationPayload represents a concrete class that is used to create a JSON payload to be delivered to Apple Push Notification Service(APNS). Currently, only alert and sound notifications are supported.
Tasks
-
– initWithAlert:Creates an instance of KGNotificationPayload which includes an alert notification.
-
– initWithAlert:sound:Creates an instance of KGNotificationPayload which includes an alert notification with sound.
-
– alertNotificationReturns the alert notification.
-
– setAlertNotification:Sets the alert notification.
-
– soundNotificationReturns the sound notification.
-
– setSoundNotification:Sets the sound notification.
Instance Methods
alertNotification
Returns the alert notification.
- (id<KGAlertNotification>)alertNotificationReturn Value
KGAlertNotification object
Declared In
KGNotificationPayload.hinitWithAlert:
Creates an instance of KGNotificationPayload which includes an alert notification.
- (id)initWithAlert:(id<KGAlertNotification>)alertParameters
- alert
KGAlertNotification representing the alert to be rendered when the notification is received
Return Value
id instance of KGNotificationPayload class
Declared In
KGNotificationPayload.hinitWithAlert:sound:
Creates an instance of KGNotificationPayload which includes an alert notification with sound.
- (id)initWithAlert:(id<KGAlertNotification>)alert sound:(id<KGSoundNotification>)soundParameters
- alert
KGAlertNotification representing the alert to be rendered when the notification is received
- sound
KGSoundNotification representing the sound to be played when the notification is received
Return Value
id instance of KGNotificationPayload class
Declared In
KGNotificationPayload.hsetAlertNotification:
Sets the alert notification.
- (void)setAlertNotification:(id<KGAlertNotification>)alertParameters
- alert
KGAlertNotification object representing an alert
Declared In
KGNotificationPayload.hsetSoundNotification:
Sets the sound notification.
- (void)setSoundNotification:(id<KGSoundNotification>)soundParameters
- sound
KGSoundNotification object representing a sound
Declared In
KGNotificationPayload.hsoundNotification
Returns the sound notification.
- (id<KGSoundNotification>)soundNotificationReturn Value
KGSoundNotification object
Declared In
KGNotificationPayload.h