1. Epic GamesDeveloper
  3. FURL_RFC3986

FURL_RFC3986

API > API/Plugins > API/Plugins/ElectraBase

   
Name FURL_RFC3986
Type class
Header File /Engine/Plugins/Media/ElectraUtil/Source/ElectraBase/Public/Utilities/URLParser.h
Include Path #include "Utilities/URLParser.h"

Syntax

class FURL_RFC3986

Structs

Name Remarks
FQueryParam  

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
bIsData bool   Utilities/URLParser.h  
bIsFile bool   Utilities/URLParser.h  
Fragment FString   Utilities/URLParser.h  
Host FString   Utilities/URLParser.h  
Path FString   Utilities/URLParser.h  
Port FString   Utilities/URLParser.h  
Query FString   Utilities/URLParser.h  
Scheme FString   Utilities/URLParser.h  
UserInfo FString   Utilities/URLParser.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AddOrUpdateQueryParams ( const TArray< FQueryParam >& InQueryParams
)

 Updates existing parameters with new value or adds new parameters. Utilities/URLParser.h  

void AddOrUpdateQueryParams ( const FString& InQueryParameters
)

   Utilities/URLParser.h  

FString Get ( bool bIncludeQuery,
bool bIncludeFragment
)

 Returns the full URL with or without query and fragment parts. Characters will be escaped if necessary. Utilities/URLParser.h  

FString GetFragment()

 Returns the fragment, if any, without the leading '#'. Escape sequences will already be decoded. Utilities/URLParser.h  

FString GetHost()

 Returns the host, if present. Utilities/URLParser.h  

FString GetLastPathComponent()

 Returns the last path component (the "filename"). Utilities/URLParser.h  

FString GetPath ( bool bIncludeQuery,
bool bIncludeFragment
)

 Returns the path (no scheme or host) with or without query and fragment parts. Characters will be escaped if necessary. Utilities/URLParser.h  
Returns the path. Escape sequences will already be decoded. Utilities/URLParser.h  

bool GetPathComponents ( TArray< FString >& OutPathComponents
) const

 Returns the path as individual components. Like GetPath() the components will have escape sequences already decoded. Utilities/URLParser.h  

FString GetPort()

 Returns the port, if present. Utilities/URLParser.h  

FString GetQuery()

 Returns the entire query string, if any, without the leading '?'. Escape sequences will still be present! Utilities/URLParser.h  

void GetQueryParams ( TArray< FQueryParam >& OutQueryParams,
bool bPerformUrlDecoding,
bool bSameNameReplacesValue
)

 Returns the query parameters as a list of name/value pairs. Utilities/URLParser.h  

FString GetScheme()

 Returns the scheme, if present. Does not include the :// sequence. Utilities/URLParser.h  

bool HasSameOriginAs ( const FURL_RFC3986& Other
)

 Returns if this URL has the same origin as another one as per RFC 6454. Utilities/URLParser.h  

bool IsAbsolute()

 Returns whether or not this URL is absolute (the scheme not being empty). Utilities/URLParser.h  

bool MakeRelativePath ( FString& OutRelativePath,
const FString& InAbsoluteURLToMakeRelativeToThis
) const

 Attempts to make an absolute URL relative to this one. Utilities/URLParser.h  

bool Parse ( const FString& InURL
)

 Parses the given URL. Utilities/URLParser.h  

FURL_RFC3986 & ResolveAgainst ( const FString& InParentURL
)

 Resolves this URL (which should be relative) against the specified URL. Utilities/URLParser.h  

FURL_RFC3986 & ResolveWith ( const FString& InChildURL
)

 Resolves a relative URL against this one. Utilities/URLParser.h  

void ResolveWith ( const FURL_RFC3986& Other
)

 Resolves the given (relative) URL against this one, which will be modified. Utilities/URLParser.h  

void SetFragment ( const FString& InNewFragment
)

   Utilities/URLParser.h  

void SetHost ( const FString& InNewHost
)

   Utilities/URLParser.h  

void SetPath ( const FString& InNewPath
)

   Utilities/URLParser.h  

void SetPort ( const FString& InNewPort
)

   Utilities/URLParser.h  

void SetQuery ( const FString& InNewQuery
)

   Utilities/URLParser.h  

void SetQueryParams ( const TArray< FQueryParam >& InQueryParams
)

 Replaces query parameters in the URL. Utilities/URLParser.h  

void SetScheme ( const FString& InNewScheme
)

   Utilities/URLParser.h  

Static

Name Remarks Include Path Unreal Specifiers

static void GetPathComponents ( TArray< FString >& OutPathComponents,
const FString& InPath
)

   Utilities/URLParser.h  

static void GetQueryParams ( TArray< FQueryParam >& OutQueryParams,
const FString& InQueryParameters,
bool bPerformUrlDecoding,
bool bSameNameReplacesValue
)

 Returns the given query parameter string as a list of name/value pairs. Utilities/URLParser.h  

static FString GetStandardPortForScheme ( const FString& InScheme,
bool bIgnoreCase
)

 Returns the standard port for the given scheme. An empty string is returned if none is known. Utilities/URLParser.h  

static FString GetUrlEncodeSubDelimsChars()

 Returns a string containing the "sub-delims" chars that are permitted in the query string that do not need to be escaped. Utilities/URLParser.h  

static bool UrlDecode ( FString& OutResult,
const FString& InUrlToDecode
)

 Decodes XX escaped sequences into their original characters. Appends to the output. Hence in and out must not be the same. Utilities/URLParser.h  

static bool UrlEncode ( FString& OutResult,
const FString& InUrlToEncode,
const FString& InCharsToKeep
)

 Encodes characters not permitted in a URL into XX escaped sequences. Utilities/URLParser.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page