This API is used to add the callback function for receiving new messages.
Prototype
TIM_DECL void TIMAddRecvNewMsgCallback(TIMRecvNewMsgCallback cb, const void* user_data);
Parameters
Parameter | Type | Description |
---|---|---|
cb | TIMRecvNewMsgCallback | New message callback function. For more information, see TIMRecvNewMsgCallback. |
user_data | const void* | User-defined data. The IM SDK only transfers the user data to the callback function cb without processing the data. |
Note:
If a user has logged in, the IM SDK will send new messages using the callback function set by this API. New messages include not only unread messages but also any messages that do not exist on the local terminal. For example, when the IM SDK fetches recent contact messages, the last message in the conversation can be obtained. If the message does not exist on the local terminal, it will be sent using this method. After the user logs in, the IM SDK will fetch offline messages. In order not to miss message notifications, the user needs to register new message notifications before login.
This API is used to delete the callback function for receiving new messages.
Prototype
TIM_DECL void TIMRemoveRecvNewMsgCallback(TIMRecvNewMsgCallback cb);
Parameters
Parameter | Type | Description |
---|---|---|
cb | TIMRecvNewMsgCallback | New message callback function. For more information, see TIMRecvNewMsgCallback. |
Note:
The cb parameter must be the same as that sent by TIMAddRecvNewMsgCallback. Otherwise, the callback function cannot be deleted.
This API is used to set the callback function for message read receipt.
Prototype
TIM_DECL void TIMSetMsgReadedReceiptCallback(TIMMsgReadedReceiptCallback cb, const void* user_data);
Parameters
Parameter | Type | Description |
---|---|---|
cb | TIMMsgReadedReceiptCallback | Message read receipt callback function. For more information, see TIMMsgReadedReceiptCallback. |
user_data | const void* | User-defined data. The IM SDK only transfers the user data to the callback function cb without processing the data. |
Note:
When the sender sends a message, the recipient calls the TIMMsgReportReaded API to report that the message has been read. The IM SDK at the sender's end will send the receipt using the callback function set by this API.
This API is used to set the callback function for notifying received message revocation.
Prototype
TIM_DECL void TIMSetMsgRevokeCallback(TIMMsgRevokeCallback cb, const void* user_data);
Parameters
Parameter | Type | Description |
---|---|---|
cb | TIMMsgRevokeCallback | Message revocation notification callback function. For more information, see TIMMsgRevokeCallback. |
user_data | const void* | User-defined data. The IM SDK only transfers the user data to the callback function cb without processing the data. |
Note:
If the sender calls the TIMMsgRevoke API to revoke a message that it sends to the recipient, the IM SDK at the recipient's end will send a message revocation notification using the callback function set by this API.
This API is used to set the callback function for the upload progress of message element files.
Prototype
TIM_DECL void TIMSetMsgElemUploadProgressCallback(TIMMsgElemUploadProgressCallback cb, const void* user_data);
Parameters
Parameter | Type | Description |
---|---|---|
cb | TIMMsgElemUploadProgressCallback | File upload progress callback function. For more information, see TIMMsgElemUploadProgressCallback. |
user_data | const void* | User-defined data. The IM SDK only transfers the user data to the callback function cb without processing the data. |
Note:
Set the callback function for the message element upload progress. When a message contains picture, voice, file, and video elements, the IM SDK will upload these files and trigger the callback function set by this API. Users can detect the upload progress based on the callback function.
This API is used to set the callback for group system messages.
Prototype
TIM_DECL void TIMSetGroupTipsEventCallback(TIMGroupTipsEventCallback cb, const void* user_data);
Parameters
Parameter | Type | Description |
---|---|---|
cb | TIMGroupTipsEventCallback | Group message callback function. For more information, see TIMGroupTipsEventCallback. |
user_data | const void* | User-defined data. The IM SDK only transfers the user data to the callback function cb without processing the data. |
Note:
Group system message events include joining a group, exiting a group, removing from a group, setting an admin, canceling an admin, changing group information, and changing group member information. These messages are sent to all group members.
This API is used to set the callback function for conversation events.
Prototype
TIM_DECL void TIMSetConvEventCallback(TIMConvEventCallback cb, const void* user_data);
Parameters
Parameter | Type | Description |
---|---|---|
cb | TIMConvEventCallback | Conversation event callback function. For more information, see TIMConvEventCallback. |
user_data | const void* | User-defined data. The IM SDK only transfers the user data to the callback function cb without processing the data. |
Note:
This API is used to set the callback function for monitoring the network connection status.
Prototype
TIM_DECL void TIMSetNetworkStatusListenerCallback(TIMNetworkStatusListenerCallback cb, const void* user_data);
Parameters
Parameter | Type | Description |
---|---|---|
cb | TIMNetworkStatusListenerCallback | Network connection event callback function. For more information, see TIMNetworkStatusListenerCallback. |
user_data | const void* | User-defined data. The IM SDK only transfers the user data to the callback function cb without processing the data. |
Note:
This API is used to set the callback function for kicked offline notifications.
Prototype
TIM_DECL void TIMSetKickedOfflineCallback(TIMKickedOfflineCallback cb, const void* user_data);
Parameters
Parameter | Type | Description |
---|---|---|
cb | TIMKickedOfflineCallback | Callback function when the user is kicked offline. For more information, see TIMKickedOfflineCallback. |
user_data | const void* | User-defined data. The IM SDK only transfers the user data to the callback function cb without processing the data. |
Note:
TIMKickedOfflineCallback
. After the user receives the callback on device 1, the system prompts that the user can call login to log in on device 1 and kick device 2 offline.TIMKickedOfflineCallback
.This API is used to set the callback function for ticket expiration.
Prototype
TIM_DECL void TIMSetUserSigExpiredCallback(TIMUserSigExpiredCallback cb, const void* user_data);
Parameters
Parameter | Type | Description |
---|---|---|
cb | TIMUserSigExpiredCallback | Ticket expiration callback function. For more information, see TIMUserSigExpiredCallback. |
user_data | const void* | User-defined data. The IM SDK only transfers the user data to the callback function cb without processing the data. |
Note:
User tickets may expire. If a user ticket expires, the callback function set by this API will be called. TIMLogin will return error code 70001. Developers can change the ticket based on the error code or ticket expiration callback function.
This API is used to set the callback function for adding friends.
Prototype
TIM_DECL void TIMSetOnAddFriendCallback(TIMOnAddFriendCallback cb, const void* user_data);
Parameters
Parameter | Type | Description |
---|---|---|
cb | TIMOnAddFriendCallback | Callback function for adding friends. For more information, see TIMOnAddFriendCallback. |
user_data | const void* | User-defined data. The IM SDK only transfers the user data to the callback function cb without processing the data. |
Note:
This callback function is used for multi-terminal synchronization. For example, the same IM SDK account has logged in to devices A and B. When device A adds a friend, the IM SDK on device B will receive a friend addition notification, and the IM SDK will notify the developer using this callback function.
This API is used to set the callback function for deleting friends.
Prototype
TIM_DECL void TIMSetOnDeleteFriendCallback(TIMOnDeleteFriendCallback cb, const void* user_data);
Parameters
Parameter | Type | Description |
---|---|---|
cb | TIMOnDeleteFriendCallback | Callback function for deleting friends. For more information, see TIMOnDeleteFriendCallback. |
user_data | const void* | User-defined data. The IM SDK only transfers the user data to the callback function cb without processing the data. |
Note:
This callback function is used for multi-terminal synchronization. For example, the same IM SDK account has logged in to devices A and B. When device A deletes a friend, the IM SDK on device B will receive a friend deletion notification, and the IM SDK will notify the developer using this callback function.
This API is used to set the callback function for updating friend profiles.
Prototype
TIM_DECL void TIMSetUpdateFriendProfileCallback(TIMUpdateFriendProfileCallback cb, const void* user_data);
Parameters
Parameter | Type | Description |
---|---|---|
cb | TIMUpdateFriendProfileCallback | Callback function for updating friend profiles. For more information, see TIMUpdateFriendProfileCallback |
user_data | const void* | User-defined data. The IM SDK only transfers the user data to the callback function cb without processing the data. |
Note:
This callback function is used for multi-terminal synchronization. For example, the same IM SDK account has logged in to devices A and B. When device A updates a friend's profile, the IM SDK on device B will receive a friend profile update notification, and the IM SDK will notify the developer using this callback function.
This API is used to set the callback function for friend requests.
Prototype
TIM_DECL void TIMSetFriendAddRequestCallback(TIMFriendAddRequestCallback cb, const void* user_data);
Parameters
Parameter | Type | Description |
---|---|---|
cb | TIMFriendAddRequestCallback | Callback function for friend requests. For more information, see TIMFriendAddRequestCallback. |
user_data | const void* | User-defined data. The IM SDK only transfers the user data to the callback function cb without processing the data. |
Note:
If the logged-in user has set confirmation for friend requests and another user sends a friend request to this user, the logged-in user will receive the friend request callback, and the IM SDK will notify the developer using this callback function. If the same account has logged in on multiple terminals, each terminal will receive the callback.
This API is used to set log callback.
Prototype
TIM_DECL void TIMSetLogCallback(TIMLogCallback cb, const void* user_data);
Parameters
Parameter | Type | Description |
---|---|---|
cb | TIMLogCallback | Log callback. For more information, see TIMLogCallback. |
user_data | const void* | User-defined data. The IM SDK only transfers the user data to the callback function cb without processing the data. |
Note:
After the log monitoring callback function is set, the IM SDK internal logs will be returned to the callback function set by this API. Developers can call the TIMSetConfig API to configure the log levels of logs to be returned to the callback function.
This API is used to set the callback function for message update notifications returned after messages are modified on the cloud.
Prototype
TIM_DECL void TIMSetMsgUpdateCallback(TIMMsgUpdateCallback cb, const void* user_data);
Parameters
Parameter | Type | Description |
---|---|---|
cb | TIMMsgUpdateCallback | Message update callback function. For more information, see TIMMsgUpdateCallback. |
user_data | const void* | User-defined data. The IM SDK only transfers the user data to the callback function cb without processing the data. |
Note:
Was this page helpful?