NHN Cloud > SDK User Guide > Push > iOS

Prerequisites

  1. Install NHN Cloud SDK.
  2. Enable Notification > Push in NHN Cloud Console.
  3. Check your AppKey in Push.

APNS Guide

NHN Cloud Push Components

  • NHN Cloud Push SDK for iOS consists of the following:
Service Cocoapods Pod Name Framework Dependency Build Settings
Push NHNCloudPush NHNCloudPush.framework UserNotifications.framework

[NHNCloudVoIP]
PushKit.framework
CallKit.framework
Mandatory NHNCloudCore
NHNCloudCommon
NHNCloudCore.framework
NHNCloudCommon.framework
OTHER_LDFLAGS = (
"-ObjC",
"-lc++"
);

Apply NHN Cloud Push SDK to Xcode Projects

1. Apply using Cococapods

  • Create a Podfile and add a pod for NHN Cloud SDK.
platform :ios, '9.0'
use_frameworks!

target '{YOUR PROJECT TARGET NAME}' do
    pod 'NHNCloudPush'
end

2. Apply NHN Cloud SDK by Downloading Binaries

Frameworks Setup

  • You can download the full iOS SDK from the Downloads page of NHN Cloud.
  • Add NHNCloudPush.framework, NHNCloudCore.framework, NHNCloudCommon.framework, UserNotifications.framework to your Xcode Project.
  • UserNotifications.framework can be added in the following way. linked_usernotifications_frameworks

Project Settings

  • Add -lc++ and -ObjC items to Other Linker Flags in Build Settings.
    • Project Target > Build Settings > Linking > Other Linker Flags other_linker_flags

Capabilities Setup

  • To use NHN Cloud Push, you must enable Push Notification and Background Modes items in Capabilities.
    • Project Target > Signing & Capabilities > + Capability > Push Notification add_capability_push_notifications
    • Project Target > Signing & Capabilities > + Capability > Background Modes add_capability_background_modes
    • In Background Modes items, Remote notifications must be enabled. capabilities

Changes for Xcode11/iOS13

  • VoIP
    • In iOS 13 or higher, if you do not report to CallKit after receiving a VoIP message, the message reception becomes restricted. (PushKit pushRegistry guide)
    • The call reception screen using CallKit must be implemented in the app.

Service Login

  • All products provided by NHN Cloud SDK (Push, IAP, Log & Crash, ...) share one user ID.

Login

  • If a user ID is not set at the time of initial token registration, it is registered using the device identifier. (Refer to the token registration section)
  • Setting or changing the user ID after token registration will update token information.
// Service login, set the user ID
[NHNCloudSDK setUserID:@"INPUT_USER_ID"];

Logout

  • Even if logout occurs, the registered token is not deleted.
// Service logout, set the user ID to nil
[NHNCloudSDK setUserID:nil];

Initialize NHN Cloud Push SDK

  • The token registration and query features cannot be used without initialization.
  • Set the Push AppKey issued from the NHN Cloud server in the NHNCloudPushConfigurationobject.
  • `In the development environment, the sandbox property of NHNCloudPushConfiguration의 must be set to YES to receive the message sent using the development certificate.'

Specification for Initialization API

// Initialize and set Delegate
+ (void)initWithConfiguration:(NHNCloudPushConfiguration *)configuration
                     delegate:(nullable id<NHNCloudPushDelegate>)delegate;

// Initialize
+ (void)initWithConfiguration:(NHNCloudPushConfiguration *)configuration;

// Set Delegate
+ (void)setDelegate:(nullable id<NHNCloudPushDelegate>)delegate;

Specification for Delegate API

  • When receiving a notification message while the app is running, the content of the received message is passed to the NHNCloudPushMessage object.
  • When the app is launched by the user executing (clicking) the notification, the content of the executed notification message is passed to the NHNCloudPushMessage object.
  • When the user executes (clicks) the button on the notification, the action information of the executed button is passed to the NHNCloudPushNotificationAction object.
  • It is recommended to set Delegate in application:didFinishLaunchingWithOptions: function for smooth message reception.
@protocol NHNCloudPushDelegate <NSObject>

@optional

// Receive a message
- (void)didReceiveNotificationWithMessage:(NHNCloudPushMessage *)message;

// Execute notification (click)
- (void)didReceiveNotificationResponseWithMessage:(NHNCloudPushMessage *)message

// Execute notification action (button)
- (void)didReceiveNotificationAction:(NHNCloudPushNotificationAction *)action

@end

Example of Initialization and Delegate Setting

#import <NHNCloudPush/NHNCloudPush.h>

@interface AppDelegate () <UIApplicationDelegate, NHNCloudPushDelegate>

@end


@implementation AppDelegate

- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {

    // ...

    // Create a configuration object.
    NHNCloudPushConfiguration *configuration = [[NHNCloudPushConfiguration alloc] initWithAppKey:@"INPUT_YOUR_APPKEY"];

#if DEBUG
    // In the development environment (DEBUG), the sandbox property below must be set to YES to receive the message sent using the development certificate.
    configuration.sandbox = YES;
#endif

    // Set Delegate in tandem with the initialization.
    [NHNCloudPush initWithConfiguration:configuration
                               delegate:self];

    return YES;
}

#pragma mark - NHNCloudPushDelegate
// Receive a message
- (void)didReceiveNotificationWithMessage:(NHNCloudPushMessage *)message {
    // ...
}

// Notification response (execute)
- (void)didReceiveNotificationResponseWithMessage:(NHNCloudPushMessage *)message {
    // ...
}

// Execute notification action (button, reply)
- (void)didReceiveNotificationAction:(NHNCloudPushNotificationAction *)action {
    // ...
}

Notification Option Setting

Option Name Description Default
foregroundEnabled Whether to show notifications when the app is in the foreground state NO
badgeEnabled Whether to use a badge icon YES
soundEnabled Whether to use a notification sound YES
  • The default behavior is not to expose notifications when the app is in the foreground state, so if you want notifications to show up, you need to set the notification option.

Specification for Notification Option Setting API

+ (void)setNotificationOptions:(nullable NHNCloudNotificationOptions *)options;

Example of notification option setting

NHNCloudNotificationOptions *options = [[NHNCloudNotificationOptions alloc] init];
options.foregroundEnabled = YES;    // Set the use of foreground notification (default : NO)
options.badgeEnabled = YES;         // Set the use of badge icon (default : YES)
options.soundEnabled = YES;         // Set the use of notification sound (default : YES)

[NHNCloudPush setNotificationOptions:options];

Token Registration

  • Register the issued token information to the NHN Cloud server. At this time, pass whether or not to agree to receive the push (NHNCloudPushAgreement) as a parameter.
  • If this is the initial execution, request the user for permission to allow notifications. If the permission to allow notifications is not acquired, token registration fails.
  • If a user ID is not set at the time of initial token registration, it is registered using the device identifier.

Agreement Setting

  • In accordance with the provisions of the Information and Communications Network Act (Articles 50 through 50-8), when registering a token, whether or not to receive notification/advertising/night-time advertising push messages must also be inputted. When sending a message, it is automatically filtered based on whether or not the user agreed to receive it.
  • Set user notification message agreement information in the NHNCloudPushAgreement object.

Specification for token registration and agreement setting API

// Token registration and agreement setting
+ (void)registerWithAgreement:(NHNCloudPushAgreement *)agreement
            completionHandler:(nullable void (^)(NHNCloudPushTokenInfo * _Nullable tokenInfo, NSError * _Nullable error))completionHandler;

// Register a token using the previously set agreement information
+ (void)registerWithCompletionHandler:(nullable void (^)(NHNCloudPushTokenInfo * _Nullable tokenInfo, NSError * _Nullable error))completionHandler;

Example of token registration and agreement setting

NHNCloudPushAgreement *agreement = [[NHNCloudPushAgreement alloc] initWithAllowNotifications:YES]; // Agree to receive notification message
agreement.allowAdvertisements = YES;        // Agree to receive advertising notification message
agreement.allowNightAdvertisements = YES;   // Agree to receive night-time advertising notification message

[NHNCloudPush registerWithAgreement:agreement
                  completionHandler:^(NHNCloudPushTokenInfo *tokenInfo, NSError *error) {

    if (error == nil) {
        // Token registration succeeded
        NSLog(@"Successfully registered : %@", tokenInfo.deviceToken);

    } else {
        // Token registration failed
        NSLog(@"Failed to register : %@", error.localizedDescription);
    }
}];

Token Information Query

  • Query the last successfully registered token and setting information in the current device.
  • When the token information query is successful, the setting information of the token is returned to the NHNCloudPushTokenInfo object.

Specification for Token Information Query API

+ (void)queryTokenInfoWithCompletionHandler:(void (^)(NHNCloudPushTokenInfo * _Nullable tokenInfo, NSError * _Nullable error))completionHandler;

Token information query example

[NHNCloudPush queryTokenInfoWithCompletionHandler:^(NHNCloudPushTokenInfo *tokenInfo, NSError *error) {
    if (error == nil) {
        // Token information query succeeded
        NSLog(@"Successfully query token info : %@", [tokenInfo description]);

    } else {
        // Token information query failed
        NSLog(@"Failed to query token info : %@", error.localizedDescription);
    }
}];

Token Unregistration

  • Unregister the token registered in the NHN Cloud server. Unregistered tokens are excluded from targets for sending messages.
  • If you do not want to receive messages after the service logout, you must unregister the token.
  • Even if the token is unregistered, the notification permission on the device is not revoked.

Specification for Token Unregistration API

+ (void)unregisterWithCompletionHandler:(nullable void (^)(NSString * _Nullable deviceToken, NSError * _Nullable error))completionHandler;

Token unregistration example

[NHNCloudPush unregisterWithCompletionHandler:^(NSString *deviceToken, NSError *error) {
    if (error == nil) {
        // Token unregistration succeeded
        NSLog(@"Successfully unregistered token : %@", deviceToken);

    } else {
        // Token unregistration failed
        NSLog(@"Failed to unregister : %@", error.localizedDescription);
    }
}];

Rich Message

  • Rich messages represent the media (image, video, audio) in the notification, along with the notification's subject and body, and add actions such as buttons and replies.
  • Rich message reception is supported in iOS 10.0+ or higher.
  • To represent rich messages, you need to implement Notification Service Extension that inherits and implements NHNCloudPushServiceExtension in the user application. (Refer to the Notification Service Extension section below for how to add the Notification Service Extension)

Supported Rich Messages

Button

Type Feature Action
Open App (OPEN_APP) Run the application NHNCloudPushNotificationActionOpenApp
Open URL (OPEN_URL) Go to URL
(run Web URL address or app's custom scheme)
NHNCloudPushNotificationActionOpenURL
Reply (REPLY) Send a reply from notification NHNCloudPushNotificationActionReply
Cancel (DISMISS) Cancel the current notification NHNCloudPushNotificationActionDismiss

Up to 3 buttons per message are supported.

Media

Type Supported formats Maximum size Recommendations
Image JPEG, PNG, GIF 10 MB Landscape image is recommended
Max size: 1038 x 1038
Video MPEG, MPEG3Video, MPEG4, AVIMovie 50 MB
Sound WaveAudio, MP3, MPEG4Audio 5 MB

When a web URL is used, it takes time to download media files.

Metric Collection

  • This feature collects metrics for push message reception and user notification execution in the client and sends them to the NHN Cloud server.
  • The collected data can be viewed in the Statistics tab.
  • To collect metrics, an Appkey must be defined in Push SDK initialization or info.plist file.

Received Metric Collection Setting

  • Received metrics collection is supported in iOS 10.0+ or higher.
  • Received metrics are automatically collected by the NHN Cloud Push SDK that was added to the Notification Service Extension.
  • To collect received metrics, you need to implement Notification Service Extension that inherits and implements NHNCloudPushServiceExtension in the user application. (Refer to the Notification Service Extension section below for how to add the Notification Service Extension)
  • To enable the collection of received metrics, an Appkey must be defined in the NHN Cloud Push SDK initialization in the Notification Service Extension constructor or extension's info.plist file.

Example of received metrics collection setting through initialization

  • `The application and extension are installed together, but since they are on separate sandbox environments, the initialization must be performed in the extension in addition to the initialization in the application.'
@implementation NotificationService

- (instancetype)init {
    self = [super init];

    if (self) {
        // Only AppKey needs to be set, because it is used only for sending metrics.
        NHNCloudPushConfiguration *configuration = [[NHNCloudPushConfiguration alloc] initWithAppKey:@"INPUT_YOUR_APPKEY"];

        [NHNCloudPush initWithConfiguration:configuration];
    }

    return self;
}

@end

Example of received metrics collection setting through info.plist definition

  • Property List

plist_ext

  • Source Code
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">

<key>NHNCloudSDK</key>
<dict>
    <key>NHNCloudPush</key>
    <dict>
        <key>AppKey</key>
        <string>[INPUT_YOUR_APPKEY]</string>
    </dict>
</dict>

Opened Metric Collection Setting

  • Opened metrics are automatically collected from the NHN Cloud Push SDK that was added to the application.
  • To enable the collection of opened metrics, an Appkey must be defined in the NHN Cloud Push SDK initialization or application's info.plist file.

Example of opened metrics collection setting through info.plist definition

  • Property List

plist_app

  • Source Code
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">

<key>NHNCloudSDK</key>
<dict>
    <key>NHNCloudPush</key>
    <dict>
        <key>AppKey</key>
        <string>[INPUT_YOUR_APPKEY]</string>
    </dict>
</dict>

Notification Service Extension

  • This is supported from iOS 10.0+.
  • To collect rich messages and received metrics, Notification Service Extension that inherits and implements NHNCloudPushServiceExtension must be implemented in the application.

Create Notification Service Extension

  • File New > Target > iOS > Notification Service Extension create_ext

Notification Service Extension Setting

  • Add the extension's Project Settings in the same way as the app's project settings.
  • `The extension for iOS is installed along with the app, but they do not share a container because it is on a separate sandbox environment which is separate from the app.'

Notification Service Extension Setting Example

  • The generated NotificationService class must inherit NHNCloudPushServiceExtension .
  • If there is no separate custom processing logic, the rich message and received metrics collection feature works just by inheritance.
#import <UserNotifications/UserNotifications.h>
#import <NHNCloudPush/NHNCloudPush.h>

@interface NotificationService : NHNCloudPushServiceExtension

@end

User Tag

  • The User Tag feature binds multiple user IDs in one tag and uses it to send messages.
  • It operates based on the tag ID (8-character string) rather than the tag name, and the tag ID can be created and checked in the Console > Tag menu.

Specification for User Tag Setting API

// Add the tag ID list of the user ID
+ (void)addUserTagWithIdentifiers:(NSSet<NSString *> *)tagIdentifiers
                completionHandler:(nullable void (^)(NSSet<NSString *> * _Nullable tagIdentifiers, NSError * _Nullable error))completionHandler;

// Update the tag ID list of the user ID
+ (void)setUserTagWithIdentifiers:(nullable NSSet<NSString *> *)tagIdentifiers
                completionHandler:(nullable void (^)(NSError * _Nullable error))completionHandler;

// Acquire the tag ID list of the user ID
+ (void)getUserTagWithCompletionHandler:(void (^)(NSSet<NSString *> * _Nullable tagIdentifiers, NSError * _Nullable error))completionHandler;

// Delete the tag ID list of the user ID
+ (void)removeUserTagWithIdentifiers:(NSSet<NSString *> *)tagIdentifiers
                   completionHandler:(nullable void (^)(NSSet<NSString *> * _Nullable tagIdentifiers, NSError * _Nullable error))completionHandler;

// Delete all tags of the user ID
+ (void)removeAllUserTagWithCompletionHandler:(nullable void (^)(NSError * _Nullable error))completionHandler;

Modify User Tags

Example of modifying user tags

  • Adds or updates the inputted tag ID list and returns the resulting tag ID list.
// Create a tag ID list to add
NSMutableSet<NSString *> *tagIDs = [NSMutableSet set];
[tagIDs addObject:TAG_ID_1];    // e.g. "ZZPP00b6" (8-character string)
[tagIDs addObject:TAG_ID_2];

// Add the tag ID list of the logged-in user ID
[NHNCloudPush addUserTagWithIdentifiers:tagIDs
                      completionHandler:^(NSSet<NSString *> *tagIdentifiers, NSError *error) {

    if (error == nil) {
        // Adding the tag ID list succeeded
    } else {
        // Adding the tag ID list failed
    }
}];

// Update the tag ID list of the logged-in user ID (Existing tag ID list is deleted and set to the inputted value)
[NHNCloudPush setUserTagWithIdentifiers:tagIDs
                      completionHandler:^(NSError *error) {

    if (error == nil) {
        // Updating the tag ID list succeeded
    } else {
        // Updating the tag ID list failed
    }
}];

Retrieve User Tags

  • Returns a list of all tag IDs registered to the current user.

Example of retrieving user tags

// Returns the whole tag ID list of the logged-in user ID
[NHNCloudPush getUserTagWithCompletionHandler:^(NSSet<NSString *> *tagIdentifiers, NSError *error) {
    if (error == nil) {
        // Tag ID list retrieval succeeded
    } else {
        // Tag ID list retrieval failed
    }
}];

Delete User Tags

Example of deleting user tags

  • Deletes the inputted user tag ID list and returns the resulting tag ID list.
// Create a tag ID list to delete
NSMutableSet<NSString *> *tagIDs = [NSMutableSet set];
[tagIDs addObject:TAG_ID_1];    // e.g. "ZZPP00b6" (8-character string)
[tagIDs addObject:TAG_ID_2];

// Delete the tag ID list of the logged-in user ID
[NHNCloudPush removeUserTagWithIdentifiers:tagIDs
                         completionHandler:^(NSSet<NSString *> *tagIdentifiers, NSError *error) {
    if (error == nil) {
        // Deleting the tag ID list succeeded
    } else {
        // Deleting the tag ID list failed
    }
}];

// Delete the whole tag ID list of the logged-in user ID
[NHNCloudPush removeAllUserTagWithCompletionHandler:^(NSError *error) {
    if (error == nil) {
        // Deleting the whole user tag succeeded
    } else {
        // Deleting the whole user tag failed
    }
}];

VoIP

  • VoIP function is supported from iOS 10.0 or higher.

Frameworks Setup

  • To use the VoIP function of NHN Cloud Push, you need to add PushKit.framework and CallKit.framework.
  • PushKit.framework and CallKit.framework can be added in the following way. linked_pushkit_frameworks linked_callkit_frameworks linked_frameworks_push

Capabilities Setup

  • Project Target > Signing & Capabilities > + Capability > Background Modes add_capability_background_modes

  • Voice over IP must be enabled. capabilities

Initialization

  • VoIP function is available only when NHN Cloud Push SDK initialization has been performed.
  • The VoIP function is separated as a submodule of the NHN Cloud Push SDK.

Delegate Setting

  • When a VoIP message is received, the content of the received message is passed to the NHNCloudPushMessage object.
  • It is recommended to set Delegate in application:didFinishLaunchingWithOptions: function for smooth message reception.

Specification for Delegate API

@protocol NHNCloudVoIPDelegate <NSObject>

// Receive a message
- (void)didReceiveIncomingVoiceCallWithMessage:(NHNCloudPushMessage *)message;

@end

Delegate setting example

// Add the VoIP submodule.
#import <NHNCloudPush/NHNCloudVoIP.h>

@interface AppDelegate () <UIApplicationDelegate, NHNCloudVoIPDelegate>

@end


@implementation AppDelegate

- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {

    // ...

    // Set Delegate.
    [NHNCloudVoIP setDelegate:self];

    return YES;
}

#pragma mark - NHNCloudVoIPDelegate
// Receive a message
- (void)didReceiveIncomingVoiceCallWithMessage:(NHNCloudPushMessage *)message {
    // ...
}

Token Registration

  • Register the issued VoIP token information to the NHN Cloud server.
  • VoIP function does not require separate user permission and agreement information.

Specification for Token Registration API

+ (void)registerWithCompletionHandler:(nullable void (^)(NHNCloudPushTokenInfo * _Nullable tokenInfo, NSError * _Nullable error))completionHandler;

Token registration example

[NHNCloudVoIP registerWithCompletionHandler:^(NHNCloudPushTokenInfo *tokenInfo, NSError *error) {
    if (error == nil) {
        // Token registration succeeded
        NSLog(@"Successfully registered : %@", tokenInfo.deviceToken);

    } else {
        // Token registration failed
        NSLog(@"Failed to register : %@", error.localizedDescription);
    }
}];

Token Information Query

  • Query the last successfully registered token and setting information in the current device.
  • When the token information query is successful, the setting information of the token is returned to the NHNCloudPushTokenInfo object.

Specification for Token Information Query API

@interface NHNCloudVoIP : NSObject
+ (void)queryTokenInfoWithCompletionHandler:(void (^)(NHNCloudPushTokenInfo * _Nullable tokenInfo, NSError * _Nullable error))completionHandler;

Token information query example

[NHNCloudVoIP queryTokenInfoWithCompletionHandler:^(NHNCloudPushTokenInfo *tokenInfo, NSError *error) {
    if (error == nil) {
        // Token information query succeeded
        NSLog(@"Successfully query token info : %@", [tokenInfo description]);

    } else {
        // Token information query failed
        NSLog(@"Failed to query token info : %@", error.localizedDescription);
    }
}];

Token Unregistration

  • Unregister the token registered in the NHN Cloud server. Unregistered tokens are excluded from targets for sending messages.
  • If you do not want to receive messages after the service logout, you must unregister the token.

Specification for Token Unregistration API

+ (void)unregisterWithCompletionHandler:(nullable void (^)(NSString * _Nullable deviceToken, NSError * _Nullable error))completionHandler;

Token unregistration example

[NHNCloudVoIP unregisterWithCompletionHandler:^(NSString *deviceToken, NSError *error) {
    if (error == nil) {
        // Token unregistration succeeded
        NSLog(@"Successfully unregistered token : %@", deviceToken);

    } else {
        // Token unregistration failed
        NSLog(@"Failed to unregister : %@", error.localizedDescription);
    }
}];

Error Codes

Push Function Error Code

extern NSErrorDomain const NHNCloudPushErrorDomain;

typedef NS_ERROR_ENUM(NHNCloudPushErrorDomain, NHNCloudPushError) {
    NHNCloudPushErrorUnknown = 0,              // Unknown
    NHNCloudPushErrorNotInitialized = 1,       // Not initialized
    NHNCloudPushErrorUserInvalid = 2,          // User ID unset
    NHNCloudPushErrorPermissionDenied = 3,     // Failed to obtain permission
    NHNCloudPushErrorSystemFailed = 4,         // Failure by the system
    NHNCloudPushErrorTokenInvalid = 5,         // Token value unavailable or invalid
    NHNCloudPushErrorAlreadyInProgress = 6,    // Already in progress
    NHNCloudPushErrorParameterInvalid = 7,     // Parameter error
    NHNCloudPushErrorNotSupported = 8,         // Unsupported feature
};

Network Error Codes

extern NSErrorDomain const NHNCloudNHNCloudHttpErrorDomain;

typedef NS_ERROR_ENUM(NHNCloudHttpErrorDomain, NHNCloudHttpError) {
    NHNCloudHttpErrorNetworkNotAvailable = 100,        // Network unavailable
    NHNCloudHttpErrorRequestFailed = 101,              // HTTP status code is not 200, or the server could not read the request properly
    NHNCloudHttpErrorRequestTimeout = 102,             // Timeout
    NHNCloudHttpErrorRequestInvalid = 103,             // Invalid request (parameter error, etc.)
    NHNCloudHttpErrorURLInvalid = 104,                 // URL error
    NHNCloudHttpErrorResponseInvalid = 105,            // Server response error
    NHNCloudHttpErrorAlreadyInprogress = 106,          // Same request is already in progress
    NHNCloudHttpErrorRequiresSecureConnection = 107,   // Allow Arbitrary Loads unset
};

NHN Cloud Push Class Reference

NHNCloudPushConfiguration

  • Push setting information passed when NHN Cloud Push is initialized.
@interface NHNCloudPushConfiguration : NSObject

// Service AppKey
@property (nonatomic, copy, readonly) NSString *appKey;

// Service zone
@property (nonatomic) NHNCloudServiceZone serviceZone;

// Country code (the country code used as a basis time for sending reserved messages)
@property (nonatomic, copy) NSString *countryCode;

// Language code (criteria for language selection when sending multi-language messages)
@property (nonatomic, copy) NSString *languageCode;

// Timezone
@property (nonatomic, copy) NSString *timezone;

// Sandbox (Debug) environment setting
@property (nonatomic) BOOL sandbox;


+ (instancetype)configurationWithAppKey:(NSString *)appKey;

- (instancetype)initWithAppKey:(NSString *)appKey;

@end

NHNCloudNotificationOptions

  • Notification setting information passed when NHN Cloud Push is initialized.
@interface NHNCloudNotificationOptions : NSObject

// Whether to expose the notification when the app is running
@property (nonatomic) BOOL foregroundEnabled;

// Whether to use a badge icon
@property (nonatomic) BOOL badgeEnabled;

// Whether to use notification sound
@property (nonatomic) BOOL soundEnabled;

@end

NHNCloudPushAgreement

@interface NHNCloudPushAgreement : NSObject

// Whether to agree to show notification
@property (nonatomic, assign) BOOL allowNotifications;

// Whether to agree to show advertising notification
@property (nonatomic, assign) BOOL allowAdvertisements;

// Whether to agree to show night-time advertising notification
@property (nonatomic, assign) BOOL allowNightAdvertisements;


+ (instancetype)agreementWithAllowNotifications:(BOOL)allowNotifications;

* (instancetype)initWithAllowNotifications:(BOOL)allowNotifications;

@end

NHNCloudPushMessage

  • An object returned when receiving a message.
@interface NHNCloudPushMessage : NSObject

@property (nonatomic, readonly) NSString *identifier;

@property (nonatomic, readonly, nullable) NSString *title;

@property (nonatomic, readonly, nullable) NSString *body;

@property (nonatomic, readonly) NSInteger badge;

@property (nonatomic, readonly, nullable) NHNCloudPushRichMessage *richMessage;

@property (nonatomic, readonly) NSDictionary<NSString *, NSString *> *payload;

@end

NHNCloudPushMessage

  • An object containing the contents of the rich message among the received message contents.
@interface NHNCloudPushRichMessage : NSObject

@property (nonatomic, readonly, nullable) NHNCloudPushMedia *media;

@property (nonatomic, readonly, nullable) NSArray<NHNCloudPushButton *> *buttons;

@end

NHNCloudPushMedia

  • An object containing media contents among the received rich messages.
@interface NHNCloudPushMedia : NSObject

@property (nonatomic, readonly) NHNCloudPushMediaType mediaType;

@property (nonatomic, readonly) NSString *source;

@end

NHNCloudPushButton

  • An object containing the button contents among the received rich message contents.
@interface NHNCloudPushButton : NSObject

@property (nonatomic, readonly) NSString *identifier;

@property (nonatomic, readonly) NHNCloudPushButtonType buttonType;

@property (nonatomic, readonly) NSString *name;

@property (nonatomic, readonly, nullable) NSString *link;

@property (nonatomic, readonly, nullable) NSString *hint;

@property (nonatomic, readonly, nullable) NSString *submit;

@end

NHNCloudPushNotificationAction

  • An object returned when notification action (button, reply) is received.
typedef NS_ENUM(NSInteger, NHNCloudPushNotificationActionType) {
    NHNCloudPushNotificationActionDismiss = 0,
    NHNCloudPushNotificationActionOpenApp = 1,
    NHNCloudPushNotificationActionOpenURL = 2,
    NHNCloudPushNotificationActionReply = 3,
};


@interface NHNCloudPushNotificationAction : NSObject <NSCoding, NSCopying>

@property (nonatomic, readonly) NSString *actionIdentifier;

@property (nonatomic, readonly) NSString *categoryIdentifier;

@property (nonatomic, readonly) NHNCloudPushNotificationActionType actionType;

@property (nonatomic, readonly) NHNCloudPushButton *button;

@property (nonatomic, readonly) NHNCloudPushMessage *message;

@property (nonatomic, readonly, nullable) NSString *userText;

@end

NHNCloudPushTokenInfo

  • A token information object returned when requesting token information query.
typedef NSString *NHNCloudPushType NS_STRING_ENUM;
// APNS type
extern NHNCloudPushType const NHNCloudPushTypeAPNS;
// VoIP type
extern NHNCloudPushType const NHNCloudPushTypeVoIP;


@interface NHNCloudPushTokenInfo : NSObject

// User ID
@property (nonatomic, readonly) NSString *userID;

// Token
@property (nonatomic, readonly) NSString *deviceToken;

// Country code
@property (nonatomic, readonly) NSString *countryCode;

// Language setting
@property (nonatomic, readonly) NSString *languageCode;

// Push token type
@property (nonatomic, readonly) NHNCloudPushType pushType;

// Whether to agree to show notification
@property (nonatomic, readonly) BOOL allowNotifications;

// Whether to agree to show advertising notification
@property (nonatomic, readonly) BOOL allowAdvertisements;

// Whether to agree to show night-time advertising notification
@property (nonatomic, readonly) BOOL allowNightAdvertisements;

// Timezone
@property (nonatomic, readonly) NSString *timezone;

// Token update time
@property (nonatomic, readonly) NSString *updateDateTime;

// Whether the token is registered in the sandbox environment
@property (nonatomic, getter=isSandbox) BOOL sandbox;

@end
Table of Contents
TOP