Jimin/review comments (Azure#50729)

* update factory

* address review comments 2

* Exclude EBN attribute checking

* update api-compact baseline

* revert api listing change

* Make retention policy factory mode

* update contract

* make none policy internal

* expose ThreadCreationDateRetentionPolicy

Author: jiminwen-msft

sdk/communication/Azure.Communication.Chat/README.md

@@ -70,7 +70,7 @@ CreateChatThreadOptions createChatThreadOptions = new CreateChatThreadOptions("H
 createChatThreadOptions.Metadata.Add("MetadataKey1", "MetadataValue1");
 createChatThreadOptions.Metadata.Add("MetadataKey2", "MetadataValue2");
 
-createChatThreadOptions.RetentionPolicy = new ThreadCreationDateRetentionPolicy(40);
+createChatThreadOptions.RetentionPolicy = ChatRetentionPolicy.ThreadCreationDate(40);
 
 CreateChatThreadResult createChatThreadResult = await chatClient.CreateChatThreadAsync(createChatThreadOptions);
 ChatThreadProperties chatThread = createChatThreadResult.ChatThread;
@@ -96,7 +96,7 @@ UpdateChatThreadPropertiesOptions updateChatThreadPropertiesOptions = new Update
 updateChatThreadPropertiesOptions.Topic = "Launch meeting";
 updateChatThreadPropertiesOptions.Metadata.Add("UpdateMetadataKey", "UpdateMetadataValue");
 
-updateChatThreadPropertiesOptions.RetentionPolicy = new NoneRetentionPolicy();
+updateChatThreadPropertiesOptions.RetentionPolicy = ChatRetentionPolicy.None();
 
 await chatThreadClient.UpdatePropertiesAsync(updateChatThreadPropertiesOptions);
 ```
@@ -202,7 +202,7 @@ createChatThreadOptions.Participants.Add(chatParticipant);
 createChatThreadOptions.Metadata.Add("MetadataKey1", "MetadataValue1");
 createChatThreadOptions.Metadata.Add("MetadataKey2", "MetadataValue2");
 
-createChatThreadOptions.RetentionPolicy = new ThreadCreationDateRetentionPolicy(60);
+createChatThreadOptions.RetentionPolicy = ChatRetentionPolicy.ThreadCreationDate(60);
 
 CreateChatThreadResult createChatThreadResult = await chatClient.CreateChatThreadAsync(createChatThreadOptions);
 string threadId = createChatThreadResult.ChatThread.Id;
@@ -246,7 +246,7 @@ UpdateChatThreadPropertiesOptions updateChatThreadPropertiesOptions = new Update
 updateChatThreadPropertiesOptions.Topic = "new topic !";
 updateChatThreadPropertiesOptions.Metadata.Add("UpdateMetadataKey", "UpdateMetadataValue");
 
-updateChatThreadPropertiesOptions.RetentionPolicy = new ThreadCreationDateRetentionPolicy(60);
+updateChatThreadPropertiesOptions.RetentionPolicy = ChatRetentionPolicy.ThreadCreationDate(60);
 
 await chatThreadClient.UpdatePropertiesAsync(updateChatThreadPropertiesOptions);
 ```

sdk/communication/Azure.Communication.Chat/api/Azure.Communication.Chat.net8.0.cs

@@ -130,17 +130,13 @@ public static partial class ChatModelFactory
         public static Azure.Communication.Chat.AddChatParticipantsResult AddChatParticipantsResult(System.Collections.Generic.IEnumerable<Azure.Communication.Chat.ChatError> invalidParticipants = null) { throw null; }
         public static Azure.Communication.Chat.ChatAttachment ChatAttachment(string id, Azure.Communication.Chat.ChatAttachmentType attachmentType, string name, System.Uri uri, System.Uri previewUri) { throw null; }
         public static Azure.Communication.Chat.ChatError ChatError(string code = null, string message = null, string target = null, System.Collections.Generic.IEnumerable<Azure.Communication.Chat.ChatError> details = null, Azure.Communication.Chat.ChatError innerError = null) { throw null; }
-        [System.ComponentModel.EditorBrowsableAttribute(System.ComponentModel.EditorBrowsableState.Never)]
         public static Azure.Communication.Chat.ChatMessage ChatMessage(string id, Azure.Communication.Chat.ChatMessageType type, string sequenceId, string version, Azure.Communication.Chat.ChatMessageContent content, string senderDisplayName, System.DateTimeOffset createdOn, string senderId, System.DateTimeOffset? deletedOn, System.DateTimeOffset? editedOn) { throw null; }
-        [System.ComponentModel.EditorBrowsableAttribute(System.ComponentModel.EditorBrowsableState.Never)]
         public static Azure.Communication.Chat.ChatMessage ChatMessage(string id, Azure.Communication.Chat.ChatMessageType type, string sequenceId, string version, Azure.Communication.Chat.ChatMessageContent content, string senderDisplayName, System.DateTimeOffset createdOn, string senderId, System.DateTimeOffset? deletedOn, System.DateTimeOffset? editedOn, System.Collections.Generic.IReadOnlyDictionary<string, string> metadata) { throw null; }
         public static Azure.Communication.Chat.ChatMessageContent ChatMessageContent(string message, string topic, Azure.Communication.CommunicationUserIdentifier communicationUserIdentifier, System.Collections.Generic.IEnumerable<Azure.Communication.Chat.ChatParticipant> participants) { throw null; }
         public static Azure.Communication.Chat.ChatMessageContent ChatMessageContent(string message, string topic, Azure.Communication.CommunicationUserIdentifier communicationUserIdentifier, System.Collections.Generic.IEnumerable<Azure.Communication.Chat.ChatParticipant> participants, System.Collections.Generic.IEnumerable<Azure.Communication.Chat.ChatAttachment> attachments = null) { throw null; }
-        [System.ComponentModel.EditorBrowsableAttribute(System.ComponentModel.EditorBrowsableState.Never)]
         public static Azure.Communication.Chat.ChatMessageReadReceipt ChatMessageReadReceipt(Azure.Communication.CommunicationIdentifier sender, string chatMessageId, System.DateTimeOffset readOn) { throw null; }
         public static Azure.Communication.Chat.ChatParticipant ChatParticipant(Azure.Communication.CommunicationIdentifier user, string displayName, System.DateTimeOffset? shareHistoryTime) { throw null; }
         public static Azure.Communication.Chat.ChatParticipant ChatParticipant(Azure.Communication.CommunicationIdentifier user, string displayName, System.DateTimeOffset? shareHistoryTime, System.Collections.Generic.IDictionary<string, string> metadata) { throw null; }
-        [System.ComponentModel.EditorBrowsableAttribute(System.ComponentModel.EditorBrowsableState.Never)]
         public static Azure.Communication.Chat.ChatThreadItem ChatThreadItem(string id, string topic, System.DateTimeOffset? deletedOn, System.DateTimeOffset? lastMessageReceivedOn) { throw null; }
         public static Azure.Communication.Chat.ChatThreadProperties ChatThreadProperties(string id, string topic, System.DateTimeOffset createdOn, Azure.Communication.CommunicationIdentifier createdBy, System.DateTimeOffset deletedOn) { throw null; }
         public static Azure.Communication.Chat.CreateChatThreadResult CreateChatThreadResult(Azure.Communication.Chat.ChatThreadProperties chatThread, System.Collections.Generic.IEnumerable<Azure.Communication.Chat.ChatError> invalidParticipants) { throw null; }
@@ -156,7 +152,10 @@ public ChatParticipant(Azure.Communication.CommunicationIdentifier identifier) {
     }
     public abstract partial class ChatRetentionPolicy
     {
-        protected ChatRetentionPolicy() { }
+        protected ChatRetentionPolicy(Azure.Communication.Chat.RetentionPolicyKind kind) { }
+        public Azure.Communication.Chat.RetentionPolicyKind Kind { get { throw null; } }
+        public static Azure.Communication.Chat.ChatRetentionPolicy None() { throw null; }
+        public static Azure.Communication.Chat.ChatRetentionPolicy ThreadCreationDate(int deleteThreadAfterDays) { throw null; }
     }
     public partial class ChatThreadClient
     {
@@ -234,10 +233,6 @@ internal CreateChatThreadResult() { }
         public Azure.Communication.Chat.ChatThreadProperties ChatThread { get { throw null; } }
         public System.Collections.Generic.IReadOnlyList<Azure.Communication.Chat.ChatError> InvalidParticipants { get { throw null; } }
     }
-    public partial class NoneRetentionPolicy : Azure.Communication.Chat.ChatRetentionPolicy
-    {
-        public NoneRetentionPolicy() { }
-    }
     [System.Runtime.InteropServices.StructLayoutAttribute(System.Runtime.InteropServices.LayoutKind.Sequential)]
     public readonly partial struct RetentionPolicyKind : System.IEquatable<Azure.Communication.Chat.RetentionPolicyKind>
     {
@@ -269,10 +264,10 @@ public partial class SendChatMessageResult
         internal SendChatMessageResult() { }
         public string Id { get { throw null; } }
     }
-    public partial class ThreadCreationDateRetentionPolicy : Azure.Communication.Chat.ChatRetentionPolicy
+    public sealed partial class ThreadCreationDateRetentionPolicy : Azure.Communication.Chat.ChatRetentionPolicy
     {
-        public ThreadCreationDateRetentionPolicy(int deleteThreadAfterDays) { }
-        public int DeleteThreadAfterDays { get { throw null; } set { } }
+        public ThreadCreationDateRetentionPolicy(int deleteThreadAfterDays) : base (default(Azure.Communication.Chat.RetentionPolicyKind)) { }
+        public int DeleteThreadAfterDays { get { throw null; } }
     }
     public partial class TypingNotificationOptions
     {

sdk/communication/Azure.Communication.Chat/api/Azure.Communication.Chat.netstandard2.0.cs

@@ -130,17 +130,13 @@ public static partial class ChatModelFactory
         public static Azure.Communication.Chat.AddChatParticipantsResult AddChatParticipantsResult(System.Collections.Generic.IEnumerable<Azure.Communication.Chat.ChatError> invalidParticipants = null) { throw null; }
         public static Azure.Communication.Chat.ChatAttachment ChatAttachment(string id, Azure.Communication.Chat.ChatAttachmentType attachmentType, string name, System.Uri uri, System.Uri previewUri) { throw null; }
         public static Azure.Communication.Chat.ChatError ChatError(string code = null, string message = null, string target = null, System.Collections.Generic.IEnumerable<Azure.Communication.Chat.ChatError> details = null, Azure.Communication.Chat.ChatError innerError = null) { throw null; }
-        [System.ComponentModel.EditorBrowsableAttribute(System.ComponentModel.EditorBrowsableState.Never)]
         public static Azure.Communication.Chat.ChatMessage ChatMessage(string id, Azure.Communication.Chat.ChatMessageType type, string sequenceId, string version, Azure.Communication.Chat.ChatMessageContent content, string senderDisplayName, System.DateTimeOffset createdOn, string senderId, System.DateTimeOffset? deletedOn, System.DateTimeOffset? editedOn) { throw null; }
-        [System.ComponentModel.EditorBrowsableAttribute(System.ComponentModel.EditorBrowsableState.Never)]
         public static Azure.Communication.Chat.ChatMessage ChatMessage(string id, Azure.Communication.Chat.ChatMessageType type, string sequenceId, string version, Azure.Communication.Chat.ChatMessageContent content, string senderDisplayName, System.DateTimeOffset createdOn, string senderId, System.DateTimeOffset? deletedOn, System.DateTimeOffset? editedOn, System.Collections.Generic.IReadOnlyDictionary<string, string> metadata) { throw null; }
         public static Azure.Communication.Chat.ChatMessageContent ChatMessageContent(string message, string topic, Azure.Communication.CommunicationUserIdentifier communicationUserIdentifier, System.Collections.Generic.IEnumerable<Azure.Communication.Chat.ChatParticipant> participants) { throw null; }
         public static Azure.Communication.Chat.ChatMessageContent ChatMessageContent(string message, string topic, Azure.Communication.CommunicationUserIdentifier communicationUserIdentifier, System.Collections.Generic.IEnumerable<Azure.Communication.Chat.ChatParticipant> participants, System.Collections.Generic.IEnumerable<Azure.Communication.Chat.ChatAttachment> attachments = null) { throw null; }
-        [System.ComponentModel.EditorBrowsableAttribute(System.ComponentModel.EditorBrowsableState.Never)]
         public static Azure.Communication.Chat.ChatMessageReadReceipt ChatMessageReadReceipt(Azure.Communication.CommunicationIdentifier sender, string chatMessageId, System.DateTimeOffset readOn) { throw null; }
         public static Azure.Communication.Chat.ChatParticipant ChatParticipant(Azure.Communication.CommunicationIdentifier user, string displayName, System.DateTimeOffset? shareHistoryTime) { throw null; }
         public static Azure.Communication.Chat.ChatParticipant ChatParticipant(Azure.Communication.CommunicationIdentifier user, string displayName, System.DateTimeOffset? shareHistoryTime, System.Collections.Generic.IDictionary<string, string> metadata) { throw null; }
-        [System.ComponentModel.EditorBrowsableAttribute(System.ComponentModel.EditorBrowsableState.Never)]
         public static Azure.Communication.Chat.ChatThreadItem ChatThreadItem(string id, string topic, System.DateTimeOffset? deletedOn, System.DateTimeOffset? lastMessageReceivedOn) { throw null; }
         public static Azure.Communication.Chat.ChatThreadProperties ChatThreadProperties(string id, string topic, System.DateTimeOffset createdOn, Azure.Communication.CommunicationIdentifier createdBy, System.DateTimeOffset deletedOn) { throw null; }
         public static Azure.Communication.Chat.CreateChatThreadResult CreateChatThreadResult(Azure.Communication.Chat.ChatThreadProperties chatThread, System.Collections.Generic.IEnumerable<Azure.Communication.Chat.ChatError> invalidParticipants) { throw null; }
@@ -156,7 +152,10 @@ public ChatParticipant(Azure.Communication.CommunicationIdentifier identifier) {
     }
     public abstract partial class ChatRetentionPolicy
     {
-        protected ChatRetentionPolicy() { }
+        protected ChatRetentionPolicy(Azure.Communication.Chat.RetentionPolicyKind kind) { }
+        public Azure.Communication.Chat.RetentionPolicyKind Kind { get { throw null; } }
+        public static Azure.Communication.Chat.ChatRetentionPolicy None() { throw null; }
+        public static Azure.Communication.Chat.ChatRetentionPolicy ThreadCreationDate(int deleteThreadAfterDays) { throw null; }
     }
     public partial class ChatThreadClient
     {
@@ -234,10 +233,6 @@ internal CreateChatThreadResult() { }
         public Azure.Communication.Chat.ChatThreadProperties ChatThread { get { throw null; } }
         public System.Collections.Generic.IReadOnlyList<Azure.Communication.Chat.ChatError> InvalidParticipants { get { throw null; } }
     }
-    public partial class NoneRetentionPolicy : Azure.Communication.Chat.ChatRetentionPolicy
-    {
-        public NoneRetentionPolicy() { }
-    }
     [System.Runtime.InteropServices.StructLayoutAttribute(System.Runtime.InteropServices.LayoutKind.Sequential)]
     public readonly partial struct RetentionPolicyKind : System.IEquatable<Azure.Communication.Chat.RetentionPolicyKind>
     {
@@ -269,10 +264,10 @@ public partial class SendChatMessageResult
         internal SendChatMessageResult() { }
         public string Id { get { throw null; } }
     }
-    public partial class ThreadCreationDateRetentionPolicy : Azure.Communication.Chat.ChatRetentionPolicy
+    public sealed partial class ThreadCreationDateRetentionPolicy : Azure.Communication.Chat.ChatRetentionPolicy
     {
-        public ThreadCreationDateRetentionPolicy(int deleteThreadAfterDays) { }
-        public int DeleteThreadAfterDays { get { throw null; } set { } }
+        public ThreadCreationDateRetentionPolicy(int deleteThreadAfterDays) : base (default(Azure.Communication.Chat.RetentionPolicyKind)) { }
+        public int DeleteThreadAfterDays { get { throw null; } }
     }
     public partial class TypingNotificationOptions
     {

sdk/communication/Azure.Communication.Chat/src/ApiCompatBaseline.txt

@@ -0,0 +1,5 @@
+# The attribute is in shared source which is included and compiled into the binary, so there is no compatibility concern on it.
+CannotRemoveAttribute : Attribute 'System.ComponentModel.EditorBrowsableAttribute' exists on 'Azure.Communication.Chat.ChatModelFactory.ChatMessage(System.String, Azure.Communication.Chat.ChatMessageType, System.String, System.String, Azure.Communication.Chat.ChatMessageContent, System.String, System.DateTimeOffset, System.String, System.Nullable<System.DateTimeOffset>, System.Nullable<System.DateTimeOffset>)' in the contract but not the implementation.
+CannotRemoveAttribute : Attribute 'System.ComponentModel.EditorBrowsableAttribute' exists on 'Azure.Communication.Chat.ChatModelFactory.ChatMessage(System.String, Azure.Communication.Chat.ChatMessageType, System.String, System.String, Azure.Communication.Chat.ChatMessageContent, System.String, System.DateTimeOffset, System.String, System.Nullable<System.DateTimeOffset>, System.Nullable<System.DateTimeOffset>, System.Collections.Generic.IReadOnlyDictionary<System.String, System.String>)' in the contract but not the implementation.
+CannotRemoveAttribute : Attribute 'System.ComponentModel.EditorBrowsableAttribute' exists on 'Azure.Communication.Chat.ChatModelFactory.ChatMessageReadReceipt(Azure.Communication.CommunicationIdentifier, System.String, System.DateTimeOffset)' in the contract but not the implementation.
+CannotRemoveAttribute : Attribute 'System.ComponentModel.EditorBrowsableAttribute' exists on 'Azure.Communication.Chat.ChatModelFactory.ChatThreadItem(System.String, System.String, System.Nullable<System.DateTimeOffset>, System.Nullable<System.DateTimeOffset>)' in the contract but not the implementation.

sdk/communication/Azure.Communication.Chat/src/ChatRestClient.cs

@@ -52,7 +52,7 @@ internal HttpMessage CreateCreateChatThreadRequest(CreateChatThreadOptions optio
 
             if (options.RetentionPolicy != null)
             {
-                createChatThreadRequest.RetentionPolicy = options.RetentionPolicy;
+                createChatThreadRequest.RetentionPolicy = ChatRetentionPolicyConverter.ConvertBack(options.RetentionPolicy);
             }
 
             var model = createChatThreadRequest;

sdk/communication/Azure.Communication.Chat/src/ChatThreadClient.cs

@@ -82,7 +82,12 @@ public virtual Response UpdateProperties(UpdateChatThreadPropertiesOptions optio
             scope.Start();
             try
             {
-                return _chatThreadRestClient.UpdateChatThreadProperties(Id, options.Topic, options.Metadata.ToDictionary(pair => pair.Key, pair => pair.Value), options.RetentionPolicy, cancellationToken);
+                return _chatThreadRestClient.UpdateChatThreadProperties(
+                    Id,
+                    options.Topic,
+                    options.Metadata?.ToDictionary(pair => pair.Key, pair => pair.Value),
+                    ChatRetentionPolicyConverter.ConvertBack(options.RetentionPolicy),
+                    cancellationToken);
             }
             catch (Exception ex)
             {
@@ -101,7 +106,12 @@ public virtual async Task<Response> UpdatePropertiesAsync(UpdateChatThreadProper
             scope.Start();
             try
             {
-                return await _chatThreadRestClient.UpdateChatThreadPropertiesAsync(Id, options.Topic, options.Metadata, options.RetentionPolicy, cancellationToken).ConfigureAwait(false);
+                return await _chatThreadRestClient.UpdateChatThreadPropertiesAsync(
+                    Id,
+                    options.Topic,
+                    options.Metadata,
+                    ChatRetentionPolicyConverter.ConvertBack(options.RetentionPolicy),
+                    cancellationToken).ConfigureAwait(false);
             }
             catch (Exception ex)
             {