1. Epic GamesDeveloper
  3. FURL_RFC3986

FURL_RFC3986

API > API/Plugins > API/Plugins/ElectraBase > API/Plugins/ElectraBase/Utilities

References

   
Module ElectraBase
Header /Engine/Plugins/Media/ElectraUtil/Source/ElectraBase/Public/Utilities/URLParser.h
Include #include "Utilities/URLParser.h"

Syntax

class FURL_RFC3986

Functions

  Type Name Description
Public function void

AddQueryParameters ( const FString& InQueryParameters,
bool bAppend
)

 Appends or prepends additional query parameters.
Public function FString

Get ( bool bIncludeQuery,
bool bIncludeFragment
)

 Returns the full URL with or without query and fragment parts. Characters will be escaped if necessary.
Public function Const FString Returns the fragment, if any, without the leading '#'. Escape sequences will already be decoded.
Public function Const FString

GetHost ()

 Returns the host, if present.
Public function Const FString Returns the last path component (the "filename").
Public function 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.
Public function Const FString

GetPath ()

 Returns the path. Escape sequences will already be decoded.
Public function Const void

GetPathComponents ( TArray< FString >& OutPathComponents
)

 Returns the path as individual components. Like GetPath() the components will have escape sequences already decoded.
Public function Const FString

GetPort ()

 Returns the port, if present.
Public function Const FString Returns the entire query string, if any, without the leading '?'. Escape sequences will still be present!
Public function 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.
Public function void

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

 Returns the query parameters as a list of name/value pairs.
Public function Const FString Returns the scheme, if present. Does not include the :// sequence.
Public function 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.
Public function bool

HasSameOriginAs ( const FURL_RFC3986& Other
)

 Returns if this URL has the same origin as another one as per RFC 6454.
Public function Const bool Returns whether or not this URL is absolute (the scheme not being empty).
Public function bool

Parse ( const FString& InURL
)

 Parses the given URL.
Public function FURL_RFC3986 &

ResolveAgainst ( const FString& InParentURL
)

 Resolves this URL (which should be relative) against the specified URL.
Public function FURL_RFC3986 &

ResolveWith ( const FString& InChildURL
)

 Resolves a relative URL against this one.
Public function void

SetQueryParams ( const TArray< FQueryParam >& InQueryParams
)

 Replaces query parameters in the URL.
Public function 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.
Public function Static bool

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

 Encodes characters not permitted in a URL into XX escaped sequences.

Classes

  Type Name Description
Public struct FQueryParam    

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page