Navigation
API > API/Runtime > API/Runtime/ExternalRpcRegistry > API/Runtime/ExternalRpcRegistry/UExternalRpcRegistrationComponen-
Overloads
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void RegisterHttpCallback
(
FExternalRouteInfo InRouteInfo, |
Hooks up a given delegate to the assigned route for external access. | ExternalRpcRegistrationComponent.h | |
void RegisterHttpCallback
(
FName RouteName, |
Hooks up a given delegate to the assigned route for external access. | ExternalRpcRegistrationComponent.h |
RegisterHttpCallback(FExternalRouteInfo, const FHttpRequestHandler &, bool)
Description
Hooks up a given delegate to the assigned route for external access. Use if you already have an FExternalRouteInfo object.
| Name | RegisterHttpCallback |
| Type | function |
| Header File | /Engine/Source/Runtime/ExternalRPCRegistry/Public/ExternalRpcRegistrationComponent.h |
| Include Path | #include "ExternalRpcRegistrationComponent.h" |
| Source | /Engine/Source/Runtime/ExternalRPCRegistry/Private/ExternalRpcRegistrationComponent.cpp |
void RegisterHttpCallback
(
FExternalRouteInfo InRouteInfo,
const FHttpRequestHandler & Handler,
bool bOverrideIfBound
)
Parameters
| Name | Remarks |
|---|---|
| InRouteInfo | A fully initialized FExternalRouteInfo object that describes the overall endpoint. |
| Handler | The function delegate to call when this route is accessed. |
| bOverrideIfBound | Whether or not this registry should override any previously registered route. |
RegisterHttpCallback(FName, const FHttpPath &, const EHttpServerRequestVerbs &, const FHttpRequestHandler &, bool, FString, FString, TArray< FExternalRpcArgumentDesc >)
Description
Hooks up a given delegate to the assigned route for external access. Handles creation of FExternalRouteInfo from its core parts.
| Name | RegisterHttpCallback |
| Type | function |
| Header File | /Engine/Source/Runtime/ExternalRPCRegistry/Public/ExternalRpcRegistrationComponent.h |
| Include Path | #include "ExternalRpcRegistrationComponent.h" |
| Source | /Engine/Source/Runtime/ExternalRPCRegistry/Private/ExternalRpcRegistrationComponent.cpp |
void RegisterHttpCallback
(
FName RouteName,
const FHttpPath & HttpPath,
const EHttpServerRequestVerbs & RequestVerbs,
const FHttpRequestHandler & Handler,
bool bOverrideIfBound,
FString OptionalCategory,
FString OptionalContentType,
TArray< FExternalRpcArgumentDesc > OptionalInArguments
)
Parameters
| Name | Remarks |
|---|---|
| RouteName | The friendly name of the route - used frequently in gauntlet for easier use. |
| HttpPath | Desired route for this delegate. Will be appended onto http:// |
| RequestVerbs | Verbs that should be accepted on this route. |
| Handler | The function delegate to call when this route is accessed. |
| bOverrideIfBound | Whether or not this registry should override any previously registered delegate at this route. |
| OptionalCategory | An optional category that can be added for organizational purposes |
| OptionalContentType | The sort of content type that is expected for the request body |
| OptionalInArguments | A list of arguments expected by this route. Can be set to optional or mandatory. |