NetApiHandler Interface Reference

Base class for NetApi handlers. More...

Inheritance diagram for NetApiHandler:

Public Member Functions
JsonApiStruct	GetRequest ()
	override to create custom request data
JsonApiStruct	GetResponse (JsonApiStruct request)
	override to create custom respond data

Detailed Description

Base class for NetApi handlers.

To implement a custom NetApi handler, inherit from the base NetApiHandler class. The name of your derived class determines the name of the corresponding NetApi function.

NetApi Call Lifecycle:

1. The NetApi call is received by the framework.
2. The system searches for a subclass of NetApiHandler whose name matches the requested function name.
3. Once the appropriate handler is found, its GetRequest() method is invoked.
4. The request data is deserialized into a JsonApiStruct object.
5. The handler's GetResponse() method is called, using the populated request structure.
6. The method returns a JsonApiStruct response, which is sent back to the caller.

See also

Workbench NET API

Example script

Member Function Documentation

GetRequest()

JsonApiStruct NetApiHandler.GetRequest

(

)

override to create custom request data

Implemented in AnimExportProfileChannels, AnimExportProfiles, AnimExportTrackExport, BakeInfo, CheckGUID, EBTInfo, ExampleCall, ExportFBXResource, ExportMaterialResource, ExportTerrain, ExportTextureResource, FBXReportToolMessage, GetGameMaterials, GetLayerInteraction, GetPathToAssetsFromGuids, GetPortalMat, GetPrefabChildInfo, GetPrefabGUID, GetRelativePath, GetResourceInfo, LayerPresets, LoadedProjects, LocatePrefabsFromPath, LocateProject, MaterialValidator, OpenXOB, OverrideMeshObjectMaterial, PrefabImporter, PrefabImporterBake, RegisterResource, TextureValidation, and TextureValidator.

GetResponse()

JsonApiStruct NetApiHandler.GetResponse

(

JsonApiStruct

request

)

override to create custom respond data

Implemented in AnimExportProfileChannels, AnimExportProfiles, AnimExportTrackExport, BakeInfo, CheckGUID, EBTInfo, ExampleCall, ExportFBXResource, ExportMaterialResource, ExportTerrain, ExportTextureResource, FBXReportToolMessage, GetGameMaterials, GetLayerInteraction, GetLoadedProjects, GetPathToAssetsFromGuids, GetPortalMat, GetPrefabChildInfo, GetPrefabGUID, GetRelativePath, GetResourceInfo, LayerPresets, LoadedProjects, LocatePrefabsFromPath, LocateProject, MaterialValidator, OpenXOB, OverrideMeshObjectMaterial, PrefabImporter, PrefabImporterBake, RegisterResource, TextureValidation, and TextureValidator.

---

The documentation for this interface was generated from the following file:

• WorkbenchGameCommon/generated/NetApi/NetApiHandler.c