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

Chatroom More...

Inheritance diagram for LeanCloud.Realtime.LCIMChatRoom:
Inheritance graph
[legend]
Collaboration diagram for LeanCloud.Realtime.LCIMChatRoom:
Collaboration graph
[legend]

Public Member Functions

 LCIMChatRoom (LCIMClient client)
 
async Task< int > GetOnlineMembersCount ()
 
async Task< ReadOnlyCollection< string > > GetOnlineMembers (int limit=50)
 Gets online members. More...
 
override Task< LCIMPartiallySuccessResultAddMembers (IEnumerable< string > clientIds)
 Adds members to this conversation. More...
 
override Task Read ()
 Mark the last message of this conversation as read. More...
 
override Task FetchReciptTimestamps ()
 Fetches receipt timestamp. More...
 
- Public Member Functions inherited from LeanCloud.Realtime.LCIMConversation
async Task< int > GetMembersCount ()
 The count of members of this conversation. More...
 
async Task UpdateInfo (Dictionary< string, object > attributes)
 Update attributes of this conversation. More...
 
async Task< LCIMPartiallySuccessResultRemoveMembers (IEnumerable< string > removeIds)
 Removes members from this conversation. More...
 
async Task Join ()
 Joins this conversation. More...
 
async Task Quit ()
 Leaves this conversation. More...
 
async Task< LCIMMessageSend (LCIMMessage message, LCIMMessageSendOptions options=null)
 Sends a message in this conversation. More...
 
async Task Mute ()
 Turns off the offline notifications of this conversation. More...
 
async Task Unmute ()
 Turns on the offline notifications of this conversation. More...
 
async Task< LCIMPartiallySuccessResultMuteMembers (IEnumerable< string > clientIds)
 Mutes members of this conversation. More...
 
async Task< LCIMPartiallySuccessResultUnmuteMembers (IEnumerable< string > clientIds)
 Unmutes members of this conversation. More...
 
async Task< LCIMPartiallySuccessResultBlockMembers (IEnumerable< string > clientIds)
 Adds members to the blocklist of this conversation. More...
 
async Task< LCIMPartiallySuccessResultUnblockMembers (IEnumerable< string > clientIds)
 Removes members from the blocklist of this conversation. More...
 
async Task RecallMessage (LCIMMessage message)
 Recalls a sent message. More...
 
async Task UpdateMessage (LCIMMessage oldMessage, LCIMMessage newMessage)
 Updates a sent message. More...
 
async Task UpdateMemberRole (string memberId, string role)
 Updates the role of a member of this conversation. More...
 
async Task< ReadOnlyCollection< LCIMConversationMemberInfo > > GetAllMemberInfo ()
 Gets all member roles. More...
 
async Task< LCIMConversationMemberInfoGetMemberInfo (string memberId)
 Gets the role of a specific member. More...
 
async Task< LCIMPageResultQueryMutedMembers (int limit=10, string next=null)
 Queries muted members. More...
 
async Task< LCIMPageResultQueryBlockedMembers (int limit=10, string next=null)
 Queries blocked members. More...
 
async Task< ReadOnlyCollection< LCIMMessage > > QueryMessages (LCIMMessageQueryEndpoint start=null, LCIMMessageQueryEndpoint end=null, LCIMMessageQueryDirection direction=LCIMMessageQueryDirection.NewToOld, int limit=20, int messageType=0)
 Retrieves messages. More...
 
async Task< LCIMConversationFetch ()
 Fetch conversation from server. More...
 

Additional Inherited Members

- Properties inherited from LeanCloud.Realtime.LCIMConversation
string Id [get, set]
 The ID of this conversation More...
 
bool Unique [get, set]
 Indicates whether this conversation is normal and unique. The uniqueness is based on the members when creating. More...
 
string UniqueId [get, set]
 If this conversation is unique, then it will have a unique ID. More...
 
string Name [get, set]
 The name of this conversation. More...
 
string CreatorId [get, set]
 The creator of this conversation. More...
 
ReadOnlyCollection< string > MemberIds [get]
 The members of this conversation. More...
 
ReadOnlyCollection< string > MutedMemberIds [get]
 Muted members of this conversation. More...
 
int Unread [get, set]
 The count of the unread messages. More...
 
LCIMMessage LastMessage [get, set]
 The last message in this conversation. More...
 
DateTime CreatedAt [get, set]
 The created date of this conversation. More...
 
DateTime UpdatedAt [get, set]
 The last updated date of this conversation. More...
 
long LastDeliveredTimestamp [get, set]
 The last timestamp of the delivered message. More...
 
DateTime LastDeliveredAt [get]
 The last date of the delivered message. More...
 
long LastReadTimestamp [get, set]
 The last timestamp of the message which has been read by other clients. More...
 
DateTime LastReadAt [get]
 The last date of the message which has been read by other clients. More...
 
object this[string key] [get, set]
 Custom attributes. More...
 
bool IsMute [get]
 Indicates whether offline notifications about this conversation has been muted. More...
 
LCIMClient Client [get]
 

Detailed Description

Chatroom

Constructor & Destructor Documentation

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

Member Function Documentation

override Task<LCIMPartiallySuccessResult> LeanCloud.Realtime.LCIMChatRoom.AddMembers ( IEnumerable< string >  clientIds)
inlinevirtual

Adds members to this conversation.

Parameters
clientIdsMember list.
Returns

Reimplemented from LeanCloud.Realtime.LCIMConversation.

override Task LeanCloud.Realtime.LCIMChatRoom.FetchReciptTimestamps ( )
inlinevirtual

Fetches receipt timestamp.

Returns

Reimplemented from LeanCloud.Realtime.LCIMConversation.

async Task<ReadOnlyCollection<string> > LeanCloud.Realtime.LCIMChatRoom.GetOnlineMembers ( int  limit = 50)
inline

Gets online members.

Parameters
limitQuery limit, defaults to 50.
Returns
async Task<int> LeanCloud.Realtime.LCIMChatRoom.GetOnlineMembersCount ( )
inline
override Task LeanCloud.Realtime.LCIMChatRoom.Read ( )
inlinevirtual

Mark the last message of this conversation as read.

Returns

Reimplemented from LeanCloud.Realtime.LCIMConversation.


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