![]() |
Notification SDK Client 4.34.0
|
#include <NotificationSDKClient.h>
Inherits NSObject.
Instance Methods | |
(typedef) | - NS_OPTIONS |
Class Methods | |
(BOOL) | + registerNotificationServiceWithNotificationSettings:error: |
(NSString *_Nullable) | + getOneSpanNotificationIdentifier:error: |
(BOOL) | + isOneSpanNotification: |
(NSString *_Nullable) | + parseOneSpanNotification:error: |
(NSString *_Nullable) | + getTitle: |
(NSString *_Nullable) | + getSubject: |
(NSNumber *_Nullable) | + getBadgeValue: |
(NSDictionary< NSString *, NSString * > *_Nullable) | + getCustomAttributes: |
This class provides the main functions of the Notification SDK Client.
+ (NSNumber *_Nullable) getBadgeValue: | (NSDictionary *) | notification |
Get the value of the badge of a OneSpan Notification.
notification | The NSDictionary provided by the system. |
+ (NSDictionary< NSString *, NSString * > *_Nullable) getCustomAttributes: | (NSDictionary *) | notification |
Get the custom Attributes of a OneSpan Notification.
notification | The NSDictionary provided by the system. |
+ (NSString *_Nullable) getOneSpanNotificationIdentifier: | (NSData *) | devToken | |
error: | (NSError **_Nullable) | error |
Get the OneSpan Notification Identifier as a string from the devToken provided by the dedicated system callback, after using the NotificationSDKClient#registerNotificationServiceWithNotificationSettings:error:
method.
devToken | received from the server in the dedicated system callback. This parameter cannot be null. |
error | a NSError raised if there is an error during the process.
|
+ (NSString *_Nullable) getSubject: | (NSDictionary *) | notification |
Get the subject from the notification provided as a NSDictionary and returns the associated content as a NString.
notification | The NSDictionary provided by the system. |
+ (NSString *_Nullable) getTitle: | (NSDictionary *) | notification |
Get the title from the notification provided as a NSDictionary and returns it as a NString.
notification | The NSDictionary provided by the system. |
+ (BOOL) isOneSpanNotification: | (NSDictionary *) | notification |
Check if the provided NSDictionary is a valid OneSpan notification.
notification | The NSDictionary provided by the system. |
- (typedef) NS_OPTIONS | (NSUInteger) | ||
(NotificationSDKClientNotificationType) |
NotificationSDKClientNotificationType object used to configure the type of interactions the created notification should have with the user and the system.
Values that can be used (composition with binary or |):
+ (NSString *_Nullable) parseOneSpanNotification: | (NSDictionary *) | notification | |
error: | (NSError **_Nullable) | error |
Parses the notification provided as a NSDictionary and returns the associated content as a NString.
notification | The NSDictionary provided by the system. |
error | a NSError raised if there is an error during the process.
|
+ (BOOL) registerNotificationServiceWithNotificationSettings: | (NotificationSDKClientNotificationType) | notificationType | |
error: | (NSError **_Nullable) | error |
Register to the Apple push notification service. The OneSpan Notification Identifier must be calculated with the NotificationSDKClient#getOneSpanNotificationIdentifier:error:
method from the success callback: (void)application:(UIApplication *)didRegisterForRemoteNotificationsWithDeviceToken:(NSData *) In case of failure, the application will be notified with the following callback: (void)application:(UIApplication *)didFailToRegisterForRemoteNotificationsWithError:(NSError *)
notificationType | notificationType to be used (NotificationSDKClientNotificationTypeBadge | NotificationSDKClientNotificationTypeSound | NotificationSDKClientNotificationTypeAlert ). |
error | a NSError raised if there is an error during the process.
|