Show / Hide Table of Contents

Class TencentIMSDK

Inheritance
System.Object
TencentIMSDK
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ToString()
System.Object.ReferenceEquals(System.Object, System.Object)
Namespace: com.tencent.imsdk.unity
Assembly: cs.temp.dll.dll
Syntax
public class TencentIMSDK

Methods

AddRecvNewMsgCallback(RecvNewMsgCallback, RecvNewMsgStringCallback)

注册收到新消息回调

如果用户是登录状态,ImSDK收到新消息会通过此接口设置的回调抛出,另外需要注意,抛出的消息不一定是未读的消息

只是本地曾经没有过的消息(例如在另外一个终端已读,拉取最近联系人消息时可以获取会话最后一条消息,如果本地没有,会通过此方法抛出)

在用户登录之后,ImSDK会拉取离线消息,为了不漏掉消息通知,需要在登录之前注册新消息通知

Declaration
public static void AddRecvNewMsgCallback(RecvNewMsgCallback callback = null, RecvNewMsgStringCallback stringCallback = null)
Parameters
Type Name Description
RecvNewMsgCallback callback

回调 RecvNewMsgCallback

RecvNewMsgStringCallback stringCallback

CallExperimentalAPI(ExperimentalAPIReqeustParam, ValueCallback<ReponseInfo>)

实验性接口,开发者一般使用不到,例如私有化等等

Declaration
public static TIMResult CallExperimentalAPI(ExperimentalAPIReqeustParam json_param, ValueCallback<ReponseInfo> callback)
Parameters
Type Name Description
ExperimentalAPIReqeustParam json_param

实验性接口参数 ExperimentalAPIReqeustParam

ValueCallback<ReponseInfo> callback

异步回调

Returns
Type Description
TIMResult

TIMResult

CallExperimentalAPI(ExperimentalAPIReqeustParam, ValueCallback<String>)

Declaration
public static TIMResult CallExperimentalAPI(ExperimentalAPIReqeustParam json_param, ValueCallback<string> callback)
Parameters
Type Name Description
ExperimentalAPIReqeustParam json_param
ValueCallback<System.String> callback
Returns
Type Description
TIMResult

CallExperimentalAPICallback(Int32, String, ReponseInfo, String)

Declaration
public static void CallExperimentalAPICallback(int code, string desc, ReponseInfo data, string user_data)
Parameters
Type Name Description
System.Int32 code
System.String desc
ReponseInfo data
System.String user_data

ConvCancelDraft(String, TIMConvType)

取消会话草稿

Declaration
public static TIMResult ConvCancelDraft(string conv_id, TIMConvType conv_type)
Parameters
Type Name Description
System.String conv_id

会话ID

TIMConvType conv_type

会话类型 TIMConvType

Returns
Type Description
TIMResult

TIMResult

ConvDelete(String, TIMConvType, NullValueCallback)

删除会话

Declaration
public static TIMResult ConvDelete(string conv_id, TIMConvType conv_type, NullValueCallback callback)
Parameters
Type Name Description
System.String conv_id

会话ID,c2c会话为user_id,群会话为group_id

TIMConvType conv_type

会话类型 TIMConvType

NullValueCallback callback

异步回调

Returns
Type Description
TIMResult

TIMResult

ConvDelete(String, TIMConvType, ValueCallback<String>)

Declaration
public static TIMResult ConvDelete(string conv_id, TIMConvType conv_type, ValueCallback<string> callback)
Parameters
Type Name Description
System.String conv_id
TIMConvType conv_type
ValueCallback<System.String> callback
Returns
Type Description
TIMResult

ConvGetConvInfo(List<ConvParam>, ValueCallback<List<ConvInfo>>)

获取会话信息

Declaration
public static TIMResult ConvGetConvInfo(List<ConvParam> conv_list_param, ValueCallback<List<ConvInfo>> callback)
Parameters
Type Name Description
System.Collections.Generic.List<ConvParam> conv_list_param

获取会话列表参数 ConvParam列表

ValueCallback<System.Collections.Generic.List<ConvInfo>> callback

异步回调

Returns
Type Description
TIMResult

TIMResult

ConvGetConvInfo(List<ConvParam>, ValueCallback<String>)

Declaration
public static TIMResult ConvGetConvInfo(List<ConvParam> conv_list_param, ValueCallback<string> callback)
Parameters
Type Name Description
System.Collections.Generic.List<ConvParam> conv_list_param
ValueCallback<System.String> callback
Returns
Type Description
TIMResult

ConvGetConvList(ValueCallback<List<ConvInfo>>)

获取会话列表

Declaration
public static TIMResult ConvGetConvList(ValueCallback<List<ConvInfo>> callback)
Parameters
Type Name Description
ValueCallback<System.Collections.Generic.List<ConvInfo>> callback

异步回调

Returns
Type Description
TIMResult

TIMResult

ConvGetConvList(ValueCallback<String>)

Declaration
public static TIMResult ConvGetConvList(ValueCallback<string> callback)
Parameters
Type Name Description
ValueCallback<System.String> callback
Returns
Type Description
TIMResult

ConvGetTotalUnreadMessageCount(ValueCallback<GetTotalUnreadNumberResult>)

获取全部会话未读数

Declaration
public static TIMResult ConvGetTotalUnreadMessageCount(ValueCallback<GetTotalUnreadNumberResult> callback)
Parameters
Type Name Description
ValueCallback<GetTotalUnreadNumberResult> callback

异步回调

Returns
Type Description
TIMResult

TIMResult

ConvGetTotalUnreadMessageCount(ValueCallback<String>)

Declaration
public static TIMResult ConvGetTotalUnreadMessageCount(ValueCallback<string> callback)
Parameters
Type Name Description
ValueCallback<System.String> callback
Returns
Type Description
TIMResult

ConvPinConversation(String, TIMConvType, Boolean, NullValueCallback)

会话置顶

Declaration
public static TIMResult ConvPinConversation(string conv_id, TIMConvType conv_type, bool is_pinned, NullValueCallback callback)
Parameters
Type Name Description
System.String conv_id

会话ID

TIMConvType conv_type

会话类型 TIMConvType

System.Boolean is_pinned

是否置顶标记

NullValueCallback callback

异步回调

Returns
Type Description
TIMResult

TIMResult

ConvPinConversation(String, TIMConvType, Boolean, ValueCallback<String>)

Declaration
public static TIMResult ConvPinConversation(string conv_id, TIMConvType conv_type, bool is_pinned, ValueCallback<string> callback)
Parameters
Type Name Description
System.String conv_id
TIMConvType conv_type
System.Boolean is_pinned
ValueCallback<System.String> callback
Returns
Type Description
TIMResult

ConvSetDraft(String, TIMConvType, DraftParam)

设置会话草稿

Declaration
public static TIMResult ConvSetDraft(string conv_id, TIMConvType conv_type, DraftParam param)
Parameters
Type Name Description
System.String conv_id

会话ID

TIMConvType conv_type

会话类型 TIMConvType

DraftParam param

DraftParam

Returns
Type Description
TIMResult

TIMResult

FriendshipAddFriend(FriendshipAddFriendParam, ValueCallback<FriendResult>)

添加好友

Declaration
public static TIMResult FriendshipAddFriend(FriendshipAddFriendParam param, ValueCallback<FriendResult> callback)
Parameters
Type Name Description
FriendshipAddFriendParam param

添加好友参数 FriendshipAddFriendParam

ValueCallback<FriendResult> callback

异步回调

Returns
Type Description
TIMResult

TIMResult

FriendshipAddFriend(FriendshipAddFriendParam, ValueCallback<String>)

Declaration
public static TIMResult FriendshipAddFriend(FriendshipAddFriendParam param, ValueCallback<string> callback)
Parameters
Type Name Description
FriendshipAddFriendParam param
ValueCallback<System.String> callback
Returns
Type Description
TIMResult

FriendshipAddToBlackList(List<String>, ValueCallback<List<FriendResult>>)

删除好友分组列表

Declaration
public static TIMResult FriendshipAddToBlackList(List<string> json_add_to_blacklist_param, ValueCallback<List<FriendResult>> callback)
Parameters
Type Name Description
System.Collections.Generic.List<System.String> json_add_to_blacklist_param
ValueCallback<System.Collections.Generic.List<FriendResult>> callback

异步回调

Returns
Type Description
TIMResult

TIMResult

FriendshipAddToBlackList(List<String>, ValueCallback<String>)

Declaration
public static TIMResult FriendshipAddToBlackList(List<string> json_add_to_blacklist_param, ValueCallback<string> callback)
Parameters
Type Name Description
System.Collections.Generic.List<System.String> json_add_to_blacklist_param
ValueCallback<System.String> callback
Returns
Type Description
TIMResult

FriendshipCheckFriendType(FriendshipCheckFriendTypeParam, ValueCallback<List<FriendshipCheckFriendTypeResult>>)

检测好友关系

Declaration
public static TIMResult FriendshipCheckFriendType(FriendshipCheckFriendTypeParam json_check_friend_list_param, ValueCallback<List<FriendshipCheckFriendTypeResult>> callback)
Parameters
Type Name Description
FriendshipCheckFriendTypeParam json_check_friend_list_param

检测好友关系参数 FriendshipCheckFriendTypeParam

ValueCallback<System.Collections.Generic.List<FriendshipCheckFriendTypeResult>> callback

异步回调

Returns
Type Description
TIMResult

TIMResult

FriendshipCheckFriendType(FriendshipCheckFriendTypeParam, ValueCallback<String>)

Declaration
public static TIMResult FriendshipCheckFriendType(FriendshipCheckFriendTypeParam json_check_friend_list_param, ValueCallback<string> callback)
Parameters
Type Name Description
FriendshipCheckFriendTypeParam json_check_friend_list_param
ValueCallback<System.String> callback
Returns
Type Description
TIMResult

FriendshipCreateFriendGroup(FriendGroupInfo, ValueCallback<List<FriendResult>>)

创建好友分组

Declaration
public static TIMResult FriendshipCreateFriendGroup(FriendGroupInfo json_create_friend_group_param, ValueCallback<List<FriendResult>> callback)
Parameters
Type Name Description
FriendGroupInfo json_create_friend_group_param

创建好友分组参数 FriendGroupInfo

ValueCallback<System.Collections.Generic.List<FriendResult>> callback

异步回调

Returns
Type Description
TIMResult

TIMResult

FriendshipCreateFriendGroup(FriendGroupInfo, ValueCallback<String>)

Declaration
public static TIMResult FriendshipCreateFriendGroup(FriendGroupInfo json_create_friend_group_param, ValueCallback<string> callback)
Parameters
Type Name Description
FriendGroupInfo json_create_friend_group_param
ValueCallback<System.String> callback
Returns
Type Description
TIMResult

FriendshipDeleteFriend(FriendshipDeleteFriendParam, ValueCallback<FriendResult>)

删除好友

Declaration
public static TIMResult FriendshipDeleteFriend(FriendshipDeleteFriendParam json_delete_friend_param, ValueCallback<FriendResult> callback)
Parameters
Type Name Description
FriendshipDeleteFriendParam json_delete_friend_param

删除好友参数 FriendshipDeleteFriendParam

ValueCallback<FriendResult> callback

异步回调

Returns
Type Description
TIMResult

TIMResult

FriendshipDeleteFriend(FriendshipDeleteFriendParam, ValueCallback<String>)

Declaration
public static TIMResult FriendshipDeleteFriend(FriendshipDeleteFriendParam json_delete_friend_param, ValueCallback<string> callback)
Parameters
Type Name Description
FriendshipDeleteFriendParam json_delete_friend_param
ValueCallback<System.String> callback
Returns
Type Description
TIMResult

FriendshipDeleteFriendGroup(List<String>, NullValueCallback)

删除好友分组列表

Declaration
public static TIMResult FriendshipDeleteFriendGroup(List<string> json_delete_friend_group_param, NullValueCallback callback)
Parameters
Type Name Description
System.Collections.Generic.List<System.String> json_delete_friend_group_param

删除好友分组 ,userID列表

NullValueCallback callback

异步回调

Returns
Type Description
TIMResult

TIMResult

FriendshipDeleteFriendGroup(List<String>, ValueCallback<String>)

Declaration
public static TIMResult FriendshipDeleteFriendGroup(List<string> json_delete_friend_group_param, ValueCallback<string> callback)
Parameters
Type Name Description
System.Collections.Generic.List<System.String> json_delete_friend_group_param
ValueCallback<System.String> callback
Returns
Type Description
TIMResult

FriendshipDeleteFromBlackList(List<String>, ValueCallback<List<FriendResult>>)

从黑名单删除

Declaration
public static TIMResult FriendshipDeleteFromBlackList(List<string> json_delete_from_blacklist_param, ValueCallback<List<FriendResult>> callback)
Parameters
Type Name Description
System.Collections.Generic.List<System.String> json_delete_from_blacklist_param

userID列表

ValueCallback<System.Collections.Generic.List<FriendResult>> callback

异步回调

Returns
Type Description
TIMResult

TIMResult

FriendshipDeleteFromBlackList(List<String>, ValueCallback<String>)

Declaration
public static TIMResult FriendshipDeleteFromBlackList(List<string> json_delete_from_blacklist_param, ValueCallback<string> callback)
Parameters
Type Name Description
System.Collections.Generic.List<System.String> json_delete_from_blacklist_param
ValueCallback<System.String> callback
Returns
Type Description
TIMResult

FriendshipDeletePendency(FriendshipDeletePendencyParam, ValueCallback<List<FriendResult>>)

删除好友申请未决

Declaration
public static TIMResult FriendshipDeletePendency(FriendshipDeletePendencyParam json_delete_pendency_param, ValueCallback<List<FriendResult>> callback)
Parameters
Type Name Description
FriendshipDeletePendencyParam json_delete_pendency_param

删除好友申请未决参数 FriendshipDeletePendencyParam

ValueCallback<System.Collections.Generic.List<FriendResult>> callback

异步回调

Returns
Type Description
TIMResult

TIMResult

FriendshipDeletePendency(FriendshipDeletePendencyParam, ValueCallback<String>)

Declaration
public static TIMResult FriendshipDeletePendency(FriendshipDeletePendencyParam json_delete_pendency_param, ValueCallback<string> callback)
Parameters
Type Name Description
FriendshipDeletePendencyParam json_delete_pendency_param
ValueCallback<System.String> callback
Returns
Type Description
TIMResult

FriendshipGetBlackList(ValueCallback<List<FriendProfile>>)

获取黑名单列表

Declaration
public static TIMResult FriendshipGetBlackList(ValueCallback<List<FriendProfile>> callback)
Parameters
Type Name Description
ValueCallback<System.Collections.Generic.List<FriendProfile>> callback

异步回调

Returns
Type Description
TIMResult

TIMResult

FriendshipGetBlackList(ValueCallback<String>)

Declaration
public static TIMResult FriendshipGetBlackList(ValueCallback<string> callback)
Parameters
Type Name Description
ValueCallback<System.String> callback
Returns
Type Description
TIMResult

FriendshipGetFriendGroupList(List<String>, ValueCallback<List<FriendGroupInfo>>)

获取好友分组列表

Declaration
public static TIMResult FriendshipGetFriendGroupList(List<string> json_get_friend_group_list_param, ValueCallback<List<FriendGroupInfo>> callback)
Parameters
Type Name Description
System.Collections.Generic.List<System.String> json_get_friend_group_list_param

获取好友分组,userID列表

ValueCallback<System.Collections.Generic.List<FriendGroupInfo>> callback

异步回调

Returns
Type Description
TIMResult

TIMResult

FriendshipGetFriendGroupList(List<String>, ValueCallback<String>)

Declaration
public static TIMResult FriendshipGetFriendGroupList(List<string> json_get_friend_group_list_param, ValueCallback<string> callback)
Parameters
Type Name Description
System.Collections.Generic.List<System.String> json_get_friend_group_list_param
ValueCallback<System.String> callback
Returns
Type Description
TIMResult

FriendshipGetFriendProfileList(ValueCallback<List<FriendProfile>>)

获取好友信息

Declaration
public static TIMResult FriendshipGetFriendProfileList(ValueCallback<List<FriendProfile>> callback)
Parameters
Type Name Description
ValueCallback<System.Collections.Generic.List<FriendProfile>> callback

异步回调

Returns
Type Description
TIMResult

TIMResult

FriendshipGetFriendProfileList(ValueCallback<String>)

Declaration
public static TIMResult FriendshipGetFriendProfileList(ValueCallback<string> callback)
Parameters
Type Name Description
ValueCallback<System.String> callback
Returns
Type Description
TIMResult

FriendshipGetFriendsInfo(List<String>, ValueCallback<List<FriendInfoGetResult>>)

搜索好友

Declaration
public static TIMResult FriendshipGetFriendsInfo(List<string> json_get_friends_info_param, ValueCallback<List<FriendInfoGetResult>> callback)
Parameters
Type Name Description
System.Collections.Generic.List<System.String> json_get_friends_info_param

获取好友信息,好友userIDs

ValueCallback<System.Collections.Generic.List<FriendInfoGetResult>> callback

异步回调

Returns
Type Description
TIMResult

TIMResult

FriendshipGetFriendsInfo(List<String>, ValueCallback<String>)

Declaration
public static TIMResult FriendshipGetFriendsInfo(List<string> json_get_friends_info_param, ValueCallback<string> callback)
Parameters
Type Name Description
System.Collections.Generic.List<System.String> json_get_friends_info_param
ValueCallback<System.String> callback
Returns
Type Description
TIMResult

FriendshipGetPendencyList(FriendshipGetPendencyListParam, ValueCallback<PendencyPage>)

获取好友申请未决

Declaration
public static TIMResult FriendshipGetPendencyList(FriendshipGetPendencyListParam json_get_pendency_list_param, ValueCallback<PendencyPage> callback)
Parameters
Type Name Description
FriendshipGetPendencyListParam json_get_pendency_list_param

好友申请未决参数 FriendshipGetPendencyListParam

ValueCallback<PendencyPage> callback

异步回调

Returns
Type Description
TIMResult

TIMResult

FriendshipGetPendencyList(FriendshipGetPendencyListParam, ValueCallback<String>)

Declaration
public static TIMResult FriendshipGetPendencyList(FriendshipGetPendencyListParam json_get_pendency_list_param, ValueCallback<string> callback)
Parameters
Type Name Description
FriendshipGetPendencyListParam json_get_pendency_list_param
ValueCallback<System.String> callback
Returns
Type Description
TIMResult

FriendshipHandleFriendAddRequest(FriendRespone, ValueCallback<FriendResult>)

处理好友申请

Declaration
public static TIMResult FriendshipHandleFriendAddRequest(FriendRespone json_handle_friend_add_param, ValueCallback<FriendResult> callback)
Parameters
Type Name Description
FriendRespone json_handle_friend_add_param
ValueCallback<FriendResult> callback

异步回调

Returns
Type Description
TIMResult

TIMResult

FriendshipHandleFriendAddRequest(FriendRespone, ValueCallback<String>)

Declaration
public static TIMResult FriendshipHandleFriendAddRequest(FriendRespone json_handle_friend_add_param, ValueCallback<string> callback)
Parameters
Type Name Description
FriendRespone json_handle_friend_add_param
ValueCallback<System.String> callback
Returns
Type Description
TIMResult

FriendshipModifyFriendGroup(FriendshipModifyFriendGroupParam, ValueCallback<List<FriendResult>>)

修改好友分组列表

Declaration
public static TIMResult FriendshipModifyFriendGroup(FriendshipModifyFriendGroupParam json_modify_friend_group_param, ValueCallback<List<FriendResult>> callback)
Parameters
Type Name Description
FriendshipModifyFriendGroupParam json_modify_friend_group_param

修改好友分组 FriendshipModifyFriendGroupParam

ValueCallback<System.Collections.Generic.List<FriendResult>> callback

异步回调

Returns
Type Description
TIMResult

TIMResult

FriendshipModifyFriendGroup(FriendshipModifyFriendGroupParam, ValueCallback<String>)

Declaration
public static TIMResult FriendshipModifyFriendGroup(FriendshipModifyFriendGroupParam json_modify_friend_group_param, ValueCallback<string> callback)
Parameters
Type Name Description
FriendshipModifyFriendGroupParam json_modify_friend_group_param
ValueCallback<System.String> callback
Returns
Type Description
TIMResult

FriendshipModifyFriendProfile(FriendshipModifyFriendProfileParam, NullValueCallback)

修改好友信息

Declaration
public static TIMResult FriendshipModifyFriendProfile(FriendshipModifyFriendProfileParam json_modify_friend_info_param, NullValueCallback callback)
Parameters
Type Name Description
FriendshipModifyFriendProfileParam json_modify_friend_info_param

修改好友信息参数 FriendshipModifyFriendProfileParam

NullValueCallback callback

异步回调

Returns
Type Description
TIMResult

TIMResult

FriendshipModifyFriendProfile(FriendshipModifyFriendProfileParam, ValueCallback<String>)

Declaration
public static TIMResult FriendshipModifyFriendProfile(FriendshipModifyFriendProfileParam json_modify_friend_info_param, ValueCallback<string> callback)
Parameters
Type Name Description
FriendshipModifyFriendProfileParam json_modify_friend_info_param
ValueCallback<System.String> callback
Returns
Type Description
TIMResult

FriendshipReportPendencyReaded(Int64, NullValueCallback)

上报好友申请未决已读

Declaration
public static TIMResult FriendshipReportPendencyReaded(long time_stamp, NullValueCallback callback)
Parameters
Type Name Description
System.Int64 time_stamp

上报时间戳

NullValueCallback callback

异步回调

Returns
Type Description
TIMResult

TIMResult

FriendshipReportPendencyReaded(Int64, ValueCallback<String>)

Declaration
public static TIMResult FriendshipReportPendencyReaded(long time_stamp, ValueCallback<string> callback)
Parameters
Type Name Description
System.Int64 time_stamp
ValueCallback<System.String> callback
Returns
Type Description
TIMResult

FriendshipSearchFriends(FriendSearchParam, ValueCallback<List<FriendInfoGetResult>>)

搜索好友

Declaration
public static TIMResult FriendshipSearchFriends(FriendSearchParam json_search_friends_param, ValueCallback<List<FriendInfoGetResult>> callback)
Parameters
Type Name Description
FriendSearchParam json_search_friends_param

搜索参数 FriendSearchParam

ValueCallback<System.Collections.Generic.List<FriendInfoGetResult>> callback

异步回调

Returns
Type Description
TIMResult

TIMResult

FriendshipSearchFriends(FriendSearchParam, ValueCallback<String>)

Declaration
public static TIMResult FriendshipSearchFriends(FriendSearchParam json_search_friends_param, ValueCallback<string> callback)
Parameters
Type Name Description
FriendSearchParam json_search_friends_param
ValueCallback<System.String> callback
Returns
Type Description
TIMResult

GetLoginStatus()

获取当前登录状态

Declaration
public static TIMLoginStatus GetLoginStatus()
Returns
Type Description
TIMLoginStatus

TIMLoginStatus

GetLoginUserID(StringBuilder)

获取当前登录用户ID

Declaration
public static TIMResult GetLoginUserID(StringBuilder user_id)
Parameters
Type Name Description
System.Text.StringBuilder user_id

用户与接收user_id的StringBuilder

Returns
Type Description
TIMResult

TIMResult

GetMsgGroupMessageReadMemberList(Message, TIMGroupMessageReadMembersFilter, UInt64, Int32, MsgGroupMessageReadMemberListCallback, MsgGroupMessageReadMemberListStringCallback)

获取群消息已读群成员列表

Declaration
public static TIMResult GetMsgGroupMessageReadMemberList(Message message, TIMGroupMessageReadMembersFilter filter, ulong next_seq, int count, MsgGroupMessageReadMemberListCallback callback = null, MsgGroupMessageReadMemberListStringCallback stringCallback = null)
Parameters
Type Name Description
Message message

单条群消息

TIMGroupMessageReadMembersFilter filter

指定拉取已读或未读群成员列表

System.UInt64 next_seq

分页拉取的游标,第一次默认取传 0,后续分页拉取时,传上一次分页拉取成功回调里的 next_seq

System.Int32 count

分页拉取的个数,最大支持 100 个。

MsgGroupMessageReadMemberListCallback callback

回调 MsgGroupMessageReadMemberListCallback

MsgGroupMessageReadMemberListStringCallback stringCallback

string 类型回调 MsgGroupMessageReadMemberListStringCallback

Returns
Type Description
TIMResult

GetSDKVersion()

初始化IM SDK底层库版本

Declaration
public static string GetSDKVersion()
Returns
Type Description
System.String

string version

GetServerTime()

获取服务端时间(秒)

Declaration
public static long GetServerTime()
Returns
Type Description
System.Int64

服务器时间

GroupCreate(CreateGroupParam, ValueCallback<CreateGroupResult>)

创建群

Declaration
public static TIMResult GroupCreate(CreateGroupParam group, ValueCallback<CreateGroupResult> callback)
Parameters
Type Name Description
CreateGroupParam group

创建群信息 CreateGroupParam

ValueCallback<CreateGroupResult> callback

异步回调

Returns
Type Description
TIMResult

TIMResult

GroupCreate(CreateGroupParam, ValueCallback<String>)

Declaration
public static TIMResult GroupCreate(CreateGroupParam group, ValueCallback<string> callback)
Parameters
Type Name Description
CreateGroupParam group
ValueCallback<System.String> callback
Returns
Type Description
TIMResult

GroupDelete(String, NullValueCallback)

删除群

Declaration
public static TIMResult GroupDelete(string group_id, NullValueCallback callback)
Parameters
Type Name Description
System.String group_id

群ID

NullValueCallback callback

异步回调

Returns
Type Description
TIMResult

TIMResult

GroupDelete(String, ValueCallback<String>)

Declaration
public static TIMResult GroupDelete(string group_id, ValueCallback<string> callback)
Parameters
Type Name Description
System.String group_id
ValueCallback<System.String> callback
Returns
Type Description
TIMResult

GroupDeleteGroupAttributes(String, List<String>, NullValueCallback)

删除群自定义属性

Declaration
public static TIMResult GroupDeleteGroupAttributes(string group_id, List<string> json_keys, NullValueCallback callback)
Parameters
Type Name Description
System.String group_id

群ID

System.Collections.Generic.List<System.String> json_keys

属性key列表

NullValueCallback callback

异步回调

Returns
Type Description
TIMResult

TIMResult

GroupDeleteGroupAttributes(String, List<String>, ValueCallback<String>)

Declaration
public static TIMResult GroupDeleteGroupAttributes(string group_id, List<string> json_keys, ValueCallback<string> callback)
Parameters
Type Name Description
System.String group_id
System.Collections.Generic.List<System.String> json_keys
ValueCallback<System.String> callback
Returns
Type Description
TIMResult

GroupDeleteMember(GroupDeleteMemberParam, ValueCallback<List<GroupDeleteMemberResult>>)

剔除群成员

Declaration
public static TIMResult GroupDeleteMember(GroupDeleteMemberParam param, ValueCallback<List<GroupDeleteMemberResult>> callback)
Parameters
Type Name Description
GroupDeleteMemberParam param

删除人员信息 GroupDeleteMemberParam

ValueCallback<System.Collections.Generic.List<GroupDeleteMemberResult>> callback

异步回调

Returns
Type Description
TIMResult

TIMResult

GroupDeleteMember(GroupDeleteMemberParam, ValueCallback<String>)

Declaration
public static TIMResult GroupDeleteMember(GroupDeleteMemberParam param, ValueCallback<string> callback)
Parameters
Type Name Description
GroupDeleteMemberParam param
ValueCallback<System.String> callback
Returns
Type Description
TIMResult

GroupGetGroupAttributes(String, List<String>, ValueCallback<List<GroupAttributes>>)

删除群自定义属性

Declaration
public static TIMResult GroupGetGroupAttributes(string group_id, List<string> json_keys, ValueCallback<List<GroupAttributes>> callback)
Parameters
Type Name Description
System.String group_id

群ID

System.Collections.Generic.List<System.String> json_keys

属性key列表

ValueCallback<System.Collections.Generic.List<GroupAttributes>> callback

异步回调

Returns
Type Description
TIMResult

TIMResult

GroupGetGroupAttributes(String, List<String>, ValueCallback<String>)

Declaration
public static TIMResult GroupGetGroupAttributes(string group_id, List<string> json_keys, ValueCallback<string> callback)
Parameters
Type Name Description
System.String group_id
System.Collections.Generic.List<System.String> json_keys
ValueCallback<System.String> callback
Returns
Type Description
TIMResult

GroupGetGroupInfoList(List<String>, ValueCallback<List<GetGroupInfoResult>>)

获取群信息

Declaration
public static TIMResult GroupGetGroupInfoList(List<string> group_id_list, ValueCallback<List<GetGroupInfoResult>> callback)
Parameters
Type Name Description
System.Collections.Generic.List<System.String> group_id_list

群ID列表

ValueCallback<System.Collections.Generic.List<GetGroupInfoResult>> callback

异步回调

Returns
Type Description
TIMResult

TIMResult

GroupGetGroupInfoList(List<String>, ValueCallback<String>)

Declaration
public static TIMResult GroupGetGroupInfoList(List<string> group_id_list, ValueCallback<string> callback)
Parameters
Type Name Description
System.Collections.Generic.List<System.String> group_id_list
ValueCallback<System.String> callback
Returns
Type Description
TIMResult

GroupGetJoinedGroupList(ValueCallback<List<GroupBaseInfo>>)

获取已加入的群组列表

Declaration
public static TIMResult GroupGetJoinedGroupList(ValueCallback<List<GroupBaseInfo>> callback)
Parameters
Type Name Description
ValueCallback<System.Collections.Generic.List<GroupBaseInfo>> callback

异步回调

Returns
Type Description
TIMResult

TIMResult

GroupGetJoinedGroupList(ValueCallback<String>)

Declaration
public static TIMResult GroupGetJoinedGroupList(ValueCallback<string> callback)
Parameters
Type Name Description
ValueCallback<System.String> callback
Returns
Type Description
TIMResult

GroupGetMemberInfoList(GroupGetMemberInfoListParam, ValueCallback<GroupGetMemberInfoListResult>)

获取群成员信息

Declaration
public static TIMResult GroupGetMemberInfoList(GroupGetMemberInfoListParam json_group_getmeminfos_param, ValueCallback<GroupGetMemberInfoListResult> callback)
Parameters
Type Name Description
GroupGetMemberInfoListParam json_group_getmeminfos_param

修改信息参数 GroupGetMemberInfoListParam

ValueCallback<GroupGetMemberInfoListResult> callback

异步回调

Returns
Type Description
TIMResult

TIMResult

GroupGetMemberInfoList(GroupGetMemberInfoListParam, ValueCallback<String>)

Declaration
public static TIMResult GroupGetMemberInfoList(GroupGetMemberInfoListParam json_group_getmeminfos_param, ValueCallback<string> callback)
Parameters
Type Name Description
GroupGetMemberInfoListParam json_group_getmeminfos_param
ValueCallback<System.String> callback
Returns
Type Description
TIMResult

GroupGetOnlineMemberCount(String, ValueCallback<GroupGetOnlineMemberCountResult>)

获取群在线用户数

Declaration
public static TIMResult GroupGetOnlineMemberCount(string group_id, ValueCallback<GroupGetOnlineMemberCountResult> callback)
Parameters
Type Name Description
System.String group_id

群ID

ValueCallback<GroupGetOnlineMemberCountResult> callback

异步回调

Returns
Type Description
TIMResult

TIMResult

GroupGetOnlineMemberCount(String, ValueCallback<String>)

Declaration
public static TIMResult GroupGetOnlineMemberCount(string group_id, ValueCallback<string> callback)
Parameters
Type Name Description
System.String group_id
ValueCallback<System.String> callback
Returns
Type Description
TIMResult

GroupGetPendencyList(GroupPendencyOption, ValueCallback<GroupPendencyResult>)

获取群未决信息列表

Declaration
public static TIMResult GroupGetPendencyList(GroupPendencyOption json_group_getpendence_list_param, ValueCallback<GroupPendencyResult> callback)
Parameters
Type Name Description
GroupPendencyOption json_group_getpendence_list_param

修改信息参数 GroupPendencyOption

ValueCallback<GroupPendencyResult> callback

异步回调

Returns
Type Description
TIMResult

TIMResult

GroupGetPendencyList(GroupPendencyOption, ValueCallback<String>)

Declaration
public static TIMResult GroupGetPendencyList(GroupPendencyOption json_group_getpendence_list_param, ValueCallback<string> callback)
Parameters
Type Name Description
GroupPendencyOption json_group_getpendence_list_param
ValueCallback<System.String> callback
Returns
Type Description
TIMResult

GroupHandlePendency(GroupHandlePendencyParam, NullValueCallback)

处理群未决信息

Declaration
public static TIMResult GroupHandlePendency(GroupHandlePendencyParam json_group_handle_pendency_param, NullValueCallback callback)
Parameters
Type Name Description
GroupHandlePendencyParam json_group_handle_pendency_param

处理群未决信息参数 GroupHandlePendencyParam

NullValueCallback callback

异步回调

Returns
Type Description
TIMResult

TIMResult

GroupHandlePendency(GroupHandlePendencyParam, ValueCallback<String>)

Declaration
public static TIMResult GroupHandlePendency(GroupHandlePendencyParam json_group_handle_pendency_param, ValueCallback<string> callback)
Parameters
Type Name Description
GroupHandlePendencyParam json_group_handle_pendency_param
ValueCallback<System.String> callback
Returns
Type Description
TIMResult

GroupInitGroupAttributes(String, GroupAttributes, NullValueCallback)

初始化群自定义属性

Declaration
public static TIMResult GroupInitGroupAttributes(string group_id, GroupAttributes json_group_atrributes, NullValueCallback callback)
Parameters
Type Name Description
System.String group_id

群ID

GroupAttributes json_group_atrributes

群属性参数 GroupAttributes

NullValueCallback callback

异步回调

Returns
Type Description
TIMResult

TIMResult

GroupInitGroupAttributes(String, GroupAttributes, ValueCallback<String>)

Declaration
public static TIMResult GroupInitGroupAttributes(string group_id, GroupAttributes json_group_atrributes, ValueCallback<string> callback)
Parameters
Type Name Description
System.String group_id
GroupAttributes json_group_atrributes
ValueCallback<System.String> callback
Returns
Type Description
TIMResult

GroupInviteMember(GroupInviteMemberParam, ValueCallback<List<GroupInviteMemberResult>>)

邀请用户进群

Declaration
public static TIMResult GroupInviteMember(GroupInviteMemberParam param, ValueCallback<List<GroupInviteMemberResult>> callback)
Parameters
Type Name Description
GroupInviteMemberParam param

邀请人员信息 GroupInviteMemberParam

ValueCallback<System.Collections.Generic.List<GroupInviteMemberResult>> callback

异步回调

Returns
Type Description
TIMResult

TIMResult

GroupInviteMember(GroupInviteMemberParam, ValueCallback<String>)

Declaration
public static TIMResult GroupInviteMember(GroupInviteMemberParam param, ValueCallback<string> callback)
Parameters
Type Name Description
GroupInviteMemberParam param
ValueCallback<System.String> callback
Returns
Type Description
TIMResult

GroupJoin(String, String, NullValueCallback)

加入群

Declaration
public static TIMResult GroupJoin(string group_id, string hello_message, NullValueCallback callback)
Parameters
Type Name Description
System.String group_id

群ID

System.String hello_message

进群打招呼信息

NullValueCallback callback

异步回调

Returns
Type Description
TIMResult

TIMResult

GroupJoin(String, String, ValueCallback<String>)

Declaration
public static TIMResult GroupJoin(string group_id, string hello_message, ValueCallback<string> callback)
Parameters
Type Name Description
System.String group_id
System.String hello_message
ValueCallback<System.String> callback
Returns
Type Description
TIMResult

GroupModifyGroupInfo(GroupModifyInfoParam, NullValueCallback)

修改群信息

Declaration
public static TIMResult GroupModifyGroupInfo(GroupModifyInfoParam json_group_modifyinfo_param, NullValueCallback callback)
Parameters
Type Name Description
GroupModifyInfoParam json_group_modifyinfo_param

修改信息参数 GroupModifyInfoParam

NullValueCallback callback

异步回调

Returns
Type Description
TIMResult

TIMResult

GroupModifyGroupInfo(GroupModifyInfoParam, ValueCallback<String>)

Declaration
public static TIMResult GroupModifyGroupInfo(GroupModifyInfoParam json_group_modifyinfo_param, ValueCallback<string> callback)
Parameters
Type Name Description
GroupModifyInfoParam json_group_modifyinfo_param
ValueCallback<System.String> callback
Returns
Type Description
TIMResult

GroupModifyMemberInfo(GroupModifyMemberInfoParam, NullValueCallback)

修改群成员信息

Declaration
public static TIMResult GroupModifyMemberInfo(GroupModifyMemberInfoParam json_group_modifymeminfo_param, NullValueCallback callback)
Parameters
Type Name Description
GroupModifyMemberInfoParam json_group_modifymeminfo_param

修改信息参数 GroupModifyMemberInfoParam

NullValueCallback callback

异步回调

Returns
Type Description
TIMResult

TIMResult

GroupModifyMemberInfo(GroupModifyMemberInfoParam, ValueCallback<String>)

Declaration
public static TIMResult GroupModifyMemberInfo(GroupModifyMemberInfoParam json_group_modifymeminfo_param, ValueCallback<string> callback)
Parameters
Type Name Description
GroupModifyMemberInfoParam json_group_modifymeminfo_param
ValueCallback<System.String> callback
Returns
Type Description
TIMResult

GroupQuit(String, NullValueCallback)

退出群

Declaration
public static TIMResult GroupQuit(string group_id, NullValueCallback callback)
Parameters
Type Name Description
System.String group_id

群ID

NullValueCallback callback

异步回调

Returns
Type Description
TIMResult

TIMResult

GroupQuit(String, ValueCallback<String>)

Declaration
public static TIMResult GroupQuit(string group_id, ValueCallback<string> callback)
Parameters
Type Name Description
System.String group_id
ValueCallback<System.String> callback
Returns
Type Description
TIMResult

GroupReportPendencyReaded(Int64, NullValueCallback)

上报群未决信息已读

Declaration
public static TIMResult GroupReportPendencyReaded(long time_stamp, NullValueCallback callback)
Parameters
Type Name Description
System.Int64 time_stamp

时间戳

NullValueCallback callback

异步回调

Returns
Type Description
TIMResult

TIMResult

GroupReportPendencyReaded(Int64, ValueCallback<String>)

Declaration
public static TIMResult GroupReportPendencyReaded(long time_stamp, ValueCallback<string> callback)
Parameters
Type Name Description
System.Int64 time_stamp
ValueCallback<System.String> callback
Returns
Type Description
TIMResult

GroupSearchGroupMembers(GroupMemberSearchParam, ValueCallback<List<GroupGetOnlineMemberCountResult>>)

搜索群成员

Declaration
public static TIMResult GroupSearchGroupMembers(GroupMemberSearchParam json_group_search_group_members_param, ValueCallback<List<GroupGetOnlineMemberCountResult>> callback)
Parameters
Type Name Description
GroupMemberSearchParam json_group_search_group_members_param

搜索群成员参数 GroupMemberSearchParam

ValueCallback<System.Collections.Generic.List<GroupGetOnlineMemberCountResult>> callback

异步回调

Returns
Type Description
TIMResult

TIMResult

GroupSearchGroupMembers(GroupMemberSearchParam, ValueCallback<String>)

Declaration
public static TIMResult GroupSearchGroupMembers(GroupMemberSearchParam json_group_search_group_members_param, ValueCallback<string> callback)
Parameters
Type Name Description
GroupMemberSearchParam json_group_search_group_members_param
ValueCallback<System.String> callback
Returns
Type Description
TIMResult

GroupSearchGroups(GroupSearchParam, ValueCallback<List<GroupDetailInfo>>)

获取群在线用户数

Declaration
public static TIMResult GroupSearchGroups(GroupSearchParam json_group_search_groups_param, ValueCallback<List<GroupDetailInfo>> callback)
Parameters
Type Name Description
GroupSearchParam json_group_search_groups_param
ValueCallback<System.Collections.Generic.List<GroupDetailInfo>> callback

异步回调

Returns
Type Description
TIMResult

TIMResult

GroupSearchGroups(GroupSearchParam, ValueCallback<String>)

Declaration
public static TIMResult GroupSearchGroups(GroupSearchParam json_group_search_groups_param, ValueCallback<string> callback)
Parameters
Type Name Description
GroupSearchParam json_group_search_groups_param
ValueCallback<System.String> callback
Returns
Type Description
TIMResult

Init(Int64, SdkConfig)

初始化IM SDK

Declaration
public static TIMResult Init(long sdk_app_id, SdkConfig json_sdk_config)
Parameters
Type Name Description
System.Int64 sdk_app_id

sdk_app_id,在腾讯云即时通信 IM控制台创建应用后获得

SdkConfig json_sdk_config

SdkConfig

Returns
Type Description
TIMResult

TIMResult

Login(String, String, NullValueCallback)

登录

Declaration
public static TIMResult Login(string user_id, string user_sig, NullValueCallback callback)
Parameters
Type Name Description
System.String user_id

用户ID

System.String user_sig

通过sdk_app_id与secret生成,可参考 https://cloud.tencent.com/document/product/269/32688

NullValueCallback callback

异步回调

Returns
Type Description
TIMResult

TIMResult

Login(String, String, ValueCallback<String>)

Declaration
public static TIMResult Login(string user_id, string user_sig, ValueCallback<string> callback)
Parameters
Type Name Description
System.String user_id
System.String user_sig
ValueCallback<System.String> callback
Returns
Type Description
TIMResult

Logout(NullValueCallback)

退出登录

Declaration
public static TIMResult Logout(NullValueCallback callback)
Parameters
Type Name Description
NullValueCallback callback

异步回调

Returns
Type Description
TIMResult

TIMResult

Logout(ValueCallback<String>)

Declaration
public static TIMResult Logout(ValueCallback<string> callback)
Parameters
Type Name Description
ValueCallback<System.String> callback
Returns
Type Description
TIMResult

MsgBatchSend(MsgBatchSendParam, ValueCallback<List<MsgBatchSendResult>>)

批量发送消息

Declaration
public static TIMResult MsgBatchSend(MsgBatchSendParam json_batch_send_param, ValueCallback<List<MsgBatchSendResult>> callback)
Parameters
Type Name Description
MsgBatchSendParam json_batch_send_param

批量消息体 MsgBatchSendParam

ValueCallback<System.Collections.Generic.List<MsgBatchSendResult>> callback

异步回调

Returns
Type Description
TIMResult

TIMResult

MsgBatchSend(MsgBatchSendParam, ValueCallback<String>)

Declaration
public static TIMResult MsgBatchSend(MsgBatchSendParam json_batch_send_param, ValueCallback<string> callback)
Parameters
Type Name Description
MsgBatchSendParam json_batch_send_param
ValueCallback<System.String> callback
Returns
Type Description
TIMResult

MsgCancelSend(String, TIMConvType, String, ValueCallback<Message>)

取消消息发送

Declaration
public static TIMResult MsgCancelSend(string conv_id, TIMConvType conv_type, string message_id, ValueCallback<Message> callback)
Parameters
Type Name Description
System.String conv_id

会话ID

TIMConvType conv_type

会话类型 TIMConvType

System.String message_id

消息ID

ValueCallback<Message> callback

异步回调

Returns
Type Description
TIMResult

TIMResult

MsgCancelSend(String, TIMConvType, String, ValueCallback<String>)

Declaration
public static TIMResult MsgCancelSend(string conv_id, TIMConvType conv_type, string message_id, ValueCallback<string> callback)
Parameters
Type Name Description
System.String conv_id
TIMConvType conv_type
System.String message_id
ValueCallback<System.String> callback
Returns
Type Description
TIMResult

MsgClearHistoryMessage(String, TIMConvType, NullValueCallback)

清除历史消息

Declaration
public static TIMResult MsgClearHistoryMessage(string conv_id, TIMConvType conv_type, NullValueCallback callback)
Parameters
Type Name Description
System.String conv_id

会话ID

TIMConvType conv_type

会话类型 TIMConvType

NullValueCallback callback

异步回调

Returns
Type Description
TIMResult

TIMResult

MsgClearHistoryMessage(String, TIMConvType, ValueCallback<String>)

Declaration
public static TIMResult MsgClearHistoryMessage(string conv_id, TIMConvType conv_type, ValueCallback<string> callback)
Parameters
Type Name Description
System.String conv_id
TIMConvType conv_type
ValueCallback<System.String> callback
Returns
Type Description
TIMResult

MsgDelete(String, TIMConvType, MsgDeleteParam, NullValueCallback)

消息删除

Declaration
public static TIMResult MsgDelete(string conv_id, TIMConvType conv_type, MsgDeleteParam message_delete_param, NullValueCallback callback)
Parameters
Type Name Description
System.String conv_id

会话ID

TIMConvType conv_type

会话类型 TIMConvType

MsgDeleteParam message_delete_param

删除消息参数 MsgDeleteParam

NullValueCallback callback

异步回调

Returns
Type Description
TIMResult

TIMResult

MsgDelete(String, TIMConvType, MsgDeleteParam, ValueCallback<String>)

Declaration
public static TIMResult MsgDelete(string conv_id, TIMConvType conv_type, MsgDeleteParam message_delete_param, ValueCallback<string> callback)
Parameters
Type Name Description
System.String conv_id
TIMConvType conv_type
MsgDeleteParam message_delete_param
ValueCallback<System.String> callback
Returns
Type Description
TIMResult

MsgDoBackground(Int32, NullValueCallback)

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

Declaration
public static TIMResult MsgDoBackground(int unread_count, NullValueCallback callback)
Parameters
Type Name Description
System.Int32 unread_count

unread_count

NullValueCallback callback

ValueCallback

Returns
Type Description
TIMResult

TIMResult

MsgDoBackground(Int32, ValueCallback<String>)

Declaration
public static TIMResult MsgDoBackground(int unread_count, ValueCallback<string> callback)
Parameters
Type Name Description
System.Int32 unread_count
ValueCallback<System.String> callback
Returns
Type Description
TIMResult

MsgDoForeground(NullValueCallback)

APP 检测到应用进前台时可以调用此接口(iOS 和 Android 平台专用)。

Declaration
public static TIMResult MsgDoForeground(NullValueCallback callback)
Parameters
Type Name Description
NullValueCallback callback

ValueCallback

Returns
Type Description
TIMResult

TIMResult

MsgDoForeground(ValueCallback<String>)

Declaration
public static TIMResult MsgDoForeground(ValueCallback<string> callback)
Parameters
Type Name Description
ValueCallback<System.String> callback
Returns
Type Description
TIMResult

MsgDownloadElemToPath(DownloadElemParam, String, ValueCallback<MsgDownloadElemResult>)

下载多媒体消息

Declaration
public static TIMResult MsgDownloadElemToPath(DownloadElemParam download_param, string path, ValueCallback<MsgDownloadElemResult> callback)
Parameters
Type Name Description
DownloadElemParam download_param

下载参数 DownloadElemParam

System.String path

本地路径

ValueCallback<MsgDownloadElemResult> callback

异步回调

Returns
Type Description
TIMResult

TIMResult

MsgDownloadElemToPath(DownloadElemParam, String, ValueCallback<String>)

Declaration
public static TIMResult MsgDownloadElemToPath(DownloadElemParam download_param, string path, ValueCallback<string> callback)
Parameters
Type Name Description
DownloadElemParam download_param
System.String path
ValueCallback<System.String> callback
Returns
Type Description
TIMResult

MsgDownloadMergerMessage(Message, ValueCallback<List<Message>>)

下载合并消息

Declaration
public static TIMResult MsgDownloadMergerMessage(Message message, ValueCallback<List<Message>> callback)
Parameters
Type Name Description
Message message

消息体 Message

ValueCallback<System.Collections.Generic.List<Message>> callback

异步回调

Returns
Type Description
TIMResult

TIMResult

MsgDownloadMergerMessage(Message, ValueCallback<String>)

Declaration
public static TIMResult MsgDownloadMergerMessage(Message message, ValueCallback<string> callback)
Parameters
Type Name Description
Message message
ValueCallback<System.String> callback
Returns
Type Description
TIMResult

MsgFindByMsgLocatorList(String, TIMConvType, MsgLocator, ValueCallback<List<Message>>)

通过消息定位符查找消息

Declaration
public static TIMResult MsgFindByMsgLocatorList(string conv_id, TIMConvType conv_type, MsgLocator message_locator, ValueCallback<List<Message>> callback)
Parameters
Type Name Description
System.String conv_id

会话ID

TIMConvType conv_type

会话类型 TIMConvType

MsgLocator message_locator

消息定位符 MsgLocator

ValueCallback<System.Collections.Generic.List<Message>> callback

异步回调

Returns
Type Description
TIMResult

TIMResult

MsgFindByMsgLocatorList(String, TIMConvType, MsgLocator, ValueCallback<String>)

Declaration
public static TIMResult MsgFindByMsgLocatorList(string conv_id, TIMConvType conv_type, MsgLocator message_locator, ValueCallback<string> callback)
Parameters
Type Name Description
System.String conv_id
TIMConvType conv_type
MsgLocator message_locator
ValueCallback<System.String> callback
Returns
Type Description
TIMResult

MsgFindMessages(List<String>, ValueCallback<List<Message>>)

从本地查找消息

Declaration
public static TIMResult MsgFindMessages(List<string> message_id_array, ValueCallback<List<Message>> callback)
Parameters
Type Name Description
System.Collections.Generic.List<System.String> message_id_array

查找消息的id列表

ValueCallback<System.Collections.Generic.List<Message>> callback

异步回调

Returns
Type Description
TIMResult

TIMResult

MsgFindMessages(List<String>, ValueCallback<String>)

Declaration
public static TIMResult MsgFindMessages(List<string> message_id_array, ValueCallback<string> callback)
Parameters
Type Name Description
System.Collections.Generic.List<System.String> message_id_array
ValueCallback<System.String> callback
Returns
Type Description
TIMResult

MsgGetC2CReceiveMessageOpt(List<String>, ValueCallback<List<GetC2CRecvMsgOptResult>>)

设置C2C收消息选项

Declaration
public static TIMResult MsgGetC2CReceiveMessageOpt(List<string> user_id_list, ValueCallback<List<GetC2CRecvMsgOptResult>> callback)
Parameters
Type Name Description
System.Collections.Generic.List<System.String> user_id_list

用户ID列表

ValueCallback<System.Collections.Generic.List<GetC2CRecvMsgOptResult>> callback

异步回调

Returns
Type Description
TIMResult

TIMResult

MsgGetC2CReceiveMessageOpt(List<String>, ValueCallback<String>)

Declaration
public static TIMResult MsgGetC2CReceiveMessageOpt(List<string> user_id_list, ValueCallback<string> callback)
Parameters
Type Name Description
System.Collections.Generic.List<System.String> user_id_list
ValueCallback<System.String> callback
Returns
Type Description
TIMResult

MsgGetMessageReadReceipts(List<Message>, ValueCallback<List<MessageReceipt>>)

获取消息已读回执

Declaration
public static TIMResult MsgGetMessageReadReceipts(List<Message> msg_array, ValueCallback<List<MessageReceipt>> callback)
Parameters
Type Name Description
System.Collections.Generic.List<Message> msg_array

消息列表

ValueCallback<System.Collections.Generic.List<MessageReceipt>> callback

异步回调

Returns
Type Description
TIMResult

TIMResult

MsgGetMessageReadReceipts(List<Message>, ValueCallback<String>)

Declaration
public static TIMResult MsgGetMessageReadReceipts(List<Message> msg_array, ValueCallback<string> callback)
Parameters
Type Name Description
System.Collections.Generic.List<Message> msg_array
ValueCallback<System.String> callback
Returns
Type Description
TIMResult

MsgGetMsgList(String, TIMConvType, MsgGetMsgListParam, ValueCallback<List<Message>>)

获取历史消息列表

Declaration
public static TIMResult MsgGetMsgList(string conv_id, TIMConvType conv_type, MsgGetMsgListParam get_message_list_param, ValueCallback<List<Message>> callback)
Parameters
Type Name Description
System.String conv_id

会话ID

TIMConvType conv_type

会话类型 TIMConvType

MsgGetMsgListParam get_message_list_param

获取历史消息参数 MsgGetMsgListParam

ValueCallback<System.Collections.Generic.List<Message>> callback

异步回调

Returns
Type Description
TIMResult

TIMResult

MsgGetMsgList(String, TIMConvType, MsgGetMsgListParam, ValueCallback<String>)

Declaration
public static TIMResult MsgGetMsgList(string conv_id, TIMConvType conv_type, MsgGetMsgListParam get_message_list_param, ValueCallback<string> callback)
Parameters
Type Name Description
System.String conv_id
TIMConvType conv_type
MsgGetMsgListParam get_message_list_param
ValueCallback<System.String> callback
Returns
Type Description
TIMResult

MsgImportMsgList(String, TIMConvType, List<Message>, NullValueCallback)

导入消息

Declaration
public static TIMResult MsgImportMsgList(string conv_id, TIMConvType conv_type, List<Message> message_list, NullValueCallback callback)
Parameters
Type Name Description
System.String conv_id

会话ID

TIMConvType conv_type

会话类型 TIMConvType

System.Collections.Generic.List<Message> message_list

消息列表 Message列表

NullValueCallback callback

异步回调

Returns
Type Description
TIMResult

TIMResult

MsgImportMsgList(String, TIMConvType, List<Message>, ValueCallback<String>)

Declaration
public static TIMResult MsgImportMsgList(string conv_id, TIMConvType conv_type, List<Message> message_list, ValueCallback<string> callback)
Parameters
Type Name Description
System.String conv_id
TIMConvType conv_type
System.Collections.Generic.List<Message> message_list
ValueCallback<System.String> callback
Returns
Type Description
TIMResult

MsgListDelete(String, TIMConvType, List<Message>, NullValueCallback)

消息删除

Declaration
public static TIMResult MsgListDelete(string conv_id, TIMConvType conv_type, List<Message> message_list, NullValueCallback callback)
Parameters
Type Name Description
System.String conv_id

会话ID

TIMConvType conv_type

会话类型 TIMConvType

System.Collections.Generic.List<Message> message_list
NullValueCallback callback

异步回调

Returns
Type Description
TIMResult

TIMResult

MsgListDelete(String, TIMConvType, List<Message>, ValueCallback<String>)

Declaration
public static TIMResult MsgListDelete(string conv_id, TIMConvType conv_type, List<Message> message_list, ValueCallback<string> callback)
Parameters
Type Name Description
System.String conv_id
TIMConvType conv_type
System.Collections.Generic.List<Message> message_list
ValueCallback<System.String> callback
Returns
Type Description
TIMResult

MsgMarkAllMessageAsRead(NullValueCallback)

标记所有消息为已读

Declaration
public static TIMResult MsgMarkAllMessageAsRead(NullValueCallback callback)
Parameters
Type Name Description
NullValueCallback callback

异步回调

Returns
Type Description
TIMResult

TIMResult

MsgMarkAllMessageAsRead(ValueCallback<String>)

Declaration
public static TIMResult MsgMarkAllMessageAsRead(ValueCallback<string> callback)
Parameters
Type Name Description
ValueCallback<System.String> callback
Returns
Type Description
TIMResult

MsgReportReaded(String, TIMConvType, Message, NullValueCallback)

消息已读上报

Declaration
public static TIMResult MsgReportReaded(string conv_id, TIMConvType conv_type, Message message, NullValueCallback callback)
Parameters
Type Name Description
System.String conv_id

会话ID

TIMConvType conv_type

会话类型 TIMConvType

Message message

消息体 Message

NullValueCallback callback

异步回调

Returns
Type Description
TIMResult

TIMResult

MsgReportReaded(String, TIMConvType, Message, ValueCallback<String>)

Declaration
public static TIMResult MsgReportReaded(string conv_id, TIMConvType conv_type, Message message, ValueCallback<string> callback)
Parameters
Type Name Description
System.String conv_id
TIMConvType conv_type
Message message
ValueCallback<System.String> callback
Returns
Type Description
TIMResult

MsgRevoke(String, TIMConvType, Message, NullValueCallback)

消息撤回

Declaration
public static TIMResult MsgRevoke(string conv_id, TIMConvType conv_type, Message message, NullValueCallback callback)
Parameters
Type Name Description
System.String conv_id

会话ID

TIMConvType conv_type

会话类型 TIMConvType

Message message

消息体 Message

NullValueCallback callback

异步回调

Returns
Type Description
TIMResult

TIMResult

MsgRevoke(String, TIMConvType, Message, ValueCallback<String>)

Declaration
public static TIMResult MsgRevoke(string conv_id, TIMConvType conv_type, Message message, ValueCallback<string> callback)
Parameters
Type Name Description
System.String conv_id
TIMConvType conv_type
Message message
ValueCallback<System.String> callback
Returns
Type Description
TIMResult

MsgSaveMsg(String, TIMConvType, Message, NullValueCallback)

保存消息

Declaration
public static TIMResult MsgSaveMsg(string conv_id, TIMConvType conv_type, Message message, NullValueCallback callback)
Parameters
Type Name Description
System.String conv_id

会话ID

TIMConvType conv_type

会话类型 TIMConvType

Message message

消息体

NullValueCallback callback

异步回调

Returns
Type Description
TIMResult

TIMResult

MsgSaveMsg(String, TIMConvType, Message, ValueCallback<String>)

Declaration
public static TIMResult MsgSaveMsg(string conv_id, TIMConvType conv_type, Message message, ValueCallback<string> callback)
Parameters
Type Name Description
System.String conv_id
TIMConvType conv_type
Message message
ValueCallback<System.String> callback
Returns
Type Description
TIMResult

MsgSearchLocalMessages(MessageSearchParam, ValueCallback<MessageSearchResult>)

搜索本地消息

Declaration
public static TIMResult MsgSearchLocalMessages(MessageSearchParam message_search_param, ValueCallback<MessageSearchResult> callback)
Parameters
Type Name Description
MessageSearchParam message_search_param

搜索消息参数 MessageSearchParam

ValueCallback<MessageSearchResult> callback

异步回调

Returns
Type Description
TIMResult

TIMResult

MsgSearchLocalMessages(MessageSearchParam, ValueCallback<String>)

Declaration
public static TIMResult MsgSearchLocalMessages(MessageSearchParam message_search_param, ValueCallback<string> callback)
Parameters
Type Name Description
MessageSearchParam message_search_param
ValueCallback<System.String> callback
Returns
Type Description
TIMResult

MsgSendMessage(String, TIMConvType, Message, StringBuilder, ValueCallback<Message>)

发送消息

Declaration
public static TIMResult MsgSendMessage(string conv_id, TIMConvType conv_type, Message message, StringBuilder message_id, ValueCallback<Message> callback)
Parameters
Type Name Description
System.String conv_id

会话ID

TIMConvType conv_type

会话类型 TIMConvType

Message message

消息体 Message

System.Text.StringBuilder message_id

承接消息ID的StringBuilder

ValueCallback<Message> callback

异步回调

Returns
Type Description
TIMResult

TIMResult

MsgSendMessage(String, TIMConvType, Message, StringBuilder, ValueCallback<String>)

Declaration
public static TIMResult MsgSendMessage(string conv_id, TIMConvType conv_type, Message message, StringBuilder message_id, ValueCallback<string> callback)
Parameters
Type Name Description
System.String conv_id
TIMConvType conv_type
Message message
System.Text.StringBuilder message_id
ValueCallback<System.String> callback
Returns
Type Description
TIMResult

MsgSendMessageReadReceipts(List<Message>, NullValueCallback)

发送消息已读回执

Declaration
public static TIMResult MsgSendMessageReadReceipts(List<Message> msg_array, NullValueCallback callback)
Parameters
Type Name Description
System.Collections.Generic.List<Message> msg_array

消息列表

NullValueCallback callback

异步回调

Returns
Type Description
TIMResult

TIMResult

MsgSendMessageReadReceipts(List<Message>, ValueCallback<String>)

Declaration
public static TIMResult MsgSendMessageReadReceipts(List<Message> msg_array, ValueCallback<string> callback)
Parameters
Type Name Description
System.Collections.Generic.List<Message> msg_array
ValueCallback<System.String> callback
Returns
Type Description
TIMResult

MsgSetC2CReceiveMessageOpt(List<String>, TIMReceiveMessageOpt, NullValueCallback)

设置收消息选项

Declaration
public static TIMResult MsgSetC2CReceiveMessageOpt(List<string> user_id_list, TIMReceiveMessageOpt opt, NullValueCallback callback)
Parameters
Type Name Description
System.Collections.Generic.List<System.String> user_id_list

用户ID列表

TIMReceiveMessageOpt opt

接收消息选项 TIMReceiveMessageOpt

NullValueCallback callback

异步回调

Returns
Type Description
TIMResult

TIMResult

MsgSetC2CReceiveMessageOpt(List<String>, TIMReceiveMessageOpt, ValueCallback<String>)

Declaration
public static TIMResult MsgSetC2CReceiveMessageOpt(List<string> user_id_list, TIMReceiveMessageOpt opt, ValueCallback<string> callback)
Parameters
Type Name Description
System.Collections.Generic.List<System.String> user_id_list
TIMReceiveMessageOpt opt
ValueCallback<System.String> callback
Returns
Type Description
TIMResult

MsgSetGroupReceiveMessageOpt(String, TIMReceiveMessageOpt, NullValueCallback)

设置群收消息选项

Declaration
public static TIMResult MsgSetGroupReceiveMessageOpt(string group_id, TIMReceiveMessageOpt opt, NullValueCallback callback)
Parameters
Type Name Description
System.String group_id

用户ID列表

TIMReceiveMessageOpt opt

接收消息选项 TIMReceiveMessageOpt

NullValueCallback callback

异步回调

Returns
Type Description
TIMResult

TIMResult

MsgSetGroupReceiveMessageOpt(String, TIMReceiveMessageOpt, ValueCallback<String>)

Declaration
public static TIMResult MsgSetGroupReceiveMessageOpt(string group_id, TIMReceiveMessageOpt opt, ValueCallback<string> callback)
Parameters
Type Name Description
System.String group_id
TIMReceiveMessageOpt opt
ValueCallback<System.String> callback
Returns
Type Description
TIMResult

MsgSetLocalCustomData(Message, NullValueCallback)

设置消息本地数据

Declaration
public static TIMResult MsgSetLocalCustomData(Message message, NullValueCallback callback)
Parameters
Type Name Description
Message message

消息体 Message

NullValueCallback callback

异步回调

Returns
Type Description
TIMResult

TIMResult

MsgSetLocalCustomData(Message, ValueCallback<String>)

Declaration
public static TIMResult MsgSetLocalCustomData(Message message, ValueCallback<string> callback)
Parameters
Type Name Description
Message message
ValueCallback<System.String> callback
Returns
Type Description
TIMResult

MsgSetOfflinePushToken(OfflinePushToken, NullValueCallback)

设置离线推送配置信息(iOS 和 Android 平台专用)

Declaration
public static TIMResult MsgSetOfflinePushToken(OfflinePushToken json_token, NullValueCallback callback)
Parameters
Type Name Description
OfflinePushToken json_token
NullValueCallback callback

ValueCallback

Returns
Type Description
TIMResult

TIMResult

MsgSetOfflinePushToken(OfflinePushToken, ValueCallback<String>)

Declaration
public static TIMResult MsgSetOfflinePushToken(OfflinePushToken json_token, ValueCallback<string> callback)
Parameters
Type Name Description
OfflinePushToken json_token
ValueCallback<System.String> callback
Returns
Type Description
TIMResult

ProfileGetUserProfileList(FriendShipGetProfileListParam, ValueCallback<List<UserProfile>>)

获取用户信息列表

Declaration
public static TIMResult ProfileGetUserProfileList(FriendShipGetProfileListParam json_get_user_profile_list_param, ValueCallback<List<UserProfile>> callback)
Parameters
Type Name Description
FriendShipGetProfileListParam json_get_user_profile_list_param

用户信息列表参数 FriendShipGetProfileListParam

ValueCallback<System.Collections.Generic.List<UserProfile>> callback

异步回调

Returns
Type Description
TIMResult

TIMResult

ProfileGetUserProfileList(FriendShipGetProfileListParam, ValueCallback<String>)

Declaration
public static TIMResult ProfileGetUserProfileList(FriendShipGetProfileListParam json_get_user_profile_list_param, ValueCallback<string> callback)
Parameters
Type Name Description
FriendShipGetProfileListParam json_get_user_profile_list_param
ValueCallback<System.String> callback
Returns
Type Description
TIMResult

ProfileModifySelfUserProfile(UserProfileItem, NullValueCallback)

修改自己的信息

Declaration
public static TIMResult ProfileModifySelfUserProfile(UserProfileItem json_modify_self_user_profile_param, NullValueCallback callback)
Parameters
Type Name Description
UserProfileItem json_modify_self_user_profile_param

用户信息列表参数 UserProfileItem

NullValueCallback callback

异步回调

Returns
Type Description
TIMResult

TIMResult

ProfileModifySelfUserProfile(UserProfileItem, ValueCallback<String>)

Declaration
public static TIMResult ProfileModifySelfUserProfile(UserProfileItem json_modify_self_user_profile_param, ValueCallback<string> callback)
Parameters
Type Name Description
UserProfileItem json_modify_self_user_profile_param
ValueCallback<System.String> callback
Returns
Type Description
TIMResult

RemoveRecvNewMsgCallback()

移除收到新消息回调

Declaration
public static void RemoveRecvNewMsgCallback()

SetConfig(SetConfig, ValueCallback<SetConfig>)

设置全局配置

Declaration
public static TIMResult SetConfig(SetConfig config, ValueCallback<SetConfig> callback)
Parameters
Type Name Description
SetConfig config

配置

ValueCallback<SetConfig> callback

异步回调

Returns
Type Description
TIMResult

TIMResult

SetConfig(SetConfig, ValueCallback<String>)

Declaration
public static TIMResult SetConfig(SetConfig config, ValueCallback<string> callback)
Parameters
Type Name Description
SetConfig config
ValueCallback<System.String> callback
Returns
Type Description
TIMResult

SetConvEventCallback(ConvEventCallback, ConvEventStringCallback)

设置会话事件回调

会话事件包括:

会话新增

会话删除

会话更新

会话开始

会话结束

任何产生一个新会话的操作都会触发会话新增事件,例如调用接口[TIMConvCreate]()创建会话,接收到未知会话的第一条消息等

任何已有会话变化的操作都会触发会话更新事件,例如收到会话新消息,消息撤回,已读上报等

调用接口[TIMConvDelete]()删除会话成功时会触发会话删除事件

Declaration
public static void SetConvEventCallback(ConvEventCallback callback = null, ConvEventStringCallback stringCallback = null)
Parameters
Type Name Description
ConvEventCallback callback

回调 ConvEventCallback

ConvEventStringCallback stringCallback

SetConvTotalUnreadMessageCountChangedCallback(ConvTotalUnreadMessageCountChangedCallback)

设置会话未读消息总数变更的回调

Declaration
public static void SetConvTotalUnreadMessageCountChangedCallback(ConvTotalUnreadMessageCountChangedCallback callback)
Parameters
Type Name Description
ConvTotalUnreadMessageCountChangedCallback callback

回调 ConvTotalUnreadMessageCountChangedCallback

SetFriendAddRequestCallback(FriendAddRequestCallback, FriendAddRequestStringCallback)

设置好友添加请求的回调

当前登入用户设置添加好友需要确认时,如果有用户请求加当前登入用户为好友,会收到好友添加请求的回调,ImSDK通过此回调告知开发者。如果多终端登入同一帐号,每个终端都会收到这个回调

Declaration
public static void SetFriendAddRequestCallback(FriendAddRequestCallback callback = null, FriendAddRequestStringCallback stringCallback = null)
Parameters
Type Name Description
FriendAddRequestCallback callback

回调 FriendAddRequestCallback

FriendAddRequestStringCallback stringCallback

SetFriendApplicationListDeletedCallback(FriendApplicationListDeletedCallback, FriendApplicationListDeletedStringCallback)

设置好友申请被删除的回调

1. 主动删除好友申请

2. 拒绝好友申请

3. 同意好友申请

4. 申请加别人好友被拒绝

Declaration
public static void SetFriendApplicationListDeletedCallback(FriendApplicationListDeletedCallback callback = null, FriendApplicationListDeletedStringCallback stringCallback = null)
Parameters
Type Name Description
FriendApplicationListDeletedCallback callback

回调 FriendApplicationListDeletedCallback

FriendApplicationListDeletedStringCallback stringCallback

SetFriendApplicationListReadCallback(FriendApplicationListReadCallback)

设置好友申请已读的回调

如果调用 setFriendApplicationRead 设置好友申请列表已读,会收到这个回调(主要用于多端同步)

Declaration
public static void SetFriendApplicationListReadCallback(FriendApplicationListReadCallback callback)
Parameters
Type Name Description
FriendApplicationListReadCallback callback

回调 FriendApplicationListReadCallback

SetFriendBlackListAddedCallback(FriendBlackListAddedCallback, FriendBlackListAddedStringCallback)

设置黑名单新增的回调

Declaration
public static void SetFriendBlackListAddedCallback(FriendBlackListAddedCallback callback = null, FriendBlackListAddedStringCallback stringCallback = null)
Parameters
Type Name Description
FriendBlackListAddedCallback callback

回调 FriendBlackListAddedCallback

FriendBlackListAddedStringCallback stringCallback

SetFriendBlackListDeletedCallback(FriendBlackListDeletedCallback, FriendBlackListDeletedStringCallback)

设置黑名单删除的回调

Declaration
public static void SetFriendBlackListDeletedCallback(FriendBlackListDeletedCallback callback = null, FriendBlackListDeletedStringCallback stringCallback = null)
Parameters
Type Name Description
FriendBlackListDeletedCallback callback

回调 FriendBlackListDeletedCallback

FriendBlackListDeletedStringCallback stringCallback

SetGroupAttributeChangedCallback(GroupAttributeChangedCallback, GroupAttributeChangedStringCallback)

设置群组属性变更回调

某个已加入的群的属性被修改了,会返回所在群组的所有属性(该群所有的成员都能收到)

Declaration
public static void SetGroupAttributeChangedCallback(GroupAttributeChangedCallback callback = null, GroupAttributeChangedStringCallback stringCallback = null)
Parameters
Type Name Description
GroupAttributeChangedCallback callback

回调 GroupAttributeChangedCallback

GroupAttributeChangedStringCallback stringCallback

SetGroupTipsEventCallback(GroupTipsEventCallback, GroupTipsEventStringCallback)

设置群组系统消息回调

群组系统消息事件包括 加入群、退出群、踢出群、设置管理员、取消管理员、群资料变更、群成员资料变更。此消息是针对所有群组成员下发的

Declaration
public static void SetGroupTipsEventCallback(GroupTipsEventCallback callback = null, GroupTipsEventStringCallback stringCallback = null)
Parameters
Type Name Description
GroupTipsEventCallback callback

回调 GroupTipsEventCallback

GroupTipsEventStringCallback stringCallback

SetKickedOfflineCallback(KickedOfflineCallback)

设置被踢下线通知回调

用户如果在其他终端登录,会被踢下线,这时会收到用户被踢下线的通知,出现这种情况常规的做法是提示用户进行操作(退出,或者再次把对方踢下线)

用户如果在离线状态下被踢,下次登录将会失败,可以给用户一个非常强的提醒(登录错误码ERR_IMSDK_KICKED_BY_OTHERS:6208),开发者也可以选择忽略这次错误,再次登录即可

用户在线情况下的互踢情况:

用户在设备1登录,保持在线状态下,该用户又在设备2登录,这时用户会在设备1上强制下线,收到 KickedOfflineCallback 回调

用户在设备1上收到回调后,提示用户,可继续调用login上线,强制设备2下线。这里是在线情况下互踢过程

用户离线状态互踢:

用户在设备1登录,没有进行logout情况下进程退出。该用户在设备2登录,此时由于用户不在线,无法感知此事件,

为了显式提醒用户,避免无感知的互踢,用户在设备1重新登录时,会返回(ERR_IMSDK_KICKED_BY_OTHERS:6208)错误码,表明之前被踢,是否需要把对方踢下线

如果需要,则再次调用login强制上线,设备2的登录的实例将会收到 KickedOfflineCallback 回调

Declaration
public static void SetKickedOfflineCallback(KickedOfflineCallback callback)
Parameters
Type Name Description
KickedOfflineCallback callback

回调 KickedOfflineCallback

SetLogCallback(LogCallback)

设置日志回调

设置日志监听的回调之后,ImSDK内部的日志会回传到此接口设置的回调

开发者可以通过接口SetConfig()配置哪些日志级别的日志回传到回调函数

Declaration
public static void SetLogCallback(LogCallback callback)
Parameters
Type Name Description
LogCallback callback

回调 FriendBlackListDeletedCallback

SetMsgElemUploadProgressCallback(MsgElemUploadProgressCallback, MsgElemUploadProgressStringCallback)

设置消息内元素相关文件上传进度回调

设置消息元素上传进度回调。当消息内包含图片、声音、文件、视频元素时,ImSDK会上传这些文件,并触发此接口设置的回调,用户可以根据回调感知上传的进度

Declaration
public static void SetMsgElemUploadProgressCallback(MsgElemUploadProgressCallback callback = null, MsgElemUploadProgressStringCallback stringCallback = null)
Parameters
Type Name Description
MsgElemUploadProgressCallback callback

回调 MsgElemUploadProgressCallback

MsgElemUploadProgressStringCallback stringCallback

SetMsgReadedReceiptCallback(MsgReadedReceiptCallback, MsgReadedReceiptStringCallback)

设置消息已读回执回调

发送方发送消息,接收方调用接口[TIMMsgReportReaded]()上报该消息已读,发送方ImSDK会通过此接口设置的回调抛出

Declaration
public static void SetMsgReadedReceiptCallback(MsgReadedReceiptCallback callback = null, MsgReadedReceiptStringCallback stringCallback = null)
Parameters
Type Name Description
MsgReadedReceiptCallback callback

回调 MsgReadedReceiptCallback

MsgReadedReceiptStringCallback stringCallback

SetMsgRevokeCallback(MsgRevokeCallback, MsgRevokeStringCallback)

设置接收的消息被撤回回调

发送方发送消息,接收方收到消息。此时发送方调用接口[TIMMsgRevoke]()撤回该消息,接收方的ImSDK会通过此接口设置的回调抛出

Declaration
public static void SetMsgRevokeCallback(MsgRevokeCallback callback = null, MsgRevokeStringCallback stringCallback = null)
Parameters
Type Name Description
MsgRevokeCallback callback

回调 MsgRevokeCallback

MsgRevokeStringCallback stringCallback

SetMsgUpdateCallback(MsgUpdateCallback, MsgUpdateStringCallback)

设置消息在云端被修改后回传回来的消息更新通知回调

当您发送的消息在服务端被修改后,ImSDK会通过该回调通知给您

您可以在您自己的服务器上拦截所有即时通信IM消息 [发单聊消息之前回调](https://cloud.tencent.com/document/product/269/1632)

设置成功之后,即时通信IM服务器会将您的用户发送的每条消息都同步地通知给您的业务服务器

您的业务服务器可以对该条消息进行修改(例如过滤敏感词),如果您的服务器对消息进行了修改,ImSDK就会通过此回调通知您

Declaration
public static void SetMsgUpdateCallback(MsgUpdateCallback callback = null, MsgUpdateStringCallback stringCallback = null)
Parameters
Type Name Description
MsgUpdateCallback callback

回调 FriendBlackListDeletedCallback

MsgUpdateStringCallback stringCallback

SetNetworkStatusListenerCallback(NetworkStatusListenerCallback)

设置网络连接状态监听回调

当调用接口 Init() 时,ImSDK会去连接云后台。此接口设置的回调用于监听网络连接的状态

网络连接状态包含四个:正在连接、连接失败、连接成功、已连接。这里的网络事件不表示用户本地网络状态,仅指明ImSDK是否与即时通信IM云Server连接状态

可选设置,如果要用户感知是否已经连接服务器,需要设置此回调,用于通知调用者跟通讯后台链接的连接和断开事件,另外,如果断开网络,等网络恢复后会自动重连,自动拉取消息通知用户,用户无需关心网络状态,仅作通知之用

只要用户处于登录状态,ImSDK内部会进行断网重连,用户无需关心

Declaration
public static void SetNetworkStatusListenerCallback(NetworkStatusListenerCallback callback)
Parameters
Type Name Description
NetworkStatusListenerCallback callback

回调 NetworkStatusListenerCallback

SetOnAddFriendCallback(OnAddFriendCallback, OnAddFriendStringCallback)

设置添加好友的回调

此回调为了多终端同步。例如A设备、B设备都登录了同一帐号的ImSDK,A设备添加了好友,B设备ImSDK会收到添加好友的推送,ImSDK通过此回调告知开发者

Declaration
public static void SetOnAddFriendCallback(OnAddFriendCallback callback = null, OnAddFriendStringCallback stringCallback = null)
Parameters
Type Name Description
OnAddFriendCallback callback

回调 OnAddFriendCallback

OnAddFriendStringCallback stringCallback

SetOnDeleteFriendCallback(OnDeleteFriendCallback, OnDeleteFriendStringCallback)

设置删除好友的回调

此回调为了多终端同步。例如A设备、B设备都登录了同一帐号的ImSDK,A设备删除了好友,B设备ImSDK会收到删除好友的推送,ImSDK通过此回调告知开发者

Declaration
public static void SetOnDeleteFriendCallback(OnDeleteFriendCallback callback = null, OnDeleteFriendStringCallback stringCallback = null)
Parameters
Type Name Description
OnDeleteFriendCallback callback

回调 OnDeleteFriendCallback

OnDeleteFriendStringCallback stringCallback

SetUpdateFriendProfileCallback(UpdateFriendProfileCallback, UpdateFriendProfileStringCallback)

设置更新好友资料的回调

此回调为了多终端同步。例如A设备、B设备都登录了同一帐号的ImSDK,A设备更新了好友资料,B设备ImSDK会收到更新好友资料的推送,ImSDK通过此回调告知开发者

Declaration
public static void SetUpdateFriendProfileCallback(UpdateFriendProfileCallback callback = null, UpdateFriendProfileStringCallback stringCallback = null)
Parameters
Type Name Description
UpdateFriendProfileCallback callback

回调 UpdateFriendProfileCallback

UpdateFriendProfileStringCallback stringCallback

SetUserSigExpiredCallback(UserSigExpiredCallback)

设置票据过期回调

用户票据,可能会存在过期的情况,如果用户票据过期,此接口设置的回调会调用

Login()也将会返回70001错误码。开发者可根据错误码或者票据过期回调进行票据更换

Declaration
public static void SetUserSigExpiredCallback(UserSigExpiredCallback callback)
Parameters
Type Name Description
UserSigExpiredCallback callback

回调 UserSigExpiredCallback

TIMMsgGroupMessageReadMemberListCallbackInstance(IntPtr, UInt64, Boolean, IntPtr)

Declaration
public static void TIMMsgGroupMessageReadMemberListCallbackInstance(IntPtr json_group_member_array, ulong next_seq, bool is_finished, IntPtr user_data)
Parameters
Type Name Description
System.IntPtr json_group_member_array
System.UInt64 next_seq
System.Boolean is_finished
System.IntPtr user_data

TIMMsgUpdateCallbackInstance(IntPtr, IntPtr)

Declaration
public static void TIMMsgUpdateCallbackInstance(IntPtr json_msg_array, IntPtr user_data)
Parameters
Type Name Description
System.IntPtr json_msg_array
System.IntPtr user_data

Uninit()

反初始化IM SDK

Declaration
public static TIMResult Uninit()
Returns
Type Description
TIMResult

TIMResult

In This Article
Back to top Generated by DocFX