1. Epic GamesDeveloper
  3. FWebAPIProviderSettings

FWebAPIProviderSettings

Encapsulates settings for WebAPI providers.

API > API/Plugins > API/Plugins/WebAPIEditor

Encapsulates settings for WebAPI providers.

   
Name FWebAPIProviderSettings
Type struct
Header File /Engine/Plugins/Experimental/Web/WebAPI/Source/WebAPIEditor/Public/WebAPIProviderSettings.h
Include Path #include "WebAPIProviderSettings.h"

Syntax

USTRUCT (BlueprintType )  
struct FWebAPIProviderSettings

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
bEnableArbitraryJsonPayloads bool Enable this option to allow the user to supply arbitrary json data to any request without parameters. WebAPIProviderSettings.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Provider"

Protected

Name Type Remarks Include Path Unreal Specifiers
DefaultArrayPropertyName FString   WebAPIProviderSettings.h
  • VisibleAnywhere
  • AdvancedDisplay
  • Category="Provider"
DefaultPropertyName FString   WebAPIProviderSettings.h
  • VisibleAnywhere
  • AdvancedDisplay
  • Category="Provider"
NestedPropertyTypeNameTemplate FString   WebAPIProviderSettings.h
  • VisibleAnywhere
  • AdvancedDisplay
  • Category="Provider"
OperationObjectNameTemplate FString   WebAPIProviderSettings.h
  • VisibleAnywhere
  • AdvancedDisplay
  • Category="Provider"
ParameterTypeNameTemplate FString   WebAPIProviderSettings.h
  • VisibleAnywhere
  • AdvancedDisplay
  • Category="Provider"
RequestTypeNameTemplate FString   WebAPIProviderSettings.h
  • VisibleAnywhere
  • AdvancedDisplay
  • Category="Provider"
ResponseTypeNameTemplate FString   WebAPIProviderSettings.h
  • VisibleAnywhere
  • AdvancedDisplay
  • Category="Provider"
UnsetEnumValueName FString   WebAPIProviderSettings.h
  • VisibleAnywhere
  • AdvancedDisplay
  • Category="Provider"

Functions

Public

Name Remarks Include Path Unreal Specifiers

const FString & GetDefaultArrayPropertyName()

 Return the default name given to array properties. WebAPIProviderSettings.h  

const FString & GetDefaultPropertyName()

 Return the default name given to (single item) properties. WebAPIProviderSettings.h  

const FString & GetUnsetEnumValueName ()

 Return the name of an "unset" value for a generated enum. WebAPIProviderSettings.h  

FString MakeNestedPropertyTypeName ( const FWebAPITypeNameVariant& InModelName,
const FWebAPINameVariant& InPropertyName
) const

 Makes a unique TypeName based on the provided Model and Property names. WebAPIProviderSettings.h  

FName MakeOperationObjectName ( const TObjectPtr< UWebAPIService >& InService,
const FWebAPITypeNameVariant& InOperationName
) const

 Makes a unique TypeName based on the provided Service and Operations names. WebAPIProviderSettings.h  

FString MakeParameterTypeName ( const FWebAPINameVariant& InParameterName
) const

 Makes a unique TypeName based on the provided Parameter name. WebAPIProviderSettings.h  

FString MakeRequestTypeName ( const FWebAPITypeNameVariant& InOperationName
) const

 Makes a unique TypeName based on the provided Operation name. WebAPIProviderSettings.h  

FString MakeResponseTypeName ( const FWebAPITypeNameVariant& InOperationName,
const uint32& InResponseCode
) const

 Makes a unique TypeName based on the provided Operation name and response code. WebAPIProviderSettings.h  

FString MakeValidMemberName ( const FWebAPINameVariant& InString,
const FString& InPrefix
) const

 Strips the provided string of invalid characters for a member name. WebAPIProviderSettings.h  

FString Pluralize ( const FString& InString
) const

 Returns a pluralized version of the provided string. Currently only works for english words. WebAPIProviderSettings.h  

FString Singularize ( const FString& InString
) const

 Returns a singularized version of the provided plural string. WebAPIProviderSettings.h  

FString ToInitials ( const FWebAPINameVariant& InString
) const

 Converts the given string to it's initials. WebAPIProviderSettings.h  

FString ToPascalCase ( const FWebAPINameVariant& InString
) const

 Converts the given string to Pascal Case (aka. Upper Camel Case). WebAPIProviderSettings.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page