AVFriendshipQuery (leancloud-common 0.1.13 API)

java.lang.Object
- com.avos.avoscloud.AVFriendshipQuery<T>

```
public class AVFriendshipQuery<T extends AVUser>
extends Object
```
用于查询用户的好友关系的Query对象，同时包含用户的粉丝和用户的关注

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AVFriendshipQuery<T>`	`addAscendingOrder(String key)` Also sorts the results in ascending order by the given key.
`AVFriendshipQuery<T>`	`addDescendingOrder(String key)` Also sorts the results in descending order by the given key.
`protected AVFriendshipQuery<T>`	`addWhereItem(String key, String op, Object value)`
`AVFriendship`	`get()`
`void`	`getInBackground(AVFriendshipCallback callback)`
`protected void`	`getInBackground(String objectId, boolean sync, AVFriendshipCallback callback)`
`int`	`getLimit()` Accessor for the limit.
`String`	`getOrder()`
`int`	`getSkip()` Accessor for the skip value.
`AVFriendshipQuery<T>`	`include(String key)` Include nested AVObjects for the provided key.
`AVFriendshipQuery<T>`	`limit(int limit)`
`AVFriendshipQuery<T>`	`order(String order)`
`AVFriendshipQuery<T>`	`orderByAscending(String key)` Sorts the results in ascending order by the given key.
`AVFriendshipQuery<T>`	`orderByDescending(String key)` Sorts the results in descending order by the given key.
`AVFriendshipQuery<T>`	`selectKeys(Collection<String> keys)` Restrict the fields of returned AVObjects to only include the provided keys.
`AVFriendshipQuery<T>`	`setLimit(int limit)` Controls the maximum number of results that are returned.
`AVFriendshipQuery<T>`	`setOrder(String order)` Set query order fields.
`AVFriendshipQuery<T>`	`setSkip(int skip)` Controls the number of results to skip before returning any results.
`AVFriendshipQuery<T>`	`skip(int skip)`
`AVFriendshipQuery<T>`	`whereContainedIn(String key, Collection<? extends Object> values)` Add a constraint to the query that requires a particular key's value to be contained in the provided list of values.
`AVFriendshipQuery<T>`	`whereContains(String key, String substring)` Add a constraint for finding string values that contain a provided string.
`AVFriendshipQuery<T>`	`whereContainsAll(String key, Collection<?> values)` Add a constraint to the query that requires a particular key's value match another AVFriendshipQuery.
`AVFriendshipQuery<T>`	`whereDoesNotExist(String key)` Add a constraint for finding objects that do not contain a given key.
`AVFriendshipQuery<T>`	`whereEndsWith(String key, String suffix)` Add a constraint for finding string values that end with a provided string.
`AVFriendshipQuery<T>`	`whereEqualTo(String key, Object value)` Add a constraint to the query that requires a particular key's value to be equal to the provided value.
`AVFriendshipQuery<T>`	`whereExists(String key)` Add a constraint for finding objects that contain the given key.
`AVFriendshipQuery<T>`	`whereGreaterThan(String key, Object value)` Add a constraint to the query that requires a particular key's value to be greater than the provided value.
`AVFriendshipQuery<T>`	`whereGreaterThanOrEqualTo(String key, Object value)` Add a constraint to the query that requires a particular key's value to be greater or equal to than the provided value.
`AVFriendshipQuery<T>`	`whereLessThan(String key, Object value)` Add a constraint to the query that requires a particular key's value to be less than the provided value.
`AVFriendshipQuery<T>`	`whereLessThanOrEqualTo(String key, Object value)` Add a constraint to the query that requires a particular key's value to be less or equal to than the provided value.
`AVFriendshipQuery<T>`	`whereMatches(String key, String regex)` Add a regular expression constraint for finding string values that match the provided regular expression.
`AVFriendshipQuery<T>`	`whereMatches(String key, String regex, String modifiers)` Add a regular expression constraint for finding string values that match the provided regular expression.
`AVFriendshipQuery<T>`	`whereNear(String key, AVGeoPoint point)` Add a proximity based constraint for finding objects with key point values near the point given.
`AVFriendshipQuery<T>`	`whereNotContainedIn(String key, Collection<? extends Object> values)` Add a constraint to the query that requires a particular key's value not be contained in the provided list of values.
`AVFriendshipQuery<T>`	`whereNotEqualTo(String key, Object value)` Add a constraint to the query that requires a particular key's value to be not equal to the provided value.
`AVFriendshipQuery<T>`	`whereSizeEqual(String key, int size)` 添加查询约束条件，查找key类型是数组，该数组的长度匹配提供的数值。
`AVFriendshipQuery<T>`	`whereStartsWith(String key, String prefix)` Add a constraint for finding string values that start with a provided string.
`AVFriendshipQuery<T>`	`whereWithinGeoBox(String key, AVGeoPoint southwest, AVGeoPoint northeast)` Add a constraint to the query that requires a particular key's coordinates be contained within a given rectangular geographic bounding box.
`AVFriendshipQuery<T>`	`whereWithinKilometers(String key, AVGeoPoint point, double maxDistance)` Add a proximity based constraint for finding objects with key point values near the point given and within the maximum distance given.
`AVFriendshipQuery<T>`	`whereWithinMiles(String key, AVGeoPoint point, double maxDistance)` Add a proximity based constraint for finding objects with key point values near the point given and within the maximum distance given.
`AVFriendshipQuery<T>`	`whereWithinRadians(String key, AVGeoPoint point, double maxDistance)` Add a proximity based constraint for finding objects with key point values near the point given and within the maximum distance given.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - getInBackground
```
protected void getInBackground(String objectId,
                               boolean sync,
                               AVFriendshipCallback callback)
```
  - get
```
public AVFriendship get()
                 throws AVException
```
    Throws:
    
    AVException
  - getInBackground
```
public void getInBackground(AVFriendshipCallback callback)
```
    Parameters:
    
    callback - callback.done will be called when done
  - getLimit
```
public int getLimit()
```
    Accessor for the limit.
    
    Returns:
    
    limit for query result count
  - setLimit
```
public AVFriendshipQuery<T> setLimit(int limit)
```
    Controls the maximum number of results that are returned. Setting a negative limit denotes retrieval without a limit. The default limit is 100, with a maximum of 1000 results being returned at a time.
    
    Parameters:
    
    limit - limit for query result count
    
    Returns:
    
    this query.
  - limit
```
public AVFriendshipQuery<T> limit(int limit)
```
    Parameters:
    
    limit - limit for query result count
    
    Returns:
    
    this query.
    
    See Also:
    
    setLimit(int)
  - skip
```
public AVFriendshipQuery<T> skip(int skip)
```
    Parameters:
    
    skip - count to skip in query result
    
    Returns:
    
    this query.
    
    See Also:
    
    setSkip(int)
  - getSkip
```
public int getSkip()
```
    Accessor for the skip value.
    
    Returns:
    
    count to skip in query result
  - setSkip
```
public AVFriendshipQuery<T> setSkip(int skip)
```
    Controls the number of results to skip before returning any results. This is useful for pagination. Default is to skip zero results.
    
    Parameters:
    
    skip - count to skip in query result
    
    Returns:
    
    this query
  - getOrder
```
public String getOrder()
```
  - setOrder
```
public AVFriendshipQuery<T> setOrder(String order)
```
    Set query order fields.
    
    Parameters:
    
    order - order for query result
    
    Returns:
    
    this query.
  - order
```
public AVFriendshipQuery<T> order(String order)
```
    Parameters:
    
    order - order for query result
    
    Returns:
    
    this query.
    
    See Also:
    
    setOrder(String)
  - addAscendingOrder
```
public AVFriendshipQuery<T> addAscendingOrder(String key)
```
    Also sorts the results in ascending order by the given key. The previous sort keys have precedence over this key.
    
    Parameters:
    
    key - The key to order by
    
    Returns:
    
    Returns the query so you can chain this call.
  - addDescendingOrder
```
public AVFriendshipQuery<T> addDescendingOrder(String key)
```
    Also sorts the results in descending order by the given key. The previous sort keys have precedence over this key.
    
    Parameters:
    
    key - The key to order by
    
    Returns:
    
    Returns the query so you can chain this call.
  - include
```
public AVFriendshipQuery<T> include(String key)
```
    Include nested AVObjects for the provided key. You can use dot notation to specify which fields in the included object that are also fetched.
    
    Parameters:
    
    key - The key that should be included.
    
    Returns:
    
    this query
  - selectKeys
```
public AVFriendshipQuery<T> selectKeys(Collection<String> keys)
```
    Restrict the fields of returned AVObjects to only include the provided keys. If this is called multiple times, then all of the keys specified in each of the calls will be included.
    
    Parameters:
    
    keys - The set of keys to include in the result.
    
    Returns:
    
    this query
  - orderByAscending
```
public AVFriendshipQuery<T> orderByAscending(String key)
```
    Sorts the results in ascending order by the given key.
    
    Parameters:
    
    key - The key to order by.
    
    Returns:
    
    Returns the query, so you can chain this call.
  - orderByDescending
```
public AVFriendshipQuery<T> orderByDescending(String key)
```
    Sorts the results in descending order by the given key.
    
    Parameters:
    
    key - The key to order by.
    
    Returns:
    
    Returns the query, so you can chain this call.
  - whereContainedIn
```
public AVFriendshipQuery<T> whereContainedIn(String key,
                                             Collection<? extends Object> values)
```
    Add a constraint to the query that requires a particular key's value to be contained in the provided list of values.
    
    Parameters:
    
    key - The key to check.
    
    values - The values that will match.
    
    Returns:
    
    Returns the query, so you can chain this call.
  - whereContains
```
public AVFriendshipQuery<T> whereContains(String key,
                                          String substring)
```
    Add a constraint for finding string values that contain a provided string. This will be slow for large datasets.
    
    Parameters:
    
    key - The key that the string to match is stored in.
    
    substring - The substring that the value must contain.
    
    Returns:
    
    Returns the query, so you can chain this call.
  - whereSizeEqual
```
public AVFriendshipQuery<T> whereSizeEqual(String key,
                                           int size)
```
    添加查询约束条件，查找key类型是数组，该数组的长度匹配提供的数值。
    
    Parameters:
    
    key - 查询的key
    
    size - 数组的长度
    
    Returns:
    
    this query
    
    Since:
    
    2.0.2
  - whereContainsAll
```
public AVFriendshipQuery<T> whereContainsAll(String key,
                                             Collection<?> values)
```
    Add a constraint to the query that requires a particular key's value match another AVFriendshipQuery. This only works on keys whose values are AVObjects or lists of AVObjects. Add a constraint to the query that requires a particular key's value to contain every one of the provided list of values.
    
    Parameters:
    
    key - The key to check. This key's value must be an array.
    
    values - The values that will match.
    
    Returns:
    
    Returns the query, so you can chain this call.
  - whereDoesNotExist
```
public AVFriendshipQuery<T> whereDoesNotExist(String key)
```
    Add a constraint for finding objects that do not contain a given key.
    
    Parameters:
    
    key - The key that should not exist
    
    Returns:
    
    Returns the query, so you can chain this call.
  - whereEndsWith
```
public AVFriendshipQuery<T> whereEndsWith(String key,
                                          String suffix)
```
    Add a constraint for finding string values that end with a provided string. This will be slow for large datasets.
    
    Parameters:
    
    key - The key that the string to match is stored in.
    
    suffix - The substring that the value must end with.
    
    Returns:
    
    Returns the query, so you can chain this call.
  - whereEqualTo
```
public AVFriendshipQuery<T> whereEqualTo(String key,
                                         Object value)
```
    Add a constraint to the query that requires a particular key's value to be equal to the provided value.
    
    Parameters:
    
    key - The key to check.
    
    value - The value that the AVObject must contain.
    
    Returns:
    
    Returns the query, so you can chain this call.
  - addWhereItem
```
protected AVFriendshipQuery<T> addWhereItem(String key,
                                            String op,
                                            Object value)
```
  - whereExists
```
public AVFriendshipQuery<T> whereExists(String key)
```
    Add a constraint for finding objects that contain the given key.
    
    Parameters:
    
    key - The key that should exist.
    
    Returns:
    
    Returns the query, so you can chain this call.
  - whereGreaterThan
```
public AVFriendshipQuery<T> whereGreaterThan(String key,
                                             Object value)
```
    Add a constraint to the query that requires a particular key's value to be greater than the provided value.
    
    Parameters:
    
    key - The key to check.
    
    value - The value that provides an lower bound.
    
    Returns:
    
    Returns the query, so you can chain this call.
  - whereGreaterThanOrEqualTo
```
public AVFriendshipQuery<T> whereGreaterThanOrEqualTo(String key,
                                                      Object value)
```
    Add a constraint to the query that requires a particular key's value to be greater or equal to than the provided value.
    
    Parameters:
    
    key - The key to check.
    
    value - The value that provides an lower bound.
    
    Returns:
    
    Returns the query, so you can chain this call.
  - whereLessThan
```
public AVFriendshipQuery<T> whereLessThan(String key,
                                          Object value)
```
    Add a constraint to the query that requires a particular key's value to be less than the provided value.
    
    Parameters:
    
    key - The key to check.
    
    value - The value that provides an upper bound.
    
    Returns:
    
    Returns the query, so you can chain this call.
  - whereLessThanOrEqualTo
```
public AVFriendshipQuery<T> whereLessThanOrEqualTo(String key,
                                                   Object value)
```
    Add a constraint to the query that requires a particular key's value to be less or equal to than the provided value.
    
    Parameters:
    
    key - The key to check.
    
    value - The value that provides an lower bound.
    
    Returns:
    
    Returns the query, so you can chain this call.
  - whereMatches
```
public AVFriendshipQuery<T> whereMatches(String key,
                                         String regex)
```
    Add a regular expression constraint for finding string values that match the provided regular expression. This may be slow for large datasets.
    
    Parameters:
    
    key - The key that the string to match is stored in.
    
    regex - The regular expression pattern to match.
    
    Returns:
    
    Returns the query, so you can chain this call.
  - whereMatches
```
public AVFriendshipQuery<T> whereMatches(String key,
                                         String regex,
                                         String modifiers)
```
    Add a regular expression constraint for finding string values that match the provided regular expression. This may be slow for large datasets.
    
    Parameters:
    
    key - The key that the string to match is stored in.
    
    regex - The regular expression pattern to match.
    
    modifiers - Any of the following supported PCRE modifiers: i - Case insensitive search m - Search across multiple lines of input
    
    Returns:
    
    Returns the query, so you can chain this call.
  - whereNear
```
public AVFriendshipQuery<T> whereNear(String key,
                                      AVGeoPoint point)
```
    Add a proximity based constraint for finding objects with key point values near the point given.
    
    Parameters:
    
    key - The key that the AVGeoPoint is stored in.
    
    point - The reference AVGeoPoint that is used.
    
    Returns:
    
    Returns the query, so you can chain this call.
  - whereNotContainedIn
```
public AVFriendshipQuery<T> whereNotContainedIn(String key,
                                                Collection<? extends Object> values)
```
    Add a constraint to the query that requires a particular key's value not be contained in the provided list of values.
    
    Parameters:
    
    key - The key to check.
    
    values - The values that will not match.
    
    Returns:
    
    Returns the query, so you can chain this call.
  - whereNotEqualTo
```
public AVFriendshipQuery<T> whereNotEqualTo(String key,
                                            Object value)
```
    Add a constraint to the query that requires a particular key's value to be not equal to the provided value.
    
    Parameters:
    
    key - The key to check.
    
    value - The value that must not be equalled.
    
    Returns:
    
    Returns the query, so you can chain this call.
  - whereStartsWith
```
public AVFriendshipQuery<T> whereStartsWith(String key,
                                            String prefix)
```
    Add a constraint for finding string values that start with a provided string. This query will use the backend index, so it will be fast even for large datasets.
    
    Parameters:
    
    key - The key that the string to match is stored in.
    
    prefix - The substring that the value must start with.
    
    Returns:
    
    Returns the query, so you can chain this call.
  - whereWithinGeoBox
```
public AVFriendshipQuery<T> whereWithinGeoBox(String key,
                                              AVGeoPoint southwest,
                                              AVGeoPoint northeast)
```
    Add a constraint to the query that requires a particular key's coordinates be contained within a given rectangular geographic bounding box.
    
    Parameters:
    
    key - The key to be constrained.
    
    southwest - The lower-left inclusive corner of the box.
    
    northeast - The upper-right inclusive corner of the box.
    
    Returns:
    
    Returns the query, so you can chain this call.
  - whereWithinKilometers
```
public AVFriendshipQuery<T> whereWithinKilometers(String key,
                                                  AVGeoPoint point,
                                                  double maxDistance)
```
    Add a proximity based constraint for finding objects with key point values near the point given and within the maximum distance given. Radius of earth used is 6371.0 kilometers.
    
    Parameters:
    
    key - The key that the AVGeoPoint is stored in.
    
    point - The reference AVGeoPoint that is used.
    
    maxDistance - Maximum distance (in kilometers) of results to return.
    
    Returns:
    
    Returns the query, so you can chain this call.
  - whereWithinMiles
```
public AVFriendshipQuery<T> whereWithinMiles(String key,
                                             AVGeoPoint point,
                                             double maxDistance)
```
    Add a proximity based constraint for finding objects with key point values near the point given and within the maximum distance given. Radius of earth used is 3958.8 miles.
    
    Parameters:
    
    key - The key that the AVGeoPoint is stored in.
    
    point - point The reference AVGeoPoint that is used.
    
    maxDistance - maxDistance Maximum distance (in miles) of results to return.
    
    Returns:
    
    Returns the query, so you can chain this call.
  - whereWithinRadians
```
public AVFriendshipQuery<T> whereWithinRadians(String key,
                                               AVGeoPoint point,
                                               double maxDistance)
```
    Add a proximity based constraint for finding objects with key point values near the point given and within the maximum distance given.
    
    Parameters:
    
    key - The key that the AVGeoPoint is stored in.
    
    point - The reference AVGeoPoint that is used.
    
    maxDistance - Maximum distance (in radians) of results to return.
    
    Returns:
    
    Returns the query, so you can chain this call.

Class AVFriendshipQuery<T extends AVUser>

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getInBackground

get

getInBackground

getLimit

setLimit

limit

skip

getSkip

setSkip

getOrder

setOrder

order

addAscendingOrder

addDescendingOrder

include

selectKeys

orderByAscending

orderByDescending

whereContainedIn

whereContains

whereSizeEqual

whereContainsAll

whereDoesNotExist

whereEndsWith

whereEqualTo

addWhereItem

whereExists

whereGreaterThan

whereGreaterThanOrEqualTo

whereLessThan

whereLessThanOrEqualTo

whereMatches

whereMatches

whereNear

whereNotContainedIn

whereNotEqualTo

whereStartsWith

whereWithinGeoBox

whereWithinKilometers

whereWithinMiles

whereWithinRadians