IOS SDK

目录

 [隐藏] 

• 1 简介
• 2 运行环境
• 3 功能
  • 3.1 获取AppKey
  • 3.2 上传证书
  • 3.3 工程配置
• 4 API接口
  • 4.1 注册设备信息
  • 4.2 初始化Push信息
  • 4.3 设置标签
  • 4.4 删除标签
  • 4.5 设置别名
  • 4.6 删除别名
  • 4.7 推送被打开效果统计
  • 4.8 注销App

简介

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

运行环境

iOS5.0 及以上版本。在程序启动时注册通知，参考以下代码，

- (void) registerNofitication {
[[UIApplication sharedApplication] registerForRemoteNotificationTypes:(UIRemoteNotificationTypeAlert | UIRemoteNotificationTypeBadge | UIRemoteNotificationTypeSound)];
}

- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions
{
    [self registerNofitication]; 
    return YES;
}

功能

本SDK主要提供以下功能：
1. 注册设备

• 初始化设备信息

2. 初始化Push信息

• Push服务的初始化(首次启动会进行app的注册)
• 注销App

3. 标签（Tag）

• 设置标签
• 删除标签

4. 别名（Alias）

• 设置别名
• 删除别名

5. 效果统计

• 推送点击效果(app在前台运行时)
• 推送点击效果(app不在前台运行,点击通知激活时)

获取AppKey

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

上传证书

注意：

• 请上传以pem为后缀的合法的开发证书和生产证书。

若证书验证失败，原因可能有以下几点：

• 证书制作有误，请检查证书后重试。
• 苹果服务器不能连接，请稍后连接。
• 苹果服务器判定上传证书不合格，请确认证书是否合格。

工程配置

1. 下载信鸽SDK压缩包到本地并解压；
2. 创建或打开Xcode iOS工程；
3. 将XGPush.h和libXG-SDK.a添加到Xcode工程；
4. 添加对以下libraries的引用。包括SystemConfiguration.framework , CoreTelephony.framework , AdSupport framework , libz.dylib , libXG-SDK.a

API接口

类名	说明
XGPush	Push服务，推送效果

注册设备信息

在application: didRegisterForRemoteNotificationsWithDeviceToken中调用。

函数原型

+(NSString*)registerDevice:(NSData *)deviceToken;

参数

deviceToken：
函数didRegisterForRemoteNotificationsWithDeviceToken的参数。

返回值

NSString：获取到的deviceToken字符串

示例

- (void)application:(UIApplication *)application didRegisterForRemoteNotificationsWithDeviceToken:(NSData *)deviceToken { 
   //注册设备
NSString * deviceTokenStr = [XGPush registerDevice: deviceToken];
    
   //打印获取的deviceToken的字符串
NSLog(@"deviceTokenStr is %@",deviceTokenStr);

初始化Push信息

在application: didFinishLaunchingWithOptions中调用startWithAppkey接口，初始化。

函数原型

+(void)startWithAppkey:(NSString *)appkey;

参数

appkey： 通过xg.qq.com注册app时得到的key。

返回值

无

示例

[XGPush startWithAppkey:@"da068d77a3c0f03586"];

设置标签

开发者可以针对不同的用户设置标签。

函数原型

+(void)setTag:(NSDictionary*)tag;

参数

tag： key-value键值对集合

返回值

无

示例

NSDictionary* myClassDict = [NSDictionary dictionaryWithObjectsAndKeys: @"my1Value", @"my1",@"my2Value", @"my2",@"my4Value", @"my4", nil];

 [XGPush setTag:myClassDict];

删除标签

开发者可以删除设置过的标签。

函数原型

+(void)delTag:(NSDictionary*)tag;

参数

tag： key-value键值对集合

返回值

无

示例

NSDictionary* myClassDict = [NSDictionary dictionaryWithObjectsAndKeys: @"my1Value", @"my1",@"my2Value", @"my2",@"my4Value", @"my4", nil];

 [XGPush setTag:myClassDict];

设置别名

开发者可以针对不同的设备设置别名。

函数原型

+(void)setAlias:(NSDictionary*)tag;

参数

tag： key-value键值对集合

返回值

无

示例

NSDictionary* myClassDict = [NSDictionary dictionaryWithObjectsAndKeys: @"dev1", @"ipad" , nil];

 [XGPush setAlias:myClassDict];

删除别名

开发者删除设置过的别名。

函数原型

+(void)delAlias:(NSDictionary*)tag;

参数

tag： key-value键值对集合

返回值

无

示例

NSDictionary* myClassDict = [NSDictionary dictionaryWithObjectsAndKeys: @"dev1", @"ipad" , nil];

 [XGPush delAlias:myClassDict];

推送被打开效果统计

如果需要统计由信鸽推送的点击或者打开，需要开发者在didReceiveRemoteNotification(如果没有则按照下面的示例手动添加)中调用handleReceiveNotification , 然后在didFinishLaunchingWithOptions中调用handleLaunching。

函数原型

+(void)handleReceiveNotification:(NSDictionary *)userInfo;//app在前台运行时
+(void)handleLaunching:(NSDictionary *)launchOptions;//app不在前台运行时，点击推送激活时

参数

事件本身默认的参数名

返回值

无

示例

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

- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions
{
	[XGPush handleLaunching: launchOptions];
}

注销App

注销App,不再使用信鸽的功能。

函数原型

+(void)logoutApp;

参数

无

返回值

无

示例

[XGPush logoutApp];