LCIMConversationsQuery (leancloud sdk 8.2.28 API)

java.lang.Object
- cn.leancloud.im.v2.LCIMConversationsQuery

public class LCIMConversationsQuery
extends Object

Constructor Summary

Constructors
Modifier Constructor and Description

protected LCIMConversationsQuery(LCIMClient client)

Constructors
Modifier	Constructor and Description
`protected`	`LCIMConversationsQuery(LCIMClient client)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`LCIMConversationsQuery`	`addAscendingOrder(String key)` 设置返回集合按照指定key进行升序排列，此 key 的优先级小于先前设置的 key
`LCIMConversationsQuery`	`addDescendingOrder(String key)` 设置返回集合按照指定key进行降序排列，此 key 的优先级小于先前设置的 key
`LCIMConversationsQuery`	`containsMembers(List<String> peerIds)` 增加查询条件，指定聊天室的组员包含某些成员即可返回
`void`	`directFindInBackground(String where, String sort, int skip, int limit, int flag, LCIMConversationQueryCallback callback)` direct find with conditions in background.
`void`	`findInBackground(LCIMConversationQueryCallback callback)` find in background.
`void`	`findTempConversationsInBackground(List<String> conversationIds, LCIMConversationQueryCallback callback)` find temporary conversations in background.
`long`	`getCacheMaxAge()`
`boolean`	`isWithLastMessagesRefreshed()` 是否携带最后一条消息
`LCIMConversationsQuery`	`limit(int limit)` 设置返回集合的大小上限
`static LCIMConversationsQuery`	`or(List<LCIMConversationsQuery> queries)` Constructs a IMConversationsQuery that is the or of the given queries.
`LCIMConversationsQuery`	`orderByAscending(String key)` 设置返回集合按照指定key进行增序排列
`LCIMConversationsQuery`	`orderByDescending(String key)` 设置返回集合按照指定key进行降序排列
`void`	`setCacheMaxAge(long maxAgeInSecond)` 设置查询缓存的有效时间
`LCIMConversationsQuery`	`setCompact(boolean isCompact)` 是否返回成员列表
`LCIMConversationsQuery`	`setLimit(int limit)` 设置返回集合的大小上限
`void`	`setQueryPolicy(LCQuery.CachePolicy policy)` 设置 IMConversationsQuery 的查询策略
`LCIMConversationsQuery`	`setSkip(int skip)` 设置返回集合的起始位置，一般用于分页
`LCIMConversationsQuery`	`setWithLastMessagesRefreshed(boolean isWithLastMessageRefreshed)` 设置是否携带最后一条消息
`LCIMConversationsQuery`	`skip(int skip)` 设置返回集合的起始位置，一般用于分页
`LCIMConversationsQuery`	`whereContainedIn(String key, Collection<?> value)` 增加查询条件，当conversation的属性中对应的字段对应的值包含在指定值中时即可返回
`LCIMConversationsQuery`	`whereContains(String key, String subString)` 增加查询条件，当conversation的属性中对应的字段对应的值包含此字符串即可返回
`LCIMConversationsQuery`	`whereContainsAll(String key, Collection<?> values)` 增加查询条件，当conversation的属性中对应的字段中的元素包含所有的值才可返回
`LCIMConversationsQuery`	`whereContainsIn(String key, Collection<?> value)` 增加查询条件，当conversation的属性中对应的字段对应的值包含在指定值中时即可返回
`LCIMConversationsQuery`	`whereDoesNotExist(String key)` 增加查询条件，当 conversation 的属性中对应的字段没有值时即可返回
`LCIMConversationsQuery`	`whereEndsWith(String key, String suffix)` 增加查询条件，当conversation的属性中对应的字段对应的值以此字符串结束即可返回
`LCIMConversationsQuery`	`whereEqualTo(String key, Object value)` 增加查询条件，当conversation的属性中对应的字段满足等于条件时即可返回
`LCIMConversationsQuery`	`whereExists(String key)` 增加查询条件，当 conversation 的属性中对应的字段有值时即可返回
`LCIMConversationsQuery`	`whereGreaterThan(String key, Object value)` 增加查询条件，当conversation的属性中对应的字段满足大于条件时即可返回
`LCIMConversationsQuery`	`whereGreaterThanOrEqualsTo(String key, Object value)` 增加查询条件，当conversation的属性中对应的字段满足大于等于条件时即可返回
`LCIMConversationsQuery`	`whereLessThan(String key, Object value)` 增加查询条件，当conversation的属性中对应的字段满足小于条件时即可返回
`LCIMConversationsQuery`	`whereLessThanOrEqualsTo(String key, Object value)` 增加查询条件，当conversation的属性中对应的字段满足小于等于条件时即可返回
`LCIMConversationsQuery`	`whereMatches(String key, String regex)` 增加查询条件，当conversation的属性中对应的字段对应的值满足提供的正则表达式即可返回
`LCIMConversationsQuery`	`whereMatches(String key, String regex, String modifiers)` 增加查询条件，当conversation的属性中对应的字段对应的值满足提供的正则表达式即可返回
`LCIMConversationsQuery`	`whereNear(String key, LCGeoPoint point)` 增加一个基于地理位置的近似查询，当conversation的属性中对应字段对应的地理位置在pointer附近时即可返回
`LCIMConversationsQuery`	`whereNotContainsIn(String key, Collection<?> value)` 增加查询条件，当conversation的属性中对应的字段对应的值不包含在指定值中时即可返回
`LCIMConversationsQuery`	`whereNotEqualsTo(String key, Object value)` 增加查询条件，当conversation的属性中对应的字段满足不等于条件时即可返回
`LCIMConversationsQuery`	`whereSizeEqual(String key, int size)` 添加查询约束条件，查找key类型是数组，该数组的长度匹配提供的数值
`LCIMConversationsQuery`	`whereStartsWith(String key, String prefix)` 增加查询条件，当conversation的属性中对应的字段对应的值以此字符串起始即可返回
`LCIMConversationsQuery`	`whereWithinGeoBox(String key, LCGeoPoint southwest, LCGeoPoint northeast)` 增加一个基于地理位置的查询，当conversation的属性中有对应字段对应的地址位置在指定的矩形区域内时即可返回
`LCIMConversationsQuery`	`whereWithinKilometers(String key, LCGeoPoint point, double maxDistance)` 增加一个基于地理位置的近似查询，当conversation的属性中有对应的地址位置与指定的地理位置间距不超过指定距离时返回地球半径为6371.0 千米
`LCIMConversationsQuery`	`whereWithinMiles(String key, LCGeoPoint point, double maxDistance)` 增加一个基于地理位置的近似查询，当conversation的属性中有对应的地址位置与指定的地理位置间距不超过指定距离时返回
`LCIMConversationsQuery`	`whereWithinRadians(String key, LCGeoPoint point, double maxDistance)` 增加一个基于地理位置的近似查询，当conversation的属性中有对应的地址位置与指定的地理位置间距不超过指定距离时返回
`LCIMConversationsQuery`	`withMembers(List<String> peerIds)` 增加查询条件，指定聊天室的组员条件满足条件的才返回
`LCIMConversationsQuery`	`withMembers(List<String> peerIds, boolean includeSelf)` 增加查询条件，指定聊天室的组员条件满足条件的才返回

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

- Constructor Detail
  - LCIMConversationsQuery
```
protected LCIMConversationsQuery(LCIMClient client)
```
- Method Detail
  - withMembers
```
public LCIMConversationsQuery withMembers(List<String> peerIds)
```
    增加查询条件，指定聊天室的组员条件满足条件的才返回
    
    Parameters:
    
    peerIds - peer id list.
    
    Returns:
    
    current instance.
  - withMembers
```
public LCIMConversationsQuery withMembers(List<String> peerIds,
                                          boolean includeSelf)
```
    增加查询条件，指定聊天室的组员条件满足条件的才返回
    
    Parameters:
    
    peerIds - peer client id list.
    
    includeSelf - 是否包含自己
    
    Returns:
    
    current instance.
  - containsMembers
```
public LCIMConversationsQuery containsMembers(List<String> peerIds)
```
    增加查询条件，指定聊天室的组员包含某些成员即可返回
    
    Parameters:
    
    peerIds - peer client id list.
    
    Returns:
    
    current instance.
  - whereEqualTo
```
public LCIMConversationsQuery whereEqualTo(String key,
                                           Object value)
```
    增加查询条件，当conversation的属性中对应的字段满足等于条件时即可返回
    
    Parameters:
    
    key - attribute key.
    
    value - attribute value
    
    Returns:
    
    current instance.
  - whereLessThan
```
public LCIMConversationsQuery whereLessThan(String key,
                                            Object value)
```
    增加查询条件，当conversation的属性中对应的字段满足小于条件时即可返回
    
    Parameters:
    
    key - attribute key.
    
    value - attribute value
    
    Returns:
    
    current instance.
  - whereLessThanOrEqualsTo
```
public LCIMConversationsQuery whereLessThanOrEqualsTo(String key,
                                                      Object value)
```
    增加查询条件，当conversation的属性中对应的字段满足小于等于条件时即可返回
    
    Parameters:
    
    key - attribute key.
    
    value - attribute value.
    
    Returns:
    
    current instance.
  - whereGreaterThan
```
public LCIMConversationsQuery whereGreaterThan(String key,
                                               Object value)
```
    增加查询条件，当conversation的属性中对应的字段满足大于条件时即可返回
    
    Parameters:
    
    key - attribute key.
    
    value - attribute value.
    
    Returns:
    
    current instance.
  - whereGreaterThanOrEqualsTo
```
public LCIMConversationsQuery whereGreaterThanOrEqualsTo(String key,
                                                         Object value)
```
    增加查询条件，当conversation的属性中对应的字段满足大于等于条件时即可返回
    
    Parameters:
    
    key - attribute key.
    
    value - attribute value.
    
    Returns:
    
    current instance.
  - whereNotEqualsTo
```
public LCIMConversationsQuery whereNotEqualsTo(String key,
                                               Object value)
```
    增加查询条件，当conversation的属性中对应的字段满足不等于条件时即可返回
    
    Parameters:
    
    key - attribute key.
    
    value - attribute value.
    
    Returns:
    
    current instance.
  - whereContainsIn
```
public LCIMConversationsQuery whereContainsIn(String key,
                                              Collection<?> value)
```
    增加查询条件，当conversation的属性中对应的字段对应的值包含在指定值中时即可返回
    
    Parameters:
    
    key - attribute key.
    
    value - value collection.
    
    Returns:
    
    current instance. Notice: equals to whereContainedIn
  - whereContainedIn
```
public LCIMConversationsQuery whereContainedIn(String key,
                                               Collection<?> value)
```
    增加查询条件，当conversation的属性中对应的字段对应的值包含在指定值中时即可返回
    
    Parameters:
    
    key - attribute key.
    
    value - value collection.
    
    Returns:
    
    current instance.
  - whereExists
```
public LCIMConversationsQuery whereExists(String key)
```
    增加查询条件，当 conversation 的属性中对应的字段有值时即可返回
    
    Parameters:
    
    key - The key that should exist.
    
    Returns:
    
    current instance.
  - whereDoesNotExist
```
public LCIMConversationsQuery whereDoesNotExist(String key)
```
    增加查询条件，当 conversation 的属性中对应的字段没有值时即可返回
    
    Parameters:
    
    key - attribute key.
    
    Returns:
    
    current instance.
  - whereNotContainsIn
```
public LCIMConversationsQuery whereNotContainsIn(String key,
                                                 Collection<?> value)
```
    增加查询条件，当conversation的属性中对应的字段对应的值不包含在指定值中时即可返回
    
    Parameters:
    
    key - attribute key.
    
    value - attribute values
    
    Returns:
    
    current instance.
  - whereContainsAll
```
public LCIMConversationsQuery whereContainsAll(String key,
                                               Collection<?> values)
```
    增加查询条件，当conversation的属性中对应的字段中的元素包含所有的值才可返回
    
    Parameters:
    
    key - attribute key.
    
    values - attribute values.
    
    Returns:
    
    current instance.
  - whereContains
```
public LCIMConversationsQuery whereContains(String key,
                                            String subString)
```
    增加查询条件，当conversation的属性中对应的字段对应的值包含此字符串即可返回
    
    Parameters:
    
    key - attribute key.
    
    subString - sub string.
    
    Returns:
    
    current instance.
  - whereStartsWith
```
public LCIMConversationsQuery whereStartsWith(String key,
                                              String prefix)
```
    增加查询条件，当conversation的属性中对应的字段对应的值以此字符串起始即可返回
    
    Parameters:
    
    key - attribute key.
    
    prefix - prefix string
    
    Returns:
    
    current instance.
  - whereEndsWith
```
public LCIMConversationsQuery whereEndsWith(String key,
                                            String suffix)
```
    增加查询条件，当conversation的属性中对应的字段对应的值以此字符串结束即可返回
    
    Parameters:
    
    key - attribute key.
    
    suffix - suffix string
    
    Returns:
    
    current instance.
  - whereMatches
```
public LCIMConversationsQuery whereMatches(String key,
                                           String regex)
```
    增加查询条件，当conversation的属性中对应的字段对应的值满足提供的正则表达式即可返回
    
    Parameters:
    
    key - attribute key.
    
    regex - regex pattern
    
    Returns:
    
    current instance.
  - whereMatches
```
public LCIMConversationsQuery whereMatches(String key,
                                           String regex,
                                           String modifiers)
```
    增加查询条件，当conversation的属性中对应的字段对应的值满足提供的正则表达式即可返回
    
    Parameters:
    
    key - attribute key.
    
    regex - regex pattern
    
    modifiers - 正则表达式的匹配模式，比如"-i"表示忽视大小写区分等
    
    Returns:
    
    current instance.
  - whereNear
```
public LCIMConversationsQuery whereNear(String key,
                                        LCGeoPoint point)
```
    增加一个基于地理位置的近似查询，当conversation的属性中对应字段对应的地理位置在pointer附近时即可返回
    
    Parameters:
    
    key - attribute key.
    
    point - GeoPoint
    
    Returns:
    
    current instance.
  - whereWithinGeoBox
```
public LCIMConversationsQuery whereWithinGeoBox(String key,
                                                LCGeoPoint southwest,
                                                LCGeoPoint northeast)
```
    增加一个基于地理位置的查询，当conversation的属性中有对应字段对应的地址位置在指定的矩形区域内时即可返回
    
    Parameters:
    
    key - 查询字段
    
    southwest - 矩形区域的左下角坐标
    
    northeast - 去兴趣鱼的右上角坐标
    
    Returns:
    
    current instance.
  - whereWithinKilometers
```
public LCIMConversationsQuery whereWithinKilometers(String key,
                                                    LCGeoPoint point,
                                                    double maxDistance)
```
    增加一个基于地理位置的近似查询，当conversation的属性中有对应的地址位置与指定的地理位置间距不超过指定距离时返回地球半径为6371.0 千米
    
    Parameters:
    
    key - attribute key.
    
    point - 指定的地理位置
    
    maxDistance - 距离，以千米计算
    
    Returns:
    
    current instance.
  - whereWithinMiles
```
public LCIMConversationsQuery whereWithinMiles(String key,
                                               LCGeoPoint point,
                                               double maxDistance)
```
    增加一个基于地理位置的近似查询，当conversation的属性中有对应的地址位置与指定的地理位置间距不超过指定距离时返回
    
    Parameters:
    
    key - attribute key.
    
    point - 指定的地理位置
    
    maxDistance - 距离，以英里计算
    
    Returns:
    
    current instance.
  - whereWithinRadians
```
public LCIMConversationsQuery whereWithinRadians(String key,
                                                 LCGeoPoint point,
                                                 double maxDistance)
```
    增加一个基于地理位置的近似查询，当conversation的属性中有对应的地址位置与指定的地理位置间距不超过指定距离时返回
    
    Parameters:
    
    key - attribute key.
    
    point - 指定的地理位置
    
    maxDistance - 距离，以角度计算
    
    Returns:
    
    current instance.
  - setLimit
```
public LCIMConversationsQuery setLimit(int limit)
```
    设置返回集合的大小上限
    
    Parameters:
    
    limit - 上限
    
    Returns:
    
    current instance.
  - limit
```
public LCIMConversationsQuery limit(int limit)
```
    设置返回集合的大小上限
    
    Parameters:
    
    limit - 上限
    
    Returns:
    
    current instance.
  - setSkip
```
public LCIMConversationsQuery setSkip(int skip)
```
    设置返回集合的起始位置，一般用于分页
    
    Parameters:
    
    skip - 起始位置跳过几个对象
    
    Returns:
    
    current instance.
  - skip
```
public LCIMConversationsQuery skip(int skip)
```
    设置返回集合的起始位置，一般用于分页
    
    Parameters:
    
    skip - 起始位置跳过几个对象
    
    Returns:
    
    current instance.
  - orderByAscending
```
public LCIMConversationsQuery orderByAscending(String key)
```
    设置返回集合按照指定key进行增序排列
    
    Parameters:
    
    key - attribute key.
    
    Returns:
    
    current instance.
  - orderByDescending
```
public LCIMConversationsQuery orderByDescending(String key)
```
    设置返回集合按照指定key进行降序排列
    
    Parameters:
    
    key - attribute key.
    
    Returns:
    
    current instance.
  - addAscendingOrder
```
public LCIMConversationsQuery addAscendingOrder(String key)
```
    设置返回集合按照指定key进行升序排列，此 key 的优先级小于先前设置的 key
    
    Parameters:
    
    key - attribute key.
    
    Returns:
    
    current instance.
  - addDescendingOrder
```
public LCIMConversationsQuery addDescendingOrder(String key)
```
    设置返回集合按照指定key进行降序排列，此 key 的优先级小于先前设置的 key
    
    Parameters:
    
    key - attribute key.
    
    Returns:
    
    current instance.
  - whereSizeEqual
```
public LCIMConversationsQuery whereSizeEqual(String key,
                                             int size)
```
    添加查询约束条件，查找key类型是数组，该数组的长度匹配提供的数值
    
    Parameters:
    
    key - attribute key.
    
    size - size value.
    
    Returns:
    
    current instance.
  - isWithLastMessagesRefreshed
```
public boolean isWithLastMessagesRefreshed()
```
    是否携带最后一条消息
    
    Returns:
    
    flag indicating attaches with latest message.
  - setWithLastMessagesRefreshed
```
public LCIMConversationsQuery setWithLastMessagesRefreshed(boolean isWithLastMessageRefreshed)
```
    设置是否携带最后一条消息
    
    Parameters:
    
    isWithLastMessageRefreshed - flag indicating attaches with latest message.
    
    Returns:
    
    current instance.
  - setCompact
```
public LCIMConversationsQuery setCompact(boolean isCompact)
```
    是否返回成员列表
    
    Parameters:
    
    isCompact - 为 true 的话则不返回，为 false 的话则返回成员列表，默认为 false
    
    Returns:
    
    current instance.
  - setQueryPolicy
```
public void setQueryPolicy(LCQuery.CachePolicy policy)
```
    设置 IMConversationsQuery 的查询策略
    
    Parameters:
    
    policy - query policy
  - or
```
public static LCIMConversationsQuery or(List<LCIMConversationsQuery> queries)
```
    Constructs a IMConversationsQuery that is the or of the given queries.
    
    Parameters:
    
    queries - query list.
    
    Returns:
    
    new conversation query instance.
  - setCacheMaxAge
```
public void setCacheMaxAge(long maxAgeInSecond)
```
    设置查询缓存的有效时间
    
    Parameters:
    
    maxAgeInSecond - max age of cache in seconds.
  - getCacheMaxAge
```
public long getCacheMaxAge()
```
  - findInBackground
```
public void findInBackground(LCIMConversationQueryCallback callback)
```
    find in background.
    
    Parameters:
    
    callback - callback handler.
  - findTempConversationsInBackground
```
public void findTempConversationsInBackground(List<String> conversationIds,
                                              LCIMConversationQueryCallback callback)
```
    find temporary conversations in background.
    
    Parameters:
    
    conversationIds - conversation id list.
    
    callback - callback handler.
  - directFindInBackground
```
public void directFindInBackground(String where,
                                   String sort,
                                   int skip,
                                   int limit,
                                   int flag,
                                   LCIMConversationQueryCallback callback)
```
    direct find with conditions in background.
    
    Parameters:
    
    where - query condition
    
    sort - sort attributes
    
    skip - skip number
    
    limit - result maximum size
    
    flag - query flag: 0 - Normal, 1 - don't need member list within a conversation item, 2 - attach last message data within a conversation item.
    
    callback - callback function.

Class LCIMConversationsQuery

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

LCIMConversationsQuery

Method Detail

withMembers

withMembers

containsMembers

whereEqualTo

whereLessThan

whereLessThanOrEqualsTo

whereGreaterThan

whereGreaterThanOrEqualsTo

whereNotEqualsTo

whereContainsIn

whereContainedIn

whereExists

whereDoesNotExist

whereNotContainsIn

whereContainsAll

whereContains

whereStartsWith

whereEndsWith

whereMatches

whereMatches

whereNear

whereWithinGeoBox

whereWithinKilometers

whereWithinMiles

whereWithinRadians

setLimit

limit

setSkip

skip

orderByAscending

orderByDescending

addAscendingOrder

addDescendingOrder

whereSizeEqual

isWithLastMessagesRefreshed

setWithLastMessagesRefreshed

setCompact

setQueryPolicy

or

setCacheMaxAge

getCacheMaxAge

findInBackground

findTempConversationsInBackground

directFindInBackground