@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
|
@@ -2,41 +2,182 @@ import { Action1 } from "./common/Action1";
|
|
|
2
2
|
import { GNHashtable } from "./common/GNData";
|
|
3
3
|
import { CloudScriptModels } from "./entity/models/CloudScriptModels";
|
|
4
4
|
import { CloudScriptResponseModels } from "./entity/models/CloudScriptResponseModels";
|
|
5
|
+
/**
|
|
6
|
+
* Public client-scoped namespace for the CloudScript domain.
|
|
7
|
+
*
|
|
8
|
+
* Reachable through {@link GNNetwork.cloudScript} after
|
|
9
|
+
* {@link GNNetwork.init}. Provides client-side access to
|
|
10
|
+
* server-hosted JavaScript / TypeScript functions ("CloudScript")
|
|
11
|
+
* that the GearN backend executes on demand.
|
|
12
|
+
*
|
|
13
|
+
* Functional groupings:
|
|
14
|
+
*
|
|
15
|
+
* 1. **Function execution** — `executeFunction`. The backend
|
|
16
|
+
* runs the named function in the selected script version
|
|
17
|
+
* and returns the result inside a typed response. The
|
|
18
|
+
* outcome is described by {@link ExecuteResponseStatus}
|
|
19
|
+
* (`Ok`, `Exception`, `FunctionNameNotFound`,
|
|
20
|
+
* `VersionInvalid`, `Timeout`).
|
|
21
|
+
*
|
|
22
|
+
* 2. **Function management** (server / admin only) —
|
|
23
|
+
* `addFunction`, `setFunction`, `removeFunction`,
|
|
24
|
+
* `getFunctionList`, plus version management
|
|
25
|
+
* (`addVersion`, `setActiveVersion`, ...). These are
|
|
26
|
+
* placeholder client-side endpoints; in practice they are
|
|
27
|
+
* invoked through the dashboard.
|
|
28
|
+
*
|
|
29
|
+
* Common contract: same as {@link GamePlayerApi} (HTTP /
|
|
30
|
+
* `RequestType.CloudScript` / `RequestRole.Client`,
|
|
31
|
+
* callback + Promise variants, `.server` / `.admin`
|
|
32
|
+
* sub-namespaces).
|
|
33
|
+
*/
|
|
5
34
|
export declare class CloudScriptApi {
|
|
35
|
+
/** Server-scoped CloudScript operations for trusted backend callers. */
|
|
6
36
|
server: ServerCloudScriptApi;
|
|
37
|
+
/** Admin-scoped CloudScript operations for dashboard or backoffice callers. */
|
|
7
38
|
admin: AdminCloudScriptApi;
|
|
39
|
+
/**
|
|
40
|
+
* Sends the addFunction operation and returns the typed response via callback.
|
|
41
|
+
*/
|
|
8
42
|
addFunction(requestData: CloudScriptModels.AddFunctionRequestData, onResponse?: Action1<CloudScriptResponseModels.AddFunctionOperationResponse>, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): void;
|
|
43
|
+
/**
|
|
44
|
+
* Sends the addFunction operation and resolves with the typed response.
|
|
45
|
+
*/
|
|
9
46
|
addFunctionAsync(requestData: CloudScriptModels.AddFunctionRequestData, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): Promise<CloudScriptResponseModels.AddFunctionOperationResponse>;
|
|
47
|
+
/**
|
|
48
|
+
* Sends the editFunction operation and returns the typed response via callback.
|
|
49
|
+
*/
|
|
10
50
|
editFunction(requestData: CloudScriptModels.EditFunctionRequestData, onResponse?: Action1<CloudScriptResponseModels.EditFunctionOperationResponse>, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): void;
|
|
51
|
+
/**
|
|
52
|
+
* Sends the editFunction operation and resolves with the typed response.
|
|
53
|
+
*/
|
|
11
54
|
editFunctionAsync(requestData: CloudScriptModels.EditFunctionRequestData, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): Promise<CloudScriptResponseModels.EditFunctionOperationResponse>;
|
|
55
|
+
/**
|
|
56
|
+
* Sends the executeFunction operation and returns the typed response via callback.
|
|
57
|
+
*/
|
|
12
58
|
executeFunction(requestData: CloudScriptModels.ExecuteFunctionRequestData, onResponse?: Action1<CloudScriptResponseModels.ExecuteFunctionOperationResponse>, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): void;
|
|
59
|
+
/**
|
|
60
|
+
* Sends the executeFunction operation and resolves with the typed response.
|
|
61
|
+
*/
|
|
13
62
|
executeFunctionAsync(requestData: CloudScriptModels.ExecuteFunctionRequestData, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): Promise<CloudScriptResponseModels.ExecuteFunctionOperationResponse>;
|
|
63
|
+
/**
|
|
64
|
+
* Sends the getFunction operation and returns the typed response via callback.
|
|
65
|
+
*/
|
|
14
66
|
getFunction(requestData: CloudScriptModels.GetFunctionRequestData, onResponse?: Action1<CloudScriptResponseModels.GetFunctionOperationResponse>, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): void;
|
|
67
|
+
/**
|
|
68
|
+
* Sends the getFunction operation and resolves with the typed response.
|
|
69
|
+
*/
|
|
15
70
|
getFunctionAsync(requestData: CloudScriptModels.GetFunctionRequestData, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): Promise<CloudScriptResponseModels.GetFunctionOperationResponse>;
|
|
71
|
+
/**
|
|
72
|
+
* Sends the getFunctions operation and returns the typed response via callback.
|
|
73
|
+
*/
|
|
16
74
|
getFunctions(requestData: CloudScriptModels.GetFunctionsRequestData, onResponse?: Action1<CloudScriptResponseModels.GetFunctionsOperationResponse>, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): void;
|
|
75
|
+
/**
|
|
76
|
+
* Sends the getFunctions operation and resolves with the typed response.
|
|
77
|
+
*/
|
|
17
78
|
getFunctionsAsync(requestData: CloudScriptModels.GetFunctionsRequestData, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): Promise<CloudScriptResponseModels.GetFunctionsOperationResponse>;
|
|
18
79
|
}
|
|
80
|
+
/**
|
|
81
|
+
* Server-scoped CloudScript namespace, reachable through
|
|
82
|
+
* `GNNetwork.cloudScript.server`.
|
|
83
|
+
*
|
|
84
|
+
* Mirrors {@link CloudScriptApi} but with the `Server*RequestData`
|
|
85
|
+
* DTO variants. Used by trusted backend code that needs to
|
|
86
|
+
* execute or manage CloudScript functions on behalf of any
|
|
87
|
+
* player without holding their auth token. Always pass a valid
|
|
88
|
+
* server-side `secretKey`.
|
|
89
|
+
*/
|
|
19
90
|
export declare class ServerCloudScriptApi {
|
|
91
|
+
/**
|
|
92
|
+
* Sends the addFunction operation and returns the typed response via callback.
|
|
93
|
+
*/
|
|
20
94
|
addFunction(requestData: CloudScriptModels.ServerAddFunctionRequestData, onResponse?: Action1<CloudScriptResponseModels.AddFunctionOperationResponse>, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): void;
|
|
95
|
+
/**
|
|
96
|
+
* Sends the addFunction operation and resolves with the typed response.
|
|
97
|
+
*/
|
|
21
98
|
addFunctionAsync(requestData: CloudScriptModels.ServerAddFunctionRequestData, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): Promise<CloudScriptResponseModels.AddFunctionOperationResponse>;
|
|
99
|
+
/**
|
|
100
|
+
* Sends the editFunction operation and returns the typed response via callback.
|
|
101
|
+
*/
|
|
22
102
|
editFunction(requestData: CloudScriptModels.ServerEditFunctionRequestData, onResponse?: Action1<CloudScriptResponseModels.EditFunctionOperationResponse>, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): void;
|
|
103
|
+
/**
|
|
104
|
+
* Sends the editFunction operation and resolves with the typed response.
|
|
105
|
+
*/
|
|
23
106
|
editFunctionAsync(requestData: CloudScriptModels.ServerEditFunctionRequestData, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): Promise<CloudScriptResponseModels.EditFunctionOperationResponse>;
|
|
107
|
+
/**
|
|
108
|
+
* Sends the executeFunction operation and returns the typed response via callback.
|
|
109
|
+
*/
|
|
24
110
|
executeFunction(requestData: CloudScriptModels.ServerExecuteFunctionRequestData, onResponse?: Action1<CloudScriptResponseModels.ExecuteFunctionOperationResponse>, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): void;
|
|
111
|
+
/**
|
|
112
|
+
* Sends the executeFunction operation and resolves with the typed response.
|
|
113
|
+
*/
|
|
25
114
|
executeFunctionAsync(requestData: CloudScriptModels.ServerExecuteFunctionRequestData, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): Promise<CloudScriptResponseModels.ExecuteFunctionOperationResponse>;
|
|
115
|
+
/**
|
|
116
|
+
* Sends the getFunction operation and returns the typed response via callback.
|
|
117
|
+
*/
|
|
26
118
|
getFunction(requestData: CloudScriptModels.ServerGetFunctionRequestData, onResponse?: Action1<CloudScriptResponseModels.GetFunctionOperationResponse>, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): void;
|
|
119
|
+
/**
|
|
120
|
+
* Sends the getFunction operation and resolves with the typed response.
|
|
121
|
+
*/
|
|
27
122
|
getFunctionAsync(requestData: CloudScriptModels.ServerGetFunctionRequestData, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): Promise<CloudScriptResponseModels.GetFunctionOperationResponse>;
|
|
123
|
+
/**
|
|
124
|
+
* Sends the getFunctions operation and returns the typed response via callback.
|
|
125
|
+
*/
|
|
28
126
|
getFunctions(requestData: CloudScriptModels.ServerGetFunctionsRequestData, onResponse?: Action1<CloudScriptResponseModels.GetFunctionsOperationResponse>, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): void;
|
|
127
|
+
/**
|
|
128
|
+
* Sends the getFunctions operation and resolves with the typed response.
|
|
129
|
+
*/
|
|
29
130
|
getFunctionsAsync(requestData: CloudScriptModels.ServerGetFunctionsRequestData, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): Promise<CloudScriptResponseModels.GetFunctionsOperationResponse>;
|
|
30
131
|
}
|
|
132
|
+
/**
|
|
133
|
+
* Admin-scoped CloudScript namespace, reachable through
|
|
134
|
+
* `GNNetwork.cloudScript.admin`.
|
|
135
|
+
*
|
|
136
|
+
* Used by the dashboard / backoffice tooling for the
|
|
137
|
+
* full CloudScript management surface (publish new versions,
|
|
138
|
+
* promote / demote versions, grant execution permissions).
|
|
139
|
+
* Routed through {@link RequestRole.Admin} and authorised
|
|
140
|
+
* against the admin auth token.
|
|
141
|
+
*/
|
|
31
142
|
export declare class AdminCloudScriptApi {
|
|
143
|
+
/**
|
|
144
|
+
* Sends the addFunction operation and returns the typed response via callback.
|
|
145
|
+
*/
|
|
32
146
|
addFunction(requestData: CloudScriptModels.AdminAddFunctionRequestData, onResponse?: Action1<CloudScriptResponseModels.AddFunctionOperationResponse>, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): void;
|
|
147
|
+
/**
|
|
148
|
+
* Sends the addFunction operation and resolves with the typed response.
|
|
149
|
+
*/
|
|
33
150
|
addFunctionAsync(requestData: CloudScriptModels.AdminAddFunctionRequestData, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): Promise<CloudScriptResponseModels.AddFunctionOperationResponse>;
|
|
151
|
+
/**
|
|
152
|
+
* Sends the editFunction operation and returns the typed response via callback.
|
|
153
|
+
*/
|
|
34
154
|
editFunction(requestData: CloudScriptModels.AdminEditFunctionRequestData, onResponse?: Action1<CloudScriptResponseModels.EditFunctionOperationResponse>, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): void;
|
|
155
|
+
/**
|
|
156
|
+
* Sends the editFunction operation and resolves with the typed response.
|
|
157
|
+
*/
|
|
35
158
|
editFunctionAsync(requestData: CloudScriptModels.AdminEditFunctionRequestData, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): Promise<CloudScriptResponseModels.EditFunctionOperationResponse>;
|
|
159
|
+
/**
|
|
160
|
+
* Sends the executeFunction operation and returns the typed response via callback.
|
|
161
|
+
*/
|
|
36
162
|
executeFunction(requestData: CloudScriptModels.AdminExecuteFunctionRequestData, onResponse?: Action1<CloudScriptResponseModels.ExecuteFunctionOperationResponse>, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): void;
|
|
163
|
+
/**
|
|
164
|
+
* Sends the executeFunction operation and resolves with the typed response.
|
|
165
|
+
*/
|
|
37
166
|
executeFunctionAsync(requestData: CloudScriptModels.AdminExecuteFunctionRequestData, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): Promise<CloudScriptResponseModels.ExecuteFunctionOperationResponse>;
|
|
167
|
+
/**
|
|
168
|
+
* Sends the getFunction operation and returns the typed response via callback.
|
|
169
|
+
*/
|
|
38
170
|
getFunction(requestData: CloudScriptModels.AdminGetFunctionRequestData, onResponse?: Action1<CloudScriptResponseModels.GetFunctionOperationResponse>, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): void;
|
|
171
|
+
/**
|
|
172
|
+
* Sends the getFunction operation and resolves with the typed response.
|
|
173
|
+
*/
|
|
39
174
|
getFunctionAsync(requestData: CloudScriptModels.AdminGetFunctionRequestData, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): Promise<CloudScriptResponseModels.GetFunctionOperationResponse>;
|
|
175
|
+
/**
|
|
176
|
+
* Sends the getFunctions operation and returns the typed response via callback.
|
|
177
|
+
*/
|
|
40
178
|
getFunctions(requestData: CloudScriptModels.AdminGetFunctionsRequestData, onResponse?: Action1<CloudScriptResponseModels.GetFunctionsOperationResponse>, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): void;
|
|
179
|
+
/**
|
|
180
|
+
* Sends the getFunctions operation and resolves with the typed response.
|
|
181
|
+
*/
|
|
41
182
|
getFunctionsAsync(requestData: CloudScriptModels.AdminGetFunctionsRequestData, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): Promise<CloudScriptResponseModels.GetFunctionsOperationResponse>;
|
|
42
183
|
}
|
|
@@ -2,53 +2,296 @@ import { Action1 } from "./common/Action1";
|
|
|
2
2
|
import { GNHashtable } from "./common/GNData";
|
|
3
3
|
import { ContentModels } from "./entity/models/ContentModels";
|
|
4
4
|
import { ContentResponseModels } from "./entity/models/ContentResponseModels";
|
|
5
|
+
/**
|
|
6
|
+
* Public client-scoped namespace for the Content domain.
|
|
7
|
+
*
|
|
8
|
+
* Reachable through {@link GNNetwork.content} after
|
|
9
|
+
* {@link GNNetwork.init}. Manages the **metadata** side of the
|
|
10
|
+
* file pipeline — registering an upload slot, listing previously
|
|
11
|
+
* uploaded files, requesting a download token, and reading /
|
|
12
|
+
* writing arbitrary `contentData` blobs keyed by content key.
|
|
13
|
+
*
|
|
14
|
+
* Raw byte transfer is intentionally **not** part of this API:
|
|
15
|
+
* - Upload bytes go through {@link GNNetwork.uploadFile} after
|
|
16
|
+
* {@link createNewFileUploadInfo} returns a `fileId`.
|
|
17
|
+
* - Download bytes are fetched through the URL produced by
|
|
18
|
+
* {@link GNNetwork.getDownloadFileUrl} after
|
|
19
|
+
* {@link requestDownloadFileUploadInfo} returns a download
|
|
20
|
+
* token.
|
|
21
|
+
*
|
|
22
|
+
* Common contract for every method:
|
|
23
|
+
* - Routes through HTTP using {@link RequestType.Content} and the
|
|
24
|
+
* appropriate {@link RequestRole} for the sub-namespace
|
|
25
|
+
* (`Client` for this class, `Server` / `Admin` for the
|
|
26
|
+
* sub-namespaces below).
|
|
27
|
+
* - The standard parameter set
|
|
28
|
+
* (`overrideAuthToken`, `overrideSecretKey`, `customTags`,
|
|
29
|
+
* `timeout`) is documented on {@link GNNetwork.sendViaHttp}.
|
|
30
|
+
*/
|
|
5
31
|
export declare class ContentApi {
|
|
32
|
+
/**
|
|
33
|
+
* Server-scoped Content sub-namespace. Use from trusted
|
|
34
|
+
* backend code with a valid server `secretKey`.
|
|
35
|
+
*/
|
|
6
36
|
server: ServerContentApi;
|
|
37
|
+
/**
|
|
38
|
+
* Admin-scoped Content sub-namespace. Use from dashboard /
|
|
39
|
+
* backoffice tooling with a valid admin auth token.
|
|
40
|
+
*/
|
|
7
41
|
admin: AdminContentApi;
|
|
42
|
+
/**
|
|
43
|
+
* Reserves a new file slot and returns the `fileId` plus the
|
|
44
|
+
* upload token / URL needed to push the bytes.
|
|
45
|
+
*
|
|
46
|
+
* Backed by {@link OperationCode.CreateNewFileUploadInfo}.
|
|
47
|
+
* The application typically follows this with
|
|
48
|
+
* {@link GNNetwork.uploadFile} to push the actual bytes; the
|
|
49
|
+
* uploaded file becomes downloadable through
|
|
50
|
+
* {@link requestDownloadFileUploadInfo} once committed.
|
|
51
|
+
*/
|
|
8
52
|
createNewFileUploadInfo(requestData: ContentModels.CreateNewFileUploadInfoRequestData, onResponse?: Action1<ContentResponseModels.CreateNewFileUploadInfoOperationResponse>, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): void;
|
|
53
|
+
/**
|
|
54
|
+
* Promise-based wrapper around {@link createNewFileUploadInfo}.
|
|
55
|
+
*/
|
|
9
56
|
createNewFileUploadInfoAsync(requestData: ContentModels.CreateNewFileUploadInfoRequestData, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): Promise<ContentResponseModels.CreateNewFileUploadInfoOperationResponse>;
|
|
57
|
+
/**
|
|
58
|
+
* Reads a `contentData` blob by content key.
|
|
59
|
+
*
|
|
60
|
+
* Backed by {@link OperationCode.GetContentData}. `contentData`
|
|
61
|
+
* is a small, structured value the GearN backend stores under
|
|
62
|
+
* a content key — useful for game-wide config, MOTDs,
|
|
63
|
+
* remote-config flags, etc. Distinct from file uploads, which
|
|
64
|
+
* use the `*FileUploadInfo*` operations on this class.
|
|
65
|
+
*/
|
|
10
66
|
getContentData(requestData: ContentModels.GetContentDataRequestData, onResponse?: Action1<ContentResponseModels.GetContentDataOperationResponse>, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): void;
|
|
67
|
+
/**
|
|
68
|
+
* Promise-based wrapper around {@link getContentData}.
|
|
69
|
+
*/
|
|
11
70
|
getContentDataAsync(requestData: ContentModels.GetContentDataRequestData, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): Promise<ContentResponseModels.GetContentDataOperationResponse>;
|
|
71
|
+
/**
|
|
72
|
+
* Lists previously registered file upload slots, optionally
|
|
73
|
+
* filtered by tag / metadata supplied on the request DTO.
|
|
74
|
+
*
|
|
75
|
+
* Backed by {@link OperationCode.GetFileUploadInfoList}.
|
|
76
|
+
* Useful for browsing previously uploaded assets, e.g. when
|
|
77
|
+
* rebuilding a download cache.
|
|
78
|
+
*/
|
|
12
79
|
getFileUploadInfoList(requestData: ContentModels.GetFileUploadInfoListRequestData, onResponse?: Action1<ContentResponseModels.GetFileUploadInfoListOperationResponse>, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): void;
|
|
80
|
+
/**
|
|
81
|
+
* Promise-based wrapper around {@link getFileUploadInfoList}.
|
|
82
|
+
*/
|
|
13
83
|
getFileUploadInfoListAsync(requestData: ContentModels.GetFileUploadInfoListRequestData, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): Promise<ContentResponseModels.GetFileUploadInfoListOperationResponse>;
|
|
84
|
+
/**
|
|
85
|
+
* Returns the metadata for a single file upload slot.
|
|
86
|
+
*
|
|
87
|
+
* Backed by {@link OperationCode.GetFileUploadInfo}. Useful
|
|
88
|
+
* for inspecting a known `fileId` (size, mime type, upload
|
|
89
|
+
* status) without downloading the bytes.
|
|
90
|
+
*/
|
|
14
91
|
getFileUploadInfo(requestData: ContentModels.GetFileUploadInfoRequestData, onResponse?: Action1<ContentResponseModels.GetFileUploadInfoOperationResponse>, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): void;
|
|
92
|
+
/**
|
|
93
|
+
* Promise-based wrapper around {@link getFileUploadInfo}.
|
|
94
|
+
*/
|
|
15
95
|
getFileUploadInfoAsync(requestData: ContentModels.GetFileUploadInfoRequestData, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): Promise<ContentResponseModels.GetFileUploadInfoOperationResponse>;
|
|
96
|
+
/**
|
|
97
|
+
* Removes a previously registered file upload slot and any
|
|
98
|
+
* stored bytes attached to it.
|
|
99
|
+
*
|
|
100
|
+
* Backed by {@link OperationCode.RemoveFileUploadInfo}. The
|
|
101
|
+
* operation is irreversible from the client side; download
|
|
102
|
+
* URLs that were already issued become invalid.
|
|
103
|
+
*/
|
|
16
104
|
removeFileUploadInfo(requestData: ContentModels.RemoveFileUploadInfoRequestData, onResponse?: Action1<ContentResponseModels.RemoveFileUploadInfoOperationResponse>, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): void;
|
|
105
|
+
/**
|
|
106
|
+
* Promise-based wrapper around {@link removeFileUploadInfo}.
|
|
107
|
+
*/
|
|
17
108
|
removeFileUploadInfoAsync(requestData: ContentModels.RemoveFileUploadInfoRequestData, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): Promise<ContentResponseModels.RemoveFileUploadInfoOperationResponse>;
|
|
109
|
+
/**
|
|
110
|
+
* Issues a short-lived download token for an existing file
|
|
111
|
+
* upload slot.
|
|
112
|
+
*
|
|
113
|
+
* Backed by
|
|
114
|
+
* {@link OperationCode.RequestDownloadFileUploadInfo}. Pair
|
|
115
|
+
* the returned token with {@link GNNetwork.getDownloadFileUrl}
|
|
116
|
+
* to obtain the absolute download URL.
|
|
117
|
+
*/
|
|
18
118
|
requestDownloadFileUploadInfo(requestData: ContentModels.RequestDownloadFileUploadInfoRequestData, onResponse?: Action1<ContentResponseModels.RequestDownloadFileUploadInfoOperationResponse>, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): void;
|
|
119
|
+
/**
|
|
120
|
+
* Promise-based wrapper around
|
|
121
|
+
* {@link requestDownloadFileUploadInfo}.
|
|
122
|
+
*/
|
|
19
123
|
requestDownloadFileUploadInfoAsync(requestData: ContentModels.RequestDownloadFileUploadInfoRequestData, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): Promise<ContentResponseModels.RequestDownloadFileUploadInfoOperationResponse>;
|
|
124
|
+
/**
|
|
125
|
+
* Writes / replaces a `contentData` blob by content key.
|
|
126
|
+
*
|
|
127
|
+
* Backed by {@link OperationCode.SetContentData}. Use to
|
|
128
|
+
* publish small structured config values that should be
|
|
129
|
+
* fetchable through {@link getContentData} later.
|
|
130
|
+
*/
|
|
20
131
|
setContentData(requestData: ContentModels.SetContentDataRequestData, onResponse?: Action1<ContentResponseModels.SetContentDataOperationResponse>, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): void;
|
|
132
|
+
/**
|
|
133
|
+
* Promise-based wrapper around {@link setContentData}.
|
|
134
|
+
*/
|
|
21
135
|
setContentDataAsync(requestData: ContentModels.SetContentDataRequestData, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): Promise<ContentResponseModels.SetContentDataOperationResponse>;
|
|
22
136
|
}
|
|
137
|
+
/**
|
|
138
|
+
* Server-scoped Content namespace, reachable through
|
|
139
|
+
* `GNNetwork.content.server`.
|
|
140
|
+
*
|
|
141
|
+
* Mirrors every method on {@link ContentApi} but uses the
|
|
142
|
+
* `Server*RequestData` DTO variants. The server flavour accepts
|
|
143
|
+
* additional `userId` / `ownerId` parameters so a trusted
|
|
144
|
+
* backend can act on behalf of any player without holding their
|
|
145
|
+
* auth token.
|
|
146
|
+
*
|
|
147
|
+
* Always pass a valid server-side `secretKey` (typically through
|
|
148
|
+
* {@link GNServerSettings.setSecretKey} or `overrideSecretKey`)
|
|
149
|
+
* so the backend can authorise the request.
|
|
150
|
+
*/
|
|
23
151
|
export declare class ServerContentApi {
|
|
152
|
+
/**
|
|
153
|
+
* Server variant of
|
|
154
|
+
* {@link ContentApi.createNewFileUploadInfo}. Accepts the
|
|
155
|
+
* extended {@link ContentModels.ServerCreateNewFileUploadInfoRequestData}
|
|
156
|
+
* DTO so the request can target an arbitrary player.
|
|
157
|
+
*/
|
|
24
158
|
createNewFileUploadInfo(requestData: ContentModels.ServerCreateNewFileUploadInfoRequestData, onResponse?: Action1<ContentResponseModels.CreateNewFileUploadInfoOperationResponse>, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): void;
|
|
159
|
+
/**
|
|
160
|
+
* Promise-based wrapper around the server variant of
|
|
161
|
+
* {@link ContentApi.createNewFileUploadInfo}.
|
|
162
|
+
*/
|
|
25
163
|
createNewFileUploadInfoAsync(requestData: ContentModels.ServerCreateNewFileUploadInfoRequestData, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): Promise<ContentResponseModels.CreateNewFileUploadInfoOperationResponse>;
|
|
164
|
+
/**
|
|
165
|
+
* Server variant of {@link ContentApi.getContentData}.
|
|
166
|
+
*/
|
|
26
167
|
getContentData(requestData: ContentModels.ServerGetContentDataRequestData, onResponse?: Action1<ContentResponseModels.GetContentDataOperationResponse>, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): void;
|
|
168
|
+
/**
|
|
169
|
+
* Promise-based wrapper around the server variant of
|
|
170
|
+
* {@link ContentApi.getContentData}.
|
|
171
|
+
*/
|
|
27
172
|
getContentDataAsync(requestData: ContentModels.ServerGetContentDataRequestData, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): Promise<ContentResponseModels.GetContentDataOperationResponse>;
|
|
173
|
+
/**
|
|
174
|
+
* Server variant of {@link ContentApi.getFileUploadInfoList}.
|
|
175
|
+
*/
|
|
28
176
|
getFileUploadInfoList(requestData: ContentModels.ServerGetFileUploadInfoListRequestData, onResponse?: Action1<ContentResponseModels.GetFileUploadInfoListOperationResponse>, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): void;
|
|
177
|
+
/**
|
|
178
|
+
* Promise-based wrapper around the server variant of
|
|
179
|
+
* {@link ContentApi.getFileUploadInfoList}.
|
|
180
|
+
*/
|
|
29
181
|
getFileUploadInfoListAsync(requestData: ContentModels.ServerGetFileUploadInfoListRequestData, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): Promise<ContentResponseModels.GetFileUploadInfoListOperationResponse>;
|
|
182
|
+
/**
|
|
183
|
+
* Server variant of {@link ContentApi.getFileUploadInfo}.
|
|
184
|
+
*/
|
|
30
185
|
getFileUploadInfo(requestData: ContentModels.ServerGetFileUploadInfoRequestData, onResponse?: Action1<ContentResponseModels.GetFileUploadInfoOperationResponse>, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): void;
|
|
186
|
+
/**
|
|
187
|
+
* Promise-based wrapper around the server variant of
|
|
188
|
+
* {@link ContentApi.getFileUploadInfo}.
|
|
189
|
+
*/
|
|
31
190
|
getFileUploadInfoAsync(requestData: ContentModels.ServerGetFileUploadInfoRequestData, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): Promise<ContentResponseModels.GetFileUploadInfoOperationResponse>;
|
|
191
|
+
/**
|
|
192
|
+
* Server variant of {@link ContentApi.removeFileUploadInfo}.
|
|
193
|
+
*/
|
|
32
194
|
removeFileUploadInfo(requestData: ContentModels.ServerRemoveFileUploadInfoRequestData, onResponse?: Action1<ContentResponseModels.RemoveFileUploadInfoOperationResponse>, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): void;
|
|
195
|
+
/**
|
|
196
|
+
* Promise-based wrapper around the server variant of
|
|
197
|
+
* {@link ContentApi.removeFileUploadInfo}.
|
|
198
|
+
*/
|
|
33
199
|
removeFileUploadInfoAsync(requestData: ContentModels.ServerRemoveFileUploadInfoRequestData, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): Promise<ContentResponseModels.RemoveFileUploadInfoOperationResponse>;
|
|
200
|
+
/**
|
|
201
|
+
* Server variant of
|
|
202
|
+
* {@link ContentApi.requestDownloadFileUploadInfo}.
|
|
203
|
+
*/
|
|
34
204
|
requestDownloadFileUploadInfo(requestData: ContentModels.ServerRequestDownloadFileUploadInfoRequestData, onResponse?: Action1<ContentResponseModels.RequestDownloadFileUploadInfoOperationResponse>, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): void;
|
|
205
|
+
/**
|
|
206
|
+
* Promise-based wrapper around the server variant of
|
|
207
|
+
* {@link ContentApi.requestDownloadFileUploadInfo}.
|
|
208
|
+
*/
|
|
35
209
|
requestDownloadFileUploadInfoAsync(requestData: ContentModels.ServerRequestDownloadFileUploadInfoRequestData, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): Promise<ContentResponseModels.RequestDownloadFileUploadInfoOperationResponse>;
|
|
210
|
+
/**
|
|
211
|
+
* Server variant of {@link ContentApi.setContentData}.
|
|
212
|
+
*/
|
|
36
213
|
setContentData(requestData: ContentModels.ServerSetContentDataRequestData, onResponse?: Action1<ContentResponseModels.SetContentDataOperationResponse>, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): void;
|
|
214
|
+
/**
|
|
215
|
+
* Promise-based wrapper around the server variant of
|
|
216
|
+
* {@link ContentApi.setContentData}.
|
|
217
|
+
*/
|
|
37
218
|
setContentDataAsync(requestData: ContentModels.ServerSetContentDataRequestData, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): Promise<ContentResponseModels.SetContentDataOperationResponse>;
|
|
38
219
|
}
|
|
220
|
+
/**
|
|
221
|
+
* Admin-scoped Content namespace, reachable through
|
|
222
|
+
* `GNNetwork.content.admin`.
|
|
223
|
+
*
|
|
224
|
+
* Mirrors the same method set as {@link ServerContentApi} but
|
|
225
|
+
* routed through {@link RequestRole.Admin}. The backend uses the
|
|
226
|
+
* caller's admin auth token to authorise privileged operations
|
|
227
|
+
* such as touching another tenant's files. Most application code
|
|
228
|
+
* never needs this namespace — dashboard / backoffice tools are
|
|
229
|
+
* the primary consumers.
|
|
230
|
+
*/
|
|
39
231
|
export declare class AdminContentApi {
|
|
232
|
+
/**
|
|
233
|
+
* Admin variant of
|
|
234
|
+
* {@link ContentApi.createNewFileUploadInfo}.
|
|
235
|
+
*/
|
|
40
236
|
createNewFileUploadInfo(requestData: ContentModels.AdminCreateNewFileUploadInfoRequestData, onResponse?: Action1<ContentResponseModels.CreateNewFileUploadInfoOperationResponse>, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): void;
|
|
237
|
+
/**
|
|
238
|
+
* Promise-based wrapper around the admin variant of
|
|
239
|
+
* {@link ContentApi.createNewFileUploadInfo}.
|
|
240
|
+
*/
|
|
41
241
|
createNewFileUploadInfoAsync(requestData: ContentModels.AdminCreateNewFileUploadInfoRequestData, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): Promise<ContentResponseModels.CreateNewFileUploadInfoOperationResponse>;
|
|
242
|
+
/**
|
|
243
|
+
* Admin variant of {@link ContentApi.getContentData}.
|
|
244
|
+
*/
|
|
42
245
|
getContentData(requestData: ContentModels.AdminGetContentDataRequestData, onResponse?: Action1<ContentResponseModels.GetContentDataOperationResponse>, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): void;
|
|
246
|
+
/**
|
|
247
|
+
* Promise-based wrapper around the admin variant of
|
|
248
|
+
* {@link ContentApi.getContentData}.
|
|
249
|
+
*/
|
|
43
250
|
getContentDataAsync(requestData: ContentModels.AdminGetContentDataRequestData, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): Promise<ContentResponseModels.GetContentDataOperationResponse>;
|
|
251
|
+
/**
|
|
252
|
+
* Admin variant of {@link ContentApi.getFileUploadInfoList}.
|
|
253
|
+
*/
|
|
44
254
|
getFileUploadInfoList(requestData: ContentModels.AdminGetFileUploadInfoListRequestData, onResponse?: Action1<ContentResponseModels.GetFileUploadInfoListOperationResponse>, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): void;
|
|
255
|
+
/**
|
|
256
|
+
* Promise-based wrapper around the admin variant of
|
|
257
|
+
* {@link ContentApi.getFileUploadInfoList}.
|
|
258
|
+
*/
|
|
45
259
|
getFileUploadInfoListAsync(requestData: ContentModels.AdminGetFileUploadInfoListRequestData, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): Promise<ContentResponseModels.GetFileUploadInfoListOperationResponse>;
|
|
260
|
+
/**
|
|
261
|
+
* Admin variant of {@link ContentApi.getFileUploadInfo}.
|
|
262
|
+
*/
|
|
46
263
|
getFileUploadInfo(requestData: ContentModels.AdminGetFileUploadInfoRequestData, onResponse?: Action1<ContentResponseModels.GetFileUploadInfoOperationResponse>, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): void;
|
|
264
|
+
/**
|
|
265
|
+
* Promise-based wrapper around the admin variant of
|
|
266
|
+
* {@link ContentApi.getFileUploadInfo}.
|
|
267
|
+
*/
|
|
47
268
|
getFileUploadInfoAsync(requestData: ContentModels.AdminGetFileUploadInfoRequestData, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): Promise<ContentResponseModels.GetFileUploadInfoOperationResponse>;
|
|
269
|
+
/**
|
|
270
|
+
* Admin variant of {@link ContentApi.removeFileUploadInfo}.
|
|
271
|
+
*/
|
|
48
272
|
removeFileUploadInfo(requestData: ContentModels.AdminRemoveFileUploadInfoRequestData, onResponse?: Action1<ContentResponseModels.RemoveFileUploadInfoOperationResponse>, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): void;
|
|
273
|
+
/**
|
|
274
|
+
* Promise-based wrapper around the admin variant of
|
|
275
|
+
* {@link ContentApi.removeFileUploadInfo}.
|
|
276
|
+
*/
|
|
49
277
|
removeFileUploadInfoAsync(requestData: ContentModels.AdminRemoveFileUploadInfoRequestData, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): Promise<ContentResponseModels.RemoveFileUploadInfoOperationResponse>;
|
|
278
|
+
/**
|
|
279
|
+
* Admin variant of
|
|
280
|
+
* {@link ContentApi.requestDownloadFileUploadInfo}.
|
|
281
|
+
*/
|
|
50
282
|
requestDownloadFileUploadInfo(requestData: ContentModels.AdminRequestDownloadFileUploadInfoRequestData, onResponse?: Action1<ContentResponseModels.RequestDownloadFileUploadInfoOperationResponse>, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): void;
|
|
283
|
+
/**
|
|
284
|
+
* Promise-based wrapper around the admin variant of
|
|
285
|
+
* {@link ContentApi.requestDownloadFileUploadInfo}.
|
|
286
|
+
*/
|
|
51
287
|
requestDownloadFileUploadInfoAsync(requestData: ContentModels.AdminRequestDownloadFileUploadInfoRequestData, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): Promise<ContentResponseModels.RequestDownloadFileUploadInfoOperationResponse>;
|
|
288
|
+
/**
|
|
289
|
+
* Admin variant of {@link ContentApi.setContentData}.
|
|
290
|
+
*/
|
|
52
291
|
setContentData(requestData: ContentModels.AdminSetContentDataRequestData, onResponse?: Action1<ContentResponseModels.SetContentDataOperationResponse>, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): void;
|
|
292
|
+
/**
|
|
293
|
+
* Promise-based wrapper around the admin variant of
|
|
294
|
+
* {@link ContentApi.setContentData}.
|
|
295
|
+
*/
|
|
53
296
|
setContentDataAsync(requestData: ContentModels.AdminSetContentDataRequestData, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): Promise<ContentResponseModels.SetContentDataOperationResponse>;
|
|
54
297
|
}
|