LeanCloud C# SDK
Public Member Functions | Properties | List of all members
LeanCloud.Realtime.LCIMConversationQuery Class Reference

Public Member Functions

 LCIMConversationQuery (LCIMClient client)
 
LCIMConversationQuery WhereEqualTo (string key, object value)
 The value corresponding to key is equal to value, or the array corresponding to key contains value. More...
 
LCIMConversationQuery WhereNotEqualTo (string key, object value)
 The value corresponding to key is not equal to value, or the array corresponding to key does not contain value. More...
 
LCIMConversationQuery WhereContainedIn (string key, IEnumerable values)
 Values contains value corresponding to key, or values contains at least one element in the array corresponding to key. More...
 
LCIMConversationQuery WhereNotContainedIn (string key, IEnumerable values)
 The value of key must not be contained in values. More...
 
LCIMConversationQuery WhereContainsAll (string key, IEnumerable values)
 The array corresponding to key contains all elements in values. More...
 
LCIMConversationQuery WhereExists (string key)
 The attribute corresponding to key exists. More...
 
LCIMConversationQuery WhereDoesNotExist (string key)
 The attribute corresponding to key does not exist. More...
 
LCIMConversationQuery WhereSizeEqualTo (string key, int size)
 The size of the array corresponding to key is equal to size. More...
 
LCIMConversationQuery WhereGreaterThan (string key, object value)
 The value corresponding to key is greater than value. More...
 
LCIMConversationQuery WhereGreaterThanOrEqualTo (string key, object value)
 The value corresponding to key is greater than or equal to value. More...
 
LCIMConversationQuery WhereLessThan (string key, object value)
 The value corresponding to key is less than value. More...
 
LCIMConversationQuery WhereLessThanOrEqualTo (string key, object value)
 The value corresponding to key is less than or equal to value. More...
 
LCIMConversationQuery WhereStartsWith (string key, string prefix)
 The string corresponding to key has a prefix. More...
 
LCIMConversationQuery WhereEndsWith (string key, string suffix)
 The string corresponding to key has a suffix. More...
 
LCIMConversationQuery WhereContains (string key, string subString)
 The string corresponding to key has a subString. More...
 
LCIMConversationQuery OrderBy (string key)
 The ascending order by the value corresponding to key. More...
 
LCIMConversationQuery OrderByDescending (string key)
 The descending order by the value corresponding to key. More...
 
LCIMConversationQuery Include (string key)
 Includes nested LCObject for the provided key. More...
 
LCIMConversationQuery Select (string key)
 Restricts the keys of the LCObject returned. More...
 
LCIMConversationQuery Skip (int value)
 Sets the amount of results to skip before returning any results. More...
 
LCIMConversationQuery Limit (int value)
 Sets the limit of the number of results to return. More...
 
async Task< ReadOnlyCollection< LCIMConversation > > Find ()
 Retrieves a list of LCObjects matching this query. More...
 
async Task< LCIMConversationFirst ()
 Retrieves the first conversation from the query. More...
 
Task< LCIMConversationGet (string convId)
 Retrieves the conversation. More...
 

Properties

bool Compact [get, set]
 Ignore the members of conversation. More...
 
bool WithLastMessageRefreshed = false [get, set]
 With the last message. More...
 

Constructor & Destructor Documentation

LeanCloud.Realtime.LCIMConversationQuery.LCIMConversationQuery ( LCIMClient  client)
inline

Member Function Documentation

async Task<ReadOnlyCollection<LCIMConversation> > LeanCloud.Realtime.LCIMConversationQuery.Find ( )
inline

Retrieves a list of LCObjects matching this query.

Returns
async Task<LCIMConversation> LeanCloud.Realtime.LCIMConversationQuery.First ( )
inline

Retrieves the first conversation from the query.

Returns
Task<LCIMConversation> LeanCloud.Realtime.LCIMConversationQuery.Get ( string  convId)
inline

Retrieves the conversation.

Parameters
convId
Returns
LCIMConversationQuery LeanCloud.Realtime.LCIMConversationQuery.Include ( string  key)
inline

Includes nested LCObject for the provided key.

Parameters
key
Returns
LCIMConversationQuery LeanCloud.Realtime.LCIMConversationQuery.Limit ( int  value)
inline

Sets the limit of the number of results to return.

Parameters
value
Returns
LCIMConversationQuery LeanCloud.Realtime.LCIMConversationQuery.OrderBy ( string  key)
inline

The ascending order by the value corresponding to key.

Parameters
keyMulti-field sorting is supported with comma.
Returns
LCIMConversationQuery LeanCloud.Realtime.LCIMConversationQuery.OrderByDescending ( string  key)
inline

The descending order by the value corresponding to key.

Parameters
keyMulti-field sorting is supported with comma.
Returns
LCIMConversationQuery LeanCloud.Realtime.LCIMConversationQuery.Select ( string  key)
inline

Restricts the keys of the LCObject returned.

Parameters
key
Returns
LCIMConversationQuery LeanCloud.Realtime.LCIMConversationQuery.Skip ( int  value)
inline

Sets the amount of results to skip before returning any results.

Parameters
value
Returns
LCIMConversationQuery LeanCloud.Realtime.LCIMConversationQuery.WhereContainedIn ( string  key,
IEnumerable  values 
)
inline

Values contains value corresponding to key, or values contains at least one element in the array corresponding to key.

Parameters
key
values
Returns
LCIMConversationQuery LeanCloud.Realtime.LCIMConversationQuery.WhereContains ( string  key,
string  subString 
)
inline

The string corresponding to key has a subString.

Parameters
key
subString
Returns
LCIMConversationQuery LeanCloud.Realtime.LCIMConversationQuery.WhereContainsAll ( string  key,
IEnumerable  values 
)
inline

The array corresponding to key contains all elements in values.

Parameters
key
values
Returns
LCIMConversationQuery LeanCloud.Realtime.LCIMConversationQuery.WhereDoesNotExist ( string  key)
inline

The attribute corresponding to key does not exist.

Parameters
key
Returns
LCIMConversationQuery LeanCloud.Realtime.LCIMConversationQuery.WhereEndsWith ( string  key,
string  suffix 
)
inline

The string corresponding to key has a suffix.

Parameters
key
suffix
Returns
LCIMConversationQuery LeanCloud.Realtime.LCIMConversationQuery.WhereEqualTo ( string  key,
object  value 
)
inline

The value corresponding to key is equal to value, or the array corresponding to key contains value.

Parameters
key
value
Returns
LCIMConversationQuery LeanCloud.Realtime.LCIMConversationQuery.WhereExists ( string  key)
inline

The attribute corresponding to key exists.

Parameters
key
Returns
LCIMConversationQuery LeanCloud.Realtime.LCIMConversationQuery.WhereGreaterThan ( string  key,
object  value 
)
inline

The value corresponding to key is greater than value.

Parameters
key
value
Returns
LCIMConversationQuery LeanCloud.Realtime.LCIMConversationQuery.WhereGreaterThanOrEqualTo ( string  key,
object  value 
)
inline

The value corresponding to key is greater than or equal to value.

Parameters
key
value
Returns
LCIMConversationQuery LeanCloud.Realtime.LCIMConversationQuery.WhereLessThan ( string  key,
object  value 
)
inline

The value corresponding to key is less than value.

Parameters
key
value
Returns
LCIMConversationQuery LeanCloud.Realtime.LCIMConversationQuery.WhereLessThanOrEqualTo ( string  key,
object  value 
)
inline

The value corresponding to key is less than or equal to value.

Parameters
key
value
Returns
LCIMConversationQuery LeanCloud.Realtime.LCIMConversationQuery.WhereNotContainedIn ( string  key,
IEnumerable  values 
)
inline

The value of key must not be contained in values.

Parameters
key
values
Returns
LCIMConversationQuery LeanCloud.Realtime.LCIMConversationQuery.WhereNotEqualTo ( string  key,
object  value 
)
inline

The value corresponding to key is not equal to value, or the array corresponding to key does not contain value.

Parameters
key
value
Returns
LCIMConversationQuery LeanCloud.Realtime.LCIMConversationQuery.WhereSizeEqualTo ( string  key,
int  size 
)
inline

The size of the array corresponding to key is equal to size.

Parameters
key
size
Returns
LCIMConversationQuery LeanCloud.Realtime.LCIMConversationQuery.WhereStartsWith ( string  key,
string  prefix 
)
inline

The string corresponding to key has a prefix.

Parameters
key
prefix
Returns

Property Documentation

bool LeanCloud.Realtime.LCIMConversationQuery.Compact
getset

Ignore the members of conversation.

bool LeanCloud.Realtime.LCIMConversationQuery.WithLastMessageRefreshed = false
getset

With the last message.


The documentation for this class was generated from the following file: