diff --git a/Realtime/Realtime/Public/Conversation/LCIMChatRoom.cs b/Realtime/Realtime/Public/Conversation/LCIMChatRoom.cs index 0ecccf1..6630bcd 100644 --- a/Realtime/Realtime/Public/Conversation/LCIMChatRoom.cs +++ b/Realtime/Realtime/Public/Conversation/LCIMChatRoom.cs @@ -5,7 +5,7 @@ using System.Threading.Tasks; namespace LeanCloud.Realtime { /// - /// Chatroom + /// LCIMChatRoom is a local representation of chatroom in LeanCloud. /// public class LCIMChatRoom : LCIMConversation { public LCIMChatRoom(LCIMClient client) : @@ -25,14 +25,29 @@ namespace LeanCloud.Realtime { return await Client.ConversationController.GetOnlineMembers(Id, limit); } + /// + /// Adds members to this conversation. + /// + /// + /// public override Task AddMembers(IEnumerable clientIds) { throw new Exception("Add members is not allowed in chat room."); } + /// + /// Flags the read status of this conversation. + /// But it's nothing to do in LCIMChatRoom. + /// + /// public override Task Read() { return Task.CompletedTask; } + /// + /// Fetchs the recipt timestamps of this conversation. + /// But it's nothing to do in LCIMChatRoom. + /// + /// public override Task FetchReciptTimestamps() { return Task.CompletedTask; } diff --git a/Realtime/Realtime/Public/Conversation/LCIMConversation.cs b/Realtime/Realtime/Public/Conversation/LCIMConversation.cs index ed6e75b..77cb321 100644 --- a/Realtime/Realtime/Public/Conversation/LCIMConversation.cs +++ b/Realtime/Realtime/Public/Conversation/LCIMConversation.cs @@ -6,7 +6,8 @@ using System.Collections.ObjectModel; namespace LeanCloud.Realtime { /// - /// Conversation + /// LCIMConversation is a local representation of general conversation + /// in LeanCloud. /// public class LCIMConversation { /// diff --git a/Realtime/Realtime/Public/Conversation/LCIMConversationMemberInfo.cs b/Realtime/Realtime/Public/Conversation/LCIMConversationMemberInfo.cs index 48e4324..b26253e 100644 --- a/Realtime/Realtime/Public/Conversation/LCIMConversationMemberInfo.cs +++ b/Realtime/Realtime/Public/Conversation/LCIMConversationMemberInfo.cs @@ -1,4 +1,7 @@ namespace LeanCloud.Realtime { + /// + /// LCIMConversationMemberInfo represents the member info of the conversation. + /// public class LCIMConversationMemberInfo { public const string Owner = "Owner"; diff --git a/Realtime/Realtime/Public/Conversation/LCIMConversationQuery.cs b/Realtime/Realtime/Public/Conversation/LCIMConversationQuery.cs index e65f193..a77099f 100644 --- a/Realtime/Realtime/Public/Conversation/LCIMConversationQuery.cs +++ b/Realtime/Realtime/Public/Conversation/LCIMConversationQuery.cs @@ -3,10 +3,12 @@ using System.Collections; using System.Collections.ObjectModel; using LeanCloud.Storage.Internal.Query; using System.Linq; -using System.Collections.Generic; using System; namespace LeanCloud.Realtime { + /// + /// LCIMConversationQuery is the query for conversation. + /// public class LCIMConversationQuery { internal const int CompactFlag = 0x1; internal const int WithLastMessageFlag = 0x2; diff --git a/Realtime/Realtime/Public/Conversation/LCIMMessageQueryOptions.cs b/Realtime/Realtime/Public/Conversation/LCIMMessageQueryOptions.cs index c936feb..5f1aae3 100644 --- a/Realtime/Realtime/Public/Conversation/LCIMMessageQueryOptions.cs +++ b/Realtime/Realtime/Public/Conversation/LCIMMessageQueryOptions.cs @@ -1,6 +1,10 @@ using System; namespace LeanCloud.Realtime { + /// + /// LCIMMessageQueryEndpoint is the parameter that controls the limitation + /// of querying messages. + /// public class LCIMMessageQueryEndpoint { public string MessageId { get; set; diff --git a/Realtime/Realtime/Public/Conversation/LCIMServiceConversation.cs b/Realtime/Realtime/Public/Conversation/LCIMServiceConversation.cs index d55a16f..68a0986 100644 --- a/Realtime/Realtime/Public/Conversation/LCIMServiceConversation.cs +++ b/Realtime/Realtime/Public/Conversation/LCIMServiceConversation.cs @@ -2,6 +2,10 @@ using System.Threading.Tasks; namespace LeanCloud.Realtime { + /// + /// LCIMServiceConversation is a local representation of service conversation + /// in LeanCloud. + /// public class LCIMServiceConversation : LCIMConversation { public LCIMServiceConversation(LCIMClient client) : base(client) { } diff --git a/Realtime/Realtime/Public/Conversation/LCIMTemporaryConversation.cs b/Realtime/Realtime/Public/Conversation/LCIMTemporaryConversation.cs index 3fc19c3..698a192 100644 --- a/Realtime/Realtime/Public/Conversation/LCIMTemporaryConversation.cs +++ b/Realtime/Realtime/Public/Conversation/LCIMTemporaryConversation.cs @@ -1,6 +1,10 @@ using System; namespace LeanCloud.Realtime { + /// + /// LCIMTemporaryConversation is a local representation of temporary conversation + /// in LeanCloud. + /// public class LCIMTemporaryConversation : LCIMConversation { public DateTime ExpiredAt { get; diff --git a/Realtime/Realtime/Public/LCIMClient.cs b/Realtime/Realtime/Public/LCIMClient.cs index 88cf67a..3f64bf4 100644 --- a/Realtime/Realtime/Public/LCIMClient.cs +++ b/Realtime/Realtime/Public/LCIMClient.cs @@ -29,6 +29,9 @@ namespace LeanCloud.Realtime { get; private set; } + /// + /// Device Id + /// public string DeviceId { get; private set; } @@ -235,6 +238,13 @@ namespace LeanCloud.Realtime { #region 接口 + /// + /// Constructs a LCIMClient with client id. + /// + /// + /// + /// + /// public LCIMClient(string clientId, string tag = null, string deviceId = null, @@ -245,6 +255,13 @@ namespace LeanCloud.Realtime { SetUpClient(clientId, tag, deviceId, signatureFactory); } + /// + /// Constructs a LCIMClient with a LCUser. + /// + /// + /// + /// + /// public LCIMClient(LCUser user, string tag = null, string deviceId = null, diff --git a/Realtime/Realtime/Public/LCRealtime.cs b/Realtime/Realtime/Public/LCRealtime.cs index 08d7c19..9b70960 100644 --- a/Realtime/Realtime/Public/LCRealtime.cs +++ b/Realtime/Realtime/Public/LCRealtime.cs @@ -2,6 +2,9 @@ using LeanCloud.Realtime.Internal.Connection; namespace LeanCloud.Realtime { + /// + /// LCRealtime contains static functions that handle the global connection. + /// public class LCRealtime { /// /// Every application uses a connection. diff --git a/Realtime/Realtime/Public/Message/LCIMAudioMessage.cs b/Realtime/Realtime/Public/Message/LCIMAudioMessage.cs index cf80bec..f7103a5 100644 --- a/Realtime/Realtime/Public/Message/LCIMAudioMessage.cs +++ b/Realtime/Realtime/Public/Message/LCIMAudioMessage.cs @@ -2,6 +2,9 @@ using LeanCloud.Storage; namespace LeanCloud.Realtime { + /// + /// LCIMAudioMessage is a local representation of audio message in LeanCloud. + /// public class LCIMAudioMessage : LCIMFileMessage { public double Duration { get; private set; diff --git a/Realtime/Realtime/Public/Message/LCIMBinaryMessage.cs b/Realtime/Realtime/Public/Message/LCIMBinaryMessage.cs index d0af326..f5d5aa2 100644 --- a/Realtime/Realtime/Public/Message/LCIMBinaryMessage.cs +++ b/Realtime/Realtime/Public/Message/LCIMBinaryMessage.cs @@ -1,4 +1,7 @@ namespace LeanCloud.Realtime { + /// + /// LCIMBinaryMessage is a local representation of binary message in LeanCloud. + /// public class LCIMBinaryMessage : LCIMMessage { public byte[] Data { get; internal set; diff --git a/Realtime/Realtime/Public/Message/LCIMFileMessage.cs b/Realtime/Realtime/Public/Message/LCIMFileMessage.cs index 1c8656c..d5fc485 100644 --- a/Realtime/Realtime/Public/Message/LCIMFileMessage.cs +++ b/Realtime/Realtime/Public/Message/LCIMFileMessage.cs @@ -5,6 +5,9 @@ using LeanCloud.Storage; using System.Threading.Tasks; namespace LeanCloud.Realtime { + /// + /// LCIMFileMessage is a local representation of file message in LeanCloud. + /// public class LCIMFileMessage : LCIMTextMessage { public LCFile File { get; set; diff --git a/Realtime/Realtime/Public/Message/LCIMImageMessage.cs b/Realtime/Realtime/Public/Message/LCIMImageMessage.cs index 07679ed..5fd2a97 100644 --- a/Realtime/Realtime/Public/Message/LCIMImageMessage.cs +++ b/Realtime/Realtime/Public/Message/LCIMImageMessage.cs @@ -2,6 +2,9 @@ using LeanCloud.Storage; namespace LeanCloud.Realtime { + /// + /// LCIMImageMessage is a local representation of image message in LeanCloud. + /// public class LCIMImageMessage : LCIMFileMessage { public int Width { get; private set; diff --git a/Realtime/Realtime/Public/Message/LCIMLocationMessage.cs b/Realtime/Realtime/Public/Message/LCIMLocationMessage.cs index 44fde3b..6ebf596 100644 --- a/Realtime/Realtime/Public/Message/LCIMLocationMessage.cs +++ b/Realtime/Realtime/Public/Message/LCIMLocationMessage.cs @@ -3,6 +3,9 @@ using System.Collections.Generic; using LeanCloud.Storage; namespace LeanCloud.Realtime { + /// + /// LCIMLocationMessage is a local representation of location message in LeanCloud. + /// public class LCIMLocationMessage : LCIMTextMessage { public LCGeoPoint Location { get; set; diff --git a/Realtime/Realtime/Public/Message/LCIMTextMessage.cs b/Realtime/Realtime/Public/Message/LCIMTextMessage.cs index e9cee7b..5c834fa 100644 --- a/Realtime/Realtime/Public/Message/LCIMTextMessage.cs +++ b/Realtime/Realtime/Public/Message/LCIMTextMessage.cs @@ -1,6 +1,9 @@ using System.Collections.Generic; namespace LeanCloud.Realtime { + /// + /// LCIMTextMessage is a local representation of text message in LeanCloud. + /// public class LCIMTextMessage : LCIMTypedMessage { public string Text { get; set; diff --git a/Realtime/Realtime/Public/Message/LCIMVideoMessage.cs b/Realtime/Realtime/Public/Message/LCIMVideoMessage.cs index c49ce9f..0fe119a 100644 --- a/Realtime/Realtime/Public/Message/LCIMVideoMessage.cs +++ b/Realtime/Realtime/Public/Message/LCIMVideoMessage.cs @@ -2,6 +2,9 @@ using LeanCloud.Storage; namespace LeanCloud.Realtime { + /// + /// LCIMVideoMessage is a local representation of video message in LeanCloud. + /// public class LCIMVideoMessage : LCIMFileMessage { public int Width { get; private set; diff --git a/Realtime/Realtime/Public/Result/LCIMOperationFailure.cs b/Realtime/Realtime/Public/Result/LCIMOperationFailure.cs index 1f95229..e282a12 100644 --- a/Realtime/Realtime/Public/Result/LCIMOperationFailure.cs +++ b/Realtime/Realtime/Public/Result/LCIMOperationFailure.cs @@ -1,6 +1,9 @@ using System.Collections.Generic; namespace LeanCloud.Realtime { + /// + /// LCIMOperationFailure is the result that handles the operation of conversation. + /// public class LCIMOperationFailure { public int Code { get; set; diff --git a/Realtime/Realtime/Public/Result/LCIMPageResult.cs b/Realtime/Realtime/Public/Result/LCIMPageResult.cs index a559db6..259dfb9 100644 --- a/Realtime/Realtime/Public/Result/LCIMPageResult.cs +++ b/Realtime/Realtime/Public/Result/LCIMPageResult.cs @@ -1,6 +1,9 @@ using System.Collections.ObjectModel; namespace LeanCloud.Realtime { + /// + /// LCIMPageResult represents the results of query. + /// public class LCIMPageResult { public ReadOnlyCollection Results { get; internal set; diff --git a/Realtime/Realtime/Public/Result/LCIMPartiallySuccessResult.cs b/Realtime/Realtime/Public/Result/LCIMPartiallySuccessResult.cs index 86f61e5..92e008a 100644 --- a/Realtime/Realtime/Public/Result/LCIMPartiallySuccessResult.cs +++ b/Realtime/Realtime/Public/Result/LCIMPartiallySuccessResult.cs @@ -1,6 +1,9 @@ using System.Collections.Generic; namespace LeanCloud.Realtime { + /// + /// LCIMPartiallySuccessResult is the result that handles the operation of conversation. + /// public class LCIMPartiallySuccessResult { public List SuccessfulClientIdList { get; internal set; diff --git a/Realtime/Realtime/Public/Signature/ILCIMSignatureFactory.cs b/Realtime/Realtime/Public/Signature/ILCIMSignatureFactory.cs index 47efa91..7cd9fc6 100644 --- a/Realtime/Realtime/Public/Signature/ILCIMSignatureFactory.cs +++ b/Realtime/Realtime/Public/Signature/ILCIMSignatureFactory.cs @@ -2,6 +2,9 @@ using System.Threading.Tasks; namespace LeanCloud.Realtime { + /// + /// + /// public interface ILCIMSignatureFactory { Task CreateConnectSignature(string clientId); diff --git a/Realtime/Realtime/Public/Signature/LCIMSignature.cs b/Realtime/Realtime/Public/Signature/LCIMSignature.cs index 416b86d..1207f52 100644 --- a/Realtime/Realtime/Public/Signature/LCIMSignature.cs +++ b/Realtime/Realtime/Public/Signature/LCIMSignature.cs @@ -1,4 +1,7 @@ namespace LeanCloud.Realtime { + /// + /// LCIMSignature represents a LCRealtime signature. + /// public class LCIMSignature { public string Signature { get; set;