Instance Methods | |
(void) | - addFriendListener: |
(void) | - removeFriendListener: |
(void) | - setFriendListener: |
(void) | - getFriendList:fail: |
(void) | - getFriendsInfo:succ:fail: |
(void) | - setFriendInfo:succ:fail: |
(void) | - searchFriends:succ:fail: |
(void) | - addFriend:succ:fail: |
(void) | - deleteFromFriendList:deleteType:succ:fail: |
(void) | - checkFriend:checkType:succ:fail: |
(void) | - getFriendApplicationList:fail: |
(void) | - acceptFriendApplication:type:succ:fail: |
(void) | - refuseFriendApplication:succ:fail: |
(void) | - deleteFriendApplication:succ:fail: |
(void) | - setFriendApplicationRead:fail: |
(void) | - addToBlackList:succ:fail: |
(void) | - deleteFromBlackList:succ:fail: |
(void) | - getBlackList:fail: |
(void) | - createFriendGroup:userIDList:succ:fail: |
(void) | - getFriendGroupList:succ:fail: |
(void) | - deleteFriendGroup:succ:fail: |
(void) | - renameFriendGroup:newName:succ:fail: |
(void) | - addFriendsToFriendGroup:userIDList:succ:fail: |
(void) | - deleteFriendsFromFriendGroup:userIDList:succ:fail: |
|
protected |
Callback definition on get friend list successfully.
|
protected |
Callback definition on get specified friends information successfully.
|
protected |
Callback definition for friend related operation.
|
protected |
Callback definition for friend list related operation.
|
protected |
Callback definition for check relation type.
|
protected |
Callback definition on get friend groups successfully.
|
protected |
Callback definition on get friend application list successfully.
|
protected |
|
protected |
|
protected |
Enumeration definition of relation type.
|
protected |
- (void) addFriendListener: | (addFriendListener(listener:)) | NS_SWIFT_NAME |
1.1 Add the relationship chain listener
- (void) removeFriendListener: | (removeFriendListener(listener:)) | NS_SWIFT_NAME |
1.2 Remove the relationship chain listener
- (void) setFriendListener: | (id< V2TIMFriendshipListener >) | listener |
Set the relationship chain listener
It is deprecated and discouraged to call this function. Please call APIs ref addFriendListener and removeFriendListener instead.
- (void) getFriendList: | (V2TIMFriendInfoListSucc) | succ | |
fail: | (V2TIMFail) | fail | |
2.1 Get the friend list
- (void) getFriendsInfo: | (NSArray< NSString * > *) | userIDList | |
succ: | (V2TIMFriendInfoResultListSucc) | succ | |
fail: | (V2TIMFail) | fail | |
2.2 Get the profiles of specified friends
userIDList | List of friends' userIDs
|
- (void) setFriendInfo: | (V2TIMFriendInfo *) | info | |
succ: | (V2TIMSucc) | succ | |
fail: | (V2TIMFail) | fail | |
2.3 Set the profile of a specified friend
- (void) searchFriends: | (V2TIMFriendSearchParam *) | searchParam | |
succ: | (V2TIMFriendInfoResultListSucc) | succ | |
fail: | (V2TIMFail) | fail | |
2.4 Search for friends (supported only in 5.4.666 and later versions and need to buy Flagship Edition)
- (void) addFriend: | (V2TIMFriendAddApplication *) | application | |
succ: | (V2TIMFriendOperationResultSucc) | succ | |
fail: | (V2TIMFail) | fail | |
2.5 Add a friend
- (void) deleteFromFriendList: | (NSArray *) | userIDList | |
deleteType: | (V2TIMFriendType) | deleteType | |
succ: | (V2TIMFriendOperationResultListSucc) | succ | |
fail: | (V2TIMFail) | fail | |
2.6 Delete friends
userIDList | List of the friend userIDs to be deleted
|
deleteType | Deletion type
|
- (void) checkFriend: | (NSArray< NSString * > *) | userIDList | |
checkType: | (V2TIMFriendType) | checkType | |
succ: | (V2TIMFriendCheckResultListSucc) | succ | |
fail: | (V2TIMFail) | fail | |
2.7 Check your relationships with specified users
userIDList | List of the userIDs to be checked |
checkType | Check type (one-way or two-way friend check) |
succ | Callback on success |
fail | Callback on fail |
- (void) getFriendApplicationList: | (V2TIMFriendApplicationResultSucc) | succ | |
fail: | (V2TIMFail) | fail | |
3.1 Get the friend request list
- (void) acceptFriendApplication: | (V2TIMFriendApplication *) | application | |
type: | (V2TIMFriendAcceptType) | acceptType | |
succ: | (V2TIMFriendOperationResultSucc) | succ | |
fail: | (V2TIMFail) | fail | |
3.2 Accept friend requests
application | Friend request information, which will be returned when calling getFriendApplicationList is successful |
acceptType | Build one-way or two-way friend relationships
|
- (void) refuseFriendApplication: | (V2TIMFriendApplication *) | application | |
succ: | (V2TIMFriendOperationResultSucc) | succ | |
fail: | (V2TIMFail) | fail | |
3.3 Reject friend requests
application | Friend request information, which will be returned when calling getFriendApplicationList is successful |
- (void) deleteFriendApplication: | (V2TIMFriendApplication *) | application | |
succ: | (V2TIMSucc) | succ | |
fail: | (V2TIMFail) | fail | |
3.4 Delete friend requests
application | Friend request information, which will be returned when calling getFriendApplicationList is successful |
- (void) setFriendApplicationRead: | (V2TIMSucc) | succ | |
fail: | (V2TIMFail) | fail | |
3.5 Set a friend request as read
- (void) addToBlackList: | (NSArray *) | userIDList | |
succ: | (V2TIMFriendOperationResultListSucc) | succ | |
fail: | (V2TIMFail) | fail | |
4.1 Add users to the blocklist
- (void) deleteFromBlackList: | (NSArray *) | userIDList | |
succ: | (V2TIMFriendOperationResultListSucc) | succ | |
fail: | (V2TIMFail) | fail | |
4.2 Delete users from the blocklist
- (void) getBlackList: | (V2TIMFriendInfoListSucc) | succ | |
fail: | (V2TIMFail) | fail | |
4.3 Get the blocklist
- (void) createFriendGroup: | (NSString *) | groupName | |
userIDList: | (NSArray *) | userIDList | |
succ: | (V2TIMFriendOperationResultListSucc) | succ | |
fail: | (V2TIMFail) | fail | |
5.1 Create a friend group
groupName | Friend group name |
userIDList | List of the friend userIDs to be added to the friend group |
- (void) getFriendGroupList: | (NSArray *) | groupNameList | |
succ: | (V2TIMFriendGroupListSucc) | succ | |
fail: | (V2TIMFail) | fail | |
5.2 Get friend group information
groupNameList | List of the names of the friend groups whose information is to be obtained. If null is passed in, the information of all friend groups is obtained. |
- (void) deleteFriendGroup: | (NSArray *) | groupNameList | |
succ: | (V2TIMSucc) | succ | |
fail: | (V2TIMFail) | fail | |
5.3 Delete friend groups
- (void) renameFriendGroup: | (NSString *) | oldName | |
newName: | (NSString *) | newName | |
succ: | (V2TIMSucc) | succ | |
fail: | (V2TIMFail) | fail | |
5.4 Modify the name of a friend group
- (void) addFriendsToFriendGroup: | (NSString *) | groupName | |
userIDList: | (NSArray *) | userIDList | |
succ: | (V2TIMFriendOperationResultListSucc) | succ | |
fail: | (V2TIMFail) | fail | |
5.5 Add friends to a friend group
- (void) deleteFriendsFromFriendGroup: | (NSString *) | groupName | |
userIDList: | (NSArray *) | userIDList | |
succ: | (V2TIMFriendOperationResultListSucc) | succ | |
fail: | (V2TIMFail) | fail | |
5.6 Delete friends from a friend group