Conforms to NSObject
Declared in KGAlertNotification.h

Overview

KGAlertNotification provides APIs to construct JSON alert payload to be sent to the Apple Push Notification Service(APNS) from an application. The application developers can use this class to create notifications that cater to their specific needs.

Tasks

  • – actionKey

    Returns the resource-bundle key for the action button in the alert notification. Returns nil if the key is not set. If the resource-bundle key is not set, the action button is rendered with “View” label.

         required method
  • – setActionKey:

    Sets the resource-bundle key for the action button in the alert notification.

         required method
  • – launchImage

    Returns the image file name that will be used as part of the alert notification. Returns nil if the image file name is not specified.

         required method
  • – setLaunchImage:

    Sets the image file name to be used as part of the alert notification.

         required method
  • – toJSON

    Returns JSON formatted payload for the alert notification to be sent to the APNS service.

         required method

Instance Methods

actionKey

Returns the resource-bundle key for the action button in the alert notification. Returns nil if the key is not set. If the resource-bundle key is not set, the action button is rendered with “View” label.

- (NSString *)actionKey

Return Value

NSString representing the resource-bundle key for the action button

Declared In

KGAlertNotification.h

launchImage

Returns the image file name that will be used as part of the alert notification. Returns nil if the image file name is not specified.

- (NSString *)launchImage

Return Value

NSString representing the image file name

Declared In

KGAlertNotification.h

setActionKey:

Sets the resource-bundle key for the action button in the alert notification.

- (void)setActionKey:(NSString *)actionKey

Parameters

actionKey

NSString representing the resource-bundle key for the action button

Declared In

KGAlertNotification.h

setLaunchImage:

Sets the image file name to be used as part of the alert notification.

- (void)setLaunchImage:(NSString *)filename

Parameters

filename

NSString representing the image filename

Declared In

KGAlertNotification.h

toJSON

Returns JSON formatted payload for the alert notification to be sent to the APNS service.

- (NSString *)toJSON

Return Value

NSString representing the JSON payload

Declared In

KGAlertNotification.h