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

package/Runtime/Networking/Handler/OnGamePlayerFriendUpdateEventHandler.cs

@@ -1,32 +1,54 @@
-namespace XmobiTea.GN.Networking
-{
-    using System;
-    using System.Collections.Generic;
-    using XmobiTea.GN.Constant;
-    using XmobiTea.GN.Entity;
-    using XmobiTea.GN.Entity.Models;
-    using XmobiTea.GN.Helper;
-
-    public class GamePlayerFriendUpdate
-    {
-        [StringDataMember(code = GNParameterCode.CharacterId, isOptional = true)]
-        public string? characterId;
-
-        [GNArrayDataMember(code = GNParameterCode.PlayerFriends, elementCls = typeof(GenericModels.FriendItem))]
-        public List<GenericModels.FriendItem> playerFriends;
-    }
-
-    public class OnGamePlayerFriendUpdateEventHandler : IServerEventHandler
-    {
-        public static Action<GamePlayerFriendUpdate> onUpdate;
-
-        public int getEventCode() => EventCode.OnGamePlayerFriendUpdate;
-
-        public void handle(OperationEvent operationEvent)
-        {
-            OnGamePlayerFriendUpdateEventHandler.onUpdate?.Invoke(ConverterService.deserializeObject<GamePlayerFriendUpdate>(operationEvent.getParameters()));
-        }
-
-    }
-
-}
+namespace XmobiTea.GN.Networking
+{
+    using System;
+    using System.Collections.Generic;
+    using XmobiTea.GN.Constant;
+    using XmobiTea.GN.Entity;
+    using XmobiTea.GN.Entity.Models;
+    using XmobiTea.GN.Helper;
+
+    /// <summary>
+    /// Represents the data structure for updating a player's friend list in the game.
+    /// </summary>
+    public class GamePlayerFriendUpdate
+    {
+        /// <summary>
+        /// The character ID (optional).
+        /// </summary>
+        [StringDataMember(code = GNParameterCode.CharacterId, isOptional = true)]
+        public string? characterId;
+
+        /// <summary>
+        /// A list of player friends associated with the game player.
+        /// </summary>
+        [GNArrayDataMember(code = GNParameterCode.PlayerFriends, elementCls = typeof(GenericModels.FriendItem))]
+        public List<GenericModels.FriendItem> playerFriends;
+    }
+
+    /// <summary>
+    /// Handles the "OnGamePlayerFriendUpdate" event.
+    /// </summary>
+    public class OnGamePlayerFriendUpdateEventHandler : IServerEventHandler
+    {
+        /// <summary>
+        /// Event triggered when a game player's friend list is updated.
+        /// </summary>
+        public static Action<GamePlayerFriendUpdate> onUpdate;
+
+        /// <summary>
+        /// Gets the event code associated with this handler.
+        /// </summary>
+        /// <returns>The event code for "OnGamePlayerFriendUpdate".</returns>
+        public int getEventCode() => EventCode.OnGamePlayerFriendUpdate;
+
+        /// <summary>
+        /// Handles the "OnGamePlayerFriendUpdate" operation event.
+        /// Deserializes the event parameters and invokes the update action.
+        /// </summary>
+        /// <param name="operationEvent">The operation event containing the parameters for the friend update.</param>
+        public void handle(OperationEvent operationEvent)
+        {
+            OnGamePlayerFriendUpdateEventHandler.onUpdate?.Invoke(ConverterService.deserializeObject<GamePlayerFriendUpdate>(operationEvent.getParameters()));
+        }
+    }
+}

package/Runtime/Networking/Handler/OnGamePlayerFriendUpdateEventHandler.cs.meta

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

package/Runtime/Networking/Handler/OnGamePlayerGroupUpdateEventHandler.cs

@@ -1,32 +1,54 @@
-namespace XmobiTea.GN.Networking
-{
-    using System;
-    using System.Collections.Generic;
-    using XmobiTea.GN.Constant;
-    using XmobiTea.GN.Entity;
-    using XmobiTea.GN.Entity.Models;
-    using XmobiTea.GN.Helper;
-
-    public class GamePlayerGroupUpdate
-    {
-        [StringDataMember(code = GNParameterCode.CharacterId, isOptional = true)]
-        public string? characterId;
-
-        [GNArrayDataMember(code = GNParameterCode.PlayerGroups, elementCls = typeof(GenericModels.GroupItem))]
-        public List<GenericModels.GroupItem> playerGroups;
-    }
-
-    public class OnGamePlayerGroupUpdateEventHandler : IServerEventHandler
-    {
-        public static Action<GamePlayerGroupUpdate> onUpdate;
-
-        public int getEventCode() => EventCode.OnGamePlayerGroupUpdate;
-
-        public void handle(OperationEvent operationEvent)
-        {
-            OnGamePlayerGroupUpdateEventHandler.onUpdate?.Invoke(ConverterService.deserializeObject<GamePlayerGroupUpdate>(operationEvent.getParameters()));
-        }
-
-    }
-
-}
+namespace XmobiTea.GN.Networking
+{
+    using System;
+    using System.Collections.Generic;
+    using XmobiTea.GN.Constant;
+    using XmobiTea.GN.Entity;
+    using XmobiTea.GN.Entity.Models;
+    using XmobiTea.GN.Helper;
+
+    /// <summary>
+    /// Represents the data structure for updating a player's group list in the game.
+    /// </summary>
+    public class GamePlayerGroupUpdate
+    {
+        /// <summary>
+        /// The character ID (optional).
+        /// </summary>
+        [StringDataMember(code = GNParameterCode.CharacterId, isOptional = true)]
+        public string? characterId;
+
+        /// <summary>
+        /// A list of player groups associated with the game player.
+        /// </summary>
+        [GNArrayDataMember(code = GNParameterCode.PlayerGroups, elementCls = typeof(GenericModels.GroupItem))]
+        public List<GenericModels.GroupItem> playerGroups;
+    }
+
+    /// <summary>
+    /// Handles the "OnGamePlayerGroupUpdate" event.
+    /// </summary>
+    public class OnGamePlayerGroupUpdateEventHandler : IServerEventHandler
+    {
+        /// <summary>
+        /// Event triggered when a game player's group list is updated.
+        /// </summary>
+        public static Action<GamePlayerGroupUpdate> onUpdate;
+
+        /// <summary>
+        /// Gets the event code associated with this handler.
+        /// </summary>
+        /// <returns>The event code for "OnGamePlayerGroupUpdate".</returns>
+        public int getEventCode() => EventCode.OnGamePlayerGroupUpdate;
+
+        /// <summary>
+        /// Handles the "OnGamePlayerGroupUpdate" operation event.
+        /// Deserializes the event parameters and invokes the update action.
+        /// </summary>
+        /// <param name="operationEvent">The operation event containing the parameters for the group update.</param>
+        public void handle(OperationEvent operationEvent)
+        {
+            OnGamePlayerGroupUpdateEventHandler.onUpdate?.Invoke(ConverterService.deserializeObject<GamePlayerGroupUpdate>(operationEvent.getParameters()));
+        }
+    }
+}

package/Runtime/Networking/Handler/OnGamePlayerGroupUpdateEventHandler.cs.meta

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

package/Runtime/Networking/Handler/OnGroupMemberUpdateEventHandler.cs

@@ -1,29 +1,48 @@
-namespace XmobiTea.GN.Networking
-{
-    using System;
-    using System.Collections.Generic;
-    using XmobiTea.GN.Constant;
-    using XmobiTea.GN.Entity;
-    using XmobiTea.GN.Entity.Models;
-    using XmobiTea.GN.Helper;
-
-    public class GroupMemberUpdate
-    {
-        [GNArrayDataMember(code = GNParameterCode.Members, elementCls = typeof(GenericModels.FriendItem))]
-        public List<GenericModels.MemberItem> members;
-    }
-
-    public class OnGroupMemberUpdateEventHandler : IServerEventHandler
-    {
-        public static Action<GroupMemberUpdate> onUpdate;
-
-        public int getEventCode() => EventCode.OnGroupMemberUpdate;
-
-        public void handle(OperationEvent operationEvent)
-        {
-            OnGroupMemberUpdateEventHandler.onUpdate?.Invoke(ConverterService.deserializeObject<GroupMemberUpdate>(operationEvent.getParameters()));
-        }
-
-    }
-
-}
+namespace XmobiTea.GN.Networking
+{
+    using System;
+    using System.Collections.Generic;
+    using XmobiTea.GN.Constant;
+    using XmobiTea.GN.Entity;
+    using XmobiTea.GN.Entity.Models;
+    using XmobiTea.GN.Helper;
+
+    /// <summary>
+    /// Represents the data structure for updating group members.
+    /// </summary>
+    public class GroupMemberUpdate
+    {
+        /// <summary>
+        /// A list of members associated with the group.
+        /// </summary>
+        [GNArrayDataMember(code = GNParameterCode.Members, elementCls = typeof(GenericModels.FriendItem))]
+        public List<GenericModels.MemberItem> members;
+    }
+
+    /// <summary>
+    /// Handles the "OnGroupMemberUpdate" event.
+    /// </summary>
+    public class OnGroupMemberUpdateEventHandler : IServerEventHandler
+    {
+        /// <summary>
+        /// Event triggered when group members are updated.
+        /// </summary>
+        public static Action<GroupMemberUpdate> onUpdate;
+
+        /// <summary>
+        /// Gets the event code associated with this handler.
+        /// </summary>
+        /// <returns>The event code for "OnGroupMemberUpdate".</returns>
+        public int getEventCode() => EventCode.OnGroupMemberUpdate;
+
+        /// <summary>
+        /// Handles the "OnGroupMemberUpdate" operation event.
+        /// Deserializes the event parameters and invokes the update action.
+        /// </summary>
+        /// <param name="operationEvent">The operation event containing the parameters for the group member update.</param>
+        public void handle(OperationEvent operationEvent)
+        {
+            OnGroupMemberUpdateEventHandler.onUpdate?.Invoke(ConverterService.deserializeObject<GroupMemberUpdate>(operationEvent.getParameters()));
+        }
+    }
+}

package/Runtime/Networking/Handler/OnGroupMemberUpdateEventHandler.cs.meta

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

package/Runtime/Networking/Handler/OnGroupMessageUpdateEventHandler.cs

@@ -1,29 +1,47 @@
-namespace XmobiTea.GN.Networking
-{
-    using System;
-    using System.Collections.Generic;
-    using XmobiTea.GN.Constant;
-    using XmobiTea.GN.Entity;
-    using XmobiTea.GN.Entity.Models;
-    using XmobiTea.GN.Helper;
-
-    public class GroupMessageUpdate
-    {
-        [GNArrayDataMember(code = GNParameterCode.GroupMessages, elementCls = typeof(GroupModels.GroupMessageResponseData))]
-        public List<GroupModels.GroupMessageResponseData> groupMessages;
-    }
-
-    public class OnGroupMessageUpdateEventHandler : IServerEventHandler
-    {
-        public static Action<GroupMessageUpdate> onUpdate;
-
-        public int getEventCode() => EventCode.OnGroupMessageUpdate;
-
-        public void handle(OperationEvent operationEvent)
-        {
-            OnGroupMessageUpdateEventHandler.onUpdate?.Invoke(ConverterService.deserializeObject<GroupMessageUpdate>(operationEvent.getParameters()));
-        }
-
-    }
-
-}
+namespace XmobiTea.GN.Networking
+{
+    using System;
+    using System.Collections.Generic;
+    using XmobiTea.GN.Constant;
+    using XmobiTea.GN.Entity;
+    using XmobiTea.GN.Entity.Models;
+    using XmobiTea.GN.Helper;
+
+    /// <summary>
+    /// Represents an update for group messages.
+    /// </summary>
+    public class GroupMessageUpdate
+    {
+        /// <summary>
+        /// A list of updated group messages.
+        /// </summary>
+        [GNArrayDataMember(code = GNParameterCode.GroupMessages, elementCls = typeof(GroupModels.GroupMessageResponseData))]
+        public List<GroupModels.GroupMessageResponseData> groupMessages;
+    }
+
+    /// <summary>
+    /// Event handler for handling updates to group messages.
+    /// </summary>
+    public class OnGroupMessageUpdateEventHandler : IServerEventHandler
+    {
+        /// <summary>
+        /// An action to be invoked when a group message update occurs.
+        /// </summary>
+        public static Action<GroupMessageUpdate> onUpdate;
+
+        /// <summary>
+        /// Gets the event code associated with the group message update.
+        /// </summary>
+        /// <returns>The event code for group message updates.</returns>
+        public int getEventCode() => EventCode.OnGroupMessageUpdate;
+
+        /// <summary>
+        /// Handles the group message update event.
+        /// </summary>
+        /// <param name="operationEvent">The operation event containing the update data.</param>
+        public void handle(OperationEvent operationEvent)
+        {
+            OnGroupMessageUpdateEventHandler.onUpdate?.Invoke(ConverterService.deserializeObject<GroupMessageUpdate>(operationEvent.getParameters()));
+        }
+    }
+}

package/Runtime/Networking/Handler/OnGroupMessageUpdateEventHandler.cs.meta

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

package/Runtime/Networking/Handler.meta

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

package/Runtime/Networking/Http/HttpPeer.cs

@@ -1,67 +1,95 @@
 namespace XmobiTea.GN.Networking.Http
 {
     using System;
-
-    using XmobiTea.GN.Constant;
-    using XmobiTea.GN.Helper;
+    using System.Text;
     using XmobiTea.GN.Common;
     using XmobiTea.GN.Config;
-    using System.Text;
-    using XmobiTea.MsgPack;
+    using XmobiTea.GN.Constant;
+    using XmobiTea.GN.Helper;
     using XmobiTea.GN.Logger;
+    using XmobiTea.MsgPack;
 
+    /// <summary>
+    /// Represents the HTTP application response.
+    /// </summary>
     public class HttpAppResponse
     {
+        /// <summary>Gets or sets the HTTP status code.</summary>
         public long statusCode { get; internal set; }
+
+        /// <summary>Gets or sets the error message, if any.</summary>
         public string error { get; internal set; }
+
+        /// <summary>Gets or sets the response data in byte array format.</summary>
         public byte[] data { get; internal set; }
+
+        /// <summary>Gets or sets the response text as a string.</summary>
         public string text { get; internal set; }
 
+        /// <summary>
+        /// Checks if the response contains an error.
+        /// </summary>
+        /// <returns>True if there is an error; otherwise, false.</returns>
         public bool hasError()
         {
             return this.error != null;
         }
 
+        /// <summary>
+        /// Converts the HTTP response to a string for logging purposes.
+        /// </summary>
+        /// <returns>A string representation of the response.</returns>
         public string toString()
         {
             var stringBuilder = new StringBuilder();
-
             stringBuilder.Append(" StatusCode: " + this.statusCode);
             if (!string.IsNullOrEmpty(this.error)) stringBuilder.Append(", <color=red>Error: " + this.error + "</color>");
             stringBuilder.Append(", Text: " + this.text);
-
             return stringBuilder.ToString();
         }
 
+        /// <summary>
+        /// Returns a string representation of the HTTP response.
+        /// </summary>
+        /// <returns>A string representation of the HTTP response.</returns>
         public override string ToString()
         {
             return this.toString();
         }
     }
 
+    /// <summary>
+    /// Enum representing the type of HTTP POST requests.
+    /// </summary>
     public enum PostType
     {
         Json = 0,
         MsgPack = 1,
     }
 
+    /// <summary>
+    /// Class for managing HTTP peer connections and requests.
+    /// </summary>
     internal class HttpPeer : PeerBase
     {
         private NetworkingHttpPeerBase networkingHttpPeerBase;
 
         private const char JSON_CHAR_KNOWN = '[';
 
+        /// <summary>
+        /// Initializes the GN HTTP socket object.
+        /// </summary>
         internal override void initGNSocketObject()
         {
             var gnServerSettings = GNNetwork.gnServerSettings;
             if (gnServerSettings == null) throw new NullReferenceException("Where is GN Server Settings");
 
             this.isUse = gnServerSettings.isUseHttp();
-
             var httpRequestType = gnServerSettings.getHttpRequestType();
 
 #if UNITY_USING_BEST_HTTP
-            if (httpRequestType == HttpRequestType.HTTPRequest) this.networkingHttpPeerBase = new NetworkingPeerHttpRequest(); else
+            if (httpRequestType == HttpRequestType.HTTPRequest) this.networkingHttpPeerBase = new NetworkingPeerHttpRequest();
+            else
 #endif
             if (httpRequestType == HttpRequestType.UnityWebRequest) this.networkingHttpPeerBase = new NetworkingPeerUnityWebRequest();
             else if (httpRequestType == HttpRequestType.HttpWebRequest) this.networkingHttpPeerBase = new NetworkingPeerHttpWebRequest();
@@ -71,18 +99,20 @@
             this.networkingHttpPeerBase.init(httpUrl, userAgent);
         }
 
+        /// <summary>
+        /// Sends an operation request via HTTP.
+        /// </summary>
+        /// <param name="operationPending">The operation pending to be sent.</param>
         internal override void send(OperationPending operationPending)
         {
             base.send(operationPending);
-
             GNDebug.log("[GN Http SEND] " + operationPending.getOperationRequest().ToString());
 
             var operationRequest = operationPending.getOperationRequest();
-
             var authToken = operationPending.getAuthToken();
             var secretKey = operationPending.getSecretKey();
+            var gameId = operationPending.getGameId();
             var customTags = operationPending.getCustomTags();
-
             var postType = !operationRequest.isEncrypted() ? PostType.Json : PostType.MsgPack;
 
             var subUri = (postType == PostType.Json ? NetworkingPeer.API_JSON : NetworkingPeer.API_MSG_PACK) + "/" + operationRequest.getOperationCode() + "/" + (int)operationPending.getRequestType() + "/" + (int)operationPending.getRequestRole();
@@ -90,20 +120,24 @@
             this.networkingHttpPeerBase.postRequest(subUri, operationRequest.getParameters(), postType, httpAppResponse =>
             {
                 this.onSendOperationRequestResponse(operationPending, httpAppResponse);
-            }, operationRequest.getTimeout(), authToken, secretKey, customTags);
+            }, operationRequest.getTimeout(), authToken, secretKey, customTags, gameId);
         }
 
+        /// <summary>
+        /// Handles the response of an operation request.
+        /// </summary>
+        /// <param name="operationPending">The pending operation.</param>
+        /// <param name="httpAppResponse">The HTTP application response received.</param>
         void onSendOperationRequestResponse(OperationPending operationPending, HttpAppResponse httpAppResponse)
         {
             var operationRequest = operationPending.getOperationRequest();
             var obj = new GNArray();
-            
+
             if (!httpAppResponse.hasError())
             {
                 if (httpAppResponse.statusCode == 200)
                 {
                     var isEncrypted = false;
-
                     GNArray gnArray = null;
 
                     if (!string.IsNullOrEmpty(httpAppResponse.text))
@@ -150,31 +184,40 @@
             this.onResponseHandler(obj, operationRequest.isEncrypted());
         }
 
-        internal void getRequest(string subUri, Action<HttpAppResponse> onHttpAppResponse, float timeout = 15, string authToken = null, string secretKey = null)
+        /// <summary>
+        /// Sends a GET request to the specified URI.
+        /// </summary>
+        /// <param name="subUri">The sub-URI for the request.</param>
+        /// <param name="onHttpAppResponse">Callback to handle the HTTP response.</param>
+        /// <param name="timeout">The timeout for the request, in seconds.</param>
+        /// <param name="authToken">Optional authentication token.</param>
+        /// <param name="secretKey">Optional secret key.</param>
+        internal void getRequest(string subUri, Action<HttpAppResponse> onHttpAppResponse, float timeout = 15, string authToken = null, string secretKey = null, string gameId = null)
         {
-            this.networkingHttpPeerBase.getRequest(subUri, onHttpAppResponse, timeout, authToken, secretKey);
+            this.networkingHttpPeerBase.getRequest(subUri, onHttpAppResponse, timeout, authToken, secretKey, gameId);
         }
 
+        /// <summary>
+        /// Uploads a file to the server.
+        /// </summary>
+        /// <param name="fileId">The ID of the file to upload.</param>
+        /// <param name="content">The content of the file as a byte array.</param>
+        /// <param name="mimetype">The MIME type of the file.</param>
+        /// <param name="onHttpAppResponse">Callback to handle the HTTP response.</param>
+        /// <param name="timeout">The timeout for the request, in seconds.</param>
         internal void uploadFile(string fileId, byte[] content, string mimetype, Action<HttpAppResponse> onHttpAppResponse, float timeout = 60)
         {
             var authToken = GNNetwork.getAuthenticateStatus().getAuthToken();
 
             if (string.IsNullOrEmpty(authToken))
             {
-                var httpAppResponse = new HttpAppResponse();
-                httpAppResponse.statusCode = 401;
-                httpAppResponse.error = "Auth token null";
-
+                var httpAppResponse = new HttpAppResponse { statusCode = 401, error = "Auth token null" };
                 onHttpAppResponse?.Invoke(httpAppResponse);
-
                 return;
             }
 
             var subUri = NetworkingPeer.UPLOAD_FILE + "/" + fileId;
-
             this.networkingHttpPeerBase.postRequestUpload(subUri, content, mimetype, onHttpAppResponse, timeout);
         }
-
     }
-
 }