TIMOfflinePushManagerFunction.h 文件参考

函数
TIM_API int	TIMMsgSetOfflinePushToken (const char *json_token, TIMCommCallback cb, const void *user_data)
TIM_API int	TIMMsgDoBackground (uint32_t unread_count, TIMCommCallback cb, const void *user_data)
TIM_API int	TIMMsgDoForeground (TIMCommCallback cb, const void *user_data)

函数说明

TIMMsgSetOfflinePushToken()

TIM_API int TIMMsgSetOfflinePushToken	(	const char *	json_token,
		TIMCommCallback	cb,
		const void *	user_data
	)

1.1 设置离线推送配置信息（iOS 和 Android 平台专用）

参数

json_token	离线推送配置 Json 字符串, Json Key 请参考 OfflinePushToken。注意 kTIMOfflinePushTokenToken 字段要填写为设备 Token 的 hex 字符串（即 base16 编码）。
cb	成功与否的回调。回调函数定义请参考 TIMCommCallback
user_data	用户自定义数据，ImSDK只负责传回给回调函数cb，不做任何处理

返回

int 返回TIM_SUCC表示接口调用成功（接口只有返回TIM_SUCC，回调cb才会被调用），其他值表示接口调用失败。每个返回值的定义请参考 TIMResult

注意

• 接口成功设置后会开启离线推送功能，如果您需要自定义推送的格式信息，请参考 TIMMsgSendMessage 接口。
• 如果您想关闭离线推送，请把 json_token 设置为 NULL。

示例

Json::Value json_parameters;
json_parameters[kTIMOfflinePushTokenToken] = "token base16 string";
json_parameters[kTIMOfflinePushTokenBusinessID] = 1234578;
json_parameters[kTIMOfflinePushTokenType] = 0;
TIMMsgSetOfflinePushToken(json_parameters.toStyledString().c_str(),
    [](int32_t code, const char* desc, const char* json_params, const void* user_data) {
}, nullptr);

TIMMsgDoBackground()

TIM_API int TIMMsgDoBackground	(	uint32_t	unread_count,
		TIMCommCallback	cb,
		const void *	user_data
	)

1.2 APP 检测到应用退后台时可以调用此接口，可以用作桌面应用角标的初始化未读数量（iOS 和 Android 平台专用）

参数

unread_count	未读数量
cb	成功与否的回调。回调函数定义请参考 TIMCommCallback
user_data	用户自定义数据，ImSDK只负责传回给回调函数cb，不做任何处理

返回

int 返回TIM_SUCC表示接口调用成功（接口只有返回TIM_SUCC，回调cb才会被调用），其他值表示接口调用失败。每个返回值的定义请参考 TIMResult

注意

• 从 6.1 版本开始，如果配置了离线推送，会收到厂商或 TPNS 的离线推送通道下发的通知栏消息。

TIMMsgDoForeground()

TIM_API int TIMMsgDoForeground	(	TIMCommCallback	cb,
		const void *	user_data
	)

1.3 APP 检测到应用进前台时可以调用此接口（iOS 和 Android 平台专用）

参数

cb	成功与否的回调。回调函数定义请参考 TIMCommCallback
user_data	用户自定义数据，ImSDK只负责传回给回调函数cb，不做任何处理

返回

int 返回TIM_SUCC表示接口调用成功（接口只有返回TIM_SUCC，回调cb才会被调用），其他值表示接口调用失败。每个返回值的定义请参考 TIMResult

注意

• 从 6.1 版本开始，调用 TIMMsgDoForeground，会停止离线推送。但如果应用被 kill，仍然可以正常接收离线推送。