RHAPI_TokenResponse
Summary
Members | Descriptions |
---|---|
struct FRHAPI_TokenResponse | OAuth2 Token Response. |
struct FRHAPI_TokenResponse
struct FRHAPI_TokenResponse
: public FRHAPI_Model
OAuth2 Token Response.
Summary
Members | Descriptions |
---|---|
public FString AccessToken | Result access token. |
public FString TokenType | Result token type. |
public FString RefreshToken_Optional | Result refresh token that can be used to get new access tokens. |
public bool RefreshToken_IsSet | true if RefreshToken_Optional has been set to a value |
public int32 ExpiresIn | Result 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) const | Writes 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 () const | Gets 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 () const | Gets 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 () const | Gets the value of RefreshToken_Optional, regardless of it having been set. |
public inline const FString & GetRefreshToken (const FString & DefaultValue) const | Gets the value of RefreshToken_Optional, if it has been set, otherwise it returns DefaultValue. |
public inline bool GetRefreshToken (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 () | Returns a pointer to RefreshToken_Optional, if it has been set, otherwise returns nullptr. |
public inline const FString * GetRefreshTokenOrNull () const | Returns 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 () const | Gets the value of ExpiresIn. |
public inline void SetExpiresIn (int32 NewValue) | Sets the value of ExpiresIn. |
public inline bool IsExpiresInDefaultValue () const | Returns 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
Result token type.
public FString
RefreshToken_Optional
Result refresh token that can be used to get new access tokens.
public bool
RefreshToken_IsSet
true if RefreshToken_Optional has been set to a value
public int32
ExpiresIn
Result access token expiration time in seconds.
public virtual bool
FromJson
(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
(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
()
Gets the value of AccessToken.
public inline const FString &
GetAccessToken
() const
Gets 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
() const
Gets 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
() const
Gets the value of RefreshToken_Optional, regardless of it having been set.
public inline const FString &
GetRefreshToken
(const FString & DefaultValue) const
Gets the value of RefreshToken_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool
GetRefreshToken
(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
()
Returns a pointer to RefreshToken_Optional, if it has been set, otherwise returns nullptr.
public inline const FString *
GetRefreshTokenOrNull
() const
Returns 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
() const
Gets the value of ExpiresIn.
public inline void
SetExpiresIn
(int32 NewValue)
Sets the value of ExpiresIn.
public inline bool
IsExpiresInDefaultValue
() const
Returns true if ExpiresIn matches the default value.
public inline void
SetExpiresInToDefault
()
Sets the value of ExpiresIn to its default