V2TIMFriendshipManager | Tencent IM for React native

Hierarchy

V2TIMFriendshipManager

Index

Methods 事件监听

Methods Other

事件监听 Methods

addFriendListener

addFriendListener(listener: V2TimFriendshipListener): void

添加关系链监听器

Parameters
- listener: V2TimFriendshipListener
  
  监听器
Returns void

removeFriendListener

removeFriendListener(listener?: V2TimFriendshipListener): void

移除关系链监听器

Parameters
- Optional listener: V2TimFriendshipListener
  
  监听器
Returns void

获取好友信息 Methods

getFriendsInfo

getFriendsInfo(userIDList: string[]): Promise<V2TimValueCallback<V2TimFriendInfoResult[]>>

获取指定好友资料

Parameters
- userIDList: string[]
  好友ID数组
  - ID 建议一次最大 100 个，因为数量过多可能会导致数据包太大被后台拒绝，后台限制数据包最大为 1M。
Returns Promise<V2TimValueCallback<V2TimFriendInfoResult[]>>

获取好友列表 Methods

getFriendList

getFriendList(): Promise<V2TimValueCallback<V2TimFriendInfo[]>>

获取好友列表

Returns Promise<V2TimValueCallback<V2TimFriendInfo[]>>

设置指定好友资料 Methods

setFriendInfo

setFriendInfo(userID: string, friendRemark?: string, friendCustomInfo?: StringMap): Promise<V2TimCallback>

设置指定好友资料

Parameters
- userID: string
  
  好友userID
- Optional friendRemark: string
  
  好友备注
- Optional friendCustomInfo: StringMap
  
  好友自定义信息
Returns Promise<V2TimCallback>

Other Methods

acceptFriendApplication

acceptFriendApplication(responseType: FriendResponseTypeEnum, type: FriendApplicationTypeEnum, userID: string): Promise<V2TimValueCallback<V2TimFriendOperationResult>>

同意好友申请

Parameters
- responseType: FriendResponseTypeEnum
  
  建立单向/双向好友关系
- type: FriendApplicationTypeEnum
  
  请求类型
- userID: string
  
  用户ID
Returns Promise<V2TimValueCallback<V2TimFriendOperationResult>>

addFriend

addFriend(userID: string, addType: FriendType, remark?: string, friendGroup?: string, addWording?: string, addSource?: string): Promise<V2TimValueCallback<V2TimFriendOperationResult>>

添加好友

Parameters
- userID: string
  
  好友userID
- addType: FriendType
  
  添加方式
- Optional remark: string
  
  好友备注
- Optional friendGroup: string
  
  好友分组
- Optional addWording: string
  
  添加简述
- Optional addSource: string
  
  来源描述
Returns Promise<V2TimValueCallback<V2TimFriendOperationResult>>

addFriendsToFriendGroup

addFriendsToFriendGroup(groupName: string, userIDList: string[]): Promise<V2TimValueCallback<V2TimFriendOperationResult[]>>

添加好友到分组

Parameters
- groupName: string
  
  好友分组名称
- userIDList: string[]
  
  用户userID 列表
Returns Promise<V2TimValueCallback<V2TimFriendOperationResult[]>>

addToBlackList

addToBlackList(userIDList: string[]): Promise<V2TimValueCallback<V2TimFriendOperationResult[]>>

添加用户到黑名单

Parameters
- userIDList: string[]
  
  用户userID 列表
Returns Promise<V2TimValueCallback<V2TimFriendOperationResult[]>>

checkFriend

checkFriend(userIDList: string[], checkType: FriendType): Promise<V2TimValueCallback<V2TimFriendCheckResult[]>>

检查指定用户的好友关系
note
checkType 的使用需要注意：
- checkType 如果传入 V2TIM_FRIEND_TYPE_SINGLE，结果返回：V2TIM_FRIEND_RELATION_TYPE_NONE、V2TIM_FRIEND_RELATION_TYPE_IN_MY_FRIEND_LIST 两种情况
- checkType 如果传入 V2TIM_FRIEND_TYPE_BOTH，结果返回：V2TIM_FRIEND_RELATION_TYPE_NONE、V2TIM_FRIEND_RELATION_TYPE_IN_MY_FRIEND_LIST、 V2TIM_FRIEND_RELATION_TYPE_IN_OTHER_FRIEND_LIST、V2TIM_FRIEND_RELATION_TYPE_BOTH_WAY 四种情况
Parameters
- userIDList: string[]
  
  要检查的userID 列表
- checkType: FriendType
  
  检查类型
Returns Promise<V2TimValueCallback<V2TimFriendCheckResult[]>>

createFriendGroup

createFriendGroup(groupName: string, userIDList?: string[]): Promise<V2TimValueCallback<V2TimFriendOperationResult[]>>

创建好友分组

Parameters
- groupName: string
  
  分组名称
- Optional userIDList: string[]
  
  用户userID 列表
Returns Promise<V2TimValueCallback<V2TimFriendOperationResult[]>>

deleteFriendApplication

deleteFriendApplication(type: FriendApplicationTypeEnum, userID: string): Promise<V2TimValueCallback<V2TimFriendOperationResult>>

删除好友申请

Parameters
- type: FriendApplicationTypeEnum
  
  请求类型
- userID: string
  
  用户ID
Returns Promise<V2TimValueCallback<V2TimFriendOperationResult>>

deleteFriendGroup

deleteFriendGroup(groupNameList?: string[]): Promise<V2TimCallback>

删除好友分组

Parameters
- Optional groupNameList: string[]
  
  分组名称列表
Returns Promise<V2TimCallback>

deleteFriendsFromFriendGroup

deleteFriendsFromFriendGroup(groupName: string, userIDList: string[]): Promise<V2TimValueCallback<V2TimFriendOperationResult[]>>

把好友从好友分组中删除

Parameters
- groupName: string
  
  好友分组名称
- userIDList: string[]
  
  用户userID 列表
Returns Promise<V2TimValueCallback<V2TimFriendOperationResult[]>>

deleteFromBlackList

deleteFromBlackList(userIDList: string[]): Promise<V2TimValueCallback<V2TimFriendOperationResult[]>>

把用户从黑名单中删除

Parameters
- userIDList: string[]
  
  用户userID 列表
Returns Promise<V2TimValueCallback<V2TimFriendOperationResult[]>>

deleteFromFriendList

deleteFromFriendList(userIDList: string[], deleteType: FriendType): Promise<V2TimValueCallback<V2TimFriendOperationResult[]>>

删除好友

Parameters
- userIDList: string[]
  
  要删除的好友 userID 列表
- deleteType: FriendType
  
  删除类型
Returns Promise<V2TimValueCallback<V2TimFriendOperationResult[]>>

getBlackList

getBlackList(): Promise<V2TimValueCallback<V2TimFriendInfo[]>>

获取黑名单

Returns Promise<V2TimValueCallback<V2TimFriendInfo[]>>

getFriendApplicationList

getFriendApplicationList(): Promise<V2TimValueCallback<V2TimFriendApplicationResult>>

获取好友申请列表

Returns Promise<V2TimValueCallback<V2TimFriendApplicationResult>>

getFriendGroups

getFriendGroups(groupNameList?: string[]): Promise<V2TimValueCallback<V2TimFriendGroup[]>>

获取分组信息

Parameters
- Optional groupNameList: string[]
  
  要获取信息的好友分组名称列表,传入 null 获得所有分组信息
Returns Promise<V2TimValueCallback<V2TimFriendGroup[]>>

refuseFriendApplication

refuseFriendApplication(type: FriendApplicationTypeEnum, userID: string): Promise<V2TimValueCallback<V2TimFriendOperationResult>>

拒绝好友申请

Parameters
- type: FriendApplicationTypeEnum
  
  请求类型
- userID: string
  
  用户ID
Returns Promise<V2TimValueCallback<V2TimFriendOperationResult>>

renameFriendGroup

renameFriendGroup(oldName: string, newName: string): Promise<V2TimCallback>

好友分组重命名

Parameters
- oldName: string
  
  分组旧名称
- newName: string
  
  分组新名称
Returns Promise<V2TimCallback>

searchFriends

searchFriends(param0: V2TimFriendSearchParam): Promise<V2TimValueCallback<V2TimFriendInfoResult[]>>

搜索好友

note
需要购买旗舰版套餐

Parameters
- param0: V2TimFriendSearchParam
Returns Promise<V2TimValueCallback<V2TimFriendInfoResult[]>>

setFriendApplicationRead

setFriendApplicationRead(): Promise<V2TimCallback>

设置好友申请已读

Returns Promise<V2TimCallback>

Hierarchy

Index

Methods 事件监听

Methods 获取好友信息

Methods 获取好友列表

Methods 设置指定好友资料

Methods Other

事件监听 Methods

addFriendListener

Parameters

listener: V2TimFriendshipListener

Returns void

removeFriendListener

Parameters

Optional listener: V2TimFriendshipListener

Returns void

获取好友信息 Methods

getFriendsInfo

Parameters

userIDList: string[]

Returns Promise<V2TimValueCallback<V2TimFriendInfoResult[]>>

获取好友列表 Methods

getFriendList

Returns Promise<V2TimValueCallback<V2TimFriendInfo[]>>

设置指定好友资料 Methods

setFriendInfo

Parameters

userID: string

Optional friendRemark: string

Optional friendCustomInfo: StringMap

Returns Promise<V2TimCallback>

Other Methods

acceptFriendApplication

同意好友申请

Parameters

responseType: FriendResponseTypeEnum

type: FriendApplicationTypeEnum

userID: string

Returns Promise<V2TimValueCallback<V2TimFriendOperationResult>>

addFriend

添加好友

Parameters

userID: string

addType: FriendType

Optional remark: string

Optional friendGroup: string

Optional addWording: string

Optional addSource: string

Returns Promise<V2TimValueCallback<V2TimFriendOperationResult>>

addFriendsToFriendGroup

添加好友到分组

Parameters

groupName: string

userIDList: string[]

Returns Promise<V2TimValueCallback<V2TimFriendOperationResult[]>>

addToBlackList

Parameters

userIDList: string[]

Returns Promise<V2TimValueCallback<V2TimFriendOperationResult[]>>

checkFriend

Parameters

userIDList: string[]

checkType: FriendType

Returns Promise<V2TimValueCallback<V2TimFriendCheckResult[]>>

createFriendGroup

创建好友分组

Parameters

groupName: string

Optional userIDList: string[]

Returns Promise<V2TimValueCallback<V2TimFriendOperationResult[]>>

deleteFriendApplication

删除好友申请

Parameters

type: FriendApplicationTypeEnum

userID: string

Returns Promise<V2TimValueCallback<V2TimFriendOperationResult>>

deleteFriendGroup

删除好友分组

Parameters

Optional groupNameList: string[]

Methods 事件监听

Methods 获取好友信息

Methods 获取好友列表

Methods 设置指定好友资料

事件监听 Methods

获取好友信息 Methods

获取好友列表 Methods

设置指定好友资料 Methods