FriendService

```
public interface FriendService
```
Friends management, friend list, blacklist, and notifications

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`InvocationFuture<java.lang.Void>`	`ackAddFriendRequest(java.lang.String account, boolean agree)` Accept or reject a friend request
`InvocationFuture<java.lang.Void>`	`addFriend(AddFriendData data)` Friend request
`InvocationFuture<java.lang.Void>`	`addToBlackList(java.lang.String account)` Add an account to the blacklist
`InvocationFuture<java.lang.Void>`	`deleteFriend(java.lang.String account)` Delete a friend without delete the alias by default
`InvocationFuture<java.lang.Void>`	`deleteFriend(java.lang.String account, boolean deleteAlias)` Delete a friend and alias.
`java.util.List<java.lang.String>`	`getBlackList()` Get the accounts in the blacklist
`java.util.List<java.lang.String>`	`getFriendAccounts()` Get the accounts of friends
`Friend`	`getFriendByAccount(java.lang.String account)` Get friends by accounts
`java.util.List<Friend>`	`getFriends()` Get the list of friends
`java.util.List<java.lang.String>`	`getMuteList()` Get the accounts whose alert setting is muted
`boolean`	`isInBlackList(java.lang.String account)` Check if the peer account is included in the blacklist
`boolean`	`isMyFriend(java.lang.String account)` Check if the peer account is in the friend list of the current account
`boolean`	`isNeedMessageNotify(java.lang.String account)` Chech if the account needs alert
`InvocationFuture<java.lang.Void>`	`removeFromBlackList(java.lang.String account)` Remove an account from the blacklist
`InvocationFuture<java.util.List<java.lang.String>>`	`searchAccountByAlias(java.lang.String alias)` Search accounts using alias
`InvocationFuture<java.util.List<Friend>>`	`searchFriendsByKeyword(java.lang.String keyword)` Search accounts for friends that match keywords
`InvocationFuture<java.lang.Void>`	`setMessageNotify(java.lang.String account, boolean notify)` Set notification alert or mute the alert
`InvocationFuture<java.lang.Void>`	`updateFriendFields(java.lang.String friendAccount, java.util.Map<FriendFieldEnum,java.lang.Object> fields)` Update the friendship

- Method Detail
  - addFriend
```
InvocationFuture<java.lang.Void> addFriend(AddFriendData data)
```
    Friend request
    
    Parameters:
    
    data - Friend request data, such as peer account, request verification type, and added messages.
    
    Returns:
    
    InvocationFuture Configurable callback function that is triggered after a request is sent. If an error occurs, a specific error code will be returned.
  - ackAddFriendRequest
```
InvocationFuture<java.lang.Void> ackAddFriendRequest(java.lang.String account,
                                                     boolean agree)
```
    Accept or reject a friend request
    
    Parameters:
    
    account - Peer account
    
    agree - true: accept the friend request; false: reject the friend request.
    
    Returns:
    
    InvocationFuture Configurable callback function that is triggered after a request is sent. If an error occurs, a specific error code will be returned.
  - deleteFriend
```
InvocationFuture<java.lang.Void> deleteFriend(java.lang.String account)
```
    Delete a friend without delete the alias by default
    
    Parameters:
    
    account - The account from which the friendship is disassociated
    
    Returns:
    
    InvocationFuture Configurable callback function that is triggered after a request is sent. If an error occurs, a specific error code will be returned.
  - deleteFriend
```
InvocationFuture<java.lang.Void> deleteFriend(java.lang.String account,
                                              boolean deleteAlias)
```
    Delete a friend and alias.
    
    Parameters:
    
    account - The account from which the friendship is disassociated
    
    Returns:
    
    InvocationFuture Configurable callback function that is triggered after a request is sent. If an error occurs, a specific error code will be returned.
  - getFriends
```
java.util.List<Friend> getFriends()
```
    Get the list of friends
    
    Returns:
    
    List of friends
  - getFriendAccounts
```
java.util.List<java.lang.String> getFriendAccounts()
```
    Get the accounts of friends
    
    Returns:
    
    accounts of friends
  - getFriendByAccount
```
Friend getFriendByAccount(java.lang.String account)
```
    Get friends by accounts
    
    Parameters:
    
    account - User account
    
    Returns:
    
    The friend relationship of the account
  - isMyFriend
```
boolean isMyFriend(java.lang.String account)
```
    Check if the peer account is in the friend list of the current account
    
    Parameters:
    
    account - Peer account
    
    Returns:
    
    The result
  - updateFriendFields
```
InvocationFuture<java.lang.Void> updateFriendFields(java.lang.String friendAccount,
                                                    java.util.Map<FriendFieldEnum,java.lang.Object> fields)
```
    Update the friendship
    
    Parameters:
    
    friendAccount - The friend account
    
    fields - Fields to be updated. Alias and extension fields are supported. Note: The alias can contain up to 128 characters. Extension fields require Maps whose key must be String and value is Object. SDK converts maps into JSON string and the maps can contain 256 characters long.
    
    Returns:
    
    InvocationFuture Configurable callback function that is triggered after a request is sent. If an error occurs, a specific error code will be returned.
  - addToBlackList
```
InvocationFuture<java.lang.Void> addToBlackList(java.lang.String account)
```
    Add an account to the blacklist
    
    Parameters:
    
    account - The account to be removed
    
    Returns:
    
    InvocationFuture Configurable callback function that is triggered after a request is sent. If an error occurs, a specific error code will be returned.
  - removeFromBlackList
```
InvocationFuture<java.lang.Void> removeFromBlackList(java.lang.String account)
```
    Remove an account from the blacklist
    
    Parameters:
    
    account - The account to be removed
    
    Returns:
    
    InvocationFuture Configurable callback function that is triggered after a request is sent. If an error occurs, a specific error code will be returned.
  - isInBlackList
```
boolean isInBlackList(java.lang.String account)
```
    Check if the peer account is included in the blacklist
    
    Parameters:
    
    account - User account
    
    Returns:
    
    The result
  - getBlackList
```
java.util.List<java.lang.String> getBlackList()
```
    Get the accounts in the blacklist
    
    Returns:
    
    accounts in the blacklist
  - setMessageNotify
```
InvocationFuture<java.lang.Void> setMessageNotify(java.lang.String account,
                                                  boolean notify)
```
    Set notification alert or mute the alert
    
    Parameters:
    
    account - The account for which the alert is set
    
    notify - Specify whether to alert new notifications. False: mute the alert.
    
    Returns:
    
    InvocationFuture Configurable callback function that is triggered after a request is sent. If an error occurs, a specific error code will be returned.
  - isNeedMessageNotify
```
boolean isNeedMessageNotify(java.lang.String account)
```
    Chech if the account needs alert
    
    Parameters:
    
    account - The account to be removed
    
    Returns:
    
    true: alert is needed; false: mute the alert
  - getMuteList
```
java.util.List<java.lang.String> getMuteList()
```
    Get the accounts whose alert setting is muted
    
    Returns:
    
    accounts whose alert setting is muted
  - searchFriendsByKeyword
```
InvocationFuture<java.util.List<Friend>> searchFriendsByKeyword(java.lang.String keyword)
```
    Search accounts for friends that match keywords
    
    Returns:
    
    List of friends
  - searchAccountByAlias
```
InvocationFuture<java.util.List<java.lang.String>> searchAccountByAlias(java.lang.String alias)
```
    Search accounts using alias
    
    Parameters:
    
    alias - The alias
    
    Returns:
    
    Accounts that match the alias

Interface FriendService

Method Summary

Method Detail

addFriend

ackAddFriendRequest

deleteFriend

deleteFriend

getFriends

getFriendAccounts

getFriendByAccount

isMyFriend

updateFriendFields

addToBlackList

removeFromBlackList

isInBlackList

getBlackList

setMessageNotify

isNeedMessageNotify

getMuteList

searchFriendsByKeyword

searchAccountByAlias