JPUSHService.h 29 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686
  1. /*
  2. * | | | | \ \ / / | | | | / _______|
  3. * | |____| | \ \/ / | |____| | / /
  4. * | |____| | \ / | |____| | | | _____
  5. * | | | | / \ | | | | | | |____ |
  6. * | | | | / /\ \ | | | | \ \______| |
  7. * | | | | /_/ \_\ | | | | \_________|
  8. *
  9. * Copyright (c) 2011 ~ 2017 Shenzhen HXHG. All rights reserved.
  10. */
  11. #define JPUSH_VERSION_NUMBER 3.2.2
  12. #import <Foundation/Foundation.h>
  13. @class CLRegion;
  14. @class UILocalNotification;
  15. @class CLLocation;
  16. @class UNNotificationCategory;
  17. @class UNNotificationSettings;
  18. @class UNNotificationRequest;
  19. @class UNNotification;
  20. @protocol JPUSHRegisterDelegate;
  21. @protocol JPUSHGeofenceDelegate;
  22. typedef void (^JPUSHTagsOperationCompletion)(NSInteger iResCode, NSSet *iTags, NSInteger seq);
  23. typedef void (^JPUSHTagValidOperationCompletion)(NSInteger iResCode, NSSet *iTags, NSInteger seq, BOOL isBind);
  24. typedef void (^JPUSHAliasOperationCompletion)(NSInteger iResCode, NSString *iAlias, NSInteger seq);
  25. extern NSString *const kJPFNetworkIsConnectingNotification; // 正在连接中
  26. extern NSString *const kJPFNetworkDidSetupNotification; // 建立连接
  27. extern NSString *const kJPFNetworkDidCloseNotification; // 关闭连接
  28. extern NSString *const kJPFNetworkDidRegisterNotification; // 注册成功
  29. extern NSString *const kJPFNetworkFailedRegisterNotification; //注册失败
  30. extern NSString *const kJPFNetworkDidLoginNotification; // 登录成功
  31. extern NSString *const kJPFNetworkDidReceiveMessageNotification; // 收到消息(非APNS)
  32. extern NSString *const kJPFServiceErrorNotification; // 错误提示
  33. typedef NS_OPTIONS(NSUInteger, JPAuthorizationOptions) {
  34. JPAuthorizationOptionNone = 0, // the application may not present any UI upon a notification being received
  35. JPAuthorizationOptionBadge = (1 << 0), // the application may badge its icon upon a notification being received
  36. JPAuthorizationOptionSound = (1 << 1), // the application may play a sound upon a notification being received
  37. JPAuthorizationOptionAlert = (1 << 2), // the application may display an alert upon a notification being received
  38. JPAuthorizationOptionCarPlay = (1 << 3), // The ability to display notifications in a CarPlay environment.
  39. JPAuthorizationOptionCriticalAlert NS_AVAILABLE_IOS(12.0) = (1 << 4) , //The ability to play sounds for critical alerts.
  40. JPAuthorizationOptionProvidesAppNotificationSettings NS_AVAILABLE_IOS(12.0) = (1 << 5) , //An option indicating the system should display a button for in-app notification settings.
  41. JPAuthorizationOptionProvisional NS_AVAILABLE_IOS(12.0) = (1 << 6) , //The ability to post noninterrupting notifications provisionally to the Notification Center.
  42. };
  43. /*!
  44. * 通知注册实体类
  45. */
  46. @interface JPUSHRegisterEntity : NSObject
  47. /*!
  48. * 支持的类型
  49. * badge,sound,alert
  50. */
  51. @property (nonatomic, assign) NSInteger types;
  52. /*!
  53. * 注入的类别
  54. * iOS10 UNNotificationCategory
  55. * iOS8-iOS9 UIUserNotificationCategory
  56. */
  57. @property (nonatomic, strong) NSSet *categories;
  58. @end
  59. /*!
  60. * 进行删除、查找推送实体类
  61. */
  62. @interface JPushNotificationIdentifier : NSObject<NSCopying, NSCoding>
  63. @property (nonatomic, copy) NSArray<NSString *> *identifiers; // 推送的标识数组
  64. @property (nonatomic, copy) UILocalNotification *notificationObj NS_DEPRECATED_IOS(4_0, 10_0); // iOS10以下可以传UILocalNotification对象数据,iOS10以上无效
  65. @property (nonatomic, assign) BOOL delivered NS_AVAILABLE_IOS(10_0); // 在通知中心显示的或待推送的标志,默认为NO,YES表示在通知中心显示的,NO表示待推送的
  66. @property (nonatomic, copy) void (^findCompletionHandler)(NSArray *results); // 用于查询回调,调用[findNotification:]方法前必须设置,results为返回相应对象数组,iOS10以下返回UILocalNotification对象数组;iOS10以上根据delivered传入值返回UNNotification或UNNotificationRequest对象数组(delivered传入YES,则返回UNNotification对象数组,否则返回UNNotificationRequest对象数组)
  67. @end
  68. /*!
  69. * 推送通知声音实体类
  70. * iOS10以上有效
  71. */
  72. @interface JPushNotificationSound : NSObject <NSCopying, NSCoding>
  73. @property (nonatomic, copy) NSString *soundName; //普通通知铃声
  74. @property (nonatomic, copy) NSString *criticalSoundName NS_AVAILABLE_IOS(12.0); //警告通知铃声
  75. @property (nonatomic, assign) float criticalSoundVolume NS_AVAILABLE_IOS(12.0); //警告通知铃声音量,有效值在0~1之间,默认为1
  76. @end
  77. /*!
  78. * 推送内容实体类
  79. */
  80. @interface JPushNotificationContent : NSObject<NSCopying, NSCoding>
  81. @property (nonatomic, copy) NSString *title; // 推送标题
  82. @property (nonatomic, copy) NSString *subtitle; // 推送副标题
  83. @property (nonatomic, copy) NSString *body; // 推送内容
  84. @property (nonatomic, copy) NSNumber *badge; // 角标的数字。如果不需要改变角标传@(-1)
  85. @property (nonatomic, copy) NSString *action NS_DEPRECATED_IOS(8_0, 10_0); // 弹框的按钮显示的内容(IOS 8默认为"打开", 其他默认为"启动",iOS10以上无效)
  86. @property (nonatomic, copy) NSString *categoryIdentifier; // 行为分类标识
  87. @property (nonatomic, copy) NSDictionary *userInfo; // 本地推送时可以设置userInfo来增加附加信息,远程推送时设置的payload推送内容作为此userInfo
  88. @property (nonatomic, copy) NSString *sound; // 声音名称,不设置则为默认声音
  89. @property (nonatomic, copy) JPushNotificationSound *soundSetting NS_AVAILABLE_IOS(10.0); //推送声音实体
  90. @property (nonatomic, copy) NSArray *attachments NS_AVAILABLE_IOS(10_0); // 附件,iOS10以上有效,需要传入UNNotificationAttachment对象数组类型
  91. @property (nonatomic, copy) NSString *threadIdentifier NS_AVAILABLE_IOS(10_0); // 线程或与推送请求相关对话的标识,iOS10以上有效,可用来对推送进行分组
  92. @property (nonatomic, copy) NSString *launchImageName NS_AVAILABLE_IOS(10_0); // 启动图片名,iOS10以上有效,从推送启动时将会用到
  93. @property (nonatomic, copy) NSString *summaryArgument NS_AVAILABLE_IOS(12.0); //插入到通知摘要中的部分参数。iOS12以上有效。
  94. @property (nonatomic, assign) NSUInteger summaryArgumentCount NS_AVAILABLE_IOS(12.0); //插入到通知摘要中的项目数。iOS12以上有效。
  95. @end
  96. /*!
  97. * 推送触发方式实体类
  98. * 注:dateComponents、timeInterval、region在iOS10以上可选择其中一个参数传入有效值,如果同时传入值会根据优先级I、II、III使其中一种触发方式生效,fireDate为iOS10以下根据时间触发时须传入的参数
  99. */
  100. @interface JPushNotificationTrigger : NSObject<NSCopying, NSCoding>
  101. @property (nonatomic, assign) BOOL repeat; // 设置是否重复,默认为NO
  102. @property (nonatomic, copy) NSDate *fireDate NS_DEPRECATED_IOS(2_0, 10_0); // 用来设置触发推送的时间,iOS10以上无效
  103. @property (nonatomic, copy) CLRegion *region NS_AVAILABLE_IOS(8_0); // 用来设置触发推送的位置,iOS8以上有效,iOS10以上优先级为I,应用需要有允许使用定位的授权
  104. @property (nonatomic, copy) NSDateComponents *dateComponents NS_AVAILABLE_IOS(10_0); // 用来设置触发推送的日期时间,iOS10以上有效,优先级为II
  105. @property (nonatomic, assign) NSTimeInterval timeInterval NS_AVAILABLE_IOS(10_0); // 用来设置触发推送的时间,iOS10以上有效,优先级为III
  106. @end
  107. /*!
  108. * 注册或更新推送实体类
  109. */
  110. @interface JPushNotificationRequest : NSObject<NSCopying, NSCoding>
  111. @property (nonatomic, copy) NSString *requestIdentifier; // 推送请求标识
  112. @property (nonatomic, copy) JPushNotificationContent *content; // 设置推送的具体内容
  113. @property (nonatomic, copy) JPushNotificationTrigger *trigger; // 设置推送的触发方式
  114. @property (nonatomic, copy) void (^completionHandler)(id result); // 注册或更新推送成功回调,iOS10以上成功则result为UNNotificationRequest对象,失败则result为nil;iOS10以下成功result为UILocalNotification对象,失败则result为nil
  115. @end
  116. /*!
  117. * JPush 核心头文件
  118. */
  119. @interface JPUSHService : NSObject
  120. ///----------------------------------------------------
  121. /// @name Setup 启动相关
  122. ///----------------------------------------------------
  123. /*!
  124. * @abstract 启动SDK
  125. *
  126. * @param launchingOption 启动参数.
  127. * @param appKey 一个JPush 应用必须的,唯一的标识. 请参考 JPush 相关说明文档来获取这个标识.
  128. * @param channel 发布渠道. 可选.
  129. * @param isProduction 是否生产环境. 如果为开发状态,设置为 NO; 如果为生产状态,应改为 YES.
  130. * App 证书环境取决于profile provision的配置,此处建议与证书环境保持一致.
  131. *
  132. * @discussion 提供SDK启动必须的参数, 来启动 SDK.
  133. * 此接口必须在 App 启动时调用, 否则 JPush SDK 将无法正常工作.
  134. */
  135. + (void)setupWithOption:(NSDictionary *)launchingOption
  136. appKey:(NSString *)appKey
  137. channel:(NSString *)channel
  138. apsForProduction:(BOOL)isProduction;
  139. /*!
  140. * @abstract 启动SDK
  141. *
  142. * @param launchingOption 启动参数.
  143. * @param appKey 一个JPush 应用必须的,唯一的标识. 请参考 JPush 相关说明文档来获取这个标识.
  144. * @param channel 发布渠道. 可选.
  145. * @param isProduction 是否生产环境. 如果为开发状态,设置为 NO; 如果为生产状态,应改为 YES.
  146. * App 证书环境取决于profile provision的配置,此处建议与证书环境保持一致.
  147. * @param advertisingId 广告标识符(IDFA) 如果不需要使用IDFA,传nil.
  148. *
  149. * @discussion 提供SDK启动必须的参数, 来启动 SDK.
  150. * 此接口必须在 App 启动时调用, 否则 JPush SDK 将无法正常工作.
  151. */
  152. + (void)setupWithOption:(NSDictionary *)launchingOption
  153. appKey:(NSString *)appKey
  154. channel:(NSString *)channel
  155. apsForProduction:(BOOL)isProduction
  156. advertisingIdentifier:(NSString *)advertisingId;
  157. ///----------------------------------------------------
  158. /// @name APNs about 通知相关
  159. ///----------------------------------------------------
  160. /*!
  161. * @abstract 注册要处理的远程通知类型
  162. *
  163. * @param types 通知类型
  164. * @param categories 类别组
  165. *
  166. */
  167. + (void)registerForRemoteNotificationTypes:(NSUInteger)types
  168. categories:(NSSet *)categories;
  169. /*!
  170. * @abstract 新版本的注册方法(兼容iOS10)
  171. *
  172. * @param config 注册通知配置
  173. * @param delegate 代理
  174. *
  175. */
  176. + (void)registerForRemoteNotificationConfig:(JPUSHRegisterEntity *)config delegate:(id<JPUSHRegisterDelegate>)delegate;
  177. + (void)registerDeviceToken:(NSData *)deviceToken;
  178. /*!
  179. * @abstract 处理收到的 APNs 消息
  180. */
  181. + (void)handleRemoteNotification:(NSDictionary *)remoteInfo;
  182. /*!
  183. * Tags操作接口
  184. * 支持增加/覆盖/删除/清空/查询操作
  185. * 详情请参考文档:https://docs.jiguang.cn/jpush/client/iOS/ios_api/)
  186. */
  187. /**
  188. 增加tags
  189. @param tags 需要增加的tags集合
  190. @param completion 响应回调
  191. @param seq 请求序列号
  192. */
  193. + (void)addTags:(NSSet<NSString *> *)tags
  194. completion:(JPUSHTagsOperationCompletion)completion
  195. seq:(NSInteger)seq;
  196. /**
  197. 覆盖tags
  198. 调用该接口会覆盖用户所有的tags
  199. @param tags 需要设置的tags集合
  200. @param completion 响应回调
  201. @param seq 请求序列号
  202. */
  203. + (void)setTags:(NSSet<NSString *> *)tags
  204. completion:(JPUSHTagsOperationCompletion)completion
  205. seq:(NSInteger)seq;
  206. /**
  207. 删除指定tags
  208. @param tags 需要删除的tags集合
  209. @param completion 响应回调
  210. @param seq 请求序列号
  211. */
  212. + (void)deleteTags:(NSSet<NSString *> *)tags
  213. completion:(JPUSHTagsOperationCompletion)completion
  214. seq:(NSInteger)seq;
  215. /**
  216. 清空所有tags
  217. @param completion 响应回调
  218. @param seq 请求序列号
  219. */
  220. + (void)cleanTags:(JPUSHTagsOperationCompletion)completion
  221. seq:(NSInteger)seq;
  222. /**
  223. 查询全部tags
  224. @param completion 响应回调,请在回调中获取查询结果
  225. @param seq 请求序列号
  226. */
  227. + (void)getAllTags:(JPUSHTagsOperationCompletion)completion
  228. seq:(NSInteger)seq;
  229. /**
  230. 验证tag是否绑定
  231. @param completion 响应回调,回调中查看是否绑定
  232. @param seq 请求序列号
  233. */
  234. + (void)validTag:(NSString *)tag
  235. completion:(JPUSHTagValidOperationCompletion)completion
  236. seq:(NSInteger)seq;
  237. /**
  238. 设置Alias
  239. @param alias 需要设置的alias
  240. @param completion 响应回调
  241. @param seq 请求序列号
  242. */
  243. + (void)setAlias:(NSString *)alias
  244. completion:(JPUSHAliasOperationCompletion)completion
  245. seq:(NSInteger)seq;
  246. /**
  247. 删除alias
  248. @param completion 响应回调
  249. @param seq 请求序列号
  250. */
  251. + (void)deleteAlias:(JPUSHAliasOperationCompletion)completion
  252. seq:(NSInteger)seq;
  253. /**
  254. 查询当前alias
  255. @param completion 响应回调
  256. @param seq 请求序列号
  257. */
  258. + (void)getAlias:(JPUSHAliasOperationCompletion)completion
  259. seq:(NSInteger)seq;
  260. /*!
  261. * @abstract 过滤掉无效的 tags
  262. *
  263. * @discussion 如果 tags 数量超过限制数量, 则返回靠前的有效的 tags.
  264. * 建议设置 tags 前用此接口校验. SDK 内部也会基于此接口来做过滤.
  265. */
  266. + (NSSet *)filterValidTags:(NSSet *)tags;
  267. ///----------------------------------------------------
  268. /// @name Stats 统计功能
  269. ///----------------------------------------------------
  270. /*!
  271. * @abstract 开始记录页面停留
  272. *
  273. * @param pageName 页面名称
  274. * @discussion JCore 1.1.8 版本后,如需统计页面流,请使用 JAnalytics
  275. */
  276. + (void)startLogPageView:(NSString *)pageName __attribute__((deprecated("JCore 1.1.8 版本已过期")));
  277. /*!
  278. * @abstract 停止记录页面停留
  279. *
  280. * @param pageName 页面
  281. * @discussion JCore 1.1.8 版本后,如需统计页面流,请使用 JAnalytics
  282. */
  283. + (void)stopLogPageView:(NSString *)pageName __attribute__((deprecated("JCore 1.1.8 版本已过期")));
  284. /*!
  285. * @abstract 直接上报在页面的停留时间
  286. *
  287. * @param pageName 页面
  288. * @param seconds 停留的秒数
  289. * @discussion JCore 1.1.8 版本后,如需统计页面流,请使用 JAnalytics
  290. */
  291. + (void)beginLogPageView:(NSString *)pageName duration:(int)seconds __attribute__((deprecated("JCore 1.1.8 版本已过期")));
  292. /*!
  293. * @abstract 开启Crash日志收集
  294. *
  295. * @discussion 默认是关闭状态.
  296. */
  297. + (void)crashLogON;
  298. /*!
  299. * @abstract 地理位置上报
  300. *
  301. * @param latitude 纬度.
  302. * @param longitude 经度.
  303. *
  304. */
  305. + (void)setLatitude:(double)latitude longitude:(double)longitude;
  306. /*!
  307. * @abstract 地理位置上报
  308. *
  309. * @param location 直接传递 CLLocation * 型的地理信息
  310. *
  311. * @discussion 需要链接 CoreLocation.framework 并且 #import <CoreLocation/CoreLocation.h>
  312. */
  313. + (void)setLocation:(CLLocation *)location;
  314. /**
  315. 设置地理围栏的最大个数
  316. 默认值为 10 ,iOS系统默认地理围栏最大个数为20
  317. @param count 个数 count
  318. */
  319. + (void)setGeofenecMaxCount:(NSInteger)count;
  320. /**
  321. 注册地理围栏的代理
  322. @param delegate 代理
  323. @param launchOptions app启动完成是收到的字段参数
  324. */
  325. + (void)registerLbsGeofenceDelegate:(id<JPUSHGeofenceDelegate>)delegate withLaunchOptions:(NSDictionary *)launchOptions;
  326. /**
  327. 删除地理围栏
  328. @param geofenceId 地理围栏id
  329. */
  330. + (void)removeGeofenceWithIdentifier:(NSString *)geofenceId;
  331. ///----------------------------------------------------
  332. /// @name Local Notification 本地通知
  333. ///----------------------------------------------------
  334. /*!
  335. * @abstract 注册或更新推送 (支持iOS10,并兼容iOS10以下版本)
  336. *
  337. * JPush 2.1.9新接口
  338. * @param request JPushNotificationRequest类型,设置推送的属性,设置已有推送的request.requestIdentifier即更新已有的推送,否则为注册新推送,更新推送仅仅在iOS10以上有效,结果通过request.completionHandler返回
  339. * @discussion 旧的注册本地推送接口被废弃,使用此接口可以替换
  340. *
  341. */
  342. + (void)addNotification:(JPushNotificationRequest *)request;
  343. /*!
  344. * @abstract 移除推送 (支持iOS10,并兼容iOS10以下版本)
  345. *
  346. * JPush 2.1.9新接口
  347. * @param identifier JPushNotificationIdentifier类型,iOS10以上identifier设置为nil,则移除所有在通知中心显示推送和待推送请求,也可以通过设置identifier.delivered和identifier.identifiers来移除相应在通知中心显示推送或待推送请求,identifier.identifiers如果设置为nil或空数组则移除相应标志下所有在通知中心显示推送或待推送请求;iOS10以下identifier设置为nil,则移除所有推送,identifier.delivered属性无效,另外可以通过identifier.notificationObj传入特定推送对象来移除此推送。
  348. * @discussion 旧的所有删除推送接口被废弃,使用此接口可以替换
  349. *
  350. */
  351. + (void)removeNotification:(JPushNotificationIdentifier *)identifier;
  352. /*!
  353. * @abstract 查找推送 (支持iOS10,并兼容iOS10以下版本)
  354. *
  355. * JPush 2.1.9新接口
  356. * @param identifier JPushNotificationIdentifier类型,iOS10以上可以通过设置identifier.delivered和identifier.identifiers来查找相应在通知中心显示推送或待推送请求,identifier.identifiers如果设置为nil或空数组则返回相应标志下所有在通知中心显示推送或待推送请求;iOS10以下identifier.delivered属性无效,identifier.identifiers如果设置nil或空数组则返回所有未触发的推送。须要设置identifier.findCompletionHandler回调才能得到查找结果,通过(NSArray *results)返回相应对象数组。
  357. * @discussion 旧的查找推送接口被废弃,使用此接口可以替换
  358. *
  359. */
  360. + (void)findNotification:(JPushNotificationIdentifier *)identifier;
  361. /*!
  362. * @abstract 本地推送,最多支持64个
  363. *
  364. * @param fireDate 本地推送触发的时间
  365. * @param alertBody 本地推送需要显示的内容
  366. * @param badge 角标的数字。如果不需要改变角标传-1
  367. * @param alertAction 弹框的按钮显示的内容(IOS 8默认为"打开", 其他默认为"启动")
  368. * @param notificationKey 本地推送标示符
  369. * @param userInfo 自定义参数,可以用来标识推送和增加附加信息
  370. * @param soundName 自定义通知声音,设置为nil为默认声音
  371. *
  372. * @discussion 最多支持 64 个定义,此方法被[addNotification:]方法取代
  373. */
  374. + (UILocalNotification *)setLocalNotification:(NSDate *)fireDate
  375. alertBody:(NSString *)alertBody
  376. badge:(int)badge
  377. alertAction:(NSString *)alertAction
  378. identifierKey:(NSString *)notificationKey
  379. userInfo:(NSDictionary *)userInfo
  380. soundName:(NSString *)soundName __attribute__((deprecated("JPush 2.1.9 版本已过期")));
  381. /*!
  382. * @abstract 本地推送 (支持 iOS8 新参数)
  383. *
  384. * IOS8新参数
  385. * @param region 自定义参数
  386. * @param regionTriggersOnce 自定义参数
  387. * @param category 自定义参数
  388. * @discussion 此方法被[addNotification:]方法取代
  389. */
  390. + (UILocalNotification *)setLocalNotification:(NSDate *)fireDate
  391. alertBody:(NSString *)alertBody
  392. badge:(int)badge
  393. alertAction:(NSString *)alertAction
  394. identifierKey:(NSString *)notificationKey
  395. userInfo:(NSDictionary *)userInfo
  396. soundName:(NSString *)soundName
  397. region:(CLRegion *)region
  398. regionTriggersOnce:(BOOL)regionTriggersOnce
  399. category:(NSString *)category NS_AVAILABLE_IOS(8_0) __attribute__((deprecated("JPush 2.1.9 版本已过期")));
  400. /*!
  401. * @abstract 前台展示本地推送
  402. *
  403. * @param notification 本地推送对象
  404. * @param notificationKey 需要前台显示的本地推送通知的标示符
  405. *
  406. * @discussion 默认App在前台运行时不会进行弹窗,在程序接收通知调用此接口可实现指定的推送弹窗。--iOS10以下还可继续使用,iOS10以上在[UNUserNotificationCenterDelegate willPresentNotification:withCompletionHandler:]方法中调用completionHandler(UNNotificationPresentationOptionSound | UNNotificationPresentationOptionAlert);即可
  407. */
  408. + (void)showLocalNotificationAtFront:(UILocalNotification *)notification
  409. identifierKey:(NSString *)notificationKey __attribute__((deprecated("JPush 2.1.9 版本已过期")));
  410. /*!
  411. * @abstract 删除本地推送定义
  412. *
  413. * @param notificationKey 本地推送标示符
  414. * @discussion 此方法被[removeNotification:]方法取代
  415. */
  416. + (void)deleteLocalNotificationWithIdentifierKey:(NSString *)notificationKey __attribute__((deprecated("JPush 2.1.9 版本已过期")));
  417. /*!
  418. * @abstract 删除本地推送定义
  419. * @discussion 此方法被[removeNotification:]方法取代
  420. */
  421. + (void)deleteLocalNotification:(UILocalNotification *)localNotification __attribute__((deprecated("JPush 2.1.9 版本已过期")));
  422. /*!
  423. * @abstract 获取指定通知
  424. *
  425. * @param notificationKey 本地推送标示符
  426. * @return 本地推送对象数组, [array count]为0时表示没找到
  427. * @discussion 此方法被[findNotification:]方法取代
  428. */
  429. + (NSArray *)findLocalNotificationWithIdentifier:(NSString *)notificationKey __attribute__((deprecated("JPush 2.1.9 版本已过期")));
  430. /*!
  431. * @abstract 清除所有本地推送对象
  432. * @discussion 此方法被[removeNotification:]方法取代
  433. */
  434. + (void)clearAllLocalNotifications __attribute__((deprecated("JPush 2.1.9 版本已过期")));
  435. ///----------------------------------------------------
  436. /// @name Server badge 服务器端 badge 功能
  437. ///----------------------------------------------------
  438. /*!
  439. * @abstract 设置角标(到服务器)
  440. *
  441. * @param value 新的值. 会覆盖服务器上保存的值(这个用户)
  442. *
  443. * @discussion 本接口不会改变应用本地的角标值.
  444. * 本地仍须调用 UIApplication:setApplicationIconBadgeNumber 函数来设置脚标.
  445. *
  446. * 本接口用于配合 JPush 提供的服务器端角标功能.
  447. * 该功能解决的问题是, 服务器端推送 APNs 时, 并不知道客户端原来已经存在的角标是多少, 指定一个固定的数字不太合理.
  448. *
  449. * JPush 服务器端脚标功能提供:
  450. *
  451. * - 通过本 API 把当前客户端(当前这个用户的) 的实际 badge 设置到服务器端保存起来;
  452. * - 调用服务器端 API 发 APNs 时(通常这个调用是批量针对大量用户),
  453. * 使用 "+1" 的语义, 来表达需要基于目标用户实际的 badge 值(保存的) +1 来下发通知时带上新的 badge 值;
  454. */
  455. + (BOOL)setBadge:(NSInteger)value;
  456. /*!
  457. * @abstract 重置脚标(为0)
  458. *
  459. * @discussion 相当于 [setBadge:0] 的效果.
  460. * 参考 [JPUSHService setBadge:] 说明来理解其作用.
  461. */
  462. + (void)resetBadge;
  463. ///----------------------------------------------------
  464. /// @name Other Feature 其他功能
  465. ///----------------------------------------------------
  466. /*!
  467. * @abstract 设置手机号码(到服务器)
  468. *
  469. * @param mobileNumber 手机号码. 会与用户信息一一对应。可为空,为空则清除号码
  470. * @param completion 响应回调。成功则error为空,失败则error带有错误码及错误信息
  471. *
  472. * @discussion 设置手机号码后,可实现“推送不到短信到”的通知方式,提高推送达到率。结果信息通过completion异步返回,也可将completion设置为nil不处理结果信息。
  473. *
  474. */
  475. + (void)setMobileNumber:(NSString *)mobileNumber completion:(void (^)(NSError *error))completion;
  476. ///----------------------------------------------------
  477. /// @name Logs and others 日志与其他
  478. ///----------------------------------------------------
  479. /*!
  480. * @abstract JPush标识此设备的 registrationID
  481. *
  482. * @discussion SDK注册成功后, 调用此接口获取到 registrationID 才能够获取到.
  483. *
  484. * JPush 支持根据 registrationID 来进行推送.
  485. * 如果你需要此功能, 应该通过此接口获取到 registrationID 后, 上报到你自己的服务器端, 并保存下来.
  486. * registrationIDCompletionHandler:是新增的获取registrationID的方法,需要在block中获取registrationID,resCode为返回码,模拟器调用此接口resCode返回1011,registrationID返回nil.
  487. * 更多的理解请参考 JPush 的文档网站.
  488. */
  489. + (NSString *)registrationID;
  490. + (void)registrationIDCompletionHandler:(void(^)(int resCode,NSString *registrationID))completionHandler;
  491. /*!
  492. * @abstract 打开日志级别到 Debug
  493. *
  494. * @discussion JMessage iOS 的日志系统参考 Android 设计了级别.
  495. * 从低到高是: Verbose, Debug, Info, Warning, Error.
  496. * 对日志级别的进一步理解, 请参考 Android 相关的说明.
  497. *
  498. * SDK 默认开启的日志级别为: Info. 只显示必要的信息, 不打印调试日志.
  499. *
  500. * 请在SDK启动后调用本接口,调用本接口可打开日志级别为: Debug, 打印调试日志.
  501. */
  502. + (void)setDebugMode;
  503. /*!
  504. * @abstract 关闭日志
  505. *
  506. * @discussion 关于日志级别的说明, 参考 [JPUSHService setDebugMode]
  507. *
  508. * 虽说是关闭日志, 但还是会打印 Warning, Error 日志. 这二种日志级别, 在程序运行正常时, 不应有打印输出.
  509. *
  510. * 建议在发布的版本里, 调用此接口, 关闭掉日志打印.
  511. */
  512. + (void)setLogOFF;
  513. ///----------------------------------------------------
  514. ///********************下列方法已过期********************
  515. ///**************请使用新版tag/alias操作接口**************
  516. ///----------------------------------------------------
  517. /// @name Tag alias setting 设置别名与标签
  518. ///----------------------------------------------------
  519. /*!
  520. * 下面的接口是可选的
  521. * 设置标签和(或)别名(若参数为nil,则忽略;若是空对象,则清空;详情请参考文档:https://docs.jiguang.cn/jpush/client/iOS/ios_api/)
  522. * setTags:alias:fetchCompletionHandle:是新的设置标签别名的方法,不再需要显示声明回调函数,只需要在block里面处理设置结果即可.
  523. * WARN: 使用block时需要注意循环引用问题
  524. */
  525. + (void) setTags:(NSSet *)tags
  526. alias:(NSString *)alias
  527. callbackSelector:(SEL)cbSelector
  528. target:(id)theTarget __attribute__((deprecated("JPush 2.1.1 版本已过期")));
  529. + (void) setTags:(NSSet *)tags
  530. alias:(NSString *)alias
  531. callbackSelector:(SEL)cbSelector
  532. object:(id)theTarget __attribute__((deprecated("JPush 3.0.6 版本已过期")));
  533. + (void) setTags:(NSSet *)tags
  534. callbackSelector:(SEL)cbSelector
  535. object:(id)theTarget __attribute__((deprecated("JPush 3.0.6 版本已过期")));
  536. + (void)setTags:(NSSet *)tags
  537. alias:(NSString *)alias
  538. fetchCompletionHandle:(void (^)(int iResCode, NSSet *iTags, NSString *iAlias))completionHandler __attribute__((deprecated("JPush 3.0.6 版本已过期")));
  539. + (void) setTags:(NSSet *)tags
  540. aliasInbackground:(NSString *)alias __attribute__((deprecated("JPush 3.0.6 版本已过期")));
  541. + (void)setAlias:(NSString *)alias
  542. callbackSelector:(SEL)cbSelector
  543. object:(id)theTarget __attribute__((deprecated("JPush 3.0.6 版本已过期")));
  544. @end
  545. @class UNUserNotificationCenter;
  546. @class UNNotificationResponse;
  547. @protocol JPUSHRegisterDelegate <NSObject>
  548. /*
  549. * @brief handle UserNotifications.framework [willPresentNotification:withCompletionHandler:]
  550. * @param center [UNUserNotificationCenter currentNotificationCenter] 新特性用户通知中心
  551. * @param notification 前台得到的的通知对象
  552. * @param completionHandler 该callback中的options 请使用UNNotificationPresentationOptions
  553. */
  554. - (void)jpushNotificationCenter:(UNUserNotificationCenter *)center willPresentNotification:(UNNotification *)notification withCompletionHandler:(void (^)(NSInteger options))completionHandler;
  555. /*
  556. * @brief handle UserNotifications.framework [didReceiveNotificationResponse:withCompletionHandler:]
  557. * @param center [UNUserNotificationCenter currentNotificationCenter] 新特性用户通知中心
  558. * @param response 通知响应对象
  559. * @param completionHandler
  560. */
  561. - (void)jpushNotificationCenter:(UNUserNotificationCenter *)center didReceiveNotificationResponse:(UNNotificationResponse *)response withCompletionHandler:(void(^)(void))completionHandler;
  562. /*
  563. * @brief handle UserNotifications.framework [openSettingsForNotification:]
  564. * @param center [UNUserNotificationCenter currentNotificationCenter] 新特性用户通知中心
  565. * @param notification 当前管理的通知对象
  566. */
  567. - (void)jpushNotificationCenter:(UNUserNotificationCenter *)center openSettingsForNotification:(UNNotification *)notification NS_AVAILABLE_IOS(12.0);
  568. @end
  569. @protocol JPUSHGeofenceDelegate <NSObject>
  570. /**
  571. 进入地理围栏区域
  572. @param geofenceId 地理围栏id
  573. @param userInfo 地理围栏触发时返回的信息
  574. @param error 错误信息
  575. */
  576. - (void)jpushGeofenceIdentifer:(NSString *)geofenceId didEnterRegion:(NSDictionary *)userInfo error:(NSError *)error;
  577. /**
  578. 离开地理围栏区域
  579. @param geofenceId 地理围栏id
  580. @param userInfo 地理围栏触发时返回的信息
  581. @param error 错误信息
  582. */
  583. - (void)jpushGeofenceIdentifer:(NSString *)geofenceId didExitRegion:(NSDictionary *)userInfo error:(NSError *)error;
  584. @end