Skip to content

RHAPI_TokenResponse

Summary

MembersDescriptions
struct FRHAPI_TokenResponseOAuth2 Token Response.

struct FRHAPI_TokenResponse

struct FRHAPI_TokenResponse
: public FRHAPI_Model

OAuth2 Token Response.

Summary

MembersDescriptions
public FString AccessTokenResult access token.
public FString TokenTypeResult token type.
public FString RefreshToken_OptionalResult refresh token that can be used to get new access tokens.
public bool RefreshToken_IsSettrue if RefreshToken_Optional has been set to a value
public int32 ExpiresInResult access token expiration time in seconds.
public virtual bool FromJson(const TSharedPtr< FJsonValue > & JsonValue)Fills this object with data from the passed in JSON.
public virtual void WriteJson(TSharedRef< TJsonWriter<>> & Writer) constWrites the data from this object into the specified JSON Writer stream.
public inline FString & GetAccessToken()Gets the value of AccessToken.
public inline const FString & GetAccessToken() constGets the value of AccessToken.
public inline void SetAccessToken(FString NewValue)Sets the value of AccessToken.
public inline FString & GetTokenType()Gets the value of TokenType.
public inline const FString & GetTokenType() constGets the value of TokenType.
public inline void SetTokenType(FString NewValue)Sets the value of TokenType.
public inline FString & GetRefreshToken()Gets the value of RefreshToken_Optional, regardless of it having been set.
public inline const FString & GetRefreshToken() constGets the value of RefreshToken_Optional, regardless of it having been set.
public inline const FString & GetRefreshToken(const FString & DefaultValue) constGets the value of RefreshToken_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetRefreshToken(FString & OutValue) constFills OutValue with the value of RefreshToken_Optional and returns true if it has been set, otherwise returns false.
public inline FString * GetRefreshTokenOrNull()Returns a pointer to RefreshToken_Optional, if it has been set, otherwise returns nullptr.
public inline const FString * GetRefreshTokenOrNull() constReturns a pointer to RefreshToken_Optional, if it has been set, otherwise returns nullptr.
public inline void SetRefreshToken(FString NewValue)Sets the value of RefreshToken_Optional and also sets RefreshToken_IsSet to true.
public inline void ClearRefreshToken()Clears the value of RefreshToken_Optional and sets RefreshToken_IsSet to false.
public inline int32 & GetExpiresIn()Gets the value of ExpiresIn.
public inline const int32 & GetExpiresIn() constGets the value of ExpiresIn.
public inline void SetExpiresIn(int32 NewValue)Sets the value of ExpiresIn.
public inline bool IsExpiresInDefaultValue() constReturns true if ExpiresIn matches the default value.
public inline void SetExpiresInToDefault()Sets the value of ExpiresIn to its default

Members

public FString AccessToken

Result access token.


#### `public FString `[`TokenType`](#structFRHAPI__TokenResponse_1acd10a81c1610bcddf359e92696b63489)

Result token type.


#### `public FString `[`RefreshToken_Optional`](#structFRHAPI__TokenResponse_1ac68a5e1154530c8e88fb8ac2f508ab72)

Result refresh token that can be used to get new access tokens.


#### `public bool `[`RefreshToken_IsSet`](#structFRHAPI__TokenResponse_1af8d74d0749fb2de5acdf4acfe60272f3)

true if RefreshToken_Optional has been set to a value


#### `public int32 `[`ExpiresIn`](#structFRHAPI__TokenResponse_1a86483ede9759e7f6e91e8699982e7d2e)

Result access token expiration time in seconds.


#### `public virtual bool `[`FromJson`](#structFRHAPI__TokenResponse_1aa9593a8aca941473bdec4de63517e340)`(const TSharedPtr< FJsonValue > & JsonValue)`

Fills this object with data from the passed in JSON.

Parameters

  • JsonValue Data from the API call.

Returns

true if parsing of the JSON data was successful.


#### `public virtual void `[`WriteJson`](#structFRHAPI__TokenResponse_1a667fb38cc9a4612f7b20de637d509c56)`(TSharedRef< TJsonWriter<>> & Writer) const`

Writes the data from this object into the specified JSON Writer stream.

Parameters

  • Writer JSON Writer stream to push .

#### `public inline FString & `[`GetAccessToken`](#structFRHAPI__TokenResponse_1ae02bb6e092058e18ccf61352b24820b5)`()`

Gets the value of AccessToken.


#### `public inline const FString & `[`GetAccessToken`](#structFRHAPI__TokenResponse_1ad604cb33c5feaf308d4c76460ec5bb41)`() const`

Gets the value of AccessToken.


#### `public inline void `[`SetAccessToken`](#structFRHAPI__TokenResponse_1a51f07bcf002ad820887147d4dfc4e279)`(FString NewValue)`

Sets the value of AccessToken.


#### `public inline FString & `[`GetTokenType`](#structFRHAPI__TokenResponse_1a5676d4c5ee5f92f90d90372734b0d073)`()`

Gets the value of TokenType.


#### `public inline const FString & `[`GetTokenType`](#structFRHAPI__TokenResponse_1a5247437cd4681320b756bf9974ab5e86)`() const`

Gets the value of TokenType.


#### `public inline void `[`SetTokenType`](#structFRHAPI__TokenResponse_1ac357edf097024f10de5077248e04d7d5)`(FString NewValue)`

Sets the value of TokenType.


#### `public inline FString & `[`GetRefreshToken`](#structFRHAPI__TokenResponse_1aeb7b6f2350eefadc8ad42799b2d937ef)`()`

Gets the value of RefreshToken_Optional, regardless of it having been set.


#### `public inline const FString & `[`GetRefreshToken`](#structFRHAPI__TokenResponse_1aa39c5af160236c69e2f47f0ea4d440c9)`() const`

Gets the value of RefreshToken_Optional, regardless of it having been set.


#### `public inline const FString & `[`GetRefreshToken`](#structFRHAPI__TokenResponse_1af2e4a443449b46145042457026d9a90a)`(const FString & DefaultValue) const`

Gets the value of RefreshToken_Optional, if it has been set, otherwise it returns DefaultValue.


#### `public inline bool `[`GetRefreshToken`](#structFRHAPI__TokenResponse_1a7d6ac2dde662779996bfa707f5e8f4aa)`(FString & OutValue) const`

Fills OutValue with the value of RefreshToken_Optional and returns true if it has been set, otherwise returns false.


#### `public inline FString * `[`GetRefreshTokenOrNull`](#structFRHAPI__TokenResponse_1a8361fb23129ce5754854ec8df8a37caf)`()`

Returns a pointer to RefreshToken_Optional, if it has been set, otherwise returns nullptr.


#### `public inline const FString * `[`GetRefreshTokenOrNull`](#structFRHAPI__TokenResponse_1a24388acb3504f05e34ae5418c123c4c4)`() const`

Returns a pointer to RefreshToken_Optional, if it has been set, otherwise returns nullptr.


#### `public inline void `[`SetRefreshToken`](#structFRHAPI__TokenResponse_1a8d8ee7e703a1aa50e5a9ba430c1c853e)`(FString NewValue)`

Sets the value of RefreshToken_Optional and also sets RefreshToken_IsSet to true.


#### `public inline void `[`ClearRefreshToken`](#structFRHAPI__TokenResponse_1a74cbde90c757cf242fc68161279ebfb8)`()`

Clears the value of RefreshToken_Optional and sets RefreshToken_IsSet to false.


#### `public inline int32 & `[`GetExpiresIn`](#structFRHAPI__TokenResponse_1a6756fc1ebbcd784b9a872ad5262fe371)`()`

Gets the value of ExpiresIn.


#### `public inline const int32 & `[`GetExpiresIn`](#structFRHAPI__TokenResponse_1a190123e7780c4e2e63fe2dee23ab5bc8)`() const`

Gets the value of ExpiresIn.


#### `public inline void `[`SetExpiresIn`](#structFRHAPI__TokenResponse_1ae472d563faf9b86d29b8f2250919d0be)`(int32 NewValue)`

Sets the value of ExpiresIn.


#### `public inline bool `[`IsExpiresInDefaultValue`](#structFRHAPI__TokenResponse_1aaa2d99ce14af9262ac9c281daa9dd414)`() const`

Returns true if ExpiresIn matches the default value.


#### `public inline void `[`SetExpiresInToDefault`](#structFRHAPI__TokenResponse_1a22b23057ad1e9278d2e1d605bd3edaae)`()`

Sets the value of ExpiresIn to its default