开发者社区 问答 正文

iOS API是什么?(1)



1. CloudPushSDK接口


【注意】提供回调的接口均为异步执行。


1.1 基本信息获取




SDK初始化

  • 输入appKey和appSecret初始化推送SDK。


参数

  • appKey AppKey
  • appSecret AppSecret
  • callback 回调
  1. [backcolor=transparent]+[backcolor=transparent] [backcolor=transparent]([backcolor=transparent]void[backcolor=transparent])[backcolor=transparent]asyncInit[backcolor=transparent]:([backcolor=transparent]NSString[backcolor=transparent] [backcolor=transparent]*)[backcolor=transparent]appKey
  2. [backcolor=transparent]        appSecret[backcolor=transparent]:([backcolor=transparent]NSString[backcolor=transparent] [backcolor=transparent]*)[backcolor=transparent]appSecret
  3. [backcolor=transparent]         callback[backcolor=transparent]:([backcolor=transparent]CallbackHandler[backcolor=transparent])[backcolor=transparent]callback[backcolor=transparent];


打开调试日志

  • 打开推送SDK日志;
  • 测试时可选择打开,App上线后建议关闭。
  1. [backcolor=transparent]+[backcolor=transparent] [backcolor=transparent]([backcolor=transparent]void[backcolor=transparent])[backcolor=transparent]turnOnDebug[backcolor=transparent];



获取SDK版本号

  • 版本号也可以在CloudPushSDK.h中查看。


返回

  • SDK版本号。
  1. [backcolor=transparent]+[backcolor=transparent] [backcolor=transparent]([backcolor=transparent]NSString[backcolor=transparent] [backcolor=transparent]*)[backcolor=transparent]getVersion[backcolor=transparent];



获取推送通道状态

  • 查询推送应用内通道状态。


返回

  • 推送通道是否打开。
  1. [backcolor=transparent]+[backcolor=transparent] [backcolor=transparent]([backcolor=transparent]BOOL[backcolor=transparent])[backcolor=transparent]isChannelOpened[backcolor=transparent];



获取设备deviceId

  • deviceId为阿里云移动推送过程中对设备的唯一标识(并不是设备UUID/UDID);
  • 推送通道正确打开(需要联网)后,可以获取。


返回

  • 设备唯一标识deviceId。
  1. [backcolor=transparent]+[backcolor=transparent] [backcolor=transparent]([backcolor=transparent]NSString[backcolor=transparent] [backcolor=transparent]*)[backcolor=transparent]getDeviceId[backcolor=transparent];



1.2 账号API




绑定账号

  • 将应用内账号和推送通道相关联,可以实现按账号的定点消息推送;
  • 设备只能绑定一个账号,同一账号可以绑定到多个设备;
  • 同一设备更换绑定账号时无需进行解绑,重新调用绑定账号接口即可覆盖生效;
  • 若业务场景需要先解绑后绑定,在解绑账号成功回调中进行绑定绑定操作,以此保证执行的顺序性;
  • 账户名设置支持64字节。


参数

  • account 绑定账号名
  • callback 回调
  1. [backcolor=transparent]+[backcolor=transparent] [backcolor=transparent]([backcolor=transparent]void[backcolor=transparent])[backcolor=transparent]bindAccount[backcolor=transparent]:([backcolor=transparent]NSString[backcolor=transparent] [backcolor=transparent]*)[backcolor=transparent]account
  2. [backcolor=transparent]       withCallback[backcolor=transparent]:([backcolor=transparent]CallbackHandler[backcolor=transparent])[backcolor=transparent]callback[backcolor=transparent];



解绑账号

  • 将应用内账号和推送通道取消关联。


参数

  • callback 回调
  1. [backcolor=transparent]+[backcolor=transparent] [backcolor=transparent]([backcolor=transparent]void[backcolor=transparent])[backcolor=transparent]unbindAccount[backcolor=transparent]:([backcolor=transparent]CallbackHandler[backcolor=transparent])[backcolor=transparent]callback[backcolor=transparent];



1.3 标签API




绑定标签

  • 绑定标签到指定目标;
  • 支持向设备、账号和别名绑定标签,绑定类型由参数target指定;
  • 绑定标签在10分钟内生效;
  • App最多支持绑定1万个标签【请谨慎使用,避免标签绑定达到上限】,单个标签最大支持128字符。


参数

  • target 目标类型,1:本设备;2:本设备绑定账号;3:别名
  • tags 标签(数组输入)
  • alias 别名(仅当target = 3时生效)
  • callback 回调
  1. [backcolor=transparent]+[backcolor=transparent] [backcolor=transparent]([backcolor=transparent]void[backcolor=transparent])[backcolor=transparent]bindTag[backcolor=transparent]:([backcolor=transparent]int[backcolor=transparent])[backcolor=transparent]target
  2. [backcolor=transparent]       withTags[backcolor=transparent]:([backcolor=transparent]NSArray[backcolor=transparent] [backcolor=transparent]*)[backcolor=transparent]tags
  3. [backcolor=transparent]      withAlias[backcolor=transparent]:([backcolor=transparent]NSString[backcolor=transparent] [backcolor=transparent]*)[backcolor=transparent]alias
  4. [backcolor=transparent]   withCallback[backcolor=transparent]:([backcolor=transparent]CallbackHandler[backcolor=transparent])[backcolor=transparent]callback[backcolor=transparent];



解绑标签

  • 解绑指定目标标签;
  • 支持解绑设备、账号和别名标签,解绑类型由参数target指定;
  • 解绑标签在10分钟内生效;
  • 解绑标签不等同于删除标签,目前不支持标签的删除。


参数

  • target 目标类型,1:本设备;2:本设备绑定账号;3:别名
  • tags 标签(数组输入)
  • alias 别名(仅当target = 3时生效)
  • callback 回调
  1. [backcolor=transparent]+[backcolor=transparent] [backcolor=transparent]([backcolor=transparent]void[backcolor=transparent])[backcolor=transparent]unbindTag[backcolor=transparent]:([backcolor=transparent]int[backcolor=transparent])[backcolor=transparent]target
  2. [backcolor=transparent]         withTags[backcolor=transparent]:([backcolor=transparent]NSArray[backcolor=transparent] [backcolor=transparent]*)[backcolor=transparent]tags
  3. [backcolor=transparent]        withAlias[backcolor=transparent]:([backcolor=transparent]NSString[backcolor=transparent] [backcolor=transparent]*)[backcolor=transparent]alias
  4. [backcolor=transparent]     withCallback[backcolor=transparent]:([backcolor=transparent]CallbackHandler[backcolor=transparent])[backcolor=transparent]callback[backcolor=transparent];



查询标签

  • 查询目标绑定标签,当前仅支持查询设备标签;
  • 查询结果可从callback的data中获取;
  • 标签绑定成功且生效(10分钟内)后即可查询。


参数

  • target 目标类型,1:本设备
  • callback 回调
  1. [backcolor=transparent]+[backcolor=transparent] [backcolor=transparent]([backcolor=transparent]void[backcolor=transparent])[backcolor=transparent]listTags[backcolor=transparent]:([backcolor=transparent]int[backcolor=transparent])[backcolor=transparent]target
  2. [backcolor=transparent]    withCallback[backcolor=transparent]:([backcolor=transparent]CallbackHandler[backcolor=transparent])[backcolor=transparent]callback[backcolor=transparent];



1.4 别名API




添加别名

  • 设备添加别名;
  • 单个设备最多添加128个别名,且同一别名最多添加到128个设备;
  • 别名支持128字节。


参数

  • alias 别名
  • callback 回调
  1. [backcolor=transparent]+[backcolor=transparent] [backcolor=transparent]([backcolor=transparent]void[backcolor=transparent])[backcolor=transparent]addAlias[backcolor=transparent]:([backcolor=transparent]NSString[backcolor=transparent] [backcolor=transparent]*)[backcolor=transparent]alias
  2. [backcolor=transparent]    withCallback[backcolor=transparent]:([backcolor=transparent]CallbackHandler[backcolor=transparent])[backcolor=transparent]callback[backcolor=transparent];



删除别名

  • 删除设备别名;
  • 支持删除指定别名和删除全部别名(alias为nil or length = 0)。


参数

  • alias 别名(alias为nil or length = 0时,删除设备全部别名)
  • callback 回调
  1. [backcolor=transparent]+[backcolor=transparent] [backcolor=transparent]([backcolor=transparent]void[backcolor=transparent])[backcolor=transparent]removeAlias[backcolor=transparent]:([backcolor=transparent]NSString[backcolor=transparent] [backcolor=transparent]*)[backcolor=transparent]alias
  2. [backcolor=transparent]       withCallback[backcolor=transparent]:([backcolor=transparent]CallbackHandler[backcolor=transparent])[backcolor=transparent]callback[backcolor=transparent];



查询别名

  • 查询设备别名;
  • 查询结果可从callback的data中获取。


参数

  • callback 回调
  1. [backcolor=transparent]+[backcolor=transparent] [backcolor=transparent]([backcolor=transparent]void[backcolor=transparent])[backcolor=transparent]listAliases[backcolor=transparent]:([backcolor=transparent]CallbackHandler[backcolor=transparent])[backcolor=transparent]callback[backcolor=transparent];



1.5 deviceToken API




上报设备deviceToken

  • 向阿里云推送注册该设备的deviceToken;
  • 可在APNs注册成功回调中调用该接口。


参数

  • deviceToken 苹果APNs服务器返回的deviceToken
  • callback 回调
  1. [backcolor=transparent]+[backcolor=transparent] [backcolor=transparent]([backcolor=transparent]void[backcolor=transparent])[backcolor=transparent]registerDevice[backcolor=transparent]:([backcolor=transparent]NSData[backcolor=transparent] [backcolor=transparent]*)[backcolor=transparent]deviceToken
  2. [backcolor=transparent]          withCallback[backcolor=transparent]:([backcolor=transparent]CallbackHandler[backcolor=transparent])[backcolor=transparent]callback[backcolor=transparent];



获取设备deviceToken

  • 返回获取APNs返回的deviceToken;
  • 调用registerDevice()接口后可获取。


返回

  • 设备deviceToken。
  1. [backcolor=transparent]+[backcolor=transparent] [backcolor=transparent]([backcolor=transparent]NSString[backcolor=transparent] [backcolor=transparent]*)[backcolor=transparent]getApnsDeviceToken[backcolor=transparent];



1.6 通知上报API




上报“通知点击事件”

  • 上报“通知点击事件”ACK到推送服务器;
  • 用于替换SDK v1.8.1之前的handleLaunching:和handleReceiveRemoteNotification:上报接口;


参数

  • userInfo 通知payload
  1. [backcolor=transparent]+[backcolor=transparent] [backcolor=transparent]([backcolor=transparent]void[backcolor=transparent])[backcolor=transparent]sendNotificationAck[backcolor=transparent]:([backcolor=transparent]NSDictionary[backcolor=transparent] [backcolor=transparent]*)[backcolor=transparent]userInfo[backcolor=transparent];

展开
收起
猫饭先生 2017-10-23 11:06:59 1408 分享 版权
0 条回答
写回答
取消 提交回答