提交工单
咨询集成、功能及报价等问题
ZEGO 即时通讯 SDK 拥有全面覆盖全球重点区域的网络节点,提供丰富的 API,为开发者提供全平台互动、海量并发、超低延时、消息必达的通信服务,助力打造大型直播、语聊房等场景。
API 返回的错误码,请参考 https://doc-zh.zego.im/article/11606。
方法名 | 描述 |
---|---|
updateUserOfflinePushRule:offlinePushRule:callback: | 修改离线推送的自定规则 |
querySelfUserInfo:callback: | 查询自身用户信息、用户规则。 |
createWithAppID: | 创建 ZIM 实例。 |
createWithAppConfig: | 创建 ZIM 实例。 |
getVersion | 获取 SDK 版本号。 |
getInstance | 获取 ZIM 单例对象。 |
setEventHandler: | 设置事件通知回调,传 [null] 则清空已设置的回调。 |
setLogConfig: | 设置日志相关配置。 |
setGeofencingConfig: | 设置地理围栏相关配置。 |
setCacheConfig: | 设置缓存相关配置。 |
loginWithUserInfo:token:callback: | 登录,在使用所有功能之前必须先登录。 |
loginWithUserInfo:callback: | 登录,在使用所有功能之前必须先登录。 |
loginWithUserID:config:callback;: | 登录,在使用所有功能之前必须先登录。 |
renewToken:callback: | 更新鉴权 Token。 |
queryUsersInfo:userIDs:config:callback: | 查询用户信息。 |
updateUserName:userName:callback: | 更新用户的用户名。 |
updateUserAvatarUrl:userAvatarUrl:callback: | 更新用户的用户头像URL。 |
updateUserExtendedData:extendedData:callback: | 更新用户的用户扩展字段。 |
uploadLog: | 上传日志,设置日志路径和创建实例后调用。 |
logout | 登出 ZIM 服务。 |
destroy | 销毁 ZIM 实例。 |
zim:errorInfo: | 错误信息回调。 |
zim:tokenWillExpire: | Token 将要过期的提醒回调。 |
zim:userInfoUpdated: | 用户信息更新的回调。 |
zim:userRuleUpdated: | 用户规则变更的回调。 |
方法名 | 描述 |
---|---|
callInviteWithInvitees:config:callback: | 发起呼叫邀请。 |
callJoin:callID:config:callback: | 加入进阶模式呼叫,或者切换进阶模式呼叫的主设备(仅限多端登录) |
callCancelWithInvitees:config:callback: | 取消呼叫邀请。 |
callAcceptWithCallID:config:callback: | 接受呼叫邀请。 |
callRejectWithCallID:config:callback: | 拒绝呼叫邀请。 |
callQuit:config:callback: | 退出当前呼叫邀请。 |
callEnd:config:callback: | 结束呼叫邀请。 |
callingInviteWithInvitees:callID:config:callback: | 邀请其他用户加入呼叫邀请。 |
queryCallInvitationListWithConfig:callback: | 查询呼叫邀请列表。 |
zim:blacklistChanged:userList: | 当黑名单列表发生变化时会回调当前方法 |
zim:callInvitationReceived:callID: | 被邀请者收到的呼叫邀请的通知回调。 |
zim:callInvitationCreated:callID: | 邀请者创建的呼叫邀请回调。 |
zim:callInvitationCancelled:callID: | 被邀请者收到的取消邀请的通知回调。 |
zim:callInvitationTimeout: | 被邀请者的呼叫邀请超时的通知回调。 |
zim:callInvitationAccepted:info:callID: | 邀请者收到的接受邀请的通知回调。 |
zim:callInvitationRejected:callID: | 邀请者收到的被邀请者拒绝邀请的通知回调。 |
zim:callInviteesAnsweredTimeout:callID: | 邀请者呼叫邀请超时的通知回调。 |
zim:callInvitationEnded:callID: | 呼叫结束的通知回调。 |
zim:callUserStateChanged:callID: | 呼叫邀请内的用户状态的通知回调。 |
方法名 | 描述 |
---|---|
addLocalNotificationWithContent:content:trigger:completionHandler: | 添加一条本地推送。 |
ZPNsNotificationCenter:didReceiveNotificationResponse:withCompletionHandler: | 当用户点击远程推送进入 APP 时,触发此回调方法。 |
onRegistered:Pushid: | 生成 PushID 后触发的回调。 |
registerAPNs | 向 APNs 注册。 |
setBadge:badge: | 通过该接口向 ZPNs 服务器上报当前 App 的角标数。 |
setDeviceToken:isProduct: | 使用该方法将 deviceToken 传入 ZPNs 并得到 PushID。 |
setPushConfig: | 设置各家厂商的推送设置项。 |
setVoIPToken:voIPtoken:isProduct: | 用于向 ZPNs 上传从系统获得的 VoIP 推送 token。 |
setZPNsNotificationCenterDelegate:delegate: | 设置事件通知回调,传 [null] 则清空已设置的回调。 |
shared | 获得 ZPNs 实例。 |
ZPNsNotificationCenter:willPresentNotification:userInfo:withCompletionHandler: | 应用在前台收到推送时会触发此回调方法。 |
unregisterAPNs | 不需要离线推送时可调用此方法反注册。 |
方法名 | 描述 |
---|---|
addUsersToBlacklistWithUserIDs:userIDs:callback: | 添加用户到黑名单。 |
removeUsersFromBlacklistWithUserIDs:userIDs:callback: | 将用户移除出黑名单。 |
queryBlacklistWithConfig:config:callback: | 查询黑名单。 |
checkUserIsInBlackListByUserID:userID:callback: | 检查用户是否在黑名单。 |
方法名 | 描述 |
---|---|
addFriendByUserID:userID:config:callback: | 直接添加好友。 |
sendFriendApplicationToUserID:userID:config:callback: | 发送好友申请。 |
deleteFriendsByUserIDs:userIDs:config:callback: | 批量删除好友。 |
checkFriendsRelationByUserIDs:userIDs:config:callback: | 检查好友关系。 |
updateFriendAlias:friendAlias:userID:callback: | 更新好友备注。 |
updateFriendAttributes:friendAttributes:userID:callback: | 更新好友属性。 |
acceptFriendApplicationFromUserID:userID:config:callback: | 接受好友申请。 |
rejectFriendApplicationFromUserID:userID:config:callback: | 拒绝好友申请。 |
queryFriendsInfoByUserIDs:userIDs:callback: | 批量查询好友信息。 |
queryFriendListWithConfig:config:callback: | 查询好友列表。 |
queryFriendApplicationListWithConfig:config:callback: | 查询好友申请列表。 |
searchLocalFriendsWithConfig:config:callback: | 搜索本地好友。 |
zim:friendListChanged:friendInfoList: | 当好友列表发生变化时会回调当前方法 |
zim:friendApplicationListChanged:friendApplicationInfoList: | 当好友申请列表发生变化时会回调当前方法 |
zim:friendApplicationUpdated:friendApplicationInfoList: | 当好友申请列表发生更新时会回调当前方法 |
zim:friendInfoUpdated:friendInfoList: | 当好友信息更新时候会触发该回调。 |
方法名 | 描述 |
---|---|
getVersion | 获取 ZIM Audio SDK 版本号 |
setAdvancedConfigWithKey:key:value: | 实现高级配置 |
sharedInstance | 获取单例对象。 |
initWithLicense:license: | 初始化 ZIM Audio SDK |
uninit | 反初始化 ZIM Audio SDK |
setEventHandler:eventHandler: | 设置 ZIM Audio SDK 事件通知回调 |
enableANS:enable: | 开启噪声控制功能 |
enableAGC:enable: | 开启音量增益功能 |
setANSParam:param: | 设置 ANS 参数 |
startRecordWithConfig:config: | 开始录制音频文件。 |
completeRecord | 完成录制音频文件。 |
cancelRecord | 中断录制音频 |
isRecording | 获取 ZIM Audio SDK 是否正在录制音频 |
setAudioRouteType:routeType: | 设置音频路由类型 |
startPlay:config: | 开始播放音频文件 |
stopPlay | 停止音频播放 |
isPlaying | 获取 ZIM Audio SDK 是否正在播放音频 |
onError:errorInfo: | 异常回调 |
onRecorderStarted | 录音开始回调 |
onRecorderCompleted:totalDuration: | 录音完成回调 |
onRecorderCancelled | 录音取消回调 |
onRecorderProgress:currentDuration: | 录制进度通知回调 |
onRecorderFailed:errorCode: | 音频录制失败回调 |
onPlayerStarted:totalDuration: | 音频播放开始回调 |
onPlayerEnded | 音频播放完成回调 |
onPlayerStopped | 音频播放停止回调 |
onPlayerProgress:currentDuration: | 音频播放进度回调 |
onPlayerInterrupted | 音频播放中断回调 |
onPlayerFailed:errorCode: | 音频播放失败回调 |
联系我们
文档反馈