接口文档

最近更新时间:2019-08-19 10:03:30

启动腾讯移动推送服务

接口说明

通过使用在腾讯移动推送官网注册的应用的信息,启动腾讯移动推送服务。

- (void)startXGWithAppID:(uint32_t)appID appKey:(nonnull NSString *)appKey delegate:(nullable id<XGPushDelegate>)delegate ;

参数说明

  • AppID:通过控制台申请的应用 ID, 即 Access ID。
  • AppKey: 通过控制台申请的 AppKey,即 Access Key。
  • Delegate:回调对象。
注意:

接口所需参数必须要正确填写,反之腾讯移动推送服务将不能正确为应用推送消息。

示例代码

[[XGPush defaultManager] startXGWithAppID: <#your access ID#>appKey:<#your access key#> delegate:<#your delegate#>];

终止腾讯移动推送服务

接口说明

终止腾讯移动推送服务以后,将无法通过腾讯移动推送服务向设备推送消息,如果再次需要接收腾讯移动推送服务的消息推送,则必须需要再次调用 startXGWithAppID:appKey:delegate: 方法重启腾讯移动推送服务。

- (void)stopXGNotification;

示例代码

[[XGPush defaultManager] stopXGNotification];

自定义通知栏消息行为

创建消息支持的行为

接口说明

在通知消息中创建一个可以点击的事件行为。

+ (nullable id)actionWithIdentifier:(nonnull NSString *)identifier title:(nonnull NSString *)title options:(XGNotificationActionOptions)options;

参数说明

  • identifier:行为唯一标识。
  • title:行为名称。
  • options:行为支持的选项。

示例代码

XGNotificationAction *action1 = [XGNotificationAction actionWithIdentifier:@"xgaction001" title:@"xgAction1" options:XGNotificationActionOptionNone];
注意:

通知栏带有点击事件的特性,仅支持 macOS10.14+ 以上的版本,此方法返回空。

创建分类对象

接口说明

创建分类对象,用以管理通知栏的 Action 对象。

+ (nullable id)categoryWithIdentifier:(nonnull NSString *)identifier actions:(nullable NSArray<XGNotificationAction *> *)actions intentIdentifiers:(nullable NSArray<NSString *> *)intentIdentifiers options:(XGNotificationCategoryOptions)options;

参数说明

  • identifier:分类对象的标识。
  • actions:当前分类拥有的行为对象组。
  • intentIdentifiers:用以表明可以通过 Siri 识别的标识。
  • options:分类的特性。
注意:

通知栏带有点击事件的特性,仅支持 macOS10.14+ 以上的版本,此方法返回空。

示例代码

XGNotificationCategory *category = [XGNotificationCategory categoryWithIdentifier:@"xgCategory" actions:@[action1, action2] intentIdentifiers:@[] options:XGNotificationCategoryOptionNone];

创建配置类

接口说明

管理推送消息通知栏的样式和特性。

+ (nullable instancetype)configureNotificationWithCategories:(nullable NSSet<XGNotificationCategory *> *)categories types:(XGUserNotificationTypes)types;

参数说明

  • categories:通知栏中支持的分类集合。
  • types:注册通知的样式。

示例代码

XGNotificationConfigure *configure = [XGNotificationConfigure configureNotificationWithCategories:[NSSet setWithObject:category] types:XGUserNotificationTypeAlert|XGUserNotificationTypeBadge|XGUserNotificationTypeSound];

角标自动加1

接口说明

调用此接口上报当前 App 角标数到腾讯移动推送服务器,客户端配置完成即可使用 macOS 角标自动加1的功能,如需使用此功能,请前往腾讯移动推送控制台,选择【创建推送】 > 【通知栏消息】 > 【常用设置】 > 【角标数字】,进行设置。

- (void)setBadge:(NSInteger)badgeNumber;

参数说明

badgeNumber: 应用的角标数。

注意:

此接口必须本地调用,否则管理台使用 macOS 角标自动加1功能时,角标会默认不变。

示例代码

[[XGPush defaultManager] setBadge:7];

管理应用角标

接口说明

管理 App 显示的角标数量。

@property (nonatomic) NSInteger xgApplicationBadgeNumber;

示例代码

// 设置应用角标
[[XGPush defaultManager] setXgApplicationBadgeNumber:0];

// 获取应用角标
NSInteger number = [[XGPush defaultManager] xgApplicationBadgeNumber];

统计推送效果

接口说明

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

API 接口
需要调用上报数据的接口

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

示例1

- (BOOL)application:(NSApplication *)application
  didFinishLaunchingWithOptions:(NSDictionary *)launchOptions 
  {
      [[XGPush defaultManager] reportXGNotificationInfo:launchOptions];
      return YES;
  }

回调接口

- (void)xgPushUserNotificationCenter:(UNUserNotificationCenter *)center willPresentNotification:(UNNotification *)notification withCompletionHandler:(void (^)(UNNotificationPresentationOptions))completionHandler;

示例2

- (void)xgPushUserNotificationCenter:(UNUserNotificationCenter *)center willPresentNotification:(UNNotification *)notification withCompletionHandler:(void (^)(UNNotificationPresentationOptions))completionHandler {
    [[XGPush defaultManager] reportXGNotificationInfo:notification.request.content.userInfo];
    completionHandler(UNNotificationPresentationOptionBadge | UNNotificationPresentationOptionSound | UNNotificationPresentationOptionAlert);
}

管理设备 Token

查询设备 Token

接口说明

查询当前应用从 APNs 获取的 Token 字符串。

@property (copy, nonatomic, nullable, readonly) NSString *deviceTokenString;

示例代码

NSString *token = [[XGPushTokenManager defaultTokenManager] deviceTokenString];

查询 APNs 注册结果

接口说明

如果注册成功,则应用会调用 NSApplicationDelegate 代理对象的回调方法如下:

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

查询腾讯移动推送注册结果

接口说明

SDK 的启动方法自动注册设备从 APNs 获取的 Token 到腾讯移动推送服务器,注册结果会在 XGPushDelegate 以下的回调方法返回。

- (void)xgPushDidRegisteredDeviceToken:(NSString *)deviceToken error:(NSError *)error;
说明:

此回调方法在注册成功之后调用,当前的 Token 已经注册过之后,SDK 将缓存注册信息,此方法将不再调用。

绑定/解绑 标签和账号

接口说明

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

单操作接口

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

参数说明

  • identifier:标签或账号。
  • 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];

批量操作接口

- (void)bindWithIdentifiers:(nonnull NSArray <NSString *> *)identifiers type:(XGPushTokenBindType)type
- (void)unbindWithIdentifers:(nonnull NSArray <NSString *> *)identifiers type:(XGPushTokenBindType)type;

参数说明

  • identifiers:标签或账号列表。
  • type:绑定类型。
注意:

暂不支持账号类型,标签字符串不允许有空格或者是 tab 字符。

批量更新标签/账号

- (void)updateBindedIdentifiers:(nonnull NSArray <NSString *> *)identifiers bindType:(XGPushTokenBindType)type;

参数说明

  • identifiers:标签标识字符串数组,标签字符串不允许有空格或者是 tab 字符。
  • type:标识类型。
说明:

  • 若指定为标签类型,此接口会将当前 Token 对应的旧有的标签全部替换为当前的标签。
  • 若指定账号类型,此接口仅取 identifiers 列表中第一个。

清除全部标签/账号

- (void)clearAllIdentifiers:(XGPushTokenBindType)type;

参数说明

type:标识类型。

查询绑定的标签和账号

接口说明

根据指定类型查询当前 Token 对象绑定的标识。

- (nullable NSArray<NSString *> *)identifiersWithType:(XGPushTokenBindType)type;

示例代码

// 查询标签
[[XGPushTokenManager defaultTokenManager] identifiersWithType:XGPushTokenBindTypeTag];
// 查询账号
[[XGPushTokenManager defaultTokenManager] identifiersWithType:XGPushTokenBindTypeAccount];

查询设备通知权限

接口说明

查询设备通知权限是否被用户允许。

- (void)deviceNotificationIsAllowed:(nonnull void (^)(BOOL isAllowed))handler;

参数说明

handler:查询结果的返回方法。

示例代码

[[XGPush defaultManager] deviceNotificationIsAllowed:^(BOOL isAllowed) {
        <#code#>
    }];

查询 SDK 版本

接口说明

查询当前 SDK 的版本。

- (nonnull NSString *)sdkVersion;

示例代码

[[XGPush defaultManager] sdkVersion];

本地推送

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