1. 信鸽 iOS SDK 开发指南

1.1. 简介

信鸽iOS SDK是一个能够提供Push服务的开发平台，提供给开发者简便、易用的API接口，方便快速接入。

1.2. 接入方法

(1)获取 AppId 和 AppKey

(2)工程配置

1.2.1. 获取 AppId 和 AppKey

前往http://xg.qq.com注册并获取AppKey

1.2.2. 工程配置

（1）下载信鸽 SDK, 解压缩。注：使用CocoaPods的用户可以通过如下名称管理信鸽：

pod 'QQ_XGPush'

（2）将 XGSetting.h, XGPush.h 以及 libXG-SDK.a 添加到工程

（3）添加以下库/framework 的引用 CoreTelephony.framework, SystemConfiguration.framework, UserNotifications.framework, libXG-SDK.a 以及 libz.tbd.添加完成以后,库的引用如下

library

（4）在工程配置和后台模式中打开推送,如下图

projcfg

（5）参考 Demo, 添加相关代码

1.2.3. 管理信鸽推送服务

开启 Debug

打开 Debug 模式以后可以在终端看到详细的信鸽 Debug 信息，方便定位问题

示例

//打开debug开关
[[XGPush defaultManager] setEnableDebug:YES];
//查看debug开关是否打开
BOOL debugEnabled = [[XGPush defaultManager] isEnableDebug];

启动信鸽推送服务

接口

- (void)startXGWithAppID:(uint32_t)appID appKey:(nonnull NSString *)appKey;

示例

[[XGPush defaultManager] startXGWithAppID:2200262432 appKey:@"I89WTUY132GJ"];

终止信鸽推送服务

终止信鸽推送服务以后，将无法通过信鸽推送服务向设备推送消息

接口

- (void)stopXGNotification;

示例

[[XGPush defaultManager] stopXGNotification];

统计推送效果

为了更好的了解每一条推送消息的运营效果，需要将用户对消息的行为上报

统计消息推送的抵达情况

需要在UIApplicationDelegate的回调方法(如下)中调用上报数据的接口

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

接口

- (void)reportXGNotificationInfo:(nonnull NSDictionary *)info;

示例

- (BOOL)application:(UIApplication *)application
    didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
      [[XGPush defaultManager] reportXGNotificationInfo:launchOptions];
}
统计消息被点击情况

  • iOS 10 以前的系统版本，需要在 UIApplicationDelegate 的回调方法(如下)中调用上报数据的接口

    - (void)application:(UIApplication *)application
    didReceiveRemoteNotification:(NSDictionary *)userInfo;

    接口

    - (void)reportXGNotificationInfo:(nonnull NSDictionary *)info;

    示例

    - (void)application:(UIApplication *)application
    didReceiveRemoteNotification:(NSDictionary *)userInfo {
    [[XGPush defaultManager] reportXGNotificationInfo:userInfo];
}

  • iOS 10 or later 需要在 AppDelegate中实现 UNUserNotificationCenterDelegate 的回调方法(如下)中调用上述上报接口

    - (void)userNotificationCenter:(UNUserNotificationCenter *)center
    didReceiveNotificationResponse:(UNNotificationResponse *)response
    withCompletionHandler:(void(^)())completionHandler;

    示例

    - (void)userNotificationCenter:(UNUserNotificationCenter *)center
    didReceiveNotificationResponse:(UNNotificationResponse *)response
    withCompletionHandler:(void(^)())completionHandler {
      [[XGPush defaultManager] reportXGNotificationInfo:response.notification.request.content.userInfo];

    completionHandler()
}

设置信鸽推送服务协议(XGPushDelegate)

设置信鸽推送协议代理对象是为了方便查看接口调用的情况，开发者可根据自己的需求选择实现协议的方法

示例

[[XGPush defaultManager] setDelegate:<#your delegate#>];

协议方法如下：

/**
 @brief 监控信鸽推送服务地启动情况

 @param isSuccess 信鸽推送是否启动成功
 @param error 信鸽推送启动错误的信息
 */
- (void)xgPushDidFinishStart:(BOOL)isSuccess error:(nullable NSError *)error;

/**
 @brief 监控信鸽服务的终止情况

 @param isSuccess 信鸽推送是否终止
 @param error 信鸽推动终止错误的信息
 */
- (void)xgPushDidFinishStop:(BOOL)isSuccess error:(nullable NSError *)error;


/**
 @brief 监控信鸽服务上报推送消息的情况

 @param isSuccess 上报是否成功
 @param error 上报失败的信息
 */
- (void)xgPushDidReportNotification:(BOOL)isSuccess error:(nullable NSError *)error;

管理设备Token

注册设备token

此步骤是必须的 启动推送服务以后,如果注册推送成功，则应用会调用UIApplicationDelegate代理对象的回调方法(如下)，开发者必须在其中调用注册设备token的接口

- (void)application:(UIApplication *)application didRegisterForRemoteNotificationsWithDeviceToken:(NSData *)deviceToken;

接口

- (void)registerDeviceToken:(nonnull NSData *)deviceToken;

示例

- (void)application:(UIApplication *)application
    didRegisterForRemoteNotificationsWithDeviceToken:(NSData *)deviceToken {
      [[XGPushTokenManager defaultTokenManager] registerDeviceToken:deviceToken];
}

绑定/解绑标签和账号

开发者可以针对不同的用户绑定标签,然后对该标签推送.对标签推送会让该标签下的所有设备都收到推送.一个设备可以绑定多个标签.

接口

- (void)bindWithIdentifier:(nullable NSString *)identifier type:(XGPushTokenBindType)type;
- (void)unbindWithIdentifer:(nullable NSString *)identifier type:(XGPushTokenBindType)type;

示例

绑定标签：
[[XGPushTokenManager defaultTokenManager] bindWithIdentifier:@"your tag" type:XGPushTokenBindTypeTag];

解绑标签
[[XGPushTokenManager defaultTokenManager] unbindWithIdentifer:@"your tag" type:XGPushTokenBindTypeTag];

绑定账号：
  [[XGPushTokenManager defaultTokenManager] bindWithIdentifier:@"your account" type:XGPushTokenBindTypeAccount];

解绑账号：
[[XGPushTokenManager defaultTokenManager] unbindWithIdentifer:@"your account" type:XGPushTokenBindTypeAccount];

注1: 一个设备只能绑定一个账号,绑定账号的时候前一个账号自动失效.一个账号最多绑定15台设备,超过之后会随机解绑一台设备,然后再进行注册.

管理设备Token协议(XGPushTokenManagerDelegate)

设置设备token绑定协议代理对象是为了方便查看token绑定的结果，开发者可根据自己的需求选择实现协议的方法

示例

[[XGPushTokenManager defaultTokenManager].delegatge = <#your delegate#>;

协议方法如下：

/**
 @brief 监控token对象绑定的情况

 @param identifier token对象绑定的标识
 @param type token对象绑定的类型
 @param error token对象绑定的结果信息
 */
- (void)xgPushDidBindWithIdentifier:(nullable NSString *)identifier type:(XGPushTokenBindType)type error:(nullable NSError *)error;


/**
 @brief 监控token对象解绑的情况

 @param identifier token对象绑定的标识
 @param type token对象绑定的类型
 @param error token对象绑定的结果信息
 */
- (void)xgPushDidUnbindWithIdentifier:(nullable NSString *)identifier type:(XGPushTokenBindType)type error:(nullable NSError *)error;

本地推送

本地推送相关功能请参考苹果开发者文档.

results matching ""

    No results matching ""