KGLocalizedAlertNotification Class Reference
| Inherits from | NSObject |
| Conforms to | KGAlertNotification |
| Declared in | KGLocalizedAlertNotification.h |
Overview
KGLocalizedAlertNotification is a concrete class that implements KGAlertNotification protocol. Using KGLocalizedAlertNotification class, an application developer can create sophisticated payloads involving resource keys that are agnostic of the device locale. When the notification is received by the device, iOS will automatically resolve the resource key to a specific string from the appropriate resource-bundle based on the device locale and format the parameters.
Tasks
-
– initWithLocalizationKey:Creates an instance of KGLocalizedAlertNotification with resource key for the alert message.
-
– initWithLocalizationKey:localizationArgs:Creates an instance of KGLocalizedAlertNotification with resource key for the alert message which includes type specifiers for formatting.
-
– initWithLocalizationKey:localizationArgs:actionKey:Creates an instance of KGLocalizedAlertNotification with resource key for the alert message which includes type specifiers for formatting.
-
– initWithLocalizationKey:localizationArgs:actionKey:image:Creates an instance of KGLocalizedAlertNotification with resource key for the alert message which includes type specifiers for formatting.
-
– localizationKeyReturns the localization key of the alert message that will be rendered when the remote notification is received from APNS based on the device locale.
-
– setLocalizationKey:Sets the localization key of the alert message that will be rendered when the notification is received from APNS based based on the device locale.
-
– localizationArgsReturns NSArray of NSString objects representing the names of the properties that the Gateway will use to patch the payload.
-
– setLocalizationArgs:Sets the NSArray of NSString objects representing the names of the properties that the Gateway will use to patch the payload before sending the payload to to APNS.
Instance Methods
initWithLocalizationKey:
Creates an instance of KGLocalizedAlertNotification with resource key for the alert message.
- (id)initWithLocalizationKey:(NSString *)locKeyParameters
- locKey
NSString representing the resource key for the alert message
Return Value
id for the newly created instance of KGLocalizedAlertNotification class
Declared In
KGLocalizedAlertNotification.hinitWithLocalizationKey:localizationArgs:
Creates an instance of KGLocalizedAlertNotification with resource key for the alert message which includes type specifiers for formatting.
- (id)initWithLocalizationKey:(NSString *)locKey localizationArgs:(NSArray *)locArgsParameters
- locKey
NSString representing the resource key for the alert message
- locArgs
NSArray representing the resource keys to be used to format the alert message
Return Value
id for the newly created instance of KGLocalizedAlertNotification class
Declared In
KGLocalizedAlertNotification.hinitWithLocalizationKey:localizationArgs:actionKey:
Creates an instance of KGLocalizedAlertNotification with resource key for the alert message which includes type specifiers for formatting.
- (id)initWithLocalizationKey:(NSString *)locKey localizationArgs:(NSArray *)locArgs actionKey:(NSString *)actionKeyParameters
- locKey
NSString representing the resource key for the alert message
- locArgs
NSArray representing the resource keys to be used to format the alert message
- actionKey
NSString representing the resource key for the action button
Return Value
id for the newly created instance of KGLocalizedAlertNotification class
Declared In
KGLocalizedAlertNotification.hinitWithLocalizationKey:localizationArgs:actionKey:image:
Creates an instance of KGLocalizedAlertNotification with resource key for the alert message which includes type specifiers for formatting.
- (id)initWithLocalizationKey:(NSString *)locKey localizationArgs:(NSArray *)locArgs actionKey:(NSString *)actionKey image:(NSString *)filenameParameters
- locKey
NSString representing the resource key for the alert message
- locArgs
NSArray representing the resource keys to be used to format the alert message
- actionKey
NSString representing the resource key for the action button
- filename
NSString representing the image file name
Return Value
id for the newly created instance of KGLocalizedAlertNotification class
Declared In
KGLocalizedAlertNotification.hlocalizationArgs
Returns NSArray of NSString objects representing the names of the properties that the Gateway will use to patch the payload.
- (NSArray *)localizationArgsReturn Value
NSArray contain the resource keys for the properties that will be used to format the alert message
Declared In
KGLocalizedAlertNotification.hlocalizationKey
Returns the localization key of the alert message that will be rendered when the remote notification is received from APNS based on the device locale.
- (NSString *)localizationKeyReturn Value
the resource key for the alert message
Declared In
KGLocalizedAlertNotification.hsetLocalizationArgs:
Sets the NSArray of NSString objects representing the names of the properties that the Gateway will use to patch the payload before sending the payload to to APNS.
- (void)setLocalizationArgs:(NSArray *)argsParameters
- args
NSArray containing the resource keys for the properties that will be used to format the alert message
Declared In
KGLocalizedAlertNotification.hsetLocalizationKey:
Sets the localization key of the alert message that will be rendered when the notification is received from APNS based based on the device locale.
- (void)setLocalizationKey:(NSString *)keyParameters
- key
NSString representing the resource key for the alert message
Declared In
KGLocalizedAlertNotification.h