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

LCIMChatRoom is a local representation of chatroom in LeanCloud. More...

Inheritance diagram for LeanCloud.Realtime.LCIMChatRoom:
LeanCloud.Realtime.LCIMConversation

Public Member Functions

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

Additional Inherited Members

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

Detailed Description

LCIMChatRoom is a local representation of chatroom in LeanCloud.

Constructor & Destructor Documentation

◆ LCIMChatRoom()

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

Member Function Documentation

◆ AddMembers()

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

Adds members to this conversation.

Parameters
clientIds
Returns

Reimplemented from LeanCloud.Realtime.LCIMConversation.

◆ FetchReciptTimestamps()

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

Fetchs the recipt timestamps of this conversation. But it is an no-op in LCIMChatRoom.

Returns

Reimplemented from LeanCloud.Realtime.LCIMConversation.

◆ GetOnlineMembers()

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

Gets online members.

Parameters
limitQuery limit, defaults to 50.
Returns

◆ GetOnlineMembersCount()

async Task< int > LeanCloud.Realtime.LCIMChatRoom.GetOnlineMembersCount ( )
inline

◆ Read()

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

Flags the read status of this conversation. But it is an no-op in LCIMChatRoom.

Returns

Reimplemented from LeanCloud.Realtime.LCIMConversation.


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