com.xmobitea.changx.gn-unity 2.0.3 → 2.4.0

package/Runtime/Entity/OperationResponse.cs

@@ -1,11 +1,13 @@
 namespace XmobiTea.GN.Entity
 {
     using System.Text;
-
-    using XmobiTea.GN.Constant;
     using XmobiTea.GN.Common;
+    using XmobiTea.GN.Constant;
     using XmobiTea.GN.Helper;
 
+    /// <summary>
+    /// Represents an operation response, encapsulating details such as operation code, return code, debug messages, and parameters.
+    /// </summary>
     public class OperationResponse
     {
         private int operationCode;
@@ -17,6 +19,12 @@
 
         private InvalidMember[] invalidMembers;
 
+        /// <summary>
+        /// Initializes a new instance of the <see cref="OperationResponse"/> class.
+        /// </summary>
+        /// <param name="operationCode">The operation code associated with the response.</param>
+        /// <param name="responseId">The response ID.</param>
+        /// <param name="encrypted">Indicates whether the response is encrypted.</param>
         public OperationResponse(int operationCode, int responseId, bool encrypted = true)
         {
             this.operationCode = operationCode;
@@ -26,119 +34,159 @@
             this.debugMessage = null;
         }
 
-        public int getOperationCode()
-        {
-            return this.operationCode;
-        }
-
-        public int getReturnCode()
-        {
-            return this.returnCode;
-        }
-
-        public GNHashtable getParameters()
-        {
-            return this.parameters;
-        }
-
-        public bool isEncrypted()
-        {
-            return this.encrypted;
-        }
-
-        public int getResponseId()
-        {
-            return this.responseId;
-        }
-
-        public string getDebugMessage()
-        {
-            return this.debugMessage;
-        }
-
-        public InvalidMember[] getInvalidMembers()
-        {
-            return this.invalidMembers;
-        }
-
-        public bool hasError()
-        {
-            return this.getReturnCode() != ReturnCode.Ok;
-        }
-
+        /// <summary>
+        /// Gets the operation code of the response.
+        /// </summary>
+        public int getOperationCode() => this.operationCode;
+
+        /// <summary>
+        /// Gets the return code of the response.
+        /// </summary>
+        public int getReturnCode() => this.returnCode;
+
+        /// <summary>
+        /// Gets the parameters associated with the response.
+        /// </summary>
+        public GNHashtable getParameters() => this.parameters;
+
+        /// <summary>
+        /// Determines whether the response is encrypted.
+        /// </summary>
+        public bool isEncrypted() => this.encrypted;
+
+        /// <summary>
+        /// Gets the response ID of the operation.
+        /// </summary>
+        public int getResponseId() => this.responseId;
+
+        /// <summary>
+        /// Gets the debug message, if any.
+        /// </summary>
+        public string getDebugMessage() => this.debugMessage;
+
+        /// <summary>
+        /// Gets the invalid members, if any, associated with the response.
+        /// </summary>
+        public InvalidMember[] getInvalidMembers() => this.invalidMembers;
+
+        /// <summary>
+        /// Determines whether the response has an error based on the return code.
+        /// </summary>
+        public bool hasError() => this.getReturnCode() != ReturnCode.Ok;
+
+        /// <summary>
+        /// Sets the return code for the response.
+        /// </summary>
+        /// <param name="returnCode">The return code to set.</param>
+        /// <returns>The updated <see cref="OperationResponse"/> instance.</returns>
         public OperationResponse setReturnCode(int returnCode)
         {
             this.returnCode = returnCode;
             return this;
         }
 
+        /// <summary>
+        /// Sets the debug message for the response.
+        /// </summary>
+        /// <param name="debugMessage">The debug message to set.</param>
+        /// <returns>The updated <see cref="OperationResponse"/> instance.</returns>
         public OperationResponse setDebugMessage(string debugMessage)
         {
             this.debugMessage = debugMessage;
             return this;
         }
 
+        /// <summary>
+        /// Adds or updates a parameter for the response.
+        /// </summary>
+        /// <param name="key">The parameter key.</param>
+        /// <param name="value">The parameter value.</param>
+        /// <returns>The updated <see cref="OperationResponse"/> instance.</returns>
         public OperationResponse setParameter(string key, object value)
         {
             if (this.parameters == null) this.parameters = new GNHashtable();
-
             this.parameters.add(key, value);
-
             return this;
         }
 
+        /// <summary>
+        /// Sets the parameters for the response.
+        /// </summary>
+        /// <param name="parameters">The parameters to set.</param>
+        /// <returns>The updated <see cref="OperationResponse"/> instance.</returns>
         public OperationResponse setParameters(GNHashtable parameters)
         {
             this.parameters = parameters;
             return this;
         }
 
+        /// <summary>
+        /// Sets whether the response is encrypted.
+        /// </summary>
+        /// <param name="encrypted">True if the response should be encrypted; otherwise false.</param>
+        /// <returns>The updated <see cref="OperationResponse"/> instance.</returns>
         public OperationResponse setEncrypted(bool encrypted)
         {
             this.encrypted = encrypted;
             return this;
         }
 
+        /// <summary>
+        /// Sets the invalid members for the response.
+        /// </summary>
+        /// <param name="invalidMembers">The invalid members to set.</param>
+        /// <returns>The updated <see cref="OperationResponse"/> instance.</returns>
         public OperationResponse setInvalidMembers(InvalidMember[] invalidMembers)
         {
             this.invalidMembers = invalidMembers;
             return this;
         }
 
+        /// <summary>
+        /// Converts the operation response to a string representation.
+        /// </summary>
+        /// <returns>A string representation of the operation response.</returns>
         public string toString()
         {
             var stringBuilder = new StringBuilder();
 
-            stringBuilder.Append("Code: " + CodeHelper.getOperationCodeName(this.operationCode) + ", responseId: " + this.responseId + ", returnCode " + CodeHelper.getReturnCodeName(this.returnCode));
+            stringBuilder.Append("Code: ")
+                         .Append(CodeHelper.getOperationCodeName(this.operationCode))
+                         .Append(", responseId: ")
+                         .Append(this.responseId)
+                         .Append(", returnCode: ")
+                         .Append(CodeHelper.getReturnCodeName(this.returnCode));
 
-            if (this.returnCode == ReturnCode.Ok) stringBuilder.Append(", parameters " + this.parameters);
+            if (this.returnCode == ReturnCode.Ok)
+            {
+                stringBuilder.Append(", parameters: ").Append(this.parameters);
+            }
             else if (this.returnCode == ReturnCode.InvalidRequestParameters)
             {
                 if (this.invalidMembers != null)
                 {
-                    var invalidStr = string.Empty;
-
-                    foreach (var invalidMember in this.invalidMembers)
-                    {
-                        invalidStr += invalidMember;
-                    }
-
-                    stringBuilder.Append(", invalidMembers " + invalidStr);
+                    var invalidStr = string.Join(", ", this.invalidMembers);
+                    stringBuilder.Append(", invalidMembers: ").Append(invalidStr);
                 }
-                else stringBuilder.Append(", invalidMembers " + this.invalidMembers);
+                else
+                {
+                    stringBuilder.Append(", invalidMembers: null");
+                }
+            }
+            else
+            {
+                stringBuilder.Append(", debugMessage: ").Append(this.debugMessage);
             }
-            else stringBuilder.Append(", debugMessage " + this.debugMessage);
 
-            stringBuilder.Append(", encrypted " + this.encrypted);
+            stringBuilder.Append(", encrypted: ").Append(this.encrypted);
 
             return stringBuilder.ToString();
         }
 
-        public override string ToString()
-        {
-            return this.toString();
-        }
-
+        /// <summary>
+        /// Returns a string that represents the current operation response.
+        /// </summary>
+        /// <returns>A string representation of the operation response.</returns>
+        public override string ToString() => this.toString();
     }
-
 }

package/Runtime/Entity/OperationResponse.cs.meta

@@ -1,11 +1,11 @@
-fileFormatVersion: 2
-guid: bbc7492669adfdc44b4a518df6345f2c
-MonoImporter:
-  externalObjects: {}
-  serializedVersion: 2
-  defaultReferences: []
-  executionOrder: 0
-  icon: {instanceID: 0}
-  userData: 
-  assetBundleName: 
-  assetBundleVariant: 
+fileFormatVersion: 2
+guid: bbc7492669adfdc44b4a518df6345f2c
+MonoImporter:
+  externalObjects: {}
+  serializedVersion: 2
+  defaultReferences: []
+  executionOrder: 0
+  icon: {instanceID: 0}
+  userData: 
+  assetBundleName: 
+  assetBundleVariant: 

package/Runtime/Entity/Request/CustomOperationRequest.cs

@@ -1,61 +1,112 @@
-namespace XmobiTea.GN.Entity.Request
-{
-    using XmobiTea.GN.Constant;
-    using XmobiTea.GN.Helper;
-
-    public abstract class CustomOperationRequest
-    {
-        protected abstract int operationCode { get; }
-
-        protected abstract bool operationEncrypted { get; }
-
-        protected abstract RequestType requestType { get; }
-
-        protected abstract RequestRole requestRole { get; }
-
-        protected int operationTimeout { get; }
-
-        public RequestType getRequestType()
-        {
-            return this.requestType;
-        }
-
-        public RequestRole getRequestRole()
-        {
-            return this.requestRole;
-        }
-
-        public CustomOperationRequest(int timeout)
-        {
-            this.operationTimeout = timeout;
-        }
-
-        public abstract OperationRequest build();
-    }
-
-    public abstract class CustomOperationRequest<TRequestData> : CustomOperationRequest where TRequestData : new()
-    {
-        public TRequestData requestData { get; }
-
-        public CustomOperationRequest(int timeout) : base(timeout)
-        {
-            this.requestData = new TRequestData();
-        }
-
-        public CustomOperationRequest(TRequestData requestData, int timeout) : base(timeout)
-        {
-            this.requestData = requestData;
-        }
-
-        public override OperationRequest build()
-        {
-            var request = new OperationRequest(this.operationCode, this.operationEncrypted, this.operationTimeout);
-
-            request.setParameters(ConverterService.serializeObject(this.requestData));
-
-            return request;
-        }
-
-    }
-
-}
+namespace XmobiTea.GN.Entity.Request
+{
+    using XmobiTea.GN.Constant;
+    using XmobiTea.GN.Helper;
+
+    /// <summary>
+    /// Base class for creating custom operation requests.
+    /// </summary>
+    public abstract class CustomOperationRequest
+    {
+        /// <summary>
+        /// The operation code for the request.
+        /// </summary>
+        protected abstract int operationCode { get; }
+
+        /// <summary>
+        /// Specifies if the request should be encrypted.
+        /// </summary>
+        protected abstract bool operationEncrypted { get; }
+
+        /// <summary>
+        /// The type of request (e.g., Socket, HTTP).
+        /// </summary>
+        protected abstract RequestType requestType { get; }
+
+        /// <summary>
+        /// The role of the request (e.g., Client, Admin, Server).
+        /// </summary>
+        protected abstract RequestRole requestRole { get; }
+
+        /// <summary>
+        /// Timeout value for the operation request.
+        /// </summary>
+        protected int operationTimeout { get; }
+
+        /// <summary>
+        /// Gets the request type for the operation.
+        /// </summary>
+        public RequestType getRequestType()
+        {
+            return this.requestType;
+        }
+
+        /// <summary>
+        /// Gets the request role for the operation.
+        /// </summary>
+        public RequestRole getRequestRole()
+        {
+            return this.requestRole;
+        }
+
+        /// <summary>
+        /// Constructor to initialize the operation timeout.
+        /// </summary>
+        /// <param name="timeout">Timeout in seconds for the operation.</param>
+        public CustomOperationRequest(int timeout)
+        {
+            this.operationTimeout = timeout;
+        }
+
+        /// <summary>
+        /// Builds the operation request with the provided data and settings.
+        /// </summary>
+        /// <returns>An `OperationRequest` object.</returns>
+        public abstract OperationRequest build();
+    }
+
+    /// <summary>
+    /// Generic base class for creating custom operation requests with strongly-typed request data.
+    /// </summary>
+    /// <typeparam name="TRequestData">The type of the request data.</typeparam>
+    public abstract class CustomOperationRequest<TRequestData> : CustomOperationRequest where TRequestData : new()
+    {
+        /// <summary>
+        /// Data associated with the request.
+        /// </summary>
+        public TRequestData requestData { get; }
+
+        /// <summary>
+        /// Constructor to initialize with a new instance of request data and a timeout.
+        /// </summary>
+        /// <param name="timeout">Timeout in seconds for the operation.</param>
+        public CustomOperationRequest(int timeout) : base(timeout)
+        {
+            this.requestData = new TRequestData();
+        }
+
+        /// <summary>
+        /// Constructor to initialize with an existing request data object and a timeout.
+        /// </summary>
+        /// <param name="requestData">The existing request data object.</param>
+        /// <param name="timeout">Timeout in seconds for the operation.</param>
+        public CustomOperationRequest(TRequestData requestData, int timeout) : base(timeout)
+        {
+            this.requestData = requestData;
+        }
+
+        /// <summary>
+        /// Builds the operation request with serialized data and configured settings.
+        /// </summary>
+        /// <returns>An `OperationRequest` object with serialized request data.</returns>
+        public override OperationRequest build()
+        {
+            var request = new OperationRequest(this.operationCode, this.operationEncrypted, this.operationTimeout);
+
+            // Serialize the requestData into the parameters of the request.
+            request.setParameters(ConverterService.serializeObject(this.requestData));
+
+            return request;
+        }
+    }
+}

package/Runtime/Entity/Request/CustomOperationRequest.cs.meta

@@ -1,11 +1,11 @@
-fileFormatVersion: 2
-guid: 8aa4380b0ee6727478f6e948661fb5bd
-MonoImporter:
-  externalObjects: {}
-  serializedVersion: 2
-  defaultReferences: []
-  executionOrder: 0
-  icon: {instanceID: 0}
-  userData: 
-  assetBundleName: 
-  assetBundleVariant: 
+fileFormatVersion: 2
+guid: 8aa4380b0ee6727478f6e948661fb5bd
+MonoImporter:
+  externalObjects: {}
+  serializedVersion: 2
+  defaultReferences: []
+  executionOrder: 0
+  icon: {instanceID: 0}
+  userData: 
+  assetBundleName: 
+  assetBundleVariant: 

package/Runtime/Entity/Request.meta

@@ -1,8 +1,8 @@
-fileFormatVersion: 2
-guid: 6472f7fa20319f044920e909df92bda8
-folderAsset: yes
-DefaultImporter:
-  externalObjects: {}
-  userData: 
-  assetBundleName: 
-  assetBundleVariant: 
+fileFormatVersion: 2
+guid: 6472f7fa20319f044920e909df92bda8
+folderAsset: yes
+DefaultImporter:
+  externalObjects: {}
+  userData: 
+  assetBundleName: 
+  assetBundleVariant: 

package/Runtime/Entity/Response/CustomOperationResponse.cs

@@ -1,63 +1,84 @@
-namespace XmobiTea.GN.Entity.Response
-{
-    using XmobiTea.GN.Common;
-    using XmobiTea.GN.Constant;
-    using XmobiTea.GN.Helper;
-
-    public abstract class CustomOperationResponse
-    {
-        public int operationCode { get; private set; }
-        public GNHashtable parameters { get; private set; }
-        public int returnCode { get; private set; }
-        public string debugMessage { get; private set; }
-        public int errorCode { get; private set; }
-        public InvalidMember[] invalidMembers { get; private set; }
-
-        public bool hasReturnCodeError()
-        {
-            return this.returnCode != ReturnCode.Ok;
-        }
-
-        public virtual void setupOperationResponse(OperationResponse operationResponse)
-        {
-            this.operationCode = operationResponse.getOperationCode();
-            this.returnCode = operationResponse.getReturnCode();
-            this.debugMessage = operationResponse.getDebugMessage();
-
-            this.parameters = operationResponse.getParameters();
-            this.invalidMembers = operationResponse.getInvalidMembers();
-
-            if (!this.hasReturnCodeError())
-            {
-                this.errorCode = this.parameters.getInt(ParameterCode.ErrorCode);
-            }
-        }
-
-        public string toString()
-        {
-            return "ReturnCode: " + this.returnCode + " " + (this.parameters != null ? this.parameters.ToString() : this.debugMessage);
-        }
-
-        public override string ToString()
-        {
-            return this.toString();
-        }
-    }
-
-    public class CustomOperationResponse<TResponseData> : CustomOperationResponse
-    {
-        public TResponseData responseData { get; private set; }
-
-        public override void setupOperationResponse(OperationResponse operationResponse)
-        {
-            base.setupOperationResponse(operationResponse);
-
-            if (!this.hasReturnCodeError())
-            {
-                this.responseData = ConverterService.deserializeObject<TResponseData>(this.parameters);
-            }
-        }
-
-    }
-
-}
+namespace XmobiTea.GN.Entity.Response
+{
+    using XmobiTea.GN.Common;
+    using XmobiTea.GN.Constant;
+    using XmobiTea.GN.Helper;
+
+    /// <summary>
+    /// Base class for handling custom operation responses.
+    /// </summary>
+    public abstract class CustomOperationResponse
+    {
+        public int operationCode { get; private set; }
+        public GNHashtable parameters { get; private set; }
+        public int returnCode { get; private set; }
+        public string debugMessage { get; private set; }
+        public int errorCode { get; private set; }
+        public InvalidMember[] invalidMembers { get; private set; }
+
+        /// <summary>
+        /// Checks if the response contains a return code indicating an error.
+        /// </summary>
+        public bool hasReturnCodeError()
+        {
+            return this.returnCode != ReturnCode.Ok;
+        }
+
+        /// <summary>
+        /// Configures the operation response using the provided `OperationResponse` object.
+        /// </summary>
+        /// <param name="operationResponse">The response from the operation to process.</param>
+        public virtual void setupOperationResponse(OperationResponse operationResponse)
+        {
+            this.operationCode = operationResponse.getOperationCode();
+            this.returnCode = operationResponse.getReturnCode();
+            this.debugMessage = operationResponse.getDebugMessage();
+            this.parameters = operationResponse.getParameters();
+            this.invalidMembers = operationResponse.getInvalidMembers();
+
+            // Extract error code if the return code does not indicate an error.
+            if (!this.hasReturnCodeError())
+            {
+                this.errorCode = this.parameters.getInt(ParameterCode.ErrorCode);
+            }
+        }
+
+        /// <summary>
+        /// Returns a string representation of the response.
+        /// </summary>
+        public string toString()
+        {
+            return "ReturnCode: " + this.returnCode + " " +
+                   (this.parameters != null ? this.parameters.ToString() : this.debugMessage);
+        }
+
+        public override string ToString()
+        {
+            return this.toString();
+        }
+    }
+
+    /// <summary>
+    /// A generic variant of `CustomOperationResponse` that includes typed response data.
+    /// </summary>
+    /// <typeparam name="TResponseData">The type of the response data.</typeparam>
+    public class CustomOperationResponse<TResponseData> : CustomOperationResponse
+    {
+        public TResponseData responseData { get; private set; }
+
+        /// <summary>
+        /// Configures the operation response and deserializes typed data if no errors are present.
+        /// </summary>
+        /// <param name="operationResponse">The response from the operation to process.</param>
+        public override void setupOperationResponse(OperationResponse operationResponse)
+        {
+            base.setupOperationResponse(operationResponse);
+
+            if (!this.hasReturnCodeError())
+            {
+                // Deserialize the parameters into the specified response data type.
+                this.responseData = ConverterService.deserializeObject<TResponseData>(this.parameters);
+            }
+        }
+    }
+}

package/Runtime/Entity/Response/CustomOperationResponse.cs.meta

@@ -1,11 +1,11 @@
-fileFormatVersion: 2
-guid: 209ce55f71e46fb4c8935874746a75b3
-MonoImporter:
-  externalObjects: {}
-  serializedVersion: 2
-  defaultReferences: []
-  executionOrder: 0
-  icon: {instanceID: 0}
-  userData: 
-  assetBundleName: 
-  assetBundleVariant: 
+fileFormatVersion: 2
+guid: 209ce55f71e46fb4c8935874746a75b3
+MonoImporter:
+  externalObjects: {}
+  serializedVersion: 2
+  defaultReferences: []
+  executionOrder: 0
+  icon: {instanceID: 0}
+  userData: 
+  assetBundleName: 
+  assetBundleVariant: