@xmobitea/gn-typescript-client 2.6.13 → 2.6.14
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/AGENTS.md +37 -0
- package/README.MD +420 -1
- package/dist/gearn.js.client.js +25056 -1056
- package/dist/gearn.js.client.min.js +1 -1
- package/dist/index.d.ts +30 -0
- package/dist/index.js +24236 -212
- package/dist/runtime/GNNetwork.d.ts +687 -3
- package/dist/runtime/GNNetworkAuthenticateApi.d.ts +327 -0
- package/dist/runtime/GNNetworkCharacterPlayerApi.d.ts +1026 -0
- package/dist/runtime/GNNetworkCloudScriptApi.d.ts +141 -0
- package/dist/runtime/GNNetworkContentApi.d.ts +243 -0
- package/dist/runtime/GNNetworkDashboardApi.d.ts +221 -0
- package/dist/runtime/GNNetworkGamePlayerApi.d.ts +1033 -0
- package/dist/runtime/GNNetworkGroupApi.d.ts +783 -0
- package/dist/runtime/GNNetworkInventoryApi.d.ts +673 -0
- package/dist/runtime/GNNetworkMasterPlayerApi.d.ts +1614 -6
- package/dist/runtime/GNNetworkMultiplayerApi.d.ts +234 -0
- package/dist/runtime/GNNetworkStoreInventoryApi.d.ts +309 -0
- package/dist/runtime/common/Action0.d.ts +30 -0
- package/dist/runtime/common/Action1.d.ts +32 -0
- package/dist/runtime/common/Action2.d.ts +21 -0
- package/dist/runtime/common/Action3.d.ts +16 -0
- package/dist/runtime/common/Action4.d.ts +17 -0
- package/dist/runtime/common/GNData.d.ts +368 -0
- package/dist/runtime/config/GNServerSettings.d.ts +442 -12
- package/dist/runtime/constant/Commands.d.ts +80 -0
- package/dist/runtime/constant/EventCode.d.ts +48 -0
- package/dist/runtime/constant/OperationCode.d.ts +74 -1
- package/dist/runtime/constant/ReturnCode.d.ts +72 -0
- package/dist/runtime/constant/enumType/ExecuteResponseStatus.d.ts +31 -0
- package/dist/runtime/constant/enumType/FriendStatus.d.ts +39 -0
- package/dist/runtime/constant/enumType/GoogleLoginType.d.ts +23 -0
- package/dist/runtime/constant/enumType/GroupStatus.d.ts +32 -0
- package/dist/runtime/constant/enumType/InvalidMemberType.d.ts +75 -0
- package/dist/runtime/constant/enumType/ItemType.d.ts +23 -0
- package/dist/runtime/constant/enumType/MatchStatus.d.ts +30 -0
- package/dist/runtime/constant/enumType/MatchmakingMemberStatus.d.ts +24 -0
- package/dist/runtime/constant/enumType/MatchmakingTicketStatus.d.ts +34 -0
- package/dist/runtime/constant/enumType/OwnerType.d.ts +40 -0
- package/dist/runtime/constant/enumType/PermissionDataItem.d.ts +22 -0
- package/dist/runtime/constant/enumType/PushPlatformType.d.ts +18 -0
- package/dist/runtime/constant/enumType/RequestRole.d.ts +32 -0
- package/dist/runtime/constant/enumType/RequestType.d.ts +70 -0
- package/dist/runtime/constant/enumType/StoreItemType.d.ts +21 -0
- package/dist/runtime/constant/enumType/StoreReceiveType.d.ts +30 -0
- package/dist/runtime/constant/errorCode/ErrorCode.d.ts +190 -8
- package/dist/runtime/constant/parameterCode/ParameterCode.d.ts +35 -5
- package/dist/runtime/entity/DataMember.d.ts +338 -0
- package/dist/runtime/entity/GNMetadata.d.ts +101 -0
- package/dist/runtime/entity/InvalidMember.d.ts +28 -0
- package/dist/runtime/entity/OperationEvent.d.ts +49 -0
- package/dist/runtime/entity/OperationRequest.d.ts +108 -0
- package/dist/runtime/entity/OperationResponse.d.ts +110 -0
- package/dist/runtime/entity/models/AuthenticateModels.d.ts +115 -0
- package/dist/runtime/entity/models/AuthenticateRequestModels.d.ts +131 -0
- package/dist/runtime/entity/models/AuthenticateResponseModels.d.ts +131 -0
- package/dist/runtime/entity/models/CharacterPlayerModels.d.ts +625 -1
- package/dist/runtime/entity/models/CharacterPlayerRequestModels.d.ts +972 -0
- package/dist/runtime/entity/models/CharacterPlayerResponseModels.d.ts +332 -0
- package/dist/runtime/entity/models/CloudScriptModels.d.ts +109 -0
- package/dist/runtime/entity/models/CloudScriptRequestModels.d.ts +107 -0
- package/dist/runtime/entity/models/CloudScriptResponseModels.d.ts +46 -0
- package/dist/runtime/entity/models/ContentModels.d.ts +124 -0
- package/dist/runtime/entity/models/ContentRequestModels.d.ts +152 -0
- package/dist/runtime/entity/models/ContentResponseModels.d.ts +58 -0
- package/dist/runtime/entity/models/DashboardModels.d.ts +371 -8
- package/dist/runtime/entity/models/DashboardRequestModels.d.ts +172 -0
- package/dist/runtime/entity/models/DashboardResponseModels.d.ts +170 -0
- package/dist/runtime/entity/models/GamePlayerModels.d.ts +644 -1
- package/dist/runtime/entity/models/GamePlayerRequestModels.d.ts +959 -0
- package/dist/runtime/entity/models/GamePlayerResponseModels.d.ts +333 -1
- package/dist/runtime/entity/models/GenericModels.d.ts +94 -0
- package/dist/runtime/entity/models/GroupModels.d.ts +484 -2
- package/dist/runtime/entity/models/GroupRequestModels.d.ts +737 -0
- package/dist/runtime/entity/models/GroupResponseModels.d.ts +254 -0
- package/dist/runtime/entity/models/InventoryModels.d.ts +415 -0
- package/dist/runtime/entity/models/InventoryRequestModels.d.ts +629 -0
- package/dist/runtime/entity/models/InventoryResponseModels.d.ts +218 -0
- package/dist/runtime/entity/models/MasterPlayerModels.d.ts +1065 -3
- package/dist/runtime/entity/models/MasterPlayerRequestModels.d.ts +1560 -6
- package/dist/runtime/entity/models/MasterPlayerResponseModels.d.ts +532 -1
- package/dist/runtime/entity/models/MultiplayerModels.d.ts +199 -0
- package/dist/runtime/entity/models/MultiplayerRequestModels.d.ts +196 -0
- package/dist/runtime/entity/models/MultiplayerResponseModels.d.ts +74 -0
- package/dist/runtime/entity/models/StoreInventoryModels.d.ts +262 -0
- package/dist/runtime/entity/models/StoreInventoryRequestModels.d.ts +268 -0
- package/dist/runtime/entity/models/StoreInventoryResponseModels.d.ts +98 -0
- package/dist/runtime/entity/request/CustomOperationRequest.d.ts +99 -0
- package/dist/runtime/entity/response/CustomOperationResponse.d.ts +118 -0
- package/dist/runtime/entity/response/GetAuthInfoResponse.d.ts +53 -0
- package/dist/runtime/entity/response/HealthCheckResponse.d.ts +56 -0
- package/dist/runtime/entity/response/UploadFileResponse.d.ts +19 -0
- package/dist/runtime/helper/CodeHelper.d.ts +122 -0
- package/dist/runtime/helper/ConverterService.d.ts +74 -0
- package/dist/runtime/helper/EnumUtility.d.ts +63 -0
- package/dist/runtime/helper/GNSupport.d.ts +64 -4
- package/dist/runtime/helper/GNUtils.d.ts +54 -0
- package/dist/runtime/helper/MessagePackConverterService.d.ts +48 -0
- package/dist/runtime/helper/OperationHelper.d.ts +51 -0
- package/dist/runtime/helper/StorageService.d.ts +48 -8
- package/dist/runtime/logger/GNDebug.d.ts +117 -0
- package/dist/runtime/networking/AuthenticateStatus.d.ts +64 -0
- package/dist/runtime/networking/IPeer.d.ts +83 -0
- package/dist/runtime/networking/NetworkingPeer.d.ts +256 -1
- package/dist/runtime/networking/OperationPending.d.ts +112 -0
- package/dist/runtime/networking/PeerBase.d.ts +231 -0
- package/dist/runtime/networking/handler/IServerEventHandler.d.ts +84 -0
- package/dist/runtime/networking/handler/OnCharacterPlayerFriendUpdateEventHandler.d.ts +69 -0
- package/dist/runtime/networking/handler/OnCharacterPlayerGroupUpdateEventHandler.d.ts +49 -0
- package/dist/runtime/networking/handler/OnGamePlayerFriendUpdateEventHandler.d.ts +50 -0
- package/dist/runtime/networking/handler/OnGamePlayerGroupUpdateEventHandler.d.ts +41 -0
- package/dist/runtime/networking/handler/OnGroupMemberUpdateEventHandler.d.ts +47 -0
- package/dist/runtime/networking/handler/OnGroupMessageUpdateEventHandler.d.ts +46 -0
- package/dist/runtime/networking/http/HttpPeer.d.ts +173 -0
- package/dist/runtime/networking/http/NetworkingHttpPeerBase.d.ts +87 -0
- package/dist/runtime/networking/http/NetworkingPeerAxiosRequest.d.ts +113 -0
- package/dist/runtime/networking/socket/NetworkingPeerSocketIOClient.d.ts +145 -0
- package/dist/runtime/networking/socket/NetworkingSocketPeerBase.d.ts +198 -0
- package/dist/runtime/networking/socket/SocketPeer.d.ts +155 -0
- package/dist/runtime/typescript/ServiceUpdate.d.ts +46 -0
- package/docs/AI_CHEATSHEET.md +211 -0
- package/docs/COOKBOOK.md +912 -0
- package/docs/RULES.md +307 -0
- package/docs/ai-manifest.json +725 -0
- package/docs/guides/AUTHENTICATE.md +246 -0
- package/docs/guides/CHARACTER_PLAYER.md +439 -0
- package/docs/guides/CLOUDSCRIPT.md +335 -0
- package/docs/guides/COCOS_CREATOR_INTEGRATION.md +150 -0
- package/docs/guides/CONTENT.md +291 -0
- package/docs/guides/DASHBOARD.md +262 -0
- package/docs/guides/GAME_PLAYER.md +473 -0
- package/docs/guides/GROUP.md +412 -0
- package/docs/guides/INVENTORY.md +375 -0
- package/docs/guides/MASTER_PLAYER.md +458 -0
- package/docs/guides/MULTIPLAYER.md +303 -0
- package/docs/guides/STORE_INVENTORY.md +313 -0
- package/docs/llms-full.txt +43 -0
- package/docs/reference/API_AUTHENTICATE.md +75 -0
- package/docs/reference/API_CHARACTER_PLAYER.md +226 -0
- package/docs/reference/API_CLOUDSCRIPT.md +82 -0
- package/docs/reference/API_CONTENT.md +88 -0
- package/docs/reference/API_DASHBOARD.md +82 -0
- package/docs/reference/API_GAME_PLAYER.md +223 -0
- package/docs/reference/API_GROUP.md +187 -0
- package/docs/reference/API_INDEX.md +57 -0
- package/docs/reference/API_INVENTORY.md +169 -0
- package/docs/reference/API_MASTER_PLAYER.md +323 -0
- package/docs/reference/API_MULTIPLAYER.md +97 -0
- package/docs/reference/API_STORE_INVENTORY.md +109 -0
- package/docs/reference/CONFIG.md +107 -0
- package/docs/reference/DTO_INDEX.md +2543 -0
- package/docs/reference/ENUMS.md +433 -0
- package/docs/reference/ERROR_HANDLING.md +159 -0
- package/docs/reference/EVENTS.md +188 -0
- package/docs/reference/PERMISSION_RULES.md +55 -0
- package/docs/reference/dto/AUTHENTICATE.md +619 -0
- package/docs/reference/dto/CHARACTER_PLAYER.md +3686 -0
- package/docs/reference/dto/CLOUDSCRIPT.md +400 -0
- package/docs/reference/dto/CONTENT.md +548 -0
- package/docs/reference/dto/DASHBOARD.md +1980 -0
- package/docs/reference/dto/GAME_PLAYER.md +3631 -0
- package/docs/reference/dto/GENERIC.md +151 -0
- package/docs/reference/dto/GROUP.md +2842 -0
- package/docs/reference/dto/INVENTORY.md +2385 -0
- package/docs/reference/dto/MASTER_PLAYER.md +6024 -0
- package/docs/reference/dto/MULTIPLAYER.md +850 -0
- package/docs/reference/dto/STORE_INVENTORY.md +1262 -0
- package/llms.txt +47 -0
- package/package.json +12 -3
- package/GNServerSettings.debug.json +0 -21
- package/docs/COCOS_CREATOR_INTEGRATION.md +0 -116
- package/examples/cocos-creator/GearNExample.ts.txt +0 -176
- package/srcSwift/Package.swift +0 -32
- package/srcSwift/Sources/GearN/runtime/GNNetwork.swift +0 -530
- package/srcSwift/Sources/GearN/runtime/GNNetworkAuthenticateApi.swift +0 -178
- package/srcSwift/Sources/GearN/runtime/GNNetworkCharacterPlayerApi.swift +0 -1162
- package/srcSwift/Sources/GearN/runtime/GNNetworkCloudScriptApi.swift +0 -154
- package/srcSwift/Sources/GearN/runtime/GNNetworkContentApi.swift +0 -208
- package/srcSwift/Sources/GearN/runtime/GNNetworkDashboardApi.swift +0 -240
- package/srcSwift/Sources/GearN/runtime/GNNetworkGamePlayerApi.swift +0 -1369
- package/srcSwift/Sources/GearN/runtime/GNNetworkGroupApi.swift +0 -1100
- package/srcSwift/Sources/GearN/runtime/GNNetworkInventoryApi.swift +0 -937
- package/srcSwift/Sources/GearN/runtime/GNNetworkMasterPlayerApi.swift +0 -2323
- package/srcSwift/Sources/GearN/runtime/GNNetworkMultiplayerApi.swift +0 -298
- package/srcSwift/Sources/GearN/runtime/GNNetworkStoreInventoryApi.swift +0 -397
- package/srcSwift/Sources/GearN/runtime/common/Action0.swift +0 -3
- package/srcSwift/Sources/GearN/runtime/common/Action1.swift +0 -3
- package/srcSwift/Sources/GearN/runtime/common/Action2.swift +0 -3
- package/srcSwift/Sources/GearN/runtime/common/Action3.swift +0 -3
- package/srcSwift/Sources/GearN/runtime/common/Action4.swift +0 -3
- package/srcSwift/Sources/GearN/runtime/common/GNArray.swift +0 -204
- package/srcSwift/Sources/GearN/runtime/common/GNData.swift +0 -108
- package/srcSwift/Sources/GearN/runtime/common/GNHashtable.swift +0 -200
- package/srcSwift/Sources/GearN/runtime/config/GNServerSettings.swift +0 -95
- package/srcSwift/Sources/GearN/runtime/constant/Commands.swift +0 -28
- package/srcSwift/Sources/GearN/runtime/constant/EventCode.swift +0 -10
- package/srcSwift/Sources/GearN/runtime/constant/OperationCode.swift +0 -252
- package/srcSwift/Sources/GearN/runtime/constant/ReturnCode.swift +0 -19
- package/srcSwift/Sources/GearN/runtime/constant/enumType/ExecuteResponseStatus.swift +0 -9
- package/srcSwift/Sources/GearN/runtime/constant/enumType/FriendStatus.swift +0 -8
- package/srcSwift/Sources/GearN/runtime/constant/enumType/GoogleLoginType.swift +0 -6
- package/srcSwift/Sources/GearN/runtime/constant/enumType/GroupStatus.swift +0 -8
- package/srcSwift/Sources/GearN/runtime/constant/enumType/InvalidMemberType.swift +0 -19
- package/srcSwift/Sources/GearN/runtime/constant/enumType/ItemType.swift +0 -6
- package/srcSwift/Sources/GearN/runtime/constant/enumType/MatchmakingMemberStatus.swift +0 -7
- package/srcSwift/Sources/GearN/runtime/constant/enumType/MatchmakingTicketStatus.swift +0 -9
- package/srcSwift/Sources/GearN/runtime/constant/enumType/OwnerType.swift +0 -10
- package/srcSwift/Sources/GearN/runtime/constant/enumType/PermissionDataItem.swift +0 -6
- package/srcSwift/Sources/GearN/runtime/constant/enumType/PushPlatformType.swift +0 -6
- package/srcSwift/Sources/GearN/runtime/constant/enumType/RequestRole.swift +0 -7
- package/srcSwift/Sources/GearN/runtime/constant/enumType/RequestType.swift +0 -16
- package/srcSwift/Sources/GearN/runtime/constant/enumType/StoreItemType.swift +0 -6
- package/srcSwift/Sources/GearN/runtime/constant/enumType/StoreReceiveType.swift +0 -9
- package/srcSwift/Sources/GearN/runtime/constant/errorCode/ErrorCode.swift +0 -58
- package/srcSwift/Sources/GearN/runtime/constant/parameterCode/ParameterCode.swift +0 -672
- package/srcSwift/Sources/GearN/runtime/entity/DataMember.swift +0 -196
- package/srcSwift/Sources/GearN/runtime/entity/GNMetadata.swift +0 -9
- package/srcSwift/Sources/GearN/runtime/entity/InvalidMember.swift +0 -11
- package/srcSwift/Sources/GearN/runtime/entity/OperationEvent.swift +0 -38
- package/srcSwift/Sources/GearN/runtime/entity/OperationHelper.swift +0 -28
- package/srcSwift/Sources/GearN/runtime/entity/OperationRequest.swift +0 -62
- package/srcSwift/Sources/GearN/runtime/entity/OperationResponse.swift +0 -98
- package/srcSwift/Sources/GearN/runtime/entity/models/AuthenticateModels.swift +0 -351
- package/srcSwift/Sources/GearN/runtime/entity/models/AuthenticateRequestModels.swift +0 -81
- package/srcSwift/Sources/GearN/runtime/entity/models/AuthenticateResponseModels.swift +0 -108
- package/srcSwift/Sources/GearN/runtime/entity/models/CharacterPlayerModels.swift +0 -1045
- package/srcSwift/Sources/GearN/runtime/entity/models/CharacterPlayerRequestModels.swift +0 -821
- package/srcSwift/Sources/GearN/runtime/entity/models/CharacterPlayerResponseModels.swift +0 -588
- package/srcSwift/Sources/GearN/runtime/entity/models/CloudScriptModels.swift +0 -187
- package/srcSwift/Sources/GearN/runtime/entity/models/CloudScriptRequestModels.swift +0 -84
- package/srcSwift/Sources/GearN/runtime/entity/models/CloudScriptResponseModels.swift +0 -59
- package/srcSwift/Sources/GearN/runtime/entity/models/ContentModels.swift +0 -195
- package/srcSwift/Sources/GearN/runtime/entity/models/ContentRequestModels.swift +0 -116
- package/srcSwift/Sources/GearN/runtime/entity/models/ContentResponseModels.swift +0 -81
- package/srcSwift/Sources/GearN/runtime/entity/models/DashboardModels.swift +0 -426
- package/srcSwift/Sources/GearN/runtime/entity/models/DashboardRequestModels.swift +0 -160
- package/srcSwift/Sources/GearN/runtime/entity/models/DashboardResponseModels.swift +0 -82
- package/srcSwift/Sources/GearN/runtime/entity/models/GamePlayerModels.swift +0 -1334
- package/srcSwift/Sources/GearN/runtime/entity/models/GamePlayerRequestModels.swift +0 -643
- package/srcSwift/Sources/GearN/runtime/entity/models/GamePlayerResponseModels.swift +0 -213
- package/srcSwift/Sources/GearN/runtime/entity/models/GenericModels.swift +0 -171
- package/srcSwift/Sources/GearN/runtime/entity/models/GroupModels.swift +0 -850
- package/srcSwift/Sources/GearN/runtime/entity/models/GroupRequestModels.swift +0 -485
- package/srcSwift/Sources/GearN/runtime/entity/models/GroupResponseModels.swift +0 -165
- package/srcSwift/Sources/GearN/runtime/entity/models/InventoryModels.swift +0 -679
- package/srcSwift/Sources/GearN/runtime/entity/models/InventoryRequestModels.swift +0 -413
- package/srcSwift/Sources/GearN/runtime/entity/models/InventoryResponseModels.swift +0 -141
- package/srcSwift/Sources/GearN/runtime/entity/models/MasterPlayerModels.swift +0 -378
- package/srcSwift/Sources/GearN/runtime/entity/models/MasterPlayerRequestModels.swift +0 -147
- package/srcSwift/Sources/GearN/runtime/entity/models/MasterPlayerResponseModels.swift +0 -318
- package/srcSwift/Sources/GearN/runtime/entity/models/MultiplayerModels.swift +0 -319
- package/srcSwift/Sources/GearN/runtime/entity/models/MultiplayerRequestModels.swift +0 -125
- package/srcSwift/Sources/GearN/runtime/entity/models/MultiplayerResponseModels.swift +0 -45
- package/srcSwift/Sources/GearN/runtime/entity/models/StoreInventoryModels.swift +0 -633
- package/srcSwift/Sources/GearN/runtime/entity/models/StoreInventoryRequestModels.swift +0 -173
- package/srcSwift/Sources/GearN/runtime/entity/models/StoreInventoryResponseModels.swift +0 -61
- package/srcSwift/Sources/GearN/runtime/entity/request/CustomOperationRequest.swift +0 -42
- package/srcSwift/Sources/GearN/runtime/entity/response/CustomOperationResponse.swift +0 -49
- package/srcSwift/Sources/GearN/runtime/entity/response/GetAuthInfoResponse.swift +0 -43
- package/srcSwift/Sources/GearN/runtime/entity/response/HealthCheckResponse.swift +0 -86
- package/srcSwift/Sources/GearN/runtime/entity/response/UploadFileResponse.swift +0 -15
- package/srcSwift/Sources/GearN/runtime/helper/CodeHelper.swift +0 -107
- package/srcSwift/Sources/GearN/runtime/helper/ConverterService.swift +0 -98
- package/srcSwift/Sources/GearN/runtime/helper/EnumUtility.swift +0 -34
- package/srcSwift/Sources/GearN/runtime/helper/GNSupport.swift +0 -41
- package/srcSwift/Sources/GearN/runtime/helper/GNUtils.swift +0 -66
- package/srcSwift/Sources/GearN/runtime/helper/MessagePackConverterService.swift +0 -21
- package/srcSwift/Sources/GearN/runtime/helper/StorageService.swift +0 -29
- package/srcSwift/Sources/GearN/runtime/logger/GNDebug.swift +0 -33
- package/srcSwift/Sources/GearN/runtime/networking/AuthenticateStatus.swift +0 -24
- package/srcSwift/Sources/GearN/runtime/networking/IPeer.swift +0 -8
- package/srcSwift/Sources/GearN/runtime/networking/NetworkingPeer.swift +0 -368
- package/srcSwift/Sources/GearN/runtime/networking/OperationPending.swift +0 -81
- package/srcSwift/Sources/GearN/runtime/networking/PeerBase.swift +0 -228
- package/srcSwift/Sources/GearN/runtime/networking/handler/IServerEventHandler.swift +0 -20
- package/srcSwift/Sources/GearN/runtime/networking/http/HttpPeer.swift +0 -226
- package/srcSwift/Sources/GearN/runtime/networking/http/HttpTypes.swift +0 -24
- package/srcSwift/Sources/GearN/runtime/networking/http/NetworkingHttpPeerBase.swift +0 -13
- package/srcSwift/Sources/GearN/runtime/networking/http/NetworkingPeerUrlSession.swift +0 -125
- package/srcSwift/Sources/GearN/runtime/networking/request/NetRequest.swift +0 -19
- package/srcSwift/Sources/GearN/runtime/networking/response/NetResponse.swift +0 -13
- package/srcSwift/Sources/GearN/runtime/networking/socket/NetworkingPeerSocketIOClient.swift +0 -244
- package/srcSwift/Sources/GearN/runtime/networking/socket/NetworkingSocketPeerBase.swift +0 -59
- package/srcSwift/Sources/GearN/runtime/networking/socket/SocketPeer.swift +0 -136
- package/tsconfig-build.cocos.json +0 -31
- package/webpack.config.cocos.mjs +0 -78
|
@@ -0,0 +1,75 @@
|
|
|
1
|
+
# API Reference: AuthenticateApi
|
|
2
|
+
|
|
3
|
+
Player login (account, social, device id), register, refresh auth token.
|
|
4
|
+
|
|
5
|
+
Domain guide: [guides/AUTHENTICATE.md](../guides/AUTHENTICATE.md). DTO shapes: [dto/AUTHENTICATE.md](dto/AUTHENTICATE.md) hoặc grep [DTO_INDEX.md](DTO_INDEX.md).
|
|
6
|
+
|
|
7
|
+
## Namespaces
|
|
8
|
+
|
|
9
|
+
- `GNNetwork.authenticate` — `RequestRole.Client`
|
|
10
|
+
|
|
11
|
+
## Convention
|
|
12
|
+
|
|
13
|
+
Mỗi method dưới đây có 2 form — callback và `*Async()` Promise. Ưu tiên `*Async()`.
|
|
14
|
+
|
|
15
|
+
```ts
|
|
16
|
+
// Callback
|
|
17
|
+
GNNetwork.authenticate.<method>(requestData, onResponse?, overrideAuthToken?, overrideSecretKey?, customTags?, timeout?);
|
|
18
|
+
|
|
19
|
+
// Async
|
|
20
|
+
const res = await GNNetwork.authenticate.<method>Async(requestData, overrideAuthToken?, overrideSecretKey?, customTags?, timeout?);
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
Param chung:
|
|
24
|
+
|
|
25
|
+
| Param | Type | Optional | Notes |
|
|
26
|
+
|-------|------|----------|-------|
|
|
27
|
+
| `requestData` | domain-specific (xem bảng dưới) | no | Payload chính |
|
|
28
|
+
| `onResponse` | `Action1<TResponse>` | yes | Chỉ có ở callback form |
|
|
29
|
+
| `overrideAuthToken` | `string` | yes | Override `authToken` cache cho request này |
|
|
30
|
+
| `overrideSecretKey` | `string` | yes | Override secret key mặc định của route |
|
|
31
|
+
| `customTags` | `GNHashtable` | yes | Tags gắn vào request, backend có thể log/route |
|
|
32
|
+
| `timeout` | `number` | yes | Timeout giây; default = `OperationRequest.defaultTimeOut` |
|
|
33
|
+
|
|
34
|
+
Response class expose field: `returnCode`, `errorCode`, `invalidMembers`, `debugMessage`, `responseData`. Xem [ERROR_HANDLING.md](ERROR_HANDLING.md).
|
|
35
|
+
|
|
36
|
+
|
|
37
|
+
> `server` / `admin` namespace hiện tại không có method public — giữ để đối xứng API.
|
|
38
|
+
|
|
39
|
+
## Client methods (`GNNetwork.authenticate.*`)
|
|
40
|
+
|
|
41
|
+
| Method | Request DTO | Async form | Response class | Default Permission Rules |
|
|
42
|
+
|--------|-------------|------------|----------------|--------------------------|
|
|
43
|
+
| `loginByAccount` | `AuthenticateModels.LoginByAccountRequestData` | `loginByAccountAsync(...)` | `AuthenticateResponseModels.LoginByAccountOperationResponse` | `authenticate.loginByAccount.selfEnable` |
|
|
44
|
+
| `loginByAndroidDeviceId` | `AuthenticateModels.LoginByAndroidDeviceIdRequestData` | `loginByAndroidDeviceIdAsync(...)` | `AuthenticateResponseModels.LoginByAndroidDeviceIdOperationResponse` | `authenticate.loginByAndroidDeviceId.selfEnable` |
|
|
45
|
+
| `loginByApple` | `AuthenticateModels.LoginByAppleRequestData` | `loginByAppleAsync(...)` | `AuthenticateResponseModels.LoginByAppleOperationResponse` | `authenticate.loginByApple.selfEnable` |
|
|
46
|
+
| `loginByCustomDeviceId` | `AuthenticateModels.LoginByCustomDeviceIdRequestData` | `loginByCustomDeviceIdAsync(...)` | `AuthenticateResponseModels.LoginByCustomDeviceIdOperationResponse` | `authenticate.loginByCustomDeviceId.selfEnable` |
|
|
47
|
+
| `loginByCustomId` | `AuthenticateModels.LoginByCustomIdRequestData` | `loginByCustomIdAsync(...)` | `AuthenticateResponseModels.LoginByCustomIdOperationResponse` | `authenticate.loginByCustomId.selfEnable` |
|
|
48
|
+
| `loginByEditorDeviceId` | `AuthenticateModels.LoginByEditorDeviceIdRequestData` | `loginByEditorDeviceIdAsync(...)` | `AuthenticateResponseModels.LoginByEditorDeviceIdOperationResponse` | `authenticate.loginByEditorDeviceId.selfEnable` |
|
|
49
|
+
| `loginByFacebook` | `AuthenticateModels.LoginByFacebookRequestData` | `loginByFacebookAsync(...)` | `AuthenticateResponseModels.LoginByFacebookOperationResponse` | `authenticate.loginByFacebook.selfEnable` |
|
|
50
|
+
| `loginByGenericService` | `AuthenticateModels.LoginByGenericServiceRequestData` | `loginByGenericServiceAsync(...)` | `AuthenticateResponseModels.LoginByGenericServiceOperationResponse` | `authenticate.loginByGenericService.selfEnable` |
|
|
51
|
+
| `loginByGoogle` | `AuthenticateModels.LoginByGoogleRequestData` | `loginByGoogleAsync(...)` | `AuthenticateResponseModels.LoginByGoogleOperationResponse` | `authenticate.loginByGoogle.selfEnable` |
|
|
52
|
+
| `loginByGooglePlayGameService` | `AuthenticateModels.LoginByGooglePlayGameServiceRequestData` | `loginByGooglePlayGameServiceAsync(...)` | `AuthenticateResponseModels.LoginByGooglePlayGameServiceOperationResponse` | `authenticate.loginByGooglePlayGameService.selfEnable` |
|
|
53
|
+
| `loginByGameCenter` | `AuthenticateModels.LoginByGameCenterRequestData` | `loginByGameCenterAsync(...)` | `AuthenticateResponseModels.LoginByGameCenterOperationResponse` | `authenticate.loginByGameCenter.selfEnable` |
|
|
54
|
+
| `loginByiOSDeviceId` | `AuthenticateModels.LoginByiOSDeviceIdRequestData` | `loginByiOSDeviceIdAsync(...)` | `AuthenticateResponseModels.LoginByiOSDeviceIdOperationResponse` | `authenticate.loginByiOSDeviceId.selfEnable` |
|
|
55
|
+
| `loginByLinuxDeviceId` | `AuthenticateModels.LoginByLinuxDeviceIdRequestData` | `loginByLinuxDeviceIdAsync(...)` | `AuthenticateResponseModels.LoginByLinuxDeviceIdOperationResponse` | `authenticate.loginByLinuxDeviceId.selfEnable` |
|
|
56
|
+
| `loginByMacOSDeviceId` | `AuthenticateModels.LoginByMacOSDeviceIdRequestData` | `loginByMacOSDeviceIdAsync(...)` | `AuthenticateResponseModels.LoginByMacOSDeviceIdOperationResponse` | `authenticate.loginByMacOSDeviceId.selfEnable` |
|
|
57
|
+
| `loginByWindowsDeviceId` | `AuthenticateModels.LoginByWindowsDeviceIdRequestData` | `loginByWindowsDeviceIdAsync(...)` | `AuthenticateResponseModels.LoginByWindowsDeviceIdOperationResponse` | `authenticate.loginByWindowsDeviceId.selfEnable` |
|
|
58
|
+
| `loginByWindowsPhoneDeviceId` | `AuthenticateModels.LoginByWindowsPhoneDeviceIdRequestData` | `loginByWindowsPhoneDeviceIdAsync(...)` | `AuthenticateResponseModels.LoginByWindowsPhoneDeviceIdOperationResponse` | `authenticate.loginByWindowsPhoneDeviceId.selfEnable` |
|
|
59
|
+
| `registerAccount` | `AuthenticateModels.RegisterAccountRequestData` | `registerAccountAsync(...)` | `AuthenticateResponseModels.RegisterAccountOperationResponse` | `authenticate.registerAccount.selfEnable` |
|
|
60
|
+
| `refreshAuthToken` | `AuthenticateModels.RefreshAuthTokenRequestData` | `refreshAuthTokenAsync(...)` | `AuthenticateResponseModels.RefreshAuthTokenOperationResponse` | `authenticate.refreshAuthToken.selfEnable` |
|
|
61
|
+
|
|
62
|
+
|
|
63
|
+
|
|
64
|
+
|
|
65
|
+
## Ví dụ tối thiểu
|
|
66
|
+
|
|
67
|
+
```ts
|
|
68
|
+
import { GNNetwork, ReturnCode, ErrorCode } from "@xmobitea/gn-typescript-client";
|
|
69
|
+
|
|
70
|
+
// requestData: AuthenticateModels.LoginByAccountRequestData đã build theo dto/AUTHENTICATE.md
|
|
71
|
+
const res = await GNNetwork.authenticate.loginByAccountAsync(requestData);
|
|
72
|
+
if (res.returnCode !== ReturnCode.Ok) return;
|
|
73
|
+
if (res.errorCode !== ErrorCode.Ok) return;
|
|
74
|
+
// res.responseData có typed payload
|
|
75
|
+
```
|
|
@@ -0,0 +1,226 @@
|
|
|
1
|
+
# API Reference: CharacterPlayerApi
|
|
2
|
+
|
|
3
|
+
Character-level gameplay: profile, inventory relation, friend/group relation, statistics, currency, segments, tags.
|
|
4
|
+
|
|
5
|
+
Domain guide: [guides/CHARACTER_PLAYER.md](../guides/CHARACTER_PLAYER.md). DTO shapes: [dto/CHARACTER_PLAYER.md](dto/CHARACTER_PLAYER.md) hoặc grep [DTO_INDEX.md](DTO_INDEX.md).
|
|
6
|
+
|
|
7
|
+
## Namespaces
|
|
8
|
+
|
|
9
|
+
- `GNNetwork.characterPlayer` — `RequestRole.Client`
|
|
10
|
+
- `GNNetwork.characterPlayer.server` — `RequestRole.Server`
|
|
11
|
+
- `GNNetwork.characterPlayer.admin` — `RequestRole.Admin`
|
|
12
|
+
|
|
13
|
+
## Convention
|
|
14
|
+
|
|
15
|
+
Mỗi method dưới đây có 2 form — callback và `*Async()` Promise. Ưu tiên `*Async()`.
|
|
16
|
+
|
|
17
|
+
```ts
|
|
18
|
+
// Callback
|
|
19
|
+
GNNetwork.characterPlayer.<method>(requestData, onResponse?, overrideAuthToken?, overrideSecretKey?, customTags?, timeout?);
|
|
20
|
+
|
|
21
|
+
// Async
|
|
22
|
+
const res = await GNNetwork.characterPlayer.<method>Async(requestData, overrideAuthToken?, overrideSecretKey?, customTags?, timeout?);
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
Param chung:
|
|
26
|
+
|
|
27
|
+
| Param | Type | Optional | Notes |
|
|
28
|
+
|-------|------|----------|-------|
|
|
29
|
+
| `requestData` | domain-specific (xem bảng dưới) | no | Payload chính |
|
|
30
|
+
| `onResponse` | `Action1<TResponse>` | yes | Chỉ có ở callback form |
|
|
31
|
+
| `overrideAuthToken` | `string` | yes | Override `authToken` cache cho request này |
|
|
32
|
+
| `overrideSecretKey` | `string` | yes | Override secret key mặc định của route |
|
|
33
|
+
| `customTags` | `GNHashtable` | yes | Tags gắn vào request, backend có thể log/route |
|
|
34
|
+
| `timeout` | `number` | yes | Timeout giây; default = `OperationRequest.defaultTimeOut` |
|
|
35
|
+
|
|
36
|
+
Response class expose field: `returnCode`, `errorCode`, `invalidMembers`, `debugMessage`, `responseData`. Xem [ERROR_HANDLING.md](ERROR_HANDLING.md).
|
|
37
|
+
|
|
38
|
+
|
|
39
|
+
## Client methods (`GNNetwork.characterPlayer.*`)
|
|
40
|
+
|
|
41
|
+
| Method | Request DTO | Async form | Response class | Default Permission Rules | Permission Rules khi truyền `characterId` mà `gamePlayer` đang authenticated không phải là owner của `characterPlayer` này |
|
|
42
|
+
|--------|-------------|------------|----------------|--------------------------|----------------------------------------------------------------------------------------------------------------------|
|
|
43
|
+
| `addPlayerFriend` | `CharacterPlayerModels.AddPlayerFriendRequestData` | `addPlayerFriendAsync(...)` | `CharacterPlayerResponseModels.AddPlayerFriendOperationResponse` | `characterPlayer.addPlayerFriend.selfEnable` | `characterPlayer.addPlayerFriend.otherSelfEnable` |
|
|
44
|
+
| `addSegment` | `CharacterPlayerModels.AddSegmentRequestData` | `addSegmentAsync(...)` | `CharacterPlayerResponseModels.AddSegmentOperationResponse` | `characterPlayer.addSegment.selfEnable` | `characterPlayer.addSegment.otherSelfEnable` |
|
|
45
|
+
| `getAvatar` | `CharacterPlayerModels.GetAvatarRequestData` | `getAvatarAsync(...)` | `CharacterPlayerResponseModels.GetAvatarOperationResponse` | `characterPlayer.getAvatar.selfEnable` | `characterPlayer.getAvatar.otherSelfEnable` |
|
|
46
|
+
| `getCatalogId` | `CharacterPlayerModels.GetCatalogIdRequestData` | `getCatalogIdAsync(...)` | `CharacterPlayerResponseModels.GetCatalogIdOperationResponse` | `characterPlayer.getCatalogId.selfEnable` | `characterPlayer.getCatalogId.otherSelfEnable` |
|
|
47
|
+
| `getCountryCode` | `CharacterPlayerModels.GetCountryCodeRequestData` | `getCountryCodeAsync(...)` | `CharacterPlayerResponseModels.GetCountryCodeOperationResponse` | `characterPlayer.getCountryCode.selfEnable` | `characterPlayer.getCountryCode.otherSelfEnable` |
|
|
48
|
+
| `getCustomData` | `CharacterPlayerModels.GetCustomDataRequestData` | `getCustomDataAsync(...)` | `CharacterPlayerResponseModels.GetCustomDataOperationResponse` | `characterPlayer.getCustomData.selfEnable` | `characterPlayer.getCustomData.otherSelfEnable` |
|
|
49
|
+
| `getDisplayName` | `CharacterPlayerModels.GetDisplayNameRequestData` | `getDisplayNameAsync(...)` | `CharacterPlayerResponseModels.GetDisplayNameOperationResponse` | `characterPlayer.getDisplayName.selfEnable` | `characterPlayer.getDisplayName.otherSelfEnable` |
|
|
50
|
+
| `getFriendStatisticsLeaderboardAroundPlayer` | `CharacterPlayerModels.GetFriendStatisticsLeaderboardAroundPlayerRequestData` | `getFriendStatisticsLeaderboardAroundPlayerAsync(...)` | `CharacterPlayerResponseModels.GetFriendStatisticsLeaderboardAroundPlayerOperationResponse` | `characterPlayer.getFriendStatisticsLeaderboardAroundPlayer.selfEnable` | `characterPlayer.getFriendStatisticsLeaderboardAroundPlayer.otherSelfEnable` |
|
|
51
|
+
| `getFriendStatisticsLeaderboard` | `CharacterPlayerModels.GetFriendStatisticsLeaderboardRequestData` | `getFriendStatisticsLeaderboardAsync(...)` | `CharacterPlayerResponseModels.GetFriendStatisticsLeaderboardOperationResponse` | `characterPlayer.getFriendStatisticsLeaderboard.selfEnable` | `characterPlayer.getFriendStatisticsLeaderboard.otherSelfEnable` |
|
|
52
|
+
| `getIpAddressCreate` | `CharacterPlayerModels.GetIpAddressCreateRequestData` | `getIpAddressCreateAsync(...)` | `CharacterPlayerResponseModels.GetIpAddressCreateOperationResponse` | `characterPlayer.getIpAddressCreate.selfEnable` | `characterPlayer.getIpAddressCreate.otherSelfEnable` |
|
|
53
|
+
| `getOwner` | `CharacterPlayerModels.GetOwnerRequestData` | `getOwnerAsync(...)` | `CharacterPlayerResponseModels.GetOwnerOperationResponse` | `characterPlayer.getOwner.selfEnable` | `characterPlayer.getOwner.otherSelfEnable` |
|
|
54
|
+
| `getPlayerBan` | `CharacterPlayerModels.GetPlayerBanRequestData` | `getPlayerBanAsync(...)` | `CharacterPlayerResponseModels.GetPlayerBanOperationResponse` | `characterPlayer.getPlayerBan.selfEnable` | `characterPlayer.getPlayerBan.otherSelfEnable` |
|
|
55
|
+
| `getPlayerCurrency` | `CharacterPlayerModels.GetPlayerCurrencyRequestData` | `getPlayerCurrencyAsync(...)` | `CharacterPlayerResponseModels.GetPlayerCurrencyOperationResponse` | `characterPlayer.getPlayerCurrency.selfEnable` | `characterPlayer.getPlayerCurrency.otherSelfEnable` |
|
|
56
|
+
| `getPlayerData` | `CharacterPlayerModels.GetPlayerDataRequestData` | `getPlayerDataAsync(...)` | `CharacterPlayerResponseModels.GetPlayerDataOperationResponse` | `characterPlayer.getPlayerData.selfEnable` | `characterPlayer.getPlayerData.otherSelfEnable` |
|
|
57
|
+
| `getPlayerFriend` | `CharacterPlayerModels.GetPlayerFriendRequestData` | `getPlayerFriendAsync(...)` | `CharacterPlayerResponseModels.GetPlayerFriendOperationResponse` | `characterPlayer.getPlayerFriend.selfEnable` | `characterPlayer.getPlayerFriend.otherSelfEnable` |
|
|
58
|
+
| `getPlayerGroup` | `CharacterPlayerModels.GetPlayerGroupRequestData` | `getPlayerGroupAsync(...)` | `CharacterPlayerResponseModels.GetPlayerGroupOperationResponse` | `characterPlayer.getPlayerGroup.selfEnable` | `characterPlayer.getPlayerGroup.otherSelfEnable` |
|
|
59
|
+
| `getPlayerInformation` | `CharacterPlayerModels.GetPlayerInformationRequestData` | `getPlayerInformationAsync(...)` | `CharacterPlayerResponseModels.GetPlayerInformationOperationResponse` | `characterPlayer.getPlayerInformation.selfEnable` | `characterPlayer.getPlayerInformation.otherSelfEnable` |
|
|
60
|
+
| `getPlayerInventory` | `CharacterPlayerModels.GetPlayerInventoryRequestData` | `getPlayerInventoryAsync(...)` | `CharacterPlayerResponseModels.GetPlayerInventoryOperationResponse` | `characterPlayer.getPlayerInventory.selfEnable` | `characterPlayer.getPlayerInventory.otherSelfEnable` |
|
|
61
|
+
| `getPlayerStatistics` | `CharacterPlayerModels.GetPlayerStatisticsRequestData` | `getPlayerStatisticsAsync(...)` | `CharacterPlayerResponseModels.GetPlayerStatisticsOperationResponse` | `characterPlayer.getPlayerStatistics.selfEnable` | `characterPlayer.getPlayerStatistics.otherSelfEnable` |
|
|
62
|
+
| `getPlayersWithDisplayName` | `CharacterPlayerModels.GetPlayersWithDisplayNameRequestData` | `getPlayersWithDisplayNameAsync(...)` | `CharacterPlayerResponseModels.GetPlayersWithDisplayNameOperationResponse` | `characterPlayer.getPlayersWithDisplayName.otherSelfEnable` | |
|
|
63
|
+
| `getPlayersWithSegment` | `CharacterPlayerModels.GetPlayersWithSegmentRequestData` | `getPlayersWithSegmentAsync(...)` | `CharacterPlayerResponseModels.GetPlayersWithSegmentOperationResponse` | `characterPlayer.getPlayersWithSegment.otherSelfEnable` | |
|
|
64
|
+
| `getPlayersWithTag` | `CharacterPlayerModels.GetPlayersWithTagRequestData` | `getPlayersWithTagAsync(...)` | `CharacterPlayerResponseModels.GetPlayersWithTagOperationResponse` | `characterPlayer.getPlayersWithTag.otherSelfEnable` | |
|
|
65
|
+
| `getRemoveStatus` | `CharacterPlayerModels.GetRemoveStatusRequestData` | `getRemoveStatusAsync(...)` | `CharacterPlayerResponseModels.GetRemoveStatusOperationResponse` | `characterPlayer.getRemoveStatus.selfEnable` | `characterPlayer.getRemoveStatus.otherSelfEnable` |
|
|
66
|
+
| `getSegment` | `CharacterPlayerModels.GetSegmentRequestData` | `getSegmentAsync(...)` | `CharacterPlayerResponseModels.GetSegmentOperationResponse` | `characterPlayer.getSegment.selfEnable` | `characterPlayer.getSegment.otherSelfEnable` |
|
|
67
|
+
| `getStatisticsLeaderboardAroundPlayer` | `CharacterPlayerModels.GetStatisticsLeaderboardAroundPlayerRequestData` | `getStatisticsLeaderboardAroundPlayerAsync(...)` | `CharacterPlayerResponseModels.GetStatisticsLeaderboardAroundPlayerOperationResponse` | `characterPlayer.getStatisticsLeaderboardAroundPlayer.selfEnable` | `characterPlayer.getStatisticsLeaderboardAroundPlayer.otherSelfEnable` |
|
|
68
|
+
| `getStatisticsLeaderboard` | `CharacterPlayerModels.GetStatisticsLeaderboardRequestData` | `getStatisticsLeaderboardAsync(...)` | `CharacterPlayerResponseModels.GetStatisticsLeaderboardOperationResponse` | `characterPlayer.getStatisticsLeaderboard.otherSelfEnable` | |
|
|
69
|
+
| `getTag` | `CharacterPlayerModels.GetTagRequestData` | `getTagAsync(...)` | `CharacterPlayerResponseModels.GetTagOperationResponse` | `characterPlayer.getTag.selfEnable` | `characterPlayer.getTag.otherSelfEnable` |
|
|
70
|
+
| `getTsCreate` | `CharacterPlayerModels.GetTsCreateRequestData` | `getTsCreateAsync(...)` | `CharacterPlayerResponseModels.GetTsCreateOperationResponse` | `characterPlayer.getTsCreate.selfEnable` | `characterPlayer.getTsCreate.otherSelfEnable` |
|
|
71
|
+
| `getTsLastLogin` | `CharacterPlayerModels.GetTsLastLoginRequestData` | `getTsLastLoginAsync(...)` | `CharacterPlayerResponseModels.GetTsLastLoginOperationResponse` | `characterPlayer.getTsLastLogin.selfEnable` | `characterPlayer.getTsLastLogin.otherSelfEnable` |
|
|
72
|
+
| `createGroup` | `CharacterPlayerModels.CreateGroupRequestData` | `createGroupAsync(...)` | `CharacterPlayerResponseModels.CreateGroupOperationResponse` | `characterPlayer.createGroup.selfEnable` | `characterPlayer.createGroup.otherSelfEnable` |
|
|
73
|
+
| `createPlayerItem` | `CharacterPlayerModels.CreatePlayerItemRequestData` | `createPlayerItemAsync(...)` | `CharacterPlayerResponseModels.CreatePlayerItemOperationResponse` | `characterPlayer.createPlayerItem.selfEnable` | `characterPlayer.createPlayerItem.otherSelfEnable` |
|
|
74
|
+
| `joinGroup` | `CharacterPlayerModels.JoinGroupRequestData` | `joinGroupAsync(...)` | `CharacterPlayerResponseModels.JoinGroupOperationResponse` | `characterPlayer.joinGroup.selfEnable` | `characterPlayer.joinGroup.otherSelfEnable` |
|
|
75
|
+
| `leaveGroup` | `CharacterPlayerModels.LeaveGroupRequestData` | `leaveGroupAsync(...)` | `CharacterPlayerResponseModels.LeaveGroupOperationResponse` | `characterPlayer.leaveGroup.selfEnable` | `characterPlayer.leaveGroup.otherSelfEnable` |
|
|
76
|
+
| `removePlayerFriend` | `CharacterPlayerModels.RemovePlayerFriendRequestData` | `removePlayerFriendAsync(...)` | `CharacterPlayerResponseModels.RemovePlayerFriendOperationResponse` | `characterPlayer.removePlayerFriend.selfEnable` | `characterPlayer.removePlayerFriend.otherSelfEnable` |
|
|
77
|
+
| `removePlayerItem` | `CharacterPlayerModels.RemovePlayerItemRequestData` | `removePlayerItemAsync(...)` | `CharacterPlayerResponseModels.RemovePlayerItemOperationResponse` | `characterPlayer.removePlayerItem.selfEnable` | `characterPlayer.removePlayerItem.otherSelfEnable` |
|
|
78
|
+
| `removeSegment` | `CharacterPlayerModels.RemoveSegmentRequestData` | `removeSegmentAsync(...)` | `CharacterPlayerResponseModels.RemoveSegmentOperationResponse` | `characterPlayer.removeSegment.selfEnable` | `characterPlayer.removeSegment.otherSelfEnable` |
|
|
79
|
+
| `removeTag` | `CharacterPlayerModels.RemoveTagRequestData` | `removeTagAsync(...)` | `CharacterPlayerResponseModels.RemoveTagOperationResponse` | `characterPlayer.removeTag.selfEnable` | `characterPlayer.removeTag.otherSelfEnable` |
|
|
80
|
+
| `setAvatar` | `CharacterPlayerModels.SetAvatarRequestData` | `setAvatarAsync(...)` | `CharacterPlayerResponseModels.SetAvatarOperationResponse` | `characterPlayer.setAvatar.selfEnable` | `characterPlayer.setAvatar.otherSelfEnable` |
|
|
81
|
+
| `setCountryCode` | `CharacterPlayerModels.SetCountryCodeRequestData` | `setCountryCodeAsync(...)` | `CharacterPlayerResponseModels.SetCountryCodeOperationResponse` | `characterPlayer.setCountryCode.selfEnable` | `characterPlayer.setCountryCode.otherSelfEnable` |
|
|
82
|
+
| `setCustomData` | `CharacterPlayerModels.SetCustomDataRequestData` | `setCustomDataAsync(...)` | `CharacterPlayerResponseModels.SetCustomDataOperationResponse` | `characterPlayer.setCustomData.selfEnable` | `characterPlayer.setCustomData.otherSelfEnable` |
|
|
83
|
+
| `setDisplayName` | `CharacterPlayerModels.SetDisplayNameRequestData` | `setDisplayNameAsync(...)` | `CharacterPlayerResponseModels.SetDisplayNameOperationResponse` | `characterPlayer.setDisplayName.selfEnable` | `characterPlayer.setDisplayName.otherSelfEnable` |
|
|
84
|
+
| `setOwner` | `CharacterPlayerModels.SetOwnerRequestData` | `setOwnerAsync(...)` | `CharacterPlayerResponseModels.SetOwnerOperationResponse` | `characterPlayer.setOwner.selfEnable` | `characterPlayer.setOwner.otherSelfEnable` |
|
|
85
|
+
| `setPlayerBan` | `CharacterPlayerModels.SetPlayerBanRequestData` | `setPlayerBanAsync(...)` | `CharacterPlayerResponseModels.SetPlayerBanOperationResponse` | `characterPlayer.setPlayerBan.selfEnable` | `characterPlayer.setPlayerBan.otherSelfEnable` |
|
|
86
|
+
| `changePlayerCurrency` | `CharacterPlayerModels.ChangePlayerCurrencyRequestData` | `changePlayerCurrencyAsync(...)` | `CharacterPlayerResponseModels.ChangePlayerCurrencyOperationResponse` | `characterPlayer.changePlayerCurrency.selfEnable` | `characterPlayer.changePlayerCurrency.otherSelfEnable` |
|
|
87
|
+
| `setPlayerData` | `CharacterPlayerModels.SetPlayerDataRequestData` | `setPlayerDataAsync(...)` | `CharacterPlayerResponseModels.SetPlayerDataOperationResponse` | `characterPlayer.setPlayerData.selfEnable` | `characterPlayer.setPlayerData.otherSelfEnable` |
|
|
88
|
+
| `changePlayerStatistics` | `CharacterPlayerModels.ChangePlayerStatisticsRequestData` | `changePlayerStatisticsAsync(...)` | `CharacterPlayerResponseModels.ChangePlayerStatisticsOperationResponse` | `characterPlayer.changePlayerStatistics.selfEnable` | `characterPlayer.changePlayerStatistics.otherSelfEnable` |
|
|
89
|
+
| `setRemoveStatus` | `CharacterPlayerModels.SetRemoveStatusRequestData` | `setRemoveStatusAsync(...)` | `CharacterPlayerResponseModels.SetRemoveStatusOperationResponse` | `characterPlayer.setRemoveStatus.selfEnable` | `characterPlayer.setRemoveStatus.otherSelfEnable` |
|
|
90
|
+
| `setTag` | `CharacterPlayerModels.SetTagRequestData` | `setTagAsync(...)` | `CharacterPlayerResponseModels.SetTagOperationResponse` | `characterPlayer.setTag.selfEnable` | `characterPlayer.setTag.otherSelfEnable` |
|
|
91
|
+
| `getCurrencyLeaderboard` | `CharacterPlayerModels.GetCurrencyLeaderboardRequestData` | `getCurrencyLeaderboardAsync(...)` | `CharacterPlayerResponseModels.GetCurrencyLeaderboardOperationResponse` | `characterPlayer.getCurrencyLeaderboard.otherSelfEnable` | |
|
|
92
|
+
| `getCreateLeaderboard` | `CharacterPlayerModels.GetCreateLeaderboardRequestData` | `getCreateLeaderboardAsync(...)` | `CharacterPlayerResponseModels.GetCreateLeaderboardOperationResponse` | `characterPlayer.getCreateLeaderboard.otherSelfEnable` | |
|
|
93
|
+
| `getLastLoginLeaderboard` | `CharacterPlayerModels.GetLastLoginLeaderboardRequestData` | `getLastLoginLeaderboardAsync(...)` | `CharacterPlayerResponseModels.GetLastLoginLeaderboardOperationResponse` | `characterPlayer.getLastLoginLeaderboard.otherSelfEnable` | |
|
|
94
|
+
| `getStatisticsLog` | `CharacterPlayerModels.GetStatisticsLogRequestData` | `getStatisticsLogAsync(...)` | `CharacterPlayerResponseModels.GetStatisticsLogOperationResponse` | `characterPlayer.getStatisticsLog.selfEnable` | `characterPlayer.getStatisticsLog.otherSelfEnable` |
|
|
95
|
+
| `getCurrencyLog` | `CharacterPlayerModels.GetCurrencyLogRequestData` | `getCurrencyLogAsync(...)` | `CharacterPlayerResponseModels.GetCurrencyLogOperationResponse` | `characterPlayer.getCurrencyLog.selfEnable` | `characterPlayer.getCurrencyLog.otherSelfEnable` |
|
|
96
|
+
|
|
97
|
+
|
|
98
|
+
## Server methods (`GNNetwork.characterPlayer.server.*`)
|
|
99
|
+
|
|
100
|
+
| Method | Request DTO | Async form | Response class | Default Permission Rules |
|
|
101
|
+
|--------|-------------|------------|----------------|--------------------------|
|
|
102
|
+
| `addPlayerFriend` | `CharacterPlayerModels.AddPlayerFriendRequestData` | `addPlayerFriendAsync(...)` | `CharacterPlayerResponseModels.AddPlayerFriendOperationResponse` | `characterPlayer.addPlayerFriend.selfEnable`, nếu dùng `characterId` thì cần rules `characterPlayer.addPlayerFriend.otherSelfEnable` |
|
|
103
|
+
| `addSegment` | `CharacterPlayerModels.AddSegmentRequestData` | `addSegmentAsync(...)` | `CharacterPlayerResponseModels.AddSegmentOperationResponse` | `characterPlayer.addSegment.selfEnable`, nếu dùng `characterId` thì cần rules `characterPlayer.addSegment.otherSelfEnable` |
|
|
104
|
+
| `getAvatar` | `CharacterPlayerModels.GetAvatarRequestData` | `getAvatarAsync(...)` | `CharacterPlayerResponseModels.GetAvatarOperationResponse` | `characterPlayer.getAvatar.selfEnable`, nếu dùng `characterId` thì cần rules `characterPlayer.getAvatar.otherSelfEnable` |
|
|
105
|
+
| `getCatalogId` | `CharacterPlayerModels.GetCatalogIdRequestData` | `getCatalogIdAsync(...)` | `CharacterPlayerResponseModels.GetCatalogIdOperationResponse` | `characterPlayer.getCatalogId.selfEnable`, nếu dùng `characterId` thì cần rules `characterPlayer.getCatalogId.otherSelfEnable` |
|
|
106
|
+
| `getCountryCode` | `CharacterPlayerModels.GetCountryCodeRequestData` | `getCountryCodeAsync(...)` | `CharacterPlayerResponseModels.GetCountryCodeOperationResponse` | `characterPlayer.getCountryCode.selfEnable`, nếu dùng `characterId` thì cần rules `characterPlayer.getCountryCode.otherSelfEnable` |
|
|
107
|
+
| `getCustomData` | `CharacterPlayerModels.GetCustomDataRequestData` | `getCustomDataAsync(...)` | `CharacterPlayerResponseModels.GetCustomDataOperationResponse` | `characterPlayer.getCustomData.selfEnable`, nếu dùng `characterId` thì cần rules `characterPlayer.getCustomData.otherSelfEnable` |
|
|
108
|
+
| `getDisplayName` | `CharacterPlayerModels.GetDisplayNameRequestData` | `getDisplayNameAsync(...)` | `CharacterPlayerResponseModels.GetDisplayNameOperationResponse` | `characterPlayer.getDisplayName.selfEnable`, nếu dùng `characterId` thì cần rules `characterPlayer.getDisplayName.otherSelfEnable` |
|
|
109
|
+
| `getFriendStatisticsLeaderboardAroundPlayer` | `CharacterPlayerModels.GetFriendStatisticsLeaderboardAroundPlayerRequestData` | `getFriendStatisticsLeaderboardAroundPlayerAsync(...)` | `CharacterPlayerResponseModels.GetFriendStatisticsLeaderboardAroundPlayerOperationResponse` | `characterPlayer.getFriendStatisticsLeaderboardAroundPlayer.selfEnable`, nếu dùng `characterId` thì cần rules `characterPlayer.getFriendStatisticsLeaderboardAroundPlayer.otherSelfEnable` |
|
|
110
|
+
| `getFriendStatisticsLeaderboard` | `CharacterPlayerModels.GetFriendStatisticsLeaderboardRequestData` | `getFriendStatisticsLeaderboardAsync(...)` | `CharacterPlayerResponseModels.GetFriendStatisticsLeaderboardOperationResponse` | `characterPlayer.getFriendStatisticsLeaderboard.selfEnable`, nếu dùng `characterId` thì cần rules `characterPlayer.getFriendStatisticsLeaderboard.otherSelfEnable` |
|
|
111
|
+
| `getIpAddressCreate` | `CharacterPlayerModels.GetIpAddressCreateRequestData` | `getIpAddressCreateAsync(...)` | `CharacterPlayerResponseModels.GetIpAddressCreateOperationResponse` | `characterPlayer.getIpAddressCreate.selfEnable`, nếu dùng `characterId` thì cần rules `characterPlayer.getIpAddressCreate.otherSelfEnable` |
|
|
112
|
+
| `getOwner` | `CharacterPlayerModels.GetOwnerRequestData` | `getOwnerAsync(...)` | `CharacterPlayerResponseModels.GetOwnerOperationResponse` | `characterPlayer.getOwner.selfEnable`, nếu dùng `characterId` thì cần rules `characterPlayer.getOwner.otherSelfEnable` |
|
|
113
|
+
| `getPlayerBan` | `CharacterPlayerModels.GetPlayerBanRequestData` | `getPlayerBanAsync(...)` | `CharacterPlayerResponseModels.GetPlayerBanOperationResponse` | `characterPlayer.getPlayerBan.selfEnable`, nếu dùng `characterId` thì cần rules `characterPlayer.getPlayerBan.otherSelfEnable` |
|
|
114
|
+
| `getPlayerCurrency` | `CharacterPlayerModels.GetPlayerCurrencyRequestData` | `getPlayerCurrencyAsync(...)` | `CharacterPlayerResponseModels.GetPlayerCurrencyOperationResponse` | `characterPlayer.getPlayerCurrency.selfEnable`, nếu dùng `characterId` thì cần rules `characterPlayer.getPlayerCurrency.otherSelfEnable` |
|
|
115
|
+
| `getPlayerData` | `CharacterPlayerModels.GetPlayerDataRequestData` | `getPlayerDataAsync(...)` | `CharacterPlayerResponseModels.GetPlayerDataOperationResponse` | `characterPlayer.getPlayerData.selfEnable`, nếu dùng `characterId` thì cần rules `characterPlayer.getPlayerData.otherSelfEnable` |
|
|
116
|
+
| `getPlayerFriend` | `CharacterPlayerModels.GetPlayerFriendRequestData` | `getPlayerFriendAsync(...)` | `CharacterPlayerResponseModels.GetPlayerFriendOperationResponse` | `characterPlayer.getPlayerFriend.selfEnable`, nếu dùng `characterId` thì cần rules `characterPlayer.getPlayerFriend.otherSelfEnable` |
|
|
117
|
+
| `getPlayerGroup` | `CharacterPlayerModels.GetPlayerGroupRequestData` | `getPlayerGroupAsync(...)` | `CharacterPlayerResponseModels.GetPlayerGroupOperationResponse` | `characterPlayer.getPlayerGroup.selfEnable`, nếu dùng `characterId` thì cần rules `characterPlayer.getPlayerGroup.otherSelfEnable` |
|
|
118
|
+
| `getPlayerInformation` | `CharacterPlayerModels.GetPlayerInformationRequestData` | `getPlayerInformationAsync(...)` | `CharacterPlayerResponseModels.GetPlayerInformationOperationResponse` | `characterPlayer.getPlayerInformation.selfEnable`, nếu dùng `characterId` thì cần rules `characterPlayer.getPlayerInformation.otherSelfEnable` |
|
|
119
|
+
| `getPlayerInventory` | `CharacterPlayerModels.GetPlayerInventoryRequestData` | `getPlayerInventoryAsync(...)` | `CharacterPlayerResponseModels.GetPlayerInventoryOperationResponse` | `characterPlayer.getPlayerInventory.selfEnable`, nếu dùng `characterId` thì cần rules `characterPlayer.getPlayerInventory.otherSelfEnable` |
|
|
120
|
+
| `getPlayerStatistics` | `CharacterPlayerModels.GetPlayerStatisticsRequestData` | `getPlayerStatisticsAsync(...)` | `CharacterPlayerResponseModels.GetPlayerStatisticsOperationResponse` | `characterPlayer.getPlayerStatistics.selfEnable`, nếu dùng `characterId` thì cần rules `characterPlayer.getPlayerStatistics.otherSelfEnable` |
|
|
121
|
+
| `getPlayersWithDisplayName` | `CharacterPlayerModels.GetPlayersWithDisplayNameRequestData` | `getPlayersWithDisplayNameAsync(...)` | `CharacterPlayerResponseModels.GetPlayersWithDisplayNameOperationResponse` | `characterPlayer.getPlayersWithDisplayName.selfEnable`, nếu dùng `characterId` thì cần rules `characterPlayer.getPlayersWithDisplayName.otherSelfEnable` |
|
|
122
|
+
| `getPlayersWithSegment` | `CharacterPlayerModels.GetPlayersWithSegmentRequestData` | `getPlayersWithSegmentAsync(...)` | `CharacterPlayerResponseModels.GetPlayersWithSegmentOperationResponse` | `characterPlayer.getPlayersWithSegment.selfEnable`, nếu dùng `characterId` thì cần rules `characterPlayer.getPlayersWithSegment.otherSelfEnable` |
|
|
123
|
+
| `getPlayersWithTag` | `CharacterPlayerModels.GetPlayersWithTagRequestData` | `getPlayersWithTagAsync(...)` | `CharacterPlayerResponseModels.GetPlayersWithTagOperationResponse` | `characterPlayer.getPlayersWithTag.selfEnable`, nếu dùng `characterId` thì cần rules `characterPlayer.getPlayersWithTag.otherSelfEnable` |
|
|
124
|
+
| `getRemoveStatus` | `CharacterPlayerModels.GetRemoveStatusRequestData` | `getRemoveStatusAsync(...)` | `CharacterPlayerResponseModels.GetRemoveStatusOperationResponse` | `characterPlayer.getRemoveStatus.selfEnable`, nếu dùng `characterId` thì cần rules `characterPlayer.getRemoveStatus.otherSelfEnable` |
|
|
125
|
+
| `getSegment` | `CharacterPlayerModels.GetSegmentRequestData` | `getSegmentAsync(...)` | `CharacterPlayerResponseModels.GetSegmentOperationResponse` | `characterPlayer.getSegment.selfEnable`, nếu dùng `characterId` thì cần rules `characterPlayer.getSegment.otherSelfEnable` |
|
|
126
|
+
| `getStatisticsLeaderboardAroundPlayer` | `CharacterPlayerModels.GetStatisticsLeaderboardAroundPlayerRequestData` | `getStatisticsLeaderboardAroundPlayerAsync(...)` | `CharacterPlayerResponseModels.GetStatisticsLeaderboardAroundPlayerOperationResponse` | `characterPlayer.getStatisticsLeaderboardAroundPlayer.selfEnable`, nếu dùng `characterId` thì cần rules `characterPlayer.getStatisticsLeaderboardAroundPlayer.otherSelfEnable` |
|
|
127
|
+
| `getStatisticsLeaderboard` | `CharacterPlayerModels.GetStatisticsLeaderboardRequestData` | `getStatisticsLeaderboardAsync(...)` | `CharacterPlayerResponseModels.GetStatisticsLeaderboardOperationResponse` | `characterPlayer.getStatisticsLeaderboard.selfEnable`, nếu dùng `characterId` thì cần rules `characterPlayer.getStatisticsLeaderboard.otherSelfEnable` |
|
|
128
|
+
| `getTag` | `CharacterPlayerModels.GetTagRequestData` | `getTagAsync(...)` | `CharacterPlayerResponseModels.GetTagOperationResponse` | `characterPlayer.getTag.selfEnable`, nếu dùng `characterId` thì cần rules `characterPlayer.getTag.otherSelfEnable` |
|
|
129
|
+
| `getTsCreate` | `CharacterPlayerModels.GetTsCreateRequestData` | `getTsCreateAsync(...)` | `CharacterPlayerResponseModels.GetTsCreateOperationResponse` | `characterPlayer.getTsCreate.selfEnable`, nếu dùng `characterId` thì cần rules `characterPlayer.getTsCreate.otherSelfEnable` |
|
|
130
|
+
| `getTsLastLogin` | `CharacterPlayerModels.GetTsLastLoginRequestData` | `getTsLastLoginAsync(...)` | `CharacterPlayerResponseModels.GetTsLastLoginOperationResponse` | `characterPlayer.getTsLastLogin.selfEnable`, nếu dùng `characterId` thì cần rules `characterPlayer.getTsLastLogin.otherSelfEnable` |
|
|
131
|
+
| `createGroup` | `CharacterPlayerModels.CreateGroupRequestData` | `createGroupAsync(...)` | `CharacterPlayerResponseModels.CreateGroupOperationResponse` | `characterPlayer.createGroup.selfEnable`, nếu dùng `characterId` thì cần rules `characterPlayer.createGroup.otherSelfEnable` |
|
|
132
|
+
| `createPlayerItem` | `CharacterPlayerModels.CreatePlayerItemRequestData` | `createPlayerItemAsync(...)` | `CharacterPlayerResponseModels.CreatePlayerItemOperationResponse` | `characterPlayer.createPlayerItem.selfEnable`, nếu dùng `characterId` thì cần rules `characterPlayer.createPlayerItem.otherSelfEnable` |
|
|
133
|
+
| `joinGroup` | `CharacterPlayerModels.JoinGroupRequestData` | `joinGroupAsync(...)` | `CharacterPlayerResponseModels.JoinGroupOperationResponse` | `characterPlayer.joinGroup.selfEnable`, nếu dùng `characterId` thì cần rules `characterPlayer.joinGroup.otherSelfEnable` |
|
|
134
|
+
| `leaveGroup` | `CharacterPlayerModels.LeaveGroupRequestData` | `leaveGroupAsync(...)` | `CharacterPlayerResponseModels.LeaveGroupOperationResponse` | `characterPlayer.leaveGroup.selfEnable`, nếu dùng `characterId` thì cần rules `characterPlayer.leaveGroup.otherSelfEnable` |
|
|
135
|
+
| `removePlayerFriend` | `CharacterPlayerModels.RemovePlayerFriendRequestData` | `removePlayerFriendAsync(...)` | `CharacterPlayerResponseModels.RemovePlayerFriendOperationResponse` | `characterPlayer.removePlayerFriend.selfEnable`, nếu dùng `characterId` thì cần rules `characterPlayer.removePlayerFriend.otherSelfEnable` |
|
|
136
|
+
| `removePlayerItem` | `CharacterPlayerModels.RemovePlayerItemRequestData` | `removePlayerItemAsync(...)` | `CharacterPlayerResponseModels.RemovePlayerItemOperationResponse` | `characterPlayer.removePlayerItem.selfEnable`, nếu dùng `characterId` thì cần rules `characterPlayer.removePlayerItem.otherSelfEnable` |
|
|
137
|
+
| `removeSegment` | `CharacterPlayerModels.RemoveSegmentRequestData` | `removeSegmentAsync(...)` | `CharacterPlayerResponseModels.RemoveSegmentOperationResponse` | `characterPlayer.removeSegment.selfEnable`, nếu dùng `characterId` thì cần rules `characterPlayer.removeSegment.otherSelfEnable` |
|
|
138
|
+
| `removeTag` | `CharacterPlayerModels.RemoveTagRequestData` | `removeTagAsync(...)` | `CharacterPlayerResponseModels.RemoveTagOperationResponse` | `characterPlayer.removeTag.selfEnable`, nếu dùng `characterId` thì cần rules `characterPlayer.removeTag.otherSelfEnable` |
|
|
139
|
+
| `setAvatar` | `CharacterPlayerModels.SetAvatarRequestData` | `setAvatarAsync(...)` | `CharacterPlayerResponseModels.SetAvatarOperationResponse` | `characterPlayer.setAvatar.selfEnable`, nếu dùng `characterId` thì cần rules `characterPlayer.setAvatar.otherSelfEnable` |
|
|
140
|
+
| `setCountryCode` | `CharacterPlayerModels.SetCountryCodeRequestData` | `setCountryCodeAsync(...)` | `CharacterPlayerResponseModels.SetCountryCodeOperationResponse` | `characterPlayer.setCountryCode.selfEnable`, nếu dùng `characterId` thì cần rules `characterPlayer.setCountryCode.otherSelfEnable` |
|
|
141
|
+
| `setCustomData` | `CharacterPlayerModels.SetCustomDataRequestData` | `setCustomDataAsync(...)` | `CharacterPlayerResponseModels.SetCustomDataOperationResponse` | `characterPlayer.setCustomData.selfEnable`, nếu dùng `characterId` thì cần rules `characterPlayer.setCustomData.otherSelfEnable` |
|
|
142
|
+
| `setDisplayName` | `CharacterPlayerModels.SetDisplayNameRequestData` | `setDisplayNameAsync(...)` | `CharacterPlayerResponseModels.SetDisplayNameOperationResponse` | `characterPlayer.setDisplayName.selfEnable`, nếu dùng `characterId` thì cần rules `characterPlayer.setDisplayName.otherSelfEnable` |
|
|
143
|
+
| `setOwner` | `CharacterPlayerModels.SetOwnerRequestData` | `setOwnerAsync(...)` | `CharacterPlayerResponseModels.SetOwnerOperationResponse` | `characterPlayer.setOwner.selfEnable`, nếu dùng `characterId` thì cần rules `characterPlayer.setOwner.otherSelfEnable` |
|
|
144
|
+
| `setPlayerBan` | `CharacterPlayerModels.SetPlayerBanRequestData` | `setPlayerBanAsync(...)` | `CharacterPlayerResponseModels.SetPlayerBanOperationResponse` | `characterPlayer.setPlayerBan.selfEnable`, nếu dùng `characterId` thì cần rules `characterPlayer.setPlayerBan.otherSelfEnable` |
|
|
145
|
+
| `changePlayerCurrency` | `CharacterPlayerModels.ChangePlayerCurrencyRequestData` | `changePlayerCurrencyAsync(...)` | `CharacterPlayerResponseModels.ChangePlayerCurrencyOperationResponse` | `characterPlayer.changePlayerCurrency.selfEnable`, nếu dùng `characterId` thì cần rules `characterPlayer.changePlayerCurrency.otherSelfEnable` |
|
|
146
|
+
| `setPlayerData` | `CharacterPlayerModels.SetPlayerDataRequestData` | `setPlayerDataAsync(...)` | `CharacterPlayerResponseModels.SetPlayerDataOperationResponse` | `characterPlayer.setPlayerData.selfEnable`, nếu dùng `characterId` thì cần rules `characterPlayer.setPlayerData.otherSelfEnable` |
|
|
147
|
+
| `changePlayerStatistics` | `CharacterPlayerModels.ChangePlayerStatisticsRequestData` | `changePlayerStatisticsAsync(...)` | `CharacterPlayerResponseModels.ChangePlayerStatisticsOperationResponse` | `characterPlayer.changePlayerStatistics.selfEnable`, nếu dùng `characterId` thì cần rules `characterPlayer.changePlayerStatistics.otherSelfEnable` |
|
|
148
|
+
| `setRemoveStatus` | `CharacterPlayerModels.SetRemoveStatusRequestData` | `setRemoveStatusAsync(...)` | `CharacterPlayerResponseModels.SetRemoveStatusOperationResponse` | `characterPlayer.setRemoveStatus.selfEnable`, nếu dùng `characterId` thì cần rules `characterPlayer.setRemoveStatus.otherSelfEnable` |
|
|
149
|
+
| `setTag` | `CharacterPlayerModels.SetTagRequestData` | `setTagAsync(...)` | `CharacterPlayerResponseModels.SetTagOperationResponse` | `characterPlayer.setTag.selfEnable`, nếu dùng `characterId` thì cần rules `characterPlayer.setTag.otherSelfEnable` |
|
|
150
|
+
| `getCurrencyLeaderboard` | `CharacterPlayerModels.GetCurrencyLeaderboardRequestData` | `getCurrencyLeaderboardAsync(...)` | `CharacterPlayerResponseModels.GetCurrencyLeaderboardOperationResponse` | `characterPlayer.getCurrencyLeaderboard.selfEnable`, nếu dùng `characterId` thì cần rules `characterPlayer.getCurrencyLeaderboard.otherSelfEnable` |
|
|
151
|
+
| `getCreateLeaderboard` | `CharacterPlayerModels.GetCreateLeaderboardRequestData` | `getCreateLeaderboardAsync(...)` | `CharacterPlayerResponseModels.GetCreateLeaderboardOperationResponse` | `characterPlayer.getCreateLeaderboard.selfEnable`, nếu dùng `characterId` thì cần rules `characterPlayer.getCreateLeaderboard.otherSelfEnable` |
|
|
152
|
+
| `getLastLoginLeaderboard` | `CharacterPlayerModels.GetLastLoginLeaderboardRequestData` | `getLastLoginLeaderboardAsync(...)` | `CharacterPlayerResponseModels.GetLastLoginLeaderboardOperationResponse` | `characterPlayer.getLastLoginLeaderboard.selfEnable`, nếu dùng `characterId` thì cần rules `characterPlayer.getLastLoginLeaderboard.otherSelfEnable` |
|
|
153
|
+
| `getStatisticsLog` | `CharacterPlayerModels.GetStatisticsLogRequestData` | `getStatisticsLogAsync(...)` | `CharacterPlayerResponseModels.GetStatisticsLogOperationResponse` | `characterPlayer.getStatisticsLog.selfEnable`, nếu dùng `characterId` thì cần rules `characterPlayer.getStatisticsLog.otherSelfEnable` |
|
|
154
|
+
| `getCurrencyLog` | `CharacterPlayerModels.GetCurrencyLogRequestData` | `getCurrencyLogAsync(...)` | `CharacterPlayerResponseModels.GetCurrencyLogOperationResponse` | `characterPlayer.getCurrencyLog.selfEnable`, nếu dùng `characterId` thì cần rules `characterPlayer.getCurrencyLog.otherSelfEnable` |
|
|
155
|
+
|
|
156
|
+
|
|
157
|
+
## Admin methods (`GNNetwork.characterPlayer.admin.*`)
|
|
158
|
+
|
|
159
|
+
| Method | Request DTO | Async form | Response class | Default Permission Rules |
|
|
160
|
+
|--------|-------------|------------|----------------|--------------------------|
|
|
161
|
+
| `addPlayerFriend` | `CharacterPlayerModels.AdminAddPlayerFriendRequestData` | `addPlayerFriendAsync(...)` | `CharacterPlayerResponseModels.AddPlayerFriendOperationResponse` | `characterPlayer.addPlayerFriend.adminSelfEnable` |
|
|
162
|
+
| `addSegment` | `CharacterPlayerModels.AdminAddSegmentRequestData` | `addSegmentAsync(...)` | `CharacterPlayerResponseModels.AddSegmentOperationResponse` | `characterPlayer.addSegment.adminSelfEnable` |
|
|
163
|
+
| `getAvatar` | `CharacterPlayerModels.AdminGetAvatarRequestData` | `getAvatarAsync(...)` | `CharacterPlayerResponseModels.GetAvatarOperationResponse` | `characterPlayer.getAvatar.adminSelfEnable` |
|
|
164
|
+
| `getCatalogId` | `CharacterPlayerModels.AdminGetCatalogIdRequestData` | `getCatalogIdAsync(...)` | `CharacterPlayerResponseModels.GetCatalogIdOperationResponse` | `characterPlayer.getCatalogId.adminSelfEnable` |
|
|
165
|
+
| `getCountryCode` | `CharacterPlayerModels.AdminGetCountryCodeRequestData` | `getCountryCodeAsync(...)` | `CharacterPlayerResponseModels.GetCountryCodeOperationResponse` | `characterPlayer.getCountryCode.adminSelfEnable` |
|
|
166
|
+
| `getCustomData` | `CharacterPlayerModels.AdminGetCustomDataRequestData` | `getCustomDataAsync(...)` | `CharacterPlayerResponseModels.GetCustomDataOperationResponse` | `characterPlayer.getCustomData.adminSelfEnable` |
|
|
167
|
+
| `getDisplayName` | `CharacterPlayerModels.AdminGetDisplayNameRequestData` | `getDisplayNameAsync(...)` | `CharacterPlayerResponseModels.GetDisplayNameOperationResponse` | `characterPlayer.getDisplayName.adminSelfEnable` |
|
|
168
|
+
| `getFriendStatisticsLeaderboardAroundPlayer` | `CharacterPlayerModels.AdminGetFriendStatisticsLeaderboardAroundPlayerRequestData` | `getFriendStatisticsLeaderboardAroundPlayerAsync(...)` | `CharacterPlayerResponseModels.GetFriendStatisticsLeaderboardAroundPlayerOperationResponse` | `characterPlayer.getFriendStatisticsLeaderboardAroundPlayer.adminSelfEnable` |
|
|
169
|
+
| `getFriendStatisticsLeaderboard` | `CharacterPlayerModels.AdminGetFriendStatisticsLeaderboardRequestData` | `getFriendStatisticsLeaderboardAsync(...)` | `CharacterPlayerResponseModels.GetFriendStatisticsLeaderboardOperationResponse` | `characterPlayer.getFriendStatisticsLeaderboard.adminSelfEnable` |
|
|
170
|
+
| `getIpAddressCreate` | `CharacterPlayerModels.AdminGetIpAddressCreateRequestData` | `getIpAddressCreateAsync(...)` | `CharacterPlayerResponseModels.GetIpAddressCreateOperationResponse` | `characterPlayer.getIpAddressCreate.adminSelfEnable` |
|
|
171
|
+
| `getOwner` | `CharacterPlayerModels.AdminGetOwnerRequestData` | `getOwnerAsync(...)` | `CharacterPlayerResponseModels.GetOwnerOperationResponse` | `characterPlayer.getOwner.adminSelfEnable` |
|
|
172
|
+
| `getPlayerBan` | `CharacterPlayerModels.AdminGetPlayerBanRequestData` | `getPlayerBanAsync(...)` | `CharacterPlayerResponseModels.GetPlayerBanOperationResponse` | `characterPlayer.getPlayerBan.adminSelfEnable` |
|
|
173
|
+
| `getPlayerCurrency` | `CharacterPlayerModels.AdminGetPlayerCurrencyRequestData` | `getPlayerCurrencyAsync(...)` | `CharacterPlayerResponseModels.GetPlayerCurrencyOperationResponse` | `characterPlayer.getPlayerCurrency.adminSelfEnable` |
|
|
174
|
+
| `getPlayerData` | `CharacterPlayerModels.AdminGetPlayerDataRequestData` | `getPlayerDataAsync(...)` | `CharacterPlayerResponseModels.GetPlayerDataOperationResponse` | `characterPlayer.getPlayerData.adminSelfEnable` |
|
|
175
|
+
| `getPlayerFriend` | `CharacterPlayerModels.AdminGetPlayerFriendRequestData` | `getPlayerFriendAsync(...)` | `CharacterPlayerResponseModels.GetPlayerFriendOperationResponse` | `characterPlayer.getPlayerFriend.adminSelfEnable` |
|
|
176
|
+
| `getPlayerGroup` | `CharacterPlayerModels.AdminGetPlayerGroupRequestData` | `getPlayerGroupAsync(...)` | `CharacterPlayerResponseModels.GetPlayerGroupOperationResponse` | `characterPlayer.getPlayerGroup.adminSelfEnable` |
|
|
177
|
+
| `getPlayerInformation` | `CharacterPlayerModels.AdminGetPlayerInformationRequestData` | `getPlayerInformationAsync(...)` | `CharacterPlayerResponseModels.GetPlayerInformationOperationResponse` | `characterPlayer.getPlayerInformation.adminSelfEnable` |
|
|
178
|
+
| `getPlayerInventory` | `CharacterPlayerModels.AdminGetPlayerInventoryRequestData` | `getPlayerInventoryAsync(...)` | `CharacterPlayerResponseModels.GetPlayerInventoryOperationResponse` | `characterPlayer.getPlayerInventory.adminSelfEnable` |
|
|
179
|
+
| `getPlayerStatistics` | `CharacterPlayerModels.AdminGetPlayerStatisticsRequestData` | `getPlayerStatisticsAsync(...)` | `CharacterPlayerResponseModels.GetPlayerStatisticsOperationResponse` | `characterPlayer.getPlayerStatistics.adminSelfEnable` |
|
|
180
|
+
| `getPlayersWithDisplayName` | `CharacterPlayerModels.AdminGetPlayersWithDisplayNameRequestData` | `getPlayersWithDisplayNameAsync(...)` | `CharacterPlayerResponseModels.GetPlayersWithDisplayNameOperationResponse` | `characterPlayer.getPlayersWithDisplayName.adminSelfEnable` |
|
|
181
|
+
| `getPlayersWithSegment` | `CharacterPlayerModels.AdminGetPlayersWithSegmentRequestData` | `getPlayersWithSegmentAsync(...)` | `CharacterPlayerResponseModels.GetPlayersWithSegmentOperationResponse` | `characterPlayer.getPlayersWithSegment.adminSelfEnable` |
|
|
182
|
+
| `getPlayersWithTag` | `CharacterPlayerModels.AdminGetPlayersWithTagRequestData` | `getPlayersWithTagAsync(...)` | `CharacterPlayerResponseModels.GetPlayersWithTagOperationResponse` | `characterPlayer.getPlayersWithTag.adminSelfEnable` |
|
|
183
|
+
| `getRemoveStatus` | `CharacterPlayerModels.AdminGetRemoveStatusRequestData` | `getRemoveStatusAsync(...)` | `CharacterPlayerResponseModels.GetRemoveStatusOperationResponse` | `characterPlayer.getRemoveStatus.adminSelfEnable` |
|
|
184
|
+
| `getSegment` | `CharacterPlayerModels.AdminGetSegmentRequestData` | `getSegmentAsync(...)` | `CharacterPlayerResponseModels.GetSegmentOperationResponse` | `characterPlayer.getSegment.adminSelfEnable` |
|
|
185
|
+
| `getStatisticsLeaderboardAroundPlayer` | `CharacterPlayerModels.AdminGetStatisticsLeaderboardAroundPlayerRequestData` | `getStatisticsLeaderboardAroundPlayerAsync(...)` | `CharacterPlayerResponseModels.GetStatisticsLeaderboardAroundPlayerOperationResponse` | `characterPlayer.getStatisticsLeaderboardAroundPlayer.adminSelfEnable` |
|
|
186
|
+
| `getStatisticsLeaderboard` | `CharacterPlayerModels.AdminGetStatisticsLeaderboardRequestData` | `getStatisticsLeaderboardAsync(...)` | `CharacterPlayerResponseModels.GetStatisticsLeaderboardOperationResponse` | `characterPlayer.getStatisticsLeaderboard.adminSelfEnable` |
|
|
187
|
+
| `getTag` | `CharacterPlayerModels.AdminGetTagRequestData` | `getTagAsync(...)` | `CharacterPlayerResponseModels.GetTagOperationResponse` | `characterPlayer.getTag.adminSelfEnable` |
|
|
188
|
+
| `getTsCreate` | `CharacterPlayerModels.AdminGetTsCreateRequestData` | `getTsCreateAsync(...)` | `CharacterPlayerResponseModels.GetTsCreateOperationResponse` | `characterPlayer.getTsCreate.adminSelfEnable` |
|
|
189
|
+
| `getTsLastLogin` | `CharacterPlayerModels.AdminGetTsLastLoginRequestData` | `getTsLastLoginAsync(...)` | `CharacterPlayerResponseModels.GetTsLastLoginOperationResponse` | `characterPlayer.getTsLastLogin.adminSelfEnable` |
|
|
190
|
+
| `createGroup` | `CharacterPlayerModels.AdminCreateGroupRequestData` | `createGroupAsync(...)` | `CharacterPlayerResponseModels.CreateGroupOperationResponse` | `characterPlayer.createGroup.adminSelfEnable` |
|
|
191
|
+
| `createPlayerItem` | `CharacterPlayerModels.AdminCreatePlayerItemRequestData` | `createPlayerItemAsync(...)` | `CharacterPlayerResponseModels.CreatePlayerItemOperationResponse` | `characterPlayer.createPlayerItem.adminSelfEnable` |
|
|
192
|
+
| `joinGroup` | `CharacterPlayerModels.AdminJoinGroupRequestData` | `joinGroupAsync(...)` | `CharacterPlayerResponseModels.JoinGroupOperationResponse` | `characterPlayer.joinGroup.adminSelfEnable` |
|
|
193
|
+
| `leaveGroup` | `CharacterPlayerModels.AdminLeaveGroupRequestData` | `leaveGroupAsync(...)` | `CharacterPlayerResponseModels.LeaveGroupOperationResponse` | `characterPlayer.leaveGroup.adminSelfEnable` |
|
|
194
|
+
| `removePlayerFriend` | `CharacterPlayerModels.AdminRemovePlayerFriendRequestData` | `removePlayerFriendAsync(...)` | `CharacterPlayerResponseModels.RemovePlayerFriendOperationResponse` | `characterPlayer.removePlayerFriend.adminSelfEnable` |
|
|
195
|
+
| `removePlayerItem` | `CharacterPlayerModels.AdminRemovePlayerItemRequestData` | `removePlayerItemAsync(...)` | `CharacterPlayerResponseModels.RemovePlayerItemOperationResponse` | `characterPlayer.removePlayerItem.adminSelfEnable` |
|
|
196
|
+
| `removeSegment` | `CharacterPlayerModels.AdminRemoveSegmentRequestData` | `removeSegmentAsync(...)` | `CharacterPlayerResponseModels.RemoveSegmentOperationResponse` | `characterPlayer.removeSegment.adminSelfEnable` |
|
|
197
|
+
| `removeTag` | `CharacterPlayerModels.AdminRemoveTagRequestData` | `removeTagAsync(...)` | `CharacterPlayerResponseModels.RemoveTagOperationResponse` | `characterPlayer.removeTag.adminSelfEnable` |
|
|
198
|
+
| `setAvatar` | `CharacterPlayerModels.AdminSetAvatarRequestData` | `setAvatarAsync(...)` | `CharacterPlayerResponseModels.SetAvatarOperationResponse` | `characterPlayer.setAvatar.adminSelfEnable` |
|
|
199
|
+
| `setCountryCode` | `CharacterPlayerModels.AdminSetCountryCodeRequestData` | `setCountryCodeAsync(...)` | `CharacterPlayerResponseModels.SetCountryCodeOperationResponse` | `characterPlayer.setCountryCode.adminSelfEnable` |
|
|
200
|
+
| `setCustomData` | `CharacterPlayerModels.AdminSetCustomDataRequestData` | `setCustomDataAsync(...)` | `CharacterPlayerResponseModels.SetCustomDataOperationResponse` | `characterPlayer.setCustomData.adminSelfEnable` |
|
|
201
|
+
| `setDisplayName` | `CharacterPlayerModels.AdminSetDisplayNameRequestData` | `setDisplayNameAsync(...)` | `CharacterPlayerResponseModels.SetDisplayNameOperationResponse` | `characterPlayer.setDisplayName.adminSelfEnable` |
|
|
202
|
+
| `setOwner` | `CharacterPlayerModels.AdminSetOwnerRequestData` | `setOwnerAsync(...)` | `CharacterPlayerResponseModels.SetOwnerOperationResponse` | `characterPlayer.setOwner.adminSelfEnable` |
|
|
203
|
+
| `setPlayerBan` | `CharacterPlayerModels.AdminSetPlayerBanRequestData` | `setPlayerBanAsync(...)` | `CharacterPlayerResponseModels.SetPlayerBanOperationResponse` | `characterPlayer.setPlayerBan.adminSelfEnable` |
|
|
204
|
+
| `changePlayerCurrency` | `CharacterPlayerModels.AdminChangePlayerCurrencyRequestData` | `changePlayerCurrencyAsync(...)` | `CharacterPlayerResponseModels.ChangePlayerCurrencyOperationResponse` | `characterPlayer.changePlayerCurrency.adminSelfEnable` |
|
|
205
|
+
| `setPlayerData` | `CharacterPlayerModels.AdminSetPlayerDataRequestData` | `setPlayerDataAsync(...)` | `CharacterPlayerResponseModels.SetPlayerDataOperationResponse` | `characterPlayer.setPlayerData.adminSelfEnable` |
|
|
206
|
+
| `changePlayerStatistics` | `CharacterPlayerModels.AdminChangePlayerStatisticsRequestData` | `changePlayerStatisticsAsync(...)` | `CharacterPlayerResponseModels.ChangePlayerStatisticsOperationResponse` | `characterPlayer.changePlayerStatistics.adminSelfEnable` |
|
|
207
|
+
| `setRemoveStatus` | `CharacterPlayerModels.AdminSetRemoveStatusRequestData` | `setRemoveStatusAsync(...)` | `CharacterPlayerResponseModels.SetRemoveStatusOperationResponse` | `characterPlayer.setRemoveStatus.adminSelfEnable` |
|
|
208
|
+
| `setTag` | `CharacterPlayerModels.AdminSetTagRequestData` | `setTagAsync(...)` | `CharacterPlayerResponseModels.SetTagOperationResponse` | `characterPlayer.setTag.adminSelfEnable` |
|
|
209
|
+
| `getCurrencyLeaderboard` | `CharacterPlayerModels.AdminGetCurrencyLeaderboardRequestData` | `getCurrencyLeaderboardAsync(...)` | `CharacterPlayerResponseModels.GetCurrencyLeaderboardOperationResponse` | `characterPlayer.getCurrencyLeaderboard.adminSelfEnable` |
|
|
210
|
+
| `getCreateLeaderboard` | `CharacterPlayerModels.AdminGetCreateLeaderboardRequestData` | `getCreateLeaderboardAsync(...)` | `CharacterPlayerResponseModels.GetCreateLeaderboardOperationResponse` | `characterPlayer.getCreateLeaderboard.adminSelfEnable` |
|
|
211
|
+
| `getLastLoginLeaderboard` | `CharacterPlayerModels.AdminGetLastLoginLeaderboardRequestData` | `getLastLoginLeaderboardAsync(...)` | `CharacterPlayerResponseModels.GetLastLoginLeaderboardOperationResponse` | `characterPlayer.getLastLoginLeaderboard.adminSelfEnable` |
|
|
212
|
+
| `getStatisticsLog` | `CharacterPlayerModels.AdminGetStatisticsLogRequestData` | `getStatisticsLogAsync(...)` | `CharacterPlayerResponseModels.GetStatisticsLogOperationResponse` | `characterPlayer.getStatisticsLog.adminSelfEnable` |
|
|
213
|
+
| `getCurrencyLog` | `CharacterPlayerModels.AdminGetCurrencyLogRequestData` | `getCurrencyLogAsync(...)` | `CharacterPlayerResponseModels.GetCurrencyLogOperationResponse` | `characterPlayer.getCurrencyLog.adminSelfEnable` |
|
|
214
|
+
|
|
215
|
+
|
|
216
|
+
## Ví dụ tối thiểu
|
|
217
|
+
|
|
218
|
+
```ts
|
|
219
|
+
import { GNNetwork, ReturnCode, ErrorCode } from "@xmobitea/gn-typescript-client";
|
|
220
|
+
|
|
221
|
+
// requestData: CharacterPlayerModels.AddPlayerFriendRequestData đã build theo dto/CHARACTER_PLAYER.md
|
|
222
|
+
const res = await GNNetwork.characterPlayer.addPlayerFriendAsync(requestData);
|
|
223
|
+
if (res.returnCode !== ReturnCode.Ok) return;
|
|
224
|
+
if (res.errorCode !== ErrorCode.Ok) return;
|
|
225
|
+
// res.responseData có typed payload
|
|
226
|
+
```
|
|
@@ -0,0 +1,82 @@
|
|
|
1
|
+
# API Reference: CloudScriptApi
|
|
2
|
+
|
|
3
|
+
CloudScript function add/edit/execute + version/listing.
|
|
4
|
+
|
|
5
|
+
Domain guide: [guides/CLOUDSCRIPT.md](../guides/CLOUDSCRIPT.md). DTO shapes: [dto/CLOUDSCRIPT.md](dto/CLOUDSCRIPT.md) hoặc grep [DTO_INDEX.md](DTO_INDEX.md).
|
|
6
|
+
|
|
7
|
+
## Namespaces
|
|
8
|
+
|
|
9
|
+
- `GNNetwork.cloudScript` — `RequestRole.Client`
|
|
10
|
+
- `GNNetwork.cloudScript.server` — `RequestRole.Server`
|
|
11
|
+
- `GNNetwork.cloudScript.admin` — `RequestRole.Admin`
|
|
12
|
+
|
|
13
|
+
## Convention
|
|
14
|
+
|
|
15
|
+
Mỗi method dưới đây có 2 form — callback và `*Async()` Promise. Ưu tiên `*Async()`.
|
|
16
|
+
|
|
17
|
+
```ts
|
|
18
|
+
// Callback
|
|
19
|
+
GNNetwork.cloudScript.<method>(requestData, onResponse?, overrideAuthToken?, overrideSecretKey?, customTags?, timeout?);
|
|
20
|
+
|
|
21
|
+
// Async
|
|
22
|
+
const res = await GNNetwork.cloudScript.<method>Async(requestData, overrideAuthToken?, overrideSecretKey?, customTags?, timeout?);
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
Param chung:
|
|
26
|
+
|
|
27
|
+
| Param | Type | Optional | Notes |
|
|
28
|
+
|-------|------|----------|-------|
|
|
29
|
+
| `requestData` | domain-specific (xem bảng dưới) | no | Payload chính |
|
|
30
|
+
| `onResponse` | `Action1<TResponse>` | yes | Chỉ có ở callback form |
|
|
31
|
+
| `overrideAuthToken` | `string` | yes | Override `authToken` cache cho request này |
|
|
32
|
+
| `overrideSecretKey` | `string` | yes | Override secret key mặc định của route |
|
|
33
|
+
| `customTags` | `GNHashtable` | yes | Tags gắn vào request, backend có thể log/route |
|
|
34
|
+
| `timeout` | `number` | yes | Timeout giây; default = `OperationRequest.defaultTimeOut` |
|
|
35
|
+
|
|
36
|
+
Response class expose field: `returnCode`, `errorCode`, `invalidMembers`, `debugMessage`, `responseData`. Xem [ERROR_HANDLING.md](ERROR_HANDLING.md).
|
|
37
|
+
|
|
38
|
+
|
|
39
|
+
## Client methods (`GNNetwork.cloudScript.*`)
|
|
40
|
+
|
|
41
|
+
| Method | Request DTO | Async form | Response class | Default Permission Rules | Permission Rules khi dùng userId |
|
|
42
|
+
|--------|-------------|------------|----------------|--------------------------|----------------------------------|
|
|
43
|
+
| `addFunction` | `CloudScriptModels.AddFunctionRequestData` | `addFunctionAsync(...)` | `CloudScriptResponseModels.AddFunctionOperationResponse` | `cloudScript.addFunction.otherSelfEnable` | |
|
|
44
|
+
| `editFunction` | `CloudScriptModels.EditFunctionRequestData` | `editFunctionAsync(...)` | `CloudScriptResponseModels.EditFunctionOperationResponse` | `cloudScript.editFunction.otherSelfEnable` | |
|
|
45
|
+
| `executeFunction` | `CloudScriptModels.ExecuteFunctionRequestData` | `executeFunctionAsync(...)` | `CloudScriptResponseModels.ExecuteFunctionOperationResponse` | `cloudScript.executeFunction.selfEnable` | `cloudScript.executeFunction.otherSelfEnable` |
|
|
46
|
+
| `getFunction` | `CloudScriptModels.GetFunctionRequestData` | `getFunctionAsync(...)` | `CloudScriptResponseModels.GetFunctionOperationResponse` | `cloudScript.getFunction.otherSelfEnable` | |
|
|
47
|
+
| `getFunctions` | `CloudScriptModels.GetFunctionsRequestData` | `getFunctionsAsync(...)` | `CloudScriptResponseModels.GetFunctionsOperationResponse` | `cloudScript.getFunctions.otherSelfEnable` | |
|
|
48
|
+
|
|
49
|
+
|
|
50
|
+
## Server methods (`GNNetwork.cloudScript.server.*`)
|
|
51
|
+
|
|
52
|
+
| Method | Request DTO | Async form | Response class | Default Permission Rules |
|
|
53
|
+
|--------|-------------|------------|----------------|--------------------------|
|
|
54
|
+
| `addFunction` | `CloudScriptModels.ServerAddFunctionRequestData` | `addFunctionAsync(...)` | `CloudScriptResponseModels.AddFunctionOperationResponse` | `cloudScript.addFunction.serverSelfEnable` |
|
|
55
|
+
| `editFunction` | `CloudScriptModels.ServerEditFunctionRequestData` | `editFunctionAsync(...)` | `CloudScriptResponseModels.EditFunctionOperationResponse` | `cloudScript.editFunction.serverSelfEnable` |
|
|
56
|
+
| `executeFunction` | `CloudScriptModels.ServerExecuteFunctionRequestData` | `executeFunctionAsync(...)` | `CloudScriptResponseModels.ExecuteFunctionOperationResponse` | `cloudScript.executeFunction.serverSelfEnable` |
|
|
57
|
+
| `getFunction` | `CloudScriptModels.ServerGetFunctionRequestData` | `getFunctionAsync(...)` | `CloudScriptResponseModels.GetFunctionOperationResponse` | `cloudScript.getFunction.serverSelfEnable` |
|
|
58
|
+
| `getFunctions` | `CloudScriptModels.ServerGetFunctionsRequestData` | `getFunctionsAsync(...)` | `CloudScriptResponseModels.GetFunctionsOperationResponse` | `cloudScript.getFunctions.serverSelfEnable` |
|
|
59
|
+
|
|
60
|
+
|
|
61
|
+
## Admin methods (`GNNetwork.cloudScript.admin.*`)
|
|
62
|
+
|
|
63
|
+
| Method | Request DTO | Async form | Response class | Default Permission Rules |
|
|
64
|
+
|--------|-------------|------------|----------------|--------------------------|
|
|
65
|
+
| `addFunction` | `CloudScriptModels.AdminAddFunctionRequestData` | `addFunctionAsync(...)` | `CloudScriptResponseModels.AddFunctionOperationResponse` | `cloudScript.addFunction.adminSelfEnable` |
|
|
66
|
+
| `editFunction` | `CloudScriptModels.AdminEditFunctionRequestData` | `editFunctionAsync(...)` | `CloudScriptResponseModels.EditFunctionOperationResponse` | `cloudScript.editFunction.adminSelfEnable` |
|
|
67
|
+
| `executeFunction` | `CloudScriptModels.AdminExecuteFunctionRequestData` | `executeFunctionAsync(...)` | `CloudScriptResponseModels.ExecuteFunctionOperationResponse` | `cloudScript.executeFunction.adminSelfEnable` |
|
|
68
|
+
| `getFunction` | `CloudScriptModels.AdminGetFunctionRequestData` | `getFunctionAsync(...)` | `CloudScriptResponseModels.GetFunctionOperationResponse` | `cloudScript.getFunction.adminSelfEnable` |
|
|
69
|
+
| `getFunctions` | `CloudScriptModels.AdminGetFunctionsRequestData` | `getFunctionsAsync(...)` | `CloudScriptResponseModels.GetFunctionsOperationResponse` | `cloudScript.getFunctions.adminSelfEnable` |
|
|
70
|
+
|
|
71
|
+
|
|
72
|
+
## Ví dụ tối thiểu
|
|
73
|
+
|
|
74
|
+
```ts
|
|
75
|
+
import { GNNetwork, ReturnCode, ErrorCode } from "@xmobitea/gn-typescript-client";
|
|
76
|
+
|
|
77
|
+
// requestData: CloudScriptModels.AddFunctionRequestData đã build theo dto/CLOUDSCRIPT.md
|
|
78
|
+
const res = await GNNetwork.cloudScript.addFunctionAsync(requestData);
|
|
79
|
+
if (res.returnCode !== ReturnCode.Ok) return;
|
|
80
|
+
if (res.errorCode !== ErrorCode.Ok) return;
|
|
81
|
+
// res.responseData có typed payload
|
|
82
|
+
```
|
|
@@ -0,0 +1,88 @@
|
|
|
1
|
+
# API Reference: ContentApi
|
|
2
|
+
|
|
3
|
+
Content data key-value, file upload info, download token.
|
|
4
|
+
|
|
5
|
+
Domain guide: [guides/CONTENT.md](../guides/CONTENT.md). DTO shapes: [dto/CONTENT.md](dto/CONTENT.md) hoặc grep [DTO_INDEX.md](DTO_INDEX.md).
|
|
6
|
+
|
|
7
|
+
## Namespaces
|
|
8
|
+
|
|
9
|
+
- `GNNetwork.content` — `RequestRole.Client`
|
|
10
|
+
- `GNNetwork.content.server` — `RequestRole.Server`
|
|
11
|
+
- `GNNetwork.content.admin` — `RequestRole.Admin`
|
|
12
|
+
|
|
13
|
+
## Convention
|
|
14
|
+
|
|
15
|
+
Mỗi method dưới đây có 2 form — callback và `*Async()` Promise. Ưu tiên `*Async()`.
|
|
16
|
+
|
|
17
|
+
```ts
|
|
18
|
+
// Callback
|
|
19
|
+
GNNetwork.content.<method>(requestData, onResponse?, overrideAuthToken?, overrideSecretKey?, customTags?, timeout?);
|
|
20
|
+
|
|
21
|
+
// Async
|
|
22
|
+
const res = await GNNetwork.content.<method>Async(requestData, overrideAuthToken?, overrideSecretKey?, customTags?, timeout?);
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
Param chung:
|
|
26
|
+
|
|
27
|
+
| Param | Type | Optional | Notes |
|
|
28
|
+
|-------|------|----------|-------|
|
|
29
|
+
| `requestData` | domain-specific (xem bảng dưới) | no | Payload chính |
|
|
30
|
+
| `onResponse` | `Action1<TResponse>` | yes | Chỉ có ở callback form |
|
|
31
|
+
| `overrideAuthToken` | `string` | yes | Override `authToken` cache cho request này |
|
|
32
|
+
| `overrideSecretKey` | `string` | yes | Override secret key mặc định của route |
|
|
33
|
+
| `customTags` | `GNHashtable` | yes | Tags gắn vào request, backend có thể log/route |
|
|
34
|
+
| `timeout` | `number` | yes | Timeout giây; default = `OperationRequest.defaultTimeOut` |
|
|
35
|
+
|
|
36
|
+
Response class expose field: `returnCode`, `errorCode`, `invalidMembers`, `debugMessage`, `responseData`. Xem [ERROR_HANDLING.md](ERROR_HANDLING.md).
|
|
37
|
+
|
|
38
|
+
|
|
39
|
+
## Client methods (`GNNetwork.content.*`)
|
|
40
|
+
|
|
41
|
+
| Method | Request DTO | Async form | Response class | Default Permission Rules |
|
|
42
|
+
|--------|-------------|------------|----------------|--------------------------|
|
|
43
|
+
| `createNewFileUploadInfo` | `ContentModels.CreateNewFileUploadInfoRequestData` | `createNewFileUploadInfoAsync(...)` | `ContentResponseModels.CreateNewFileUploadInfoOperationResponse` | `content.createNewFileUploadInfo.selfEnable` |
|
|
44
|
+
| `getContentData` | `ContentModels.GetContentDataRequestData` | `getContentDataAsync(...)` | `ContentResponseModels.GetContentDataOperationResponse` | `content.getContentData.otherSelfEnable` |
|
|
45
|
+
| `getFileUploadInfoList` | `ContentModels.GetFileUploadInfoListRequestData` | `getFileUploadInfoListAsync(...)` | `ContentResponseModels.GetFileUploadInfoListOperationResponse` | `content.getFileUploadInfoList.selfEnable` |
|
|
46
|
+
| `getFileUploadInfo` | `ContentModels.GetFileUploadInfoRequestData` | `getFileUploadInfoAsync(...)` | `ContentResponseModels.GetFileUploadInfoOperationResponse` | `content.getFileUploadInfo.selfEnable` |
|
|
47
|
+
| `removeFileUploadInfo` | `ContentModels.RemoveFileUploadInfoRequestData` | `removeFileUploadInfoAsync(...)` | `ContentResponseModels.RemoveFileUploadInfoOperationResponse` | `content.removeFileUploadInfo.selfEnable` |
|
|
48
|
+
| `requestDownloadFileUploadInfo` | `ContentModels.RequestDownloadFileUploadInfoRequestData` | `requestDownloadFileUploadInfoAsync(...)` | `ContentResponseModels.RequestDownloadFileUploadInfoOperationResponse` | `content.requestDownloadFileUploadInfo.otherSelfEnable` |
|
|
49
|
+
| `setContentData` | `ContentModels.SetContentDataRequestData` | `setContentDataAsync(...)` | `ContentResponseModels.SetContentDataOperationResponse` | `content.setContentData.otherSelfEnable` |
|
|
50
|
+
|
|
51
|
+
|
|
52
|
+
## Server methods (`GNNetwork.content.server.*`)
|
|
53
|
+
|
|
54
|
+
| Method | Request DTO | Async form | Response class | Default Permission Rules |
|
|
55
|
+
|--------|-------------|------------|----------------|--------------------------|
|
|
56
|
+
| `createNewFileUploadInfo` | `ContentModels.ServerCreateNewFileUploadInfoRequestData` | `createNewFileUploadInfoAsync(...)` | `ContentResponseModels.CreateNewFileUploadInfoOperationResponse` | `content.createNewFileUploadInfo.serverSelfEnable` |
|
|
57
|
+
| `getContentData` | `ContentModels.ServerGetContentDataRequestData` | `getContentDataAsync(...)` | `ContentResponseModels.GetContentDataOperationResponse` | `content.getContentData.serverSelfEnable` |
|
|
58
|
+
| `getFileUploadInfoList` | `ContentModels.ServerGetFileUploadInfoListRequestData` | `getFileUploadInfoListAsync(...)` | `ContentResponseModels.GetFileUploadInfoListOperationResponse` | `content.getFileUploadInfoList.serverSelfEnable` |
|
|
59
|
+
| `getFileUploadInfo` | `ContentModels.ServerGetFileUploadInfoRequestData` | `getFileUploadInfoAsync(...)` | `ContentResponseModels.GetFileUploadInfoOperationResponse` | `content.getFileUploadInfo.serverSelfEnable` |
|
|
60
|
+
| `removeFileUploadInfo` | `ContentModels.ServerRemoveFileUploadInfoRequestData` | `removeFileUploadInfoAsync(...)` | `ContentResponseModels.RemoveFileUploadInfoOperationResponse` | `content.removeFileUploadInfo.serverSelfEnable` |
|
|
61
|
+
| `requestDownloadFileUploadInfo` | `ContentModels.ServerRequestDownloadFileUploadInfoRequestData` | `requestDownloadFileUploadInfoAsync(...)` | `ContentResponseModels.RequestDownloadFileUploadInfoOperationResponse` | `content.requestDownloadFileUploadInfo.serverSelfEnable` |
|
|
62
|
+
| `setContentData` | `ContentModels.ServerSetContentDataRequestData` | `setContentDataAsync(...)` | `ContentResponseModels.SetContentDataOperationResponse` | `content.setContentData.serverSelfEnable` |
|
|
63
|
+
|
|
64
|
+
|
|
65
|
+
## Admin methods (`GNNetwork.content.admin.*`)
|
|
66
|
+
|
|
67
|
+
| Method | Request DTO | Async form | Response class | Default Permission Rules |
|
|
68
|
+
|--------|-------------|------------|----------------|--------------------------|
|
|
69
|
+
| `createNewFileUploadInfo` | `ContentModels.AdminCreateNewFileUploadInfoRequestData` | `createNewFileUploadInfoAsync(...)` | `ContentResponseModels.CreateNewFileUploadInfoOperationResponse` | `content.createNewFileUploadInfo.adminSelfEnable` |
|
|
70
|
+
| `getContentData` | `ContentModels.AdminGetContentDataRequestData` | `getContentDataAsync(...)` | `ContentResponseModels.GetContentDataOperationResponse` | `content.getContentData.adminSelfEnable` |
|
|
71
|
+
| `getFileUploadInfoList` | `ContentModels.AdminGetFileUploadInfoListRequestData` | `getFileUploadInfoListAsync(...)` | `ContentResponseModels.GetFileUploadInfoListOperationResponse` | `content.getFileUploadInfoList.adminSelfEnable` |
|
|
72
|
+
| `getFileUploadInfo` | `ContentModels.AdminGetFileUploadInfoRequestData` | `getFileUploadInfoAsync(...)` | `ContentResponseModels.GetFileUploadInfoOperationResponse` | `content.getFileUploadInfo.adminSelfEnable` |
|
|
73
|
+
| `removeFileUploadInfo` | `ContentModels.AdminRemoveFileUploadInfoRequestData` | `removeFileUploadInfoAsync(...)` | `ContentResponseModels.RemoveFileUploadInfoOperationResponse` | `content.removeFileUploadInfo.adminSelfEnable` |
|
|
74
|
+
| `requestDownloadFileUploadInfo` | `ContentModels.AdminRequestDownloadFileUploadInfoRequestData` | `requestDownloadFileUploadInfoAsync(...)` | `ContentResponseModels.RequestDownloadFileUploadInfoOperationResponse` | `content.requestDownloadFileUploadInfo.adminSelfEnable` |
|
|
75
|
+
| `setContentData` | `ContentModels.AdminSetContentDataRequestData` | `setContentDataAsync(...)` | `ContentResponseModels.SetContentDataOperationResponse` | `content.setContentData.adminSelfEnable` |
|
|
76
|
+
|
|
77
|
+
|
|
78
|
+
## Ví dụ tối thiểu
|
|
79
|
+
|
|
80
|
+
```ts
|
|
81
|
+
import { GNNetwork, ReturnCode, ErrorCode } from "@xmobitea/gn-typescript-client";
|
|
82
|
+
|
|
83
|
+
// requestData: ContentModels.CreateNewFileUploadInfoRequestData đã build theo dto/CONTENT.md
|
|
84
|
+
const res = await GNNetwork.content.createNewFileUploadInfoAsync(requestData);
|
|
85
|
+
if (res.returnCode !== ReturnCode.Ok) return;
|
|
86
|
+
if (res.errorCode !== ErrorCode.Ok) return;
|
|
87
|
+
// res.responseData có typed payload
|
|
88
|
+
```
|
|
@@ -0,0 +1,82 @@
|
|
|
1
|
+
# API Reference: DashboardApi
|
|
2
|
+
|
|
3
|
+
Admin login, game/admin account/secret management, analytics, server log, maintenance tools. Uses `RequestRole.Client` transport; admin context resolved from auth token.
|
|
4
|
+
|
|
5
|
+
Domain guide: [guides/DASHBOARD.md](../guides/DASHBOARD.md). DTO shapes: [dto/DASHBOARD.md](dto/DASHBOARD.md) hoặc grep [DTO_INDEX.md](DTO_INDEX.md).
|
|
6
|
+
|
|
7
|
+
## Namespaces
|
|
8
|
+
|
|
9
|
+
- `GNNetwork.dashboard` — `RequestRole.Client`
|
|
10
|
+
|
|
11
|
+
## Convention
|
|
12
|
+
|
|
13
|
+
Mỗi method dưới đây có 2 form — callback và `*Async()` Promise. Ưu tiên `*Async()`.
|
|
14
|
+
|
|
15
|
+
```ts
|
|
16
|
+
// Callback
|
|
17
|
+
GNNetwork.dashboard.<method>(requestData, onResponse?, overrideAuthToken?, overrideSecretKey?, customTags?, timeout?);
|
|
18
|
+
|
|
19
|
+
// Async
|
|
20
|
+
const res = await GNNetwork.dashboard.<method>Async(requestData, overrideAuthToken?, overrideSecretKey?, customTags?, timeout?);
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
Param chung:
|
|
24
|
+
|
|
25
|
+
| Param | Type | Optional | Notes |
|
|
26
|
+
|-------|------|----------|-------|
|
|
27
|
+
| `requestData` | domain-specific (xem bảng dưới) | no | Payload chính |
|
|
28
|
+
| `onResponse` | `Action1<TResponse>` | yes | Chỉ có ở callback form |
|
|
29
|
+
| `overrideAuthToken` | `string` | yes | Override `authToken` cache cho request này |
|
|
30
|
+
| `overrideSecretKey` | `string` | yes | Override secret key mặc định của route |
|
|
31
|
+
| `customTags` | `GNHashtable` | yes | Tags gắn vào request, backend có thể log/route |
|
|
32
|
+
| `timeout` | `number` | yes | Timeout giây; default = `OperationRequest.defaultTimeOut` |
|
|
33
|
+
|
|
34
|
+
Response class expose field: `returnCode`, `errorCode`, `invalidMembers`, `debugMessage`, `responseData`. Xem [ERROR_HANDLING.md](ERROR_HANDLING.md).
|
|
35
|
+
|
|
36
|
+
|
|
37
|
+
> `server` / `admin` namespace hiện tại không có method public — giữ để đối xứng API.
|
|
38
|
+
|
|
39
|
+
## Client methods (`GNNetwork.dashboard.*`)
|
|
40
|
+
|
|
41
|
+
| Method | Request DTO | Async form | Response class | Default Permission Rules |
|
|
42
|
+
|--------|-------------|------------|----------------|--------------------------|
|
|
43
|
+
| `changePasswordAdminAccount` | `DashboardModels.ChangePasswordAdminAccountRequestData` | `changePasswordAdminAccountAsync(...)` | `DashboardResponseModels.ChangePasswordAdminAccountOperationResponse` | `dashboard.changePasswordAdminAccount.selfEnable` |
|
|
44
|
+
| `getAdminAccountList` | `DashboardModels.GetAdminAccountListRequestData` | `getAdminAccountListAsync(...)` | `DashboardResponseModels.GetAdminAccountListOperationResponse` | `dashboard.getAdminAccountList.selfEnable` |
|
|
45
|
+
| `getGameInformation` | `DashboardModels.GetGameInformationRequestData` | `getGameInformationAsync(...)` | `DashboardResponseModels.GetGameInformationOperationResponse` | `dashboard.getGameInformation.selfEnable` |
|
|
46
|
+
| `getGameList` | `DashboardModels.GetGameListRequestData` | `getGameListAsync(...)` | `DashboardResponseModels.GetGameListOperationResponse` | `dashboard.getGameList.selfEnable` |
|
|
47
|
+
| `getMasterGameSettings` | `DashboardModels.GetMasterGameSettingsRequestData` | `getMasterGameSettingsAsync(...)` | `DashboardResponseModels.GetMasterGameSettingsOperationResponse` | `dashboard.getMasterGameSettings.selfEnable` |
|
|
48
|
+
| `getSecretInfoInformation` | `DashboardModels.GetSecretInfoInformationRequestData` | `getSecretInfoInformationAsync(...)` | `DashboardResponseModels.GetSecretInfoInformationOperationResponse` | `dashboard.getSecretInfoInformation.selfEnable` |
|
|
49
|
+
| `getSecretInfoList` | `DashboardModels.GetSecretInfoListRequestData` | `getSecretInfoListAsync(...)` | `DashboardResponseModels.GetSecretInfoListOperationResponse` | `dashboard.getSecretInfoList.selfEnable` |
|
|
50
|
+
| `getServerLog` | `DashboardModels.GetServerLogRequestData` | `getServerLogAsync(...)` | `DashboardResponseModels.GetServerLogOperationResponse` | `dashboard.getServerLog.selfEnable` |
|
|
51
|
+
| `createAdminAccount` | `DashboardModels.CreateAdminAccountRequestData` | `createAdminAccountAsync(...)` | `DashboardResponseModels.CreateAdminAccountOperationResponse` | `dashboard.createAdminAccount.selfEnable` |
|
|
52
|
+
| `createGame` | `DashboardModels.CreateGameRequestData` | `createGameAsync(...)` | `DashboardResponseModels.CreateGameOperationResponse` | `dashboard.createGame.selfEnable` |
|
|
53
|
+
| `createSecretInfo` | `DashboardModels.CreateSecretInfoRequestData` | `createSecretInfoAsync(...)` | `DashboardResponseModels.CreateSecretInfoOperationResponse` | `dashboard.createSecretInfo.selfEnable` |
|
|
54
|
+
| `loginByAdminAccount` | `DashboardModels.LoginByAdminAccountRequestData` | `loginByAdminAccountAsync(...)` | `DashboardResponseModels.LoginByAdminAccountOperationResponse` | `dashboard.loginByAdminAccount.selfEnable` |
|
|
55
|
+
| `removeAdminAccount` | `DashboardModels.RemoveAdminAccountRequestData` | `removeAdminAccountAsync(...)` | `DashboardResponseModels.RemoveAdminAccountOperationResponse` | `dashboard.removeAdminAccount.selfEnable` |
|
|
56
|
+
| `setGameInformation` | `DashboardModels.SetGameInformationRequestData` | `setGameInformationAsync(...)` | `DashboardResponseModels.SetGameInformationOperationResponse` | `dashboard.setGameInformation.selfEnable` |
|
|
57
|
+
| `setMasterGameSettings` | `DashboardModels.SetMasterGameSettingsRequestData` | `setMasterGameSettingsAsync(...)` | `DashboardResponseModels.SetMasterGameSettingsOperationResponse` | `dashboard.setMasterGameSettings.selfEnable` |
|
|
58
|
+
| `setPasswordAdminAccount` | `DashboardModels.SetPasswordAdminAccountRequestData` | `setPasswordAdminAccountAsync(...)` | `DashboardResponseModels.SetPasswordAdminAccountOperationResponse` | `dashboard.setPasswordAdminAccount.selfEnable` |
|
|
59
|
+
| `setSecretInfoInformation` | `DashboardModels.SetSecretInfoInformationRequestData` | `setSecretInfoInformationAsync(...)` | `DashboardResponseModels.SetSecretInfoInformationOperationResponse` | `dashboard.setSecretInfoInformation.selfEnable` |
|
|
60
|
+
| `setSecretKeyAdminAccount` | `DashboardModels.SetSecretKeyAdminAccountRequestData` | `setSecretKeyAdminAccountAsync(...)` | `DashboardResponseModels.SetSecretKeyAdminAccountOperationResponse` | `dashboard.setSecretKeyAdminAccount.selfEnable` |
|
|
61
|
+
| `getUsernameAdminAccount` | `DashboardModels.GetUsernameAdminAccountRequestData` | `getUsernameAdminAccountAsync(...)` | `DashboardResponseModels.GetUsernameAdminAccountOperationResponse` | `dashboard.getUsernameAdminAccount.selfEnable` |
|
|
62
|
+
| `getAnalytics` | `DashboardModels.GetAnalyticsRequestData` | `getAnalyticsAsync(...)` | `DashboardResponseModels.GetAnalyticsOperationResponse` | `dashboard.getAnalytics.selfEnable` |
|
|
63
|
+
| `getEventCallbackCloudScript` | `DashboardModels.GetEventCallbackCloudScriptRequestData` | `getEventCallbackCloudScriptAsync(...)` | `DashboardResponseModels.GetEventCallbackCloudScriptOperationResponse` | `dashboard.getEventCallbackCloudScript.selfEnable` |
|
|
64
|
+
| `setEventCallbackCloudScript` | `DashboardModels.SetEventCallbackCloudScriptRequestData` | `setEventCallbackCloudScriptAsync(...)` | `DashboardResponseModels.SetEventCallbackCloudScriptOperationResponse` | `dashboard.setEventCallbackCloudScript.selfEnable` |
|
|
65
|
+
| `resetStatisticsLeaderboard` | `DashboardModels.ResetStatisticsLeaderboardRequestData` | `resetStatisticsLeaderboardAsync(...)` | `DashboardResponseModels.ResetStatisticsLeaderboardOperationResponse` | `dashboard.resetStatisticsLeaderboard.selfEnable` |
|
|
66
|
+
| `getBackupStatisticsLeaderboardVersion` | `DashboardModels.GetBackupStatisticsLeaderboardVersionRequestData` | `getBackupStatisticsLeaderboardVersionAsync(...)` | `DashboardResponseModels.GetBackupStatisticsLeaderboardVersionOperationResponse` | `dashboard.getBackupStatisticsLeaderboardVersion.selfEnable` |
|
|
67
|
+
| `getServerGameData` | `DashboardModels.GetServerGameDataRequestData` | `getServerGameDataAsync(...)` | `DashboardResponseModels.GetServerGameDataOperationResponse` | `dashboard.getServerGameData.selfEnable` |
|
|
68
|
+
| `deleteInDatabase` | `DashboardModels.DeleteInDatabaseRequestData` | `deleteInDatabaseAsync(...)` | `DashboardResponseModels.DeleteInDatabaseOperationResponse` | `dashboard.deleteInDatabase.selfEnable` |
|
|
69
|
+
|
|
70
|
+
|
|
71
|
+
|
|
72
|
+
## Ví dụ tối thiểu
|
|
73
|
+
|
|
74
|
+
```ts
|
|
75
|
+
import { GNNetwork, ReturnCode, ErrorCode } from "@xmobitea/gn-typescript-client";
|
|
76
|
+
|
|
77
|
+
// requestData: DashboardModels.ChangePasswordAdminAccountRequestData đã build theo dto/DASHBOARD.md
|
|
78
|
+
const res = await GNNetwork.dashboard.changePasswordAdminAccountAsync(requestData);
|
|
79
|
+
if (res.returnCode !== ReturnCode.Ok) return;
|
|
80
|
+
if (res.errorCode !== ErrorCode.Ok) return;
|
|
81
|
+
// res.responseData có typed payload
|
|
82
|
+
```
|