RHAPI_OAuthTokenResponse

Summary

Members	Descriptions
struct FRHAPI_OAuthTokenResponse	OAuth token exchange response. Successful response will contain an access_token and refresh_token. If the user has not accepted all required agreements, the response will contain the appropriate needs_* flags and a regenerated_code. The regenerated_code is an authorization_code that can be used after the user has accepted the required agreements.

struct FRHAPI_OAuthTokenResponse

struct FRHAPI_OAuthTokenResponse
  : public FRHAPI_Model

OAuth token exchange response. Successful response will contain an access_token and refresh_token. If the user has not accepted all required agreements, the response will contain the appropriate needs_* flags and a regenerated_code. The regenerated_code is an authorization_code that can be used after the user has accepted the required agreements.

Summary

Members	Descriptions
public FString AccessToken_Optional	Access token for the user.
public bool AccessToken_IsSet	true if AccessToken_Optional has been set to a value
public FString RefreshToken_Optional	Refresh token for the user.
public bool RefreshToken_IsSet	true if RefreshToken_Optional has been set to a value
public bool NeedsEula_Optional	If true, the user must accept the EULA before a token can be generated.
public bool NeedsEula_IsSet	true if NeedsEula_Optional has been set to a value
public bool NeedsTos_Optional	If true, the user must accept the TOS before a token can be generated.
public bool NeedsTos_IsSet	true if NeedsTos_Optional has been set to a value
public bool NeedsPrivacyPolicy_Optional	If true, the user must accept the Privacy Policy before a token can be generated.
public bool NeedsPrivacyPolicy_IsSet	true if NeedsPrivacyPolicy_Optional has been set to a value
public FString RegeneratedCode_Optional	If present, a new code was generated and can be used after the user accepts the required agreements.
public bool RegeneratedCode_IsSet	true if RegeneratedCode_Optional has been set to a value
public FString ErrorMessage_Optional	Error message if an error occurred.
public bool ErrorMessage_IsSet	true if ErrorMessage_Optional has been set to a value
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_Optional, regardless of it having been set.
public inline const FString & GetAccessToken() const	Gets the value of AccessToken_Optional, regardless of it having been set.
public inline const FString & GetAccessToken(const FString & DefaultValue) const	Gets the value of AccessToken_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetAccessToken(FString & OutValue) const	Fills OutValue with the value of AccessToken_Optional and returns true if it has been set, otherwise returns false.
public inline FString * GetAccessTokenOrNull()	Returns a pointer to AccessToken_Optional, if it has been set, otherwise returns nullptr.
public inline const FString * GetAccessTokenOrNull() const	Returns a pointer to AccessToken_Optional, if it has been set, otherwise returns nullptr.
public inline void SetAccessToken(FString NewValue)	Sets the value of AccessToken_Optional and also sets AccessToken_IsSet to true.
public inline void ClearAccessToken()	Clears the value of AccessToken_Optional and sets AccessToken_IsSet to false.
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 bool & GetNeedsEula()	Gets the value of NeedsEula_Optional, regardless of it having been set.
public inline const bool & GetNeedsEula() const	Gets the value of NeedsEula_Optional, regardless of it having been set.
public inline const bool & GetNeedsEula(const bool & DefaultValue) const	Gets the value of NeedsEula_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetNeedsEula(bool & OutValue) const	Fills OutValue with the value of NeedsEula_Optional and returns true if it has been set, otherwise returns false.
public inline bool * GetNeedsEulaOrNull()	Returns a pointer to NeedsEula_Optional, if it has been set, otherwise returns nullptr.
public inline const bool * GetNeedsEulaOrNull() const	Returns a pointer to NeedsEula_Optional, if it has been set, otherwise returns nullptr.
public inline void SetNeedsEula(bool NewValue)	Sets the value of NeedsEula_Optional and also sets NeedsEula_IsSet to true.
public inline void ClearNeedsEula()	Clears the value of NeedsEula_Optional and sets NeedsEula_IsSet to false.
public inline bool IsNeedsEulaDefaultValue() const	Returns true if NeedsEula_Optional is set and matches the default value.
public inline void SetNeedsEulaToDefault()	Sets the value of NeedsEula_Optional to its default and also sets NeedsEula_IsSet to true.
public inline bool & GetNeedsTos()	Gets the value of NeedsTos_Optional, regardless of it having been set.
public inline const bool & GetNeedsTos() const	Gets the value of NeedsTos_Optional, regardless of it having been set.
public inline const bool & GetNeedsTos(const bool & DefaultValue) const	Gets the value of NeedsTos_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetNeedsTos(bool & OutValue) const	Fills OutValue with the value of NeedsTos_Optional and returns true if it has been set, otherwise returns false.
public inline bool * GetNeedsTosOrNull()	Returns a pointer to NeedsTos_Optional, if it has been set, otherwise returns nullptr.
public inline const bool * GetNeedsTosOrNull() const	Returns a pointer to NeedsTos_Optional, if it has been set, otherwise returns nullptr.
public inline void SetNeedsTos(bool NewValue)	Sets the value of NeedsTos_Optional and also sets NeedsTos_IsSet to true.
public inline void ClearNeedsTos()	Clears the value of NeedsTos_Optional and sets NeedsTos_IsSet to false.
public inline bool IsNeedsTosDefaultValue() const	Returns true if NeedsTos_Optional is set and matches the default value.
public inline void SetNeedsTosToDefault()	Sets the value of NeedsTos_Optional to its default and also sets NeedsTos_IsSet to true.
public inline bool & GetNeedsPrivacyPolicy()	Gets the value of NeedsPrivacyPolicy_Optional, regardless of it having been set.
public inline const bool & GetNeedsPrivacyPolicy() const	Gets the value of NeedsPrivacyPolicy_Optional, regardless of it having been set.
public inline const bool & GetNeedsPrivacyPolicy(const bool & DefaultValue) const	Gets the value of NeedsPrivacyPolicy_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetNeedsPrivacyPolicy(bool & OutValue) const	Fills OutValue with the value of NeedsPrivacyPolicy_Optional and returns true if it has been set, otherwise returns false.
public inline bool * GetNeedsPrivacyPolicyOrNull()	Returns a pointer to NeedsPrivacyPolicy_Optional, if it has been set, otherwise returns nullptr.
public inline const bool * GetNeedsPrivacyPolicyOrNull() const	Returns a pointer to NeedsPrivacyPolicy_Optional, if it has been set, otherwise returns nullptr.
public inline void SetNeedsPrivacyPolicy(bool NewValue)	Sets the value of NeedsPrivacyPolicy_Optional and also sets NeedsPrivacyPolicy_IsSet to true.
public inline void ClearNeedsPrivacyPolicy()	Clears the value of NeedsPrivacyPolicy_Optional and sets NeedsPrivacyPolicy_IsSet to false.
public inline bool IsNeedsPrivacyPolicyDefaultValue() const	Returns true if NeedsPrivacyPolicy_Optional is set and matches the default value.
public inline void SetNeedsPrivacyPolicyToDefault()	Sets the value of NeedsPrivacyPolicy_Optional to its default and also sets NeedsPrivacyPolicy_IsSet to true.
public inline FString & GetRegeneratedCode()	Gets the value of RegeneratedCode_Optional, regardless of it having been set.
public inline const FString & GetRegeneratedCode() const	Gets the value of RegeneratedCode_Optional, regardless of it having been set.
public inline const FString & GetRegeneratedCode(const FString & DefaultValue) const	Gets the value of RegeneratedCode_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetRegeneratedCode(FString & OutValue) const	Fills OutValue with the value of RegeneratedCode_Optional and returns true if it has been set, otherwise returns false.
public inline FString * GetRegeneratedCodeOrNull()	Returns a pointer to RegeneratedCode_Optional, if it has been set, otherwise returns nullptr.
public inline const FString * GetRegeneratedCodeOrNull() const	Returns a pointer to RegeneratedCode_Optional, if it has been set, otherwise returns nullptr.
public inline void SetRegeneratedCode(FString NewValue)	Sets the value of RegeneratedCode_Optional and also sets RegeneratedCode_IsSet to true.
public inline void ClearRegeneratedCode()	Clears the value of RegeneratedCode_Optional and sets RegeneratedCode_IsSet to false.
public inline FString & GetErrorMessage()	Gets the value of ErrorMessage_Optional, regardless of it having been set.
public inline const FString & GetErrorMessage() const	Gets the value of ErrorMessage_Optional, regardless of it having been set.
public inline const FString & GetErrorMessage(const FString & DefaultValue) const	Gets the value of ErrorMessage_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetErrorMessage(FString & OutValue) const	Fills OutValue with the value of ErrorMessage_Optional and returns true if it has been set, otherwise returns false.
public inline FString * GetErrorMessageOrNull()	Returns a pointer to ErrorMessage_Optional, if it has been set, otherwise returns nullptr.
public inline const FString * GetErrorMessageOrNull() const	Returns a pointer to ErrorMessage_Optional, if it has been set, otherwise returns nullptr.
public inline void SetErrorMessage(FString NewValue)	Sets the value of ErrorMessage_Optional and also sets ErrorMessage_IsSet to true.
public inline void ClearErrorMessage()	Clears the value of ErrorMessage_Optional and sets ErrorMessage_IsSet to false.

Members

public FString AccessToken_Optional

Access token for the user.

public bool AccessToken_IsSet

true if AccessToken_Optional has been set to a value

public FString RefreshToken_Optional

Refresh token for the user.

public bool RefreshToken_IsSet

true if RefreshToken_Optional has been set to a value

public bool NeedsEula_Optional

If true, the user must accept the EULA before a token can be generated.

public bool NeedsEula_IsSet

true if NeedsEula_Optional has been set to a value

public bool NeedsTos_Optional

If true, the user must accept the TOS before a token can be generated.

public bool NeedsTos_IsSet

true if NeedsTos_Optional has been set to a value

public bool NeedsPrivacyPolicy_Optional

If true, the user must accept the Privacy Policy before a token can be generated.

public bool NeedsPrivacyPolicy_IsSet

true if NeedsPrivacyPolicy_Optional has been set to a value

public FString RegeneratedCode_Optional

If present, a new code was generated and can be used after the user accepts the required agreements.

public bool RegeneratedCode_IsSet

true if RegeneratedCode_Optional has been set to a value

public FString ErrorMessage_Optional

Error message if an error occurred.

public bool ErrorMessage_IsSet

true if ErrorMessage_Optional has been set to a value

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_Optional, regardless of it having been set.

public inline const FString & GetAccessToken() const

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

public inline const FString & GetAccessToken(const FString & DefaultValue) const

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

public inline bool GetAccessToken(FString & OutValue) const

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

public inline FString * GetAccessTokenOrNull()

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

public inline const FString * GetAccessTokenOrNull() const

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

public inline void SetAccessToken(FString NewValue)

Sets the value of AccessToken_Optional and also sets AccessToken_IsSet to true.

public inline void ClearAccessToken()

Clears the value of AccessToken_Optional and sets AccessToken_IsSet to false.

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 bool & GetNeedsEula()

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

public inline const bool & GetNeedsEula() const

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

public inline const bool & GetNeedsEula(const bool & DefaultValue) const

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

public inline bool GetNeedsEula(bool & OutValue) const

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

public inline bool * GetNeedsEulaOrNull()

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

public inline const bool * GetNeedsEulaOrNull() const

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

public inline void SetNeedsEula(bool NewValue)

Sets the value of NeedsEula_Optional and also sets NeedsEula_IsSet to true.

public inline void ClearNeedsEula()

Clears the value of NeedsEula_Optional and sets NeedsEula_IsSet to false.

public inline bool IsNeedsEulaDefaultValue() const

Returns true if NeedsEula_Optional is set and matches the default value.

public inline void SetNeedsEulaToDefault()

Sets the value of NeedsEula_Optional to its default and also sets NeedsEula_IsSet to true.

public inline bool & GetNeedsTos()

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

public inline const bool & GetNeedsTos() const

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

public inline const bool & GetNeedsTos(const bool & DefaultValue) const

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

public inline bool GetNeedsTos(bool & OutValue) const

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

public inline bool * GetNeedsTosOrNull()

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

public inline const bool * GetNeedsTosOrNull() const

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

public inline void SetNeedsTos(bool NewValue)

Sets the value of NeedsTos_Optional and also sets NeedsTos_IsSet to true.

public inline void ClearNeedsTos()

Clears the value of NeedsTos_Optional and sets NeedsTos_IsSet to false.

public inline bool IsNeedsTosDefaultValue() const

Returns true if NeedsTos_Optional is set and matches the default value.

public inline void SetNeedsTosToDefault()

Sets the value of NeedsTos_Optional to its default and also sets NeedsTos_IsSet to true.

public inline bool & GetNeedsPrivacyPolicy()

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

public inline const bool & GetNeedsPrivacyPolicy() const

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

public inline const bool & GetNeedsPrivacyPolicy(const bool & DefaultValue) const

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

public inline bool GetNeedsPrivacyPolicy(bool & OutValue) const

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

public inline bool * GetNeedsPrivacyPolicyOrNull()

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

public inline const bool * GetNeedsPrivacyPolicyOrNull() const

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

public inline void SetNeedsPrivacyPolicy(bool NewValue)

Sets the value of NeedsPrivacyPolicy_Optional and also sets NeedsPrivacyPolicy_IsSet to true.

public inline void ClearNeedsPrivacyPolicy()

Clears the value of NeedsPrivacyPolicy_Optional and sets NeedsPrivacyPolicy_IsSet to false.

public inline bool IsNeedsPrivacyPolicyDefaultValue() const

Returns true if NeedsPrivacyPolicy_Optional is set and matches the default value.

public inline void SetNeedsPrivacyPolicyToDefault()

Sets the value of NeedsPrivacyPolicy_Optional to its default and also sets NeedsPrivacyPolicy_IsSet to true.

public inline FString & GetRegeneratedCode()

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

public inline const FString & GetRegeneratedCode() const

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

public inline const FString & GetRegeneratedCode(const FString & DefaultValue) const

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

public inline bool GetRegeneratedCode(FString & OutValue) const

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

public inline FString * GetRegeneratedCodeOrNull()

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

public inline const FString * GetRegeneratedCodeOrNull() const

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

public inline void SetRegeneratedCode(FString NewValue)

Sets the value of RegeneratedCode_Optional and also sets RegeneratedCode_IsSet to true.

public inline void ClearRegeneratedCode()

Clears the value of RegeneratedCode_Optional and sets RegeneratedCode_IsSet to false.

public inline FString & GetErrorMessage()

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

public inline const FString & GetErrorMessage() const

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

public inline const FString & GetErrorMessage(const FString & DefaultValue) const

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

public inline bool GetErrorMessage(FString & OutValue) const

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

public inline FString * GetErrorMessageOrNull()

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

public inline const FString * GetErrorMessageOrNull() const

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

public inline void SetErrorMessage(FString NewValue)

Sets the value of ErrorMessage_Optional and also sets ErrorMessage_IsSet to true.

public inline void ClearErrorMessage()

Clears the value of ErrorMessage_Optional and sets ErrorMessage_IsSet to false.