Skip to main content

RHAPI_VoipTokenResponse

Summary​

MembersDescriptions
struct FRHAPI_VoipTokenResponse

struct FRHAPI_VoipTokenResponse ​

struct FRHAPI_VoipTokenResponse
: public FRHAPI_Model

Summary​

MembersDescriptions
public FString TokenSigned auth voip login token for a specific client.
public FString IssuerIssuer for client's login token.
public FString ServerServer for voip login.
public FString ChannelName_OptionalChannel name for the generated token if relevant.
public bool ChannelName_IsSettrue if ChannelName_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) constWrites the data from this object into the specified JSON Writer stream.
public inline FString & GetToken()Gets the value of Token.
public inline const FString & GetToken() constGets the value of Token.
public inline void SetToken(const FString & NewValue)Sets the value of Token.
public inline void SetToken(FString && NewValue)Sets the value of Token using move semantics.
public inline FString & GetIssuer()Gets the value of Issuer.
public inline const FString & GetIssuer() constGets the value of Issuer.
public inline void SetIssuer(const FString & NewValue)Sets the value of Issuer.
public inline void SetIssuer(FString && NewValue)Sets the value of Issuer using move semantics.
public inline FString & GetServer()Gets the value of Server.
public inline const FString & GetServer() constGets the value of Server.
public inline void SetServer(const FString & NewValue)Sets the value of Server.
public inline void SetServer(FString && NewValue)Sets the value of Server using move semantics.
public inline FString & GetChannelName()Gets the value of ChannelName_Optional, regardless of it having been set.
public inline const FString & GetChannelName() constGets the value of ChannelName_Optional, regardless of it having been set.
public inline const FString & GetChannelName(const FString & DefaultValue) constGets the value of ChannelName_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetChannelName(FString & OutValue) constFills OutValue with the value of ChannelName_Optional and returns true if it has been set, otherwise returns false.
public inline FString * GetChannelNameOrNull()Returns a pointer to ChannelName_Optional, if it has been set, otherwise returns nullptr.
public inline const FString * GetChannelNameOrNull() constReturns a pointer to ChannelName_Optional, if it has been set, otherwise returns nullptr.
public inline void SetChannelName(const FString & NewValue)Sets the value of ChannelName_Optional and also sets ChannelName_IsSet to true.
public inline void SetChannelName(FString && NewValue)Sets the value of ChannelName_Optional and also sets ChannelName_IsSet to true using move semantics.
public inline void ClearChannelName()Clears the value of ChannelName_Optional and sets ChannelName_IsSet to false.
public inline bool IsChannelNameSet() constChecks whether ChannelName_Optional has been set.

Members​

public FString Token ​

Signed auth voip login token for a specific client.

public FString Issuer ​

Issuer for client's login token.

public FString Server ​

Server for voip login.

public FString ChannelName_Optional ​

Channel name for the generated token if relevant.

public bool ChannelName_IsSet ​

true if ChannelName_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 & GetToken() ​

Gets the value of Token.

public inline const FString & GetToken() const ​

Gets the value of Token.

public inline void SetToken(const FString & NewValue) ​

Sets the value of Token.

public inline void SetToken(FString && NewValue) ​

Sets the value of Token using move semantics.

public inline FString & GetIssuer() ​

Gets the value of Issuer.

public inline const FString & GetIssuer() const ​

Gets the value of Issuer.

public inline void SetIssuer(const FString & NewValue) ​

Sets the value of Issuer.

public inline void SetIssuer(FString && NewValue) ​

Sets the value of Issuer using move semantics.

public inline FString & GetServer() ​

Gets the value of Server.

public inline const FString & GetServer() const ​

Gets the value of Server.

public inline void SetServer(const FString & NewValue) ​

Sets the value of Server.

public inline void SetServer(FString && NewValue) ​

Sets the value of Server using move semantics.

public inline FString & GetChannelName() ​

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

public inline const FString & GetChannelName() const ​

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

public inline const FString & GetChannelName(const FString & DefaultValue) const ​

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

public inline bool GetChannelName(FString & OutValue) const ​

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

public inline FString * GetChannelNameOrNull() ​

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

public inline const FString * GetChannelNameOrNull() const ​

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

public inline void SetChannelName(const FString & NewValue) ​

Sets the value of ChannelName_Optional and also sets ChannelName_IsSet to true.

public inline void SetChannelName(FString && NewValue) ​

Sets the value of ChannelName_Optional and also sets ChannelName_IsSet to true using move semantics.

public inline void ClearChannelName() ​

Clears the value of ChannelName_Optional and sets ChannelName_IsSet to false.

public inline bool IsChannelNameSet() const ​

Checks whether ChannelName_Optional has been set.