Meta tags:
Headings (most frequently used words):
说明, 头文件, 参数, 示例, 返回, 接口调用示例, 请求结果处理示例, sdk, ios, 29, api接口, 获取, 注册liveactivity, 多媒体推送接口, 初始化服务, 注册远程通知, 监听在线状态, 展示apns通知, 接收apns通知, 接收透传消息, 授权回调, 通知设置回调, 发送自定义回执, 10, applink, 点击回执, 11, 关闭推送, 12, 设置标签, 13, 绑定别名, 14, 解绑别名, 15, 设置角标, 16, 复位角标, 17, 清空通知, 18, 获取缓存cid, 19, 获取个推cid, 20, 服务状态, 21, 版本号, 22, 设置渠道, 23, 注册, voiptoken, 24, voip推送消息回执, 25, 设置后台运行, 26, 地理围栏功能, 27, 发送上行消息, 28, 设置app, groups, id, extension, api, 30, sdk异常回调, 31, pushtoken, 32, pushtostarttoken, 33, 应用内弹窗, 34, 控制中心推送, 35, uiscene下处理推送数据, 当前位置, 个推文档, 客户端, 仅统计, 停止服务, 文档中心搜索,
Text of the page (most frequently used words):
nsstring (76), getuisdk (72), void (70), error (42), bool (34), 头文件 (34), self (28), nslog (21), sequencenum (20), yes (18), completionhandler (18), sdk (17), ios (17), issuccess (17), nserror (17), pushtostarttoken (16), result (16), msg (16), taskid (16), payload (15), nsdictionary (14), appid (14), testdemo (13), cid (13), msgid (13), clientid (12), stringwithformat (11), bestattemptcontent (11), request (11), aerror (11), userinfo (11), contenthandler (10), voip (10), asn (10), nullable (10), application (9), info (9), nsarray (9), fetchcompletionhandler (9), appkey (8), 请求结果处理示例 (8), liveactivity (8), 接口调用示例 (8), getuisdkdelegate (8), offline (8), center (8), appsecret (7), uiapplication (7), let (7), getuiextsdk (7), notification (7), status (7), registerremotenotification (7), unusernotificationcenter (7), fromgetui (7), api接口 (7), voiptoken (6), launchoptions (6), 0及以上 (6), tokendata (6), attributes (6), token (6), attributename (6), sendmessage (6), andsequencenum (6), alias (6), code (6), weburl (6), delegate (5), 支持版本3 (5), homepage (5), logmsg (5), todo (5), apns (5), attachments (5), nsdata (5), 请求回调见 (5), tag (5), 开发者需要调用个推注册远程通知 (5), uibackgroundfetchresult (5), response (5), 注册liveactivity (4), 绑定别名 (4), 关闭推送 (4), applink (4), connectionoptions (4), launchingoptions (4), tokens (4), activity (4), mytoken (4), string (4), 不为nil (4), unnotificationrequest (4), content (4), handelnotificationservicerequest (4), title (4), block (4), completeblock (4), errors (4), url (4), setapplicationgroupidentifier (4), messageid (4), 具体可参考getuisdkdelegate (4), 回调中的说明 (4), isenable (4), sdkstatus (4), getuisdkdidregisterclient (4), setapplicationiconbadgenumber (4), sharedapplication (4), action (4), settags (4), getuisdkdidsetpushmode (4), andmsgid (4), andtaskid (4), 本方法接管了系统的 (4), granted (4), _cmd (4), nsstringfromselector (4), didreceiveremotenotification (4), types (4), pushtoken (3), api (3), 版本号 (3), 解绑别名 (3), 通知设置回调 (3), 展示apns通知 (3), return (3), startsdkwithappid (3), available (3), getuisdkpopupdidclick (3), getuisdkpopupdidshow (3), 获取当前 (3), activityattributes (3), registerliveactivity (3), activitytoken (3), localizeddescription (3), getuisdkdidoccurerror (3), 用户可在此回调中自行修改通知样式等 (3), body (3), 不允许 (3), app进入后台后 (3), 系统回调 (3), 两次调用的间隔需大于 (3), 操作别名失败 (3), tags (3), ismodeoff (3), useractivity (3), gtsdk (3), sendfeedbackmessage (3), actionid (3), usernotificationcenter (3), ios10及以上版本 (3), getuisdknotificationcenter (3), unnotification (3), getuisdkgrantauthorization (3), 参考代码 (3), 开发者注意根据实际需求自行修改 (3), unnotificationresponse (3), willpresentnotification (3), 该方法需要在主线程中调用 (3), 集成指南 (3), 开发者中心 (2), uiscene下处理推送数据 (2), 控制中心推送 (2), 应用内弹窗 (2), sdk异常回调 (2), extension (2), 设置app (2), groups (2), 发送上行消息 (2), 地理围栏功能 (2), 设置后台运行 (2), voip推送消息回执 (2), 设置渠道 (2), 服务状态 (2), 获取个推cid (2), 获取缓存cid (2), 清空通知 (2), 复位角标 (2), 设置角标 (2), 设置标签 (2), 点击回执 (2), 发送自定义回执 (2), 授权回调 (2), 接收透传消息 (2), 接收apns通知 (2), 监听在线状态 (2), 注册远程通知 (2), 初始化服务 (2), handlescenewillconnectwithoptions (2), uisceneconnectionoptions (2), scene (2), scenedelegate (2), kgtappid (2), kgtappkey (2), kgtappsecret (2), didfinishlaunchingwithoptions (2), 需要ios (2), 0及以上系统版本 (2), getuisdkdidregistercontrolstokens (2), registercontrolstokens (2), 用户自定义的请求序列号 (2), 用来唯一标识该动作 (2), gtcountsdk (2), 已经集成用户运营sdk的用户 (2), 建议调用ido的应用内弹窗统计 (2), 展示回调 (2), getuisdkdidregisterpushtostarttoken (2), register (2), for (2), await (2), map (2), joined (2), 开发者上传pushtostarttoken (2), 02x (2), format (2), 中推出了一个新功能 (2), push (2), 通过该接口注册 (2), 请求序列码 (2), 用于标识一次注册请求 (2), getuisdkdidregisterliveactivity (2), 灵动岛 (2), 从而进行 (2), 推送服务 (2), liveactivityid (2), 英文字母 (2), 的组合 (2), 不支持空格 (2), destory (2), didreceivenotificationrequest (2), withcontenthandler (2), unnotificationcontent (2), _nonnull (2), mutablecopy (2), withcomplete (2), modified (2), 接收到 (2), 推送送达的apns信息 (2), 多媒体推送接口 (2), withattachmentscomplete (2), http (2), https (2), 错误信息 (2), wifi (2), 组成的数组 (2), identify (2), identifier (2), getuisdkdidsendmessage (2), int (2), senddata (2), nil (2), lbslocationenable (2), anduserverify (2), isverify (2), 默认为 (2), runbackgroundenable (2), pushregistry (2), registry (2), fortype (2), dictionarypayload (2), handlevoipnotification (2), type (2), pkpushregistry (2), credentials (2), registervoiptokencredentials (2), app (2), setchannelid (2), channelid (2), version (2), sdkstatusoffline (2), sdkstatusstoped (2), sdkstatusstarted (2), sdkstatusstarting (2), 正在启动 (2), 个推唯一 (2), 用于标识当前应用 (2), clearallnotificationfornotificationbar (2), resetbadge (2), 进行设置 (2), setbadge (2), value (2), andisself (2), seq (2), unbindalias (2), 小时内限制调用50次 (2), isself (2), 绑定序列码 (2), 别名名称 (2), 长度40字节 (2), 支持中 (2), 区分大小写 (2), 数字以及下划线 (2), isequal (2), 参数说明 (2), 操作成功 (2), 操作失败 (2), 操作别名时 (2), getuisdkdidaliasaction (2), bindalias (2), 比如手机号 (2), 默认一天只能成功设置一次 (2), getuisdkdidsettagsaction (2), 标签3 (2), 标签2 (2), 标签1 (2), errorinfo (2), 开启推送 (2), setpushmodeforoff (2), 默认推送开启 (2), isvalue (2), restorationhandler (2), handleapplinkfeedback (2), nsurl (2), gtsdk回调 (2), opensettingsfornotification (2), 支持ios10及以上 (2), 接收到的apns通知内容 (2), getuisdkdidreceiveslience (2), uibackgroundfetchresultnodata (2), 根据app需要自行修改参数值 (2), 通知回调 (2), 用来在后台状态下进行操作 (2), getuisdkdidreceivenotification (2), notificationcenter (2), withcompletionhandler (2), unnotificationpresentationoptions (2), getuisdkdidnotifysdkstate (2), unauthorizationoptions (2), 客户端 (2), open (2), harmony (2), 服务端 (2), 厂商应用开通指南 (2), applink集成 (2), 3分钟演示 (2), 进阶功能 (2), 随时联系技术支持, 微信扫一扫, 文档中心搜索, 在这篇文章中, 非常感谢您的反馈, 我们会继续努力做到更好, 反馈成功, 是否遇到以下问题, 联系方式, 反馈建议, 问题类型不能为空, 不是我想要的内容, 对产品功能不满意, 图片和视频难理解, 文章描述不清晰, 内容与功能不一致, 问题类型, 您的改进建议, 没帮助, 有帮助, 以上文档对您是否有帮助, api_available, options, session, uiscenesession, willconnecttosession, uiscene, 启动sdk流程, 及以下, 获取通知, else, appdelegate, uiscene模式下的启动参数, controlsclick, sn1, uuid, token3, kind3, kind2, token1, kind1, tokens入参校验是否正确, token字典, key为kind, value为token, popupdidclick, 点击回调, popupdidshow, sdk收到应用内弹窗后的回调, 弹窗内容字段, 弹窗点击回调, 弹窗展示回调, task, pushtostarttokenupdates, updates, 监听token更新, describing, utf8, encoding, data, 当app未启动时, 系统收到apns消息并启动liveactivity后, 会在后台拉活app, 运行时间有限, 目的是让app及时汇报当前liveactivity实例的pushtoken, 后续开发者可以通过apns, pushtoken对当前实例进行内容更新, 开发者需要在app启动后尽快监听pushtokenupdates并汇报pushtoken给个推, 以便后续通过apns更新liveactivity内容, start, 从而进行apns推送启动, 入参长度校验成功, sn长度为空, 推送时使用的pushtostarttoken, 实时活动的属性, 即当前activityattributes结构体名称, 不可为空, current, pushtokenupdates, 序列号, 订单号, activitytoken长度校验成功, activitytoken长度为空, 回调的, 业务id, 用于绑定token的业务关系, 格式要求只能包含中文字符, 长度限制, 128, sdk遇到错误回调, 初始化异常或者运行时出现错误, 由该接口返回错误信息, sdk内部发生错误, 通知第三方, 返回错误信息, 超时时销毁个推sdk释放资源, serviceextensiontimewillexpire, 销毁sdk, 并且释放资源, 停止服务, 返回新的通知内容, modify, the, here, 通知个推服务器apns信息送达, 回调里需调用, 来完成更新通知栏的正常展示, 该接口正常执行后将回调, 如果网络异常请求超时, 该接口的超时时间最多为5s, 5s后将回调, 通知后调用该方法, 完成后以, block方式回调, 只统计apns到达情况, 不下载多媒体资源, 个推统计完成后回调用户操作, 仅统计, 展示推送的回调处理需要放到个推回执完成的回调中, 如果apns处理有错误, 可以在这里查看相关错误详情, 个推处理apns消息遇到错误, 设置通知中的多媒体附件, 修改展示title信息, 用户可以在这里处理通知样式的修改, 修改标题, 将apns信息交由个推处理, 10003, 多媒体资源超过大小限制, 10002, 不支持, 修改为支持, ats, 地址或者将, notificationservice, 配置为支持, 10001, 多媒体地址错误, 无法下载, 资源url格式注意, 不支持中文及转译地址, 请使用英文合法地址, 可设置是否仅在, 下下载资源, 参考服务端api, 如果为true, 数据网络下将不下载资源, 展示通知不带附件, 默认是false, 数据网络下下载, 180s, 50mb, 60s, 5mb, 120s, 10mb, 多媒体大小限制, 通知后, 判断是否有多媒体资源, 如果多媒体资源存在则下载资源, 下载完成后以, 方式回调返回, 资源数组对象和, 错误数组信息, 资源下载的错误信息, 下载完成的资源数组, unnotificationattachment, 个推统计和多媒体资源下载完成后回调用户操作, 苹果开发者后台设置的, group, 支持版本2, 需要同时设置, 用于回执报表统计, 通过苹果开发者后台设置的group, didsendmessage, received, 需第三方服务器接入个推, 到达第三方服务器后返回, 消息推送到个推服务器, 服务器通过该接口通知sdk到达结果, 说明消息发送成功, 0为失败, datausingencoding, nsutf8stringencoding, 如果发送成功返回messageid, 发送失败返回nil, 如果发送错误给出错误消息, 任务id, uuidstring, 非必填, 发送的数据, 本功能为使用个推2, 0智能标签和个推3, 0应景推送的必选功能, 建议勾选, 设置是否sdk主动弹出用户定位请求, 设置地理围栏功能是否运行, 设置是否允许后台运行, 默认不设置, sdk不会执行保活逻辑, 也不会断开socket通道, 等待系统自动断开socket通道, sdk执行保活逻辑, 维持socket通道连接, sdk会主动断开socket通道等, didreceiveincomingpushwithpayload, 推送中的, 信息进行业务处理, 调用个推, 回执统计接口, pkpushpayload, 在ios, apple不再允许pushkit应用在非voip电话的场景下, 如果需要使用pushkit则需要接入callkit的接口, 若需要实现语音播报功能, 建议通过通知扩展实现, 具体参考官方demo, 消息后调用, 推送到达数, 推送中携带的payload信息, pkpushcredentials, 向个推服务器注册, didupdatepushcredentials, 在ios8, 苹果引入了一个新的被用于, 类型的推送消息, 推送时, 若app在后台则会执行相关系统回调函数, 若app杀死状态则将被唤醒并执行相关系统回调函数, 服务通过该接口注册, 传入ios系统回调的voiptoken, channel, 设置渠道信息, 根据用户分发的渠道进行设置, 个推后台可根据渠道信息进行统计分析, 生成报表, 渠道信息, 版本号字符串, 的服务状态, sdk状态, 注册成功仅表示推送通道建立, 如果appid, appsecret等验证不通过, 依然无法接收到推送消息, 请确保验证信息正确, 启动getuisdk后, sdk会自动向个推服务器注册sdk, 当成功注册时, sdk通知应用注册成功获取到cid, 获取当前用户缓存的, 长时间未登录或, 发生变化造成的, 变化以, 接口中的, 获取回调cid, 清空通知和角标, 清空下拉通知栏全部通知, 并将角标置, 即不显示角标, 如果需要角标清空需要调用系统方法设置, 重置角标, app角标复位需额外调用, 设置服务器角标计数为0, 如果需要角标显示需要调用系统方法设置, app角标显示需额外调用, badge, 同步服务器角标计数, 设置的角标值, 取值范围, 99999, nsuinteger, 请求回调同, 只能解绑与当前应用, 关联的别名, 是否只对当前cid有效, 如果是yes, 只对当前cid做解绑, 如果是no, 对所有绑定该别名的cid列表做解绑, kgtresponsebindtype, kgtresponseunbindtype, unbind, bind, 30001, 频率过快, 30002, 参数错误, 30003, 绑定别名次数超限, 30004, 未知异常, 30005, 未获取到, 30006, 发生网络错误, 30007, 别名无效, 30008, 使用场景, 同一个账号, 分别登陆在, 三台设备上的同一个, 产生了, 个不同的, 想让这三台设备同时接收到推送, 就可以考虑使用该接口, 让三台设备的三个, 都绑定同一个别名也就是你的账号, 最多支持, 台设备, 也就是最多绑定, 可用于与客户账号系统关联, 建议将邮箱, 手机号等用户标识设为别名, 后续可以使用该别名进行定向推送, 重复绑定以最后一次为准, getuisdkdidsettagaction, 内容格式不正确, 20011, 数目超限, 20010, 已经在黑名单列表, 请联系技术支持处理, 20009, 还未登陆成功, 20008, 20007, 20006, settag, 20005, 服务初始化失败, 20004, 标签重复, 20003, 调用次数超限, 20002, 100, 数量不超过, 数量过大, 单次设置的, 20001, 请求的序列码, seqtag, 需要在获取到, 之后调用, 可联系技术支持进行修改, 设置一组标签, 覆盖操作, cid只会绑定当前传入的标签, 后续可使用该标签定向推送, 若不指定sn, 会根据tags自动生成sn, 建议每个设置标签操作设置不同的sn标识, 的对象数组, 不能为, 只能包含中文字符, with, setmodeoff, 客户端可以关闭服务器的推送功能, 关闭后, 服务器将不给该客户端发推送消息, 关闭推送模式功能, continueuseractivity, restorableobjects, activitytype, isequaltostring, webpageurl, 用户可根据具体, 进行业务处理, 个推applink中携带的用户payload信息, link, ink, getui, mid, 字段存储用户透传信息, 可以根据透传内容进行业务操作, 处理个推applink回执统计, nsuseractivitytypebrowsingweb, uiuseractivityrestoring, nsuseractivity, applink回调, 该接口可统计applink用户点击次数, 返回下发中的透传信息, 开发者可在获取到payload内容后处理具体业务逻辑, 用户点击回执, applink的, payloaddata, 90001, 汇报个推自定义事件, 反馈透传消息, fromgtappid, andoffline, getuisdkdidreceivepayloaddata, sdk收到透传消息回调, 第三方自定义回执, 可用于数据统计, 发送成功, 发送失败, 为空或者, 不在取值范围以内, 下发任务的消息id, 下发任务的任务id, 用户自定义的actionid, int类型, 取值90001, 90999, nsinteger, 注册远程通知时, 若设置unauthorizationoptionprovidesappnotificationsettings, 此配置支持ios12, 开发者可以申请自定义通知设置, 对应的通知设置中跳转到当前app的回调, 用户的授权状态会通过回调, 告知开发者, 是否授权, 60002, 以下处理用于推送苹果在线透传消息时, 补全上报个推渠道消息点击数, 需通过上述userinfo的_gmid_中获取到taskid, 和msgid, _gmid_组成格式是taskid, 以冒号区分, 在您自身点击事件逻辑触发时, 执行上报埋点, 点击id固定为60002, apns消息, 个推消息, apn, nreceive, slience, 静默通知相关说明, 个推在线渠道的点击数, 需要您在客户端在线透传消息自处理展示后, 自己监听点击动作, 当客户端出现点击动作时, 调用sendfeedbackmessage方法, 上报actionid为60002的点击回执, 以此来补全统计苹果在线个推渠道透传消息的点击数, 处理来自苹果apns的静默消息通知回调, 通过个推发送透传消息时, 如果下发时cid在线, 将收到回调且offline, 如果下发时cid离线, 消息将存入个推离线服务器, 通过苹果apns发送静默消息通知, cid在线后将收到本条消息且offline, 通过苹果apns通道的消息, 才有此参数值, 推送消息的messageid, 推送消息的任务id, 应用的appid, 个推离线消息, 个推在线消息, 个推通道, 苹果apns通道, 推送消息内容, uibackgroundfetchresultnewdata, 防止两次调用completionhandler引起崩溃, 如果执行了上述代理方法中的completionhandler, 就不要执行当前回调中的completionhandler, 如果你重写了, 当前方法, 要注意只保留一个completionhandler调用, 调用多次可能多导致偶现crash, didreceivenotificationresponse, apns接收通知回调, ios10以下版本, 通知内容, unnotificationpresentationoptionbadge, unnotificationpresentationoptionsound, unnotificationpresentationoptionalert, unnotificationpresentationoptionnone, 若不显示通知, 则无法点击通知, 根据app需要, 判断是否要提示用户badge, sound, alert等, app在前台时收到apns通知后的展示回调, 用户可以设定当前通知的展示权限, 是否展示通知回调详情block, 通知中心实例, 监控sdk运行状态, sdk初始化到cid登入成功为正在启动状态, cid登入成功后为启动状态, sdk运行的状态, unauthorizationoptionsound, unauthorizationoptionalert, unauthorizationoptionbadge, 个推内部兼容ios10以下注册远程通知逻辑, 开发者无需特殊处理, 个推内部自动关联devicetoken和cid, 无需开发者手动调用, registerdevicetokendata, devicetoken, 必须使用个推注册远程通知, 否则通过个推代理无法获取部分apns回调, unauthorizationoptions类型的通知选项, registerclient, sdk启动成功返回cid, 启动sdk, launchoptions用于回执报表统计, 必须正确, 否则会导致推送消息无法接收, 初始化个推服务, 接口调用后个推服务后台运行, 联网成功后, 回调接口返回, 传入didfinishlaunchingwithoptions中的launchoptions参数, 个推sdk回调代理, 个推登记应用的appsecret, 个推登记应用的appkey, 个推登记应用的appid, 当前位置, 个推文档, 推送服务使用协议, 消息推送购买指引, 消息推送计费说明, 购买指南, sdk更新日志, 服务端常见问题, ios常见问题, android常见问题, 客户端推送常见问题, 常见问题, 点击率提升方案, 到达率提升方案, 点击提升方案集成指南, 应用内弹窗操作手册, 流程画布操作手册, 文案圈人操作手册, 点击提升方案, 文档说明, 时效性通知, 即时通知, 微信小程序推送, 消息终止, 覆盖和撤回, emoji, 表情推送, 标签推送, 通知大图, 大文本, 角标设置, 自定义通知图标, 消息分类, 自定义通知铃声, 三方账号打通, 推送应用场景, 基于应用信息生成鉴权令牌, 请求示例, 响应参数, 请求体参数说明, 请求体结构说明, 功能介绍, 场景化消息, 个推回执文档, 老版文档, 返回码说明, 用户api, 统计api, 推送api, 鉴权api, 多厂商参数, 公共参数, 进阶功能说明, 接口调用规范, 开发前必读, restapi, 推荐使用, kit常见问题, 推送后台消息, 发送语音播报消息, 发送通知消息, 推送场景化消息, 获取push, 通知类型介绍, 使用入门, 服务端接口, ios接口, android接口, 使用指南, 卓信id, 客户端插件, 小程序, harmonyos, 隐私清单说明, ios集成视频, 证书配置指南, 厂商通道限额, qps说明, 厂商sdk更新日志, 厂商消息报表补全, 厂商sdk集成指南, android多厂商, maven集成视频, android, 多厂商推送接入说明, 名词解释, 开发者中心使用说明, 产品简介, 快速接入指南, 快速入门, 本月不再提醒, 立即登录, 欢迎登录开发者中心, 体验更多产品服务, 点击提升, 合规检测, 一键认证, 数字人外呼, 短信服务, 模型管理, 标签管理, 用户分析, 统计分析, ai应用工坊, oneid服务, 用户运营, 消息推送, 请选择产品, 个推学堂, sdk下载, 退出登录, 应用管理, 安全设置, 基本资料, 您的优惠服务将于, 欢迎您, 文档中心, 个推文档中心,
Text of the page (random words):
void registerremotenotification unauthorizationoptions types 参数 types unauthorizationoptions类型的通知选项 说明 必须使用个推注册远程通知 否则通过个推代理无法获取部分apns回调 注意 个推内部自动关联devicetoken和cid 无需开发者手动调用 getuisdk registerdevicetokendata devicetoken 关联 该方法需要在主线程中调用 个推内部兼容ios10以下注册远程通知逻辑 开发者无需特殊处理 头文件 getuisdk h 接口调用示例 unauthorizationoptions types unauthorizationoptionbadge unauthorizationoptionalert unauthorizationoptionsound getuisdk registerremotenotification types 3 监听在线状态 void getuisdkdidnotifysdkstate sdkstatus status 参数 status sdk运行的状态 sdkstatusstarting 正在启动 sdkstatusstarted 启动 sdkstatusstoped 停止 sdkstatusoffline 离线 说明 监控sdk运行状态 sdk初始化到cid登入成功为正在启动状态 cid登入成功后为启动状态 示例 void getuisdkdidnotifysdkstate sdkstatus status nslog getuisdk status u status 4 展示apns通知 void getuisdknotificationcenter unusernotificationcenter center willpresentnotification unnotification notification completionhandler void unnotificationpresentationoptions completionhandler 参数 center 通知中心实例 notification 接收到的apns通知内容 completionhandler 是否展示通知回调详情block 说明 支持ios10及以上 app在前台时收到apns通知后的展示回调 用户可以设定当前通知的展示权限 本方法接管了系统的 usernotificationcenter willpresentnotification withcompletionhandler 展示回调 开发者需要调用个推注册远程通知 getuisdk registerremotenotification 头文件 getuisdk h 接口调用示例 void getuisdknotificationcenter unusernotificationcenter center willpresentnotification unnotification notification completionhandler void unnotificationpresentationoptions completionhandler nsstring msg nsstring stringwithformat testdemo apns n nsstringfromselector _cmd notification request content userinfo self homepage logmsg msg 参考代码 开发者注意根据实际需求自行修改 根据app需要 判断是否要提示用户badge sound alert等 completionhandler unnotificationpresentationoptionnone 若不显示通知 则无法点击通知 completionhandler unnotificationpresentationoptionbadge unnotificationpresentationoptionsound unnotificationpresentationoptionalert 5 接收apns通知 void getuisdkdidreceivenotification nsdictionary userinfo notificationcenter nullable unusernotificationcenter center response nullable unnotificationresponse response fetchcompletionhandler nullable void uibackgroundfetchresult completionhandler 参数 userinfo 通知内容 center unusernotificationcenter ios10及以上版本 response unnotificationresponse ios10及以上版本 fetchcompletionhandler 用来在后台状态下进行操作 ios10以下版本 说明 apns接收通知回调 本方法接管了系统的 application didreceiveremotenotification fetchcompletionhandler 和 usernotificationcenter didreceivenotificationresponse withcompletionhandler 通知回调 开发者需要调用个推注册远程通知 getuisdk registerremotenotification 注意 如果你重写了 application didreceiveremotenotification fetchcompletionhandler 和 当前方法 要注意只保留一个completionhandler调用 调用多次可能多导致偶现crash 头文件 getuisdk h 示例 void getuisdkdidreceivenotification nsdictionary userinfo notificationcenter unusernotificationcenter center response unnotificationresponse response fetchcompletionhandler void uibackgroundfetchresult completionhandler nsstring msg nsstring stringwithformat testdemo apns n nsstringfromselector _cmd userinfo self homepage logmsg msg if completionhandler 参考代码 开发者注意根据实际需求自行修改 根据app需要自行修改参数值 completionhandler uibackgroundfetchresultnodata void application uiapplication application didreceiveremotenotification nsdictionary userinfo fetchcompletionhandler void uibackgroundfetchresult completionhandler 注意 如果执行了上述代理方法中的completionhandler 就不要执行当前回调中的completionhandler 防止两次调用completionhandler引起崩溃 completionhandler uibackgroundfetchresultnewdata 6 接收透传消息 void getuisdkdidreceiveslience nsdictionary userinfo fromgetui bool fromgetui offline bool offline appid nullable nsstring appid taskid nullable nsstring taskid msgid nullable nsstring msgid fetchcompletionhandler nullable void uibackgroundfetchresult completionhandler 参数 userinfo 推送消息内容 fromgetui yes 个推通道 no 苹果apns通道 offline yes 个推离线消息 no 个推在线消息 appid 应用的appid taskid 推送消息的任务id msgid 推送消息的messageid completionhandler 用来在后台状态下进行操作 通过苹果apns通道的消息 才有此参数值 说明 通过个推发送透传消息时 如果下发时cid在线 getuisdkdelegate 将收到回调且offline no 如果下发时cid离线 消息将存入个推离线服务器 通过苹果apns发送静默消息通知 cid在线后将收到本条消息且offline yes 本方法接管了系统的 application didreceiveremotenotification fetchcompletionhandler 通知回调 处理来自苹果apns的静默消息通知回调 开发者需要调用个推注册远程通知 getuisdk registerremotenotification 个推在线渠道的点击数 需要您在客户端在线透传消息自处理展示后 自己监听点击动作 当客户端出现点击动作时 调用sendfeedbackmessage方法 上报actionid为60002的点击回执 以此来补全统计苹果在线个推渠道透传消息的点击数 静默通知相关说明 头文件 getuisdk h 示例 void getuisdkdidreceiveslience nsdictionary userinfo fromgetui bool fromgetui offline bool offline appid nsstring appid taskid nsstring taskid msgid nsstring msgid fetchcompletionhandler void uibackgroundfetchresult completionhandler nsstring msg nsstring stringwithformat testdemo apn nreceive slience fromgetui appid offline taskid msgid userinfo nsstringfromselector _cmd fromgetui 个推消息 apns消息 appid offline 离线 在线 taskid msgid userinfo self homepage logmsg msg if completionhandler 参考代码 开发者注意根据实际需求自行修改 根据app需要自行修改参数值 completionhandler uibackgroundfetchresultnodata 以下处理用于推送苹果在线透传消息时 补全上报个推渠道消息点击数 需通过上述userinfo的_gmid_中获取到taskid 和msgid _gmid_组成格式是taskid msgid clientid 以冒号区分 在您自身点击事件逻辑触发时 执行上报埋点 点击id固定为60002 getuisdk sendfeedbackmessage 60002 andtaskid taskid andmsgid msgid 7 授权回调 void getuisdkgrantauthorization bool granted error nserror error 参数 granted 是否授权 error 错误信息 说明 开发者需要调用个推注册远程通知 getuisdk registerremotenotification 用户的授权状态会通过回调 getuisdkgrantauthorization 告知开发者 头文件 getuisdk h 示例 void getuisdkgrantauthorization bool granted error nserror error nsstring msg nsstring stringwithformat testdemo apns n nsstringfromselector _cmd granted error nslog msg 8 通知设置回调 void getuisdknotificationcenter unusernotificationcenter center opensettingsfornotification nullable unnotification notification 参数 center unusernotificationcenter ios10及以上版本 notification 接收到的apns通知内容 说明 支持ios10及以上 注册远程通知时 若设置unauthorizationoptionprovidesappnotificationsettings 此配置支持ios12 开发者可以申请自定义通知设置 在 设置 对应的通知设置中跳转到当前app的回调 本方法接管了系统的 usernotificationcenter opensettingsfornotification 通知设置回调 开发者需要调用个推注册远程通知 getuisdk registerremotenotification 头文件 getuisdk h 9 发送自定义回执 bool sendfeedbackmessage nsinteger actionid andtaskid nsstring taskid andmsgid nsstring msgid 参数 actionid 用户自定义的actionid int类型 取值90001 90999 taskid 下发任务的任务id msgid 下发任务的消息id 返回 bool 发送成功 yes 发送失败 no taskid 为空或者 messageid 为空 或者 actionid 不在取值范围以内 说明 第三方自定义回执 可用于数据统计 头文件 getuisdk h 示例 gtsdk回调 sdk收到透传消息回调 void getuisdkdidreceivepayloaddata nsdata payloaddata andtaskid nsstring taskid andmsgid nsstring msgid andoffline bool offline fromgtappid nsstring appid gtsdk 汇报个推自定义事件 反馈透传消息 getuisdk sendfeedbackmessage 90001 andtaskid taskid andmsgid msgid 10 applink 点击回执 nsstring handleapplinkfeedback nsurl weburl 参数 weburl applink的 url 对象 返回 返回 weburl 中的 payload 信息 说明 applink 用户点击回执 返回下发中的透传信息 开发者可在获取到payload内容后处理具体业务逻辑 该接口可统计applink用户点击次数 头文件 getuisdk h 示例 系统回调 applink回调 bool application uiapplication application continueuseractivity nsuseractivity useractivity restorationhandler void nsarray id uiuseractivityrestoring __ nullable restorableobjects restorationhandler if useractivity activitytype isequaltostring nsuseractivitytypebrowsingweb nsurl weburl useractivity webpageurl gtsdk 处理个推applink回执统计 applink url 示例 https link gl ink getui n payload p mid 其中 n payload 字段存储用户透传信息 可以根据透传内容进行业务操作 nsstring payload getuisdk handleapplinkfeedback weburl if payload nslog testdemo 个推applink中携带的用户payload信息 url payload weburl todo 用户可根据具体 payload 进行业务处理 return yes 11 关闭推送 void setpushmodeforoff bool isvalue 参数 isvalue 关闭推送模式功能 关闭推送 yes 开启推送 no 默认推送开启 说明 客户端可以关闭服务器的推送功能 关闭后 服务器将不给该客户端发推送消息 默认推送开启 请求回调见 getuisdkdelegate 中的 void getuisdkdidsetpushmode bool ismodeoff error nserror error 具体可参考getuisdkdelegate 回调中的说明 头文件 getuisdk h 接口调用示例 getuisdk setpushmodeforoff no 请求结果处理示例 void getuisdkdidsetpushmode bool ismodeoff error nserror error if error nsstring errorinfo nsstring stringwithformat setmodeoff error error localizeddescription nslog getuisdkdidsetpushmode with error errorinfo return nsstring msg nsstring stringwithformat getuisdkdidsetpushmode ismodeoff 关闭推送 开启推送 error localizeddescription nslog msg 12 设置标签 bool settags nsarray tags bool settags nsarray tags andsequencenum nsstring asn 参数 tags nsstring 的对象数组 不能为 nil 只能包含中文字符 英文字母 0 9 的组合 不支持空格 asn 用户自定义的请求序列号 用来唯一标识该动作 若不指定sn 会根据tags自动生成sn 建议每个设置标签操作设置不同的sn标识 说明 设置一组标签 覆盖操作 cid只会绑定当前传入的标签 后续可使用该标签定向推送 需要在获取到 cid 之后调用 默认一天只能成功设置一次 可联系技术支持进行修改 请求回调见 getuisdkdelegate 中的 void getuisdkdidsettagsaction nsstring sequencenum result bool issuccess error nserror aerror 头文件 getuisdk h 接口调用示例 getuisdk settags 标签1 标签2 标签3 getuisdk settags 标签1 标签2 标签3 andsequencenum seqtag 1 请求结果处理示例 void getuisdkdidsettagsaction nsstring sequencenum result bool issuccess error nserror aerror 参数说明 sequencenum 请求的序列码 issuccess 操作成功 yes 操作失败 no aerror code 20001 tag 数量过大 单次设置的 tag 数量不超过 100 20002 调用次数超限 默认一天只能成功设置一次 20003 标签重复 20004 服务初始化失败 20005 settag 异常 20006 tag 为空 20007 sn 为空 20008 离线 还未登陆成功 20009 该 appid 已经在黑名单列表 请联系技术支持处理 20010 已存 tag 数目超限 20011 tag 内容格式不正确 nslog getuisdkdidsettagaction sequencenum issuccess error sequencenum issuccess aerror 13 绑定别名 void bindalias nsstring alias andsequencenum nsstring asn 参数 alias 别名名称 长度40字节 支持中 英文 区分大小写 数字以及下划线 asn 绑定序列码 不为nil 说明 绑定别名 后续可以使用该别名进行定向推送 重复绑定以最后一次为准 两次调用的间隔需大于 5s 单个 cid 在 24 小时内限制调用50次 可用于与客户账号系统关联 建议将邮箱 昵称 手机号等用户标识设为别名 使用场景 同一个账号 比如手机号 分别登陆在 a b c 三台设备上的同一个 app 产生了 3 个不同的 cid 想让这三台设备同时接收到推送 就可以考虑使用该接口 让三台设备的三个 cid 都绑定同一个别名也就是你的账号 比如手机号 最多支持 10 台设备 也就是最多绑定 10 个 cid 请求回调见 getuisdkdelegate 中的 getuisdkdidaliasaction nsstring action result bool issuccess sequencenum nsstring asn error nserror aerror 具体可参考getuisdkdelegate 回调中的说明 头文件 getuisdk h 接口调用示例 getuisdk bindalias 个推 andsequencenum seq 1 请求结果处理示例 void getuisdkdidaliasaction nsstring action result bool issuccess sequencenum nsstring asn error nserror aerror 参数说明 issuccess 操作成功 yes 操作失败 no aerror code 30001 操作别名失败 频率过快 两次调用的间隔需大于 5s 30002 操作别名失败 参数错误 30003 当前 cid 绑定别名次数超限 30004 操作别名失败 未知异常 30005 操作别名时 cid 未获取到 30006 操作别名时 发生网络错误 30007 别名无效 30008 sn 无效 if action isequal kgtresponsebindtype nslog testdemo bind alias result sn code asn aerror code if action isequal kgtresponseunbindtype nslog testdemo unbind alias result sn code asn aerror code 14 解绑别名 void unbindalias nsstring alias andsequencenum nsstring asn andisself bool isself 参数 alias 别名名称 长度40字节 支持中 英文 区分大小写 数字以及下划线 asn 绑定序列码 不为nil isself 是否只对当前cid有效 如果是yes 只对当前cid做解绑 如果是no 对所有绑定该别名的cid列表做解绑 说明 解绑别名 两次调用的间隔需大于 5s 只能解绑与当前应用 cid 关联的别名 单个 cid 在 24 小时内限制调用50次 请求回调同 绑定别名 getuisdk h 示例 getuisdk unbindalias 个推 andsequencenum seq 1 andisself yes 15 设置角标 void setbadge nsuinteger value 参数 value 设置的角标值 取值范围 0 99999 说明 同步服务器角标计数 app角标显示需额外调用 uiapplication sharedapplication setapplicationiconbadgenumber badge 进行设置 头文件 getuisdk h 示例 getuisdk setbadge 5 如果需要角标显示需要调用系统方法设置 uiapplication sharedapplication setapplicationiconbadgenumber 5 16 复位角标 void resetbadge 说明 设置服务器角标计数为0 app角标复位需额外调用 uiapplication sharedapplication setapplicationiconbadgenumber 0 进行设置 头文件 getuisdk h 示例 重置角标 getuisdk resetbadge 如果需要角标清空需要调用系统方法设置 uiapplication sharedapplication setapplicationiconbadgenumber 0 17 清空通知 void clearallnotificationfornotificationbar 说明 清空下拉通知栏全部通知 并将角标置 0 即不显示角标 头文件 getuisdk h 示例 清空通知和角标 getuisdk clearallnotificationfornotificationbar 18 获取缓存cid nsstring clientid 返回 clientid nsstring 个推唯一 id 用于标识当前应用 说明 获取当前用户缓存的 cid 长时间未登录或 appid 发生变化造成的 cid 变化以 17 获取回调cid 接口中的 cid 为准 头文件 getuisdk h 示例 getuisdk clientid 19 获取个推cid void getuisdkdidregisterclient nsstring clientid 参数 clientid 个推唯一 id 用于标识当前应用 说明 启动getuisdk后 sdk会自动向个推服务器注册sdk 当成功注册时 sdk通知应用注册成功获取到cid 注册成功仅表示推送通道建立 如果appid appkey appsecret等验证不通过 依然无法接收到推送消息 请确保验证信息正确 请求回调见 getuisdkdelegate 中的 void getuisdkdidregisterclient nsstring clientid 具体可参考getuisdkdelegate 回调中的说明 头文件 getuisdk h 示例 void getuisdkdidregisterclient nsstring clientid nslog getuisdk clientid clientid 20 获取 sdk 服务状态 sdkstatus status 返回 sdkstatus sdk状态 sdkstatusstarting 正在启动 sdkstatusstarted 启动 sdkstatusstoped 停止 sdkstatusoffline 离线 说明 获取当前 sdk 的服务状态 头文件 getuisdk h 示例 getuisdk status 21 获取 sdk 版本号 nsstring version 返回 nsstring 当前 sdk 版本号字符串 说明 获取当前 sdk 版本号 头文件 getuisdk h 示例 getuisdk version 22 设置渠道 void setchannelid nsstring channelid 参数 channelid 渠道信息 说明 根据用户分发的渠道进行设置 个推后台可根据渠道信息进行统计分析 生成报表 头文件 getuisdk h 示例 设置渠道信息 getuisdk setchannelid gt channel 23 注册 voiptoken bool registervoiptokencredentials nsdata voiptoken 参数 voiptoken 传入ios系统回调的voiptoken 说明 在ios8 苹果引入了一个新的被用于 voip app 类型的推送消息 收到 voip 推送时 若app在后台则会执行相关系统回调函数 若app杀死状态则将被唤醒并执行相关系统回调函数 个推 voip 服务通过该接口注册 voiptoken 从而进行 voip 推送服务 头文件 getuisdk h 示例 系统回调 void pushregistry pkpushregistry registry didupdatepushcredentials pkpushcredentials credentials fortype nsstring type 向个推服务器注册 voiptoken getuisdk registervoiptokencredentials credentials token 24 voip推送消息回执 void handlevoipnotification nsdictionary payload 参数 payload voip 推送中携带的payload信息 说明 接收 voip 消息后调用 统计 voip 推送到达数 警告 在ios 13 之后 apple不再允许pushkit应用在非voip电话的场景下 如果需要使用pushkit则需要接入callkit的接口 若需要实现语音播报功能 建议通过通知扩展实现 具体参考官方demo 头文件 getuisdk h 示例 系统回调 void pushregistry pkpushregistry registry didreceiveincomingpushwithpayload pkpushpayload payload fortype nsstring type todo 接收 voip 推送中的 payload 信息进行业务处理 nslog voip payload payload payload dictionarypayload 调用个推 voip 回执统计接口 getuisdk handlevoipnotification payload dictionarypayload 25 设置后台运行 void runbackgroundenable bool isenable 参数 isenable yes 允许 app进入后台后 sdk执行保活逻辑 维持socket通道连接 no 不允许 app进入后台后 sdk会主动断开socket通道等 默认不设置 app进入后台后 sdk不会执行保活逻辑 也不会断开socket通道 等待系统自动断开socket通道 说明 设置是否允许后台运行 头文件 getuisdk h 示例 getuisdk runbackgroundenable yes 26 地理围栏功能 void lbslocationenable bool isenable anduserverify bool isverify 参数 isenable 设置地理围栏功能是否运行 yes 允许 no 不允许 默认为 no isverify 设置是否sdk主动弹出用户定位请求 yes 允许 no 不允许 默认为 no 说明 本功能为使用个推2 0智能标签和个推3 0应景推送的必选功能 建议勾选 头文件 getuisdk h 示例 getuisdk lbslocationenable yes anduserverify yes 27 发送上行消息 nsstring sendmessage nsdata body error nserror error nsstring sendmessage nsdata body taskid nsstring taskid error nserror error 参数 body 发送的数据 taskid 任务id uuidstring 非必填 error 如果发送错误给出错误消息 返回 nsstring 如果发送成功返回messageid 发送失败返回nil 说明 请求回调见 getuisdkdelegate 中的 void getuisdkdidsendmessage nsstring messageid result int result 具体可参考getuisdkdelegate 回调中的说明 头文件 getuisdk h 接口调用示例 nserror aerror nil nsdata senddata sendmessage datausingencoding nsutf8stringencoding getuisdk sendmessage senddata error aerror 请求结果处理示例 void getuisdkdidsendmessage nsstring messageid result int result 消息推送到个推服务器 服务器通过该接口通知sdk到达结果 result 为1 说明消息发送成功 0为失败 注意 需第三方服务器接入个推 sendmessage 到达第三方服务器后返回 1 nsstring msg nsstring stringwithformat received sendmessage result d messageid result nslog testdemo getuisdk didsendmessage n n msg 28 设置app groups id void setapplicationgroupidentifier nsstring identifier 参数 identifier 通过苹果开发者后台设置的group identify 说明 需要同时设置 getuisdk setapplicationgroupidentifier 和 getuiextsdk setapplicationgroupidentifier 用于回执报表统计 支持版本2 6 4 0及以上 头文件 getuisdk h 接口调用示例 getuisdk setapplicationgroupidentifier 苹果开发者后台设置的 group identify 29 ios extension sdk api 29 1 多媒体推送接口 void handelnotificationservicerequest unnotificationrequest request withattachmentscomplete void nsarray attachments nsarray errors completeblock 参数 request 推送送达的apns信息 completeblock 个推统计和多媒体资源下载完成后回调用户操作 用户可在此回调中自行修...
|