RHAPI_PlatformUserLinkRequest
Summary
| Members | Descriptions |
|---|---|
struct FRHAPI_PlatformUserLinkRequest | Model for linking a platform user to the person of another platform user. This is used to determine the "leader" person_id that will be the assigned to a "follower" platform user. The Leader person is found using the following priority: 1. If the `leader_person_id` is provided directly 2. If the `leader_platform` and `leader_platform_user_id` are provided, the `person_id` of that platform user is used. 3. If the `scheme` and `credentials` are provided, the person_id of the platform user of credentials is used. The Follower platform user is found using the following priority: 1. If the `follower_platform` and `follower_platform_user_id` are provided directly. 2. If the Authorization header contains a user token, the platform and platform user id from the token are used. |
struct FRHAPI_PlatformUserLinkRequest
struct FRHAPI_PlatformUserLinkRequest
: public FRHAPI_Model
Model for linking a platform user to the person of another platform user. This is used to determine the "leader" person_id that will be the assigned to a "follower" platform user. The Leader person is found using the following priority: 1. If the `leader_person_id` is provided directly 2. If the `leader_platform` and `leader_platform_user_id` are provided, the `person_id` of that platform user is used. 3. If the `scheme` and `credentials` are provided, the person_id of the platform user of credentials is used. The Follower platform user is found using the following priority: 1. If the `follower_platform` and `follower_platform_user_id` are provided directly. 2. If the Authorization header contains a user token, the platform and platform user id from the token are used.
Summary
| Members | Descriptions |
|---|---|
public FGuid LeaderPersonId_Optional | Person ID of the leader to link to. If not provided, the person will be found from the leader_platform and leader_platform_user_id |
public bool LeaderPersonId_IsSet | true if LeaderPersonId_Optional has been set to a value |
public ERHAPI_Platform LeaderPlatform_Optional | Platform of the leader to link to. If not provided, the leader will be found from the scheme and credentials |
public bool LeaderPlatform_IsSet | true if LeaderPlatform_Optional has been set to a value |
public FString LeaderPlatformUserId_Optional | Platform user ID of the leader to link to. If not provided, the leader will be found from the scheme and credentials |
public bool LeaderPlatformUserId_IsSet | true if LeaderPlatformUserId_Optional has been set to a value |
public ERHAPI_Platform FollowerPlatform_Optional | Platform of the follower to link. If not provided, the follower will be found from the Authorization header's token. |
public bool FollowerPlatform_IsSet | true if FollowerPlatform_Optional has been set to a value |
public FString FollowerPlatformUserId_Optional | Platform user ID of the follower to link. If not provided, the follower will be found from the Authorization header's token. |
public bool FollowerPlatformUserId_IsSet | true if FollowerPlatformUserId_Optional has been set to a value |
public FString Scheme_Optional | Scheme to use for the leader. For most tokens, this will be Bearer |
public bool Scheme_IsSet | true if Scheme_Optional has been set to a value |
public FString Credentials_Optional | Credentials to use for the leader. For most tokens, this will be the token itself. |
public bool Credentials_IsSet | true if Credentials_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 FGuid & GetLeaderPersonId() | Gets the value of LeaderPersonId_Optional, regardless of it having been set. |
public inline const FGuid & GetLeaderPersonId() const | Gets the value of LeaderPersonId_Optional, regardless of it having been set. |
public inline const FGuid & GetLeaderPersonId(const FGuid & DefaultValue) const | Gets the value of LeaderPersonId_Optional, if it has been set, otherwise it returns DefaultValue. |
public inline bool GetLeaderPersonId(FGuid & OutValue) const | Fills OutValue with the value of LeaderPersonId_Optional and returns true if it has been set, otherwise returns false. |
public inline FGuid * GetLeaderPersonIdOrNull() | Returns a pointer to LeaderPersonId_Optional, if it has been set, otherwise returns nullptr. |
public inline const FGuid * GetLeaderPersonIdOrNull() const | Returns a pointer to LeaderPersonId_Optional, if it has been set, otherwise returns nullptr. |
public inline void SetLeaderPersonId(const FGuid & NewValue) | Sets the value of LeaderPersonId_Optional and also sets LeaderPersonId_IsSet to true. |
public inline void SetLeaderPersonId(FGuid && NewValue) | Sets the value of LeaderPersonId_Optional and also sets LeaderPersonId_IsSet to true using move semantics. |
public inline void ClearLeaderPersonId() | Clears the value of LeaderPersonId_Optional and sets LeaderPersonId_IsSet to false. |
public inline bool IsLeaderPersonIdSet() const | Checks whether LeaderPersonId_Optional has been set. |
public inline ERHAPI_Platform & GetLeaderPlatform() | Gets the value of LeaderPlatform_Optional, regardless of it having been set. |
public inline const ERHAPI_Platform & GetLeaderPlatform() const | Gets the value of LeaderPlatform_Optional, regardless of it having been set. |
public inline const ERHAPI_Platform & GetLeaderPlatform(const ERHAPI_Platform & DefaultValue) const | Gets the value of LeaderPlatform_Optional, if it has been set, otherwise it returns DefaultValue. |
public inline bool GetLeaderPlatform(ERHAPI_Platform & OutValue) const | Fills OutValue with the value of LeaderPlatform_Optional and returns true if it has been set, otherwise returns false. |
public inline ERHAPI_Platform * GetLeaderPlatformOrNull() | Returns a pointer to LeaderPlatform_Optional, if it has been set, otherwise returns nullptr. |
public inline const ERHAPI_Platform * GetLeaderPlatformOrNull() const | Returns a pointer to LeaderPlatform_Optional, if it has been set, otherwise returns nullptr. |
public inline void SetLeaderPlatform(const ERHAPI_Platform & NewValue) | Sets the value of LeaderPlatform_Optional and also sets LeaderPlatform_IsSet to true. |
public inline void SetLeaderPlatform(ERHAPI_Platform && NewValue) | Sets the value of LeaderPlatform_Optional and also sets LeaderPlatform_IsSet to true using move semantics. |
public inline void ClearLeaderPlatform() | Clears the value of LeaderPlatform_Optional and sets LeaderPlatform_IsSet to false. |
public inline bool IsLeaderPlatformSet() const | Checks whether LeaderPlatform_Optional has been set. |
public inline FString & GetLeaderPlatformUserId() | Gets the value of LeaderPlatformUserId_Optional, regardless of it having been set. |
public inline const FString & GetLeaderPlatformUserId() const | Gets the value of LeaderPlatformUserId_Optional, regardless of it having been set. |
public inline const FString & GetLeaderPlatformUserId(const FString & DefaultValue) const | Gets the value of LeaderPlatformUserId_Optional, if it has been set, otherwise it returns DefaultValue. |
public inline bool GetLeaderPlatformUserId(FString & OutValue) const | Fills OutValue with the value of LeaderPlatformUserId_Optional and returns true if it has been set, otherwise returns false. |
public inline FString * GetLeaderPlatformUserIdOrNull() | Returns a pointer to LeaderPlatformUserId_Optional, if it has been set, otherwise returns nullptr. |
public inline const FString * GetLeaderPlatformUserIdOrNull() const | Returns a pointer to LeaderPlatformUserId_Optional, if it has been set, otherwise returns nullptr. |
public inline void SetLeaderPlatformUserId(const FString & NewValue) | Sets the value of LeaderPlatformUserId_Optional and also sets LeaderPlatformUserId_IsSet to true. |
public inline void SetLeaderPlatformUserId(FString && NewValue) | Sets the value of LeaderPlatformUserId_Optional and also sets LeaderPlatformUserId_IsSet to true using move semantics. |
public inline void ClearLeaderPlatformUserId() | Clears the value of LeaderPlatformUserId_Optional and sets LeaderPlatformUserId_IsSet to false. |
public inline bool IsLeaderPlatformUserIdSet() const | Checks whether LeaderPlatformUserId_Optional has been set. |
public inline ERHAPI_Platform & GetFollowerPlatform() | Gets the value of FollowerPlatform_Optional, regardless of it having been set. |
public inline const ERHAPI_Platform & GetFollowerPlatform() const | Gets the value of FollowerPlatform_Optional, regardless of it having been set. |
public inline const ERHAPI_Platform & GetFollowerPlatform(const ERHAPI_Platform & DefaultValue) const | Gets the value of FollowerPlatform_Optional, if it has been set, otherwise it returns DefaultValue. |
public inline bool GetFollowerPlatform(ERHAPI_Platform & OutValue) const | Fills OutValue with the value of FollowerPlatform_Optional and returns true if it has been set, otherwise returns false. |
public inline ERHAPI_Platform * GetFollowerPlatformOrNull() | Returns a pointer to FollowerPlatform_Optional, if it has been set, otherwise returns nullptr. |
public inline const ERHAPI_Platform * GetFollowerPlatformOrNull() const | Returns a pointer to FollowerPlatform_Optional, if it has been set, otherwise returns nullptr. |
public inline void SetFollowerPlatform(const ERHAPI_Platform & NewValue) | Sets the value of FollowerPlatform_Optional and also sets FollowerPlatform_IsSet to true. |
public inline void SetFollowerPlatform(ERHAPI_Platform && NewValue) | Sets the value of FollowerPlatform_Optional and also sets FollowerPlatform_IsSet to true using move semantics. |
public inline void ClearFollowerPlatform() | Clears the value of FollowerPlatform_Optional and sets FollowerPlatform_IsSet to false. |
public inline bool IsFollowerPlatformSet() const | Checks whether FollowerPlatform_Optional has been set. |
public inline FString & GetFollowerPlatformUserId() | Gets the value of FollowerPlatformUserId_Optional, regardless of it having been set. |
public inline const FString & GetFollowerPlatformUserId() const | Gets the value of FollowerPlatformUserId_Optional, regardless of it having been set. |
public inline const FString & GetFollowerPlatformUserId(const FString & DefaultValue) const | Gets the value of FollowerPlatformUserId_Optional, if it has been set, otherwise it returns DefaultValue. |
public inline bool GetFollowerPlatformUserId(FString & OutValue) const | Fills OutValue with the value of FollowerPlatformUserId_Optional and returns true if it has been set, otherwise returns false. |
public inline FString * GetFollowerPlatformUserIdOrNull() | Returns a pointer to FollowerPlatformUserId_Optional, if it has been set, otherwise returns nullptr. |
public inline const FString * GetFollowerPlatformUserIdOrNull() const | Returns a pointer to FollowerPlatformUserId_Optional, if it has been set, otherwise returns nullptr. |
public inline void SetFollowerPlatformUserId(const FString & NewValue) | Sets the value of FollowerPlatformUserId_Optional and also sets FollowerPlatformUserId_IsSet to true. |
public inline void SetFollowerPlatformUserId(FString && NewValue) | Sets the value of FollowerPlatformUserId_Optional and also sets FollowerPlatformUserId_IsSet to true using move semantics. |
public inline void ClearFollowerPlatformUserId() | Clears the value of FollowerPlatformUserId_Optional and sets FollowerPlatformUserId_IsSet to false. |
public inline bool IsFollowerPlatformUserIdSet() const | Checks whether FollowerPlatformUserId_Optional has been set. |
public inline FString & GetScheme() | Gets the value of Scheme_Optional, regardless of it having been set. |
public inline const FString & GetScheme() const | Gets the value of Scheme_Optional, regardless of it having been set. |
public inline const FString & GetScheme(const FString & DefaultValue) const | Gets the value of Scheme_Optional, if it has been set, otherwise it returns DefaultValue. |
public inline bool GetScheme(FString & OutValue) const | Fills OutValue with the value of Scheme_Optional and returns true if it has been set, otherwise returns false. |
public inline FString * GetSchemeOrNull() | Returns a pointer to Scheme_Optional, if it has been set, otherwise returns nullptr. |
public inline const FString * GetSchemeOrNull() const | Returns a pointer to Scheme_Optional, if it has been set, otherwise returns nullptr. |
public inline void SetScheme(const FString & NewValue) | Sets the value of Scheme_Optional and also sets Scheme_IsSet to true. |
public inline void SetScheme(FString && NewValue) | Sets the value of Scheme_Optional and also sets Scheme_IsSet to true using move semantics. |
public inline void ClearScheme() | Clears the value of Scheme_Optional and sets Scheme_IsSet to false. |
public inline bool IsSchemeSet() const | Checks whether Scheme_Optional has been set. |
public inline FString & GetCredentials() | Gets the value of Credentials_Optional, regardless of it having been set. |
public inline const FString & GetCredentials() const | Gets the value of Credentials_Optional, regardless of it having been set. |
public inline const FString & GetCredentials(const FString & DefaultValue) const | Gets the value of Credentials_Optional, if it has been set, otherwise it returns DefaultValue. |
public inline bool GetCredentials(FString & OutValue) const | Fills OutValue with the value of Credentials_Optional and returns true if it has been set, otherwise returns false. |
public inline FString * GetCredentialsOrNull() | Returns a pointer to Credentials_Optional, if it has been set, otherwise returns nullptr. |
public inline const FString * GetCredentialsOrNull() const | Returns a pointer to Credentials_Optional, if it has been set, otherwise returns nullptr. |
public inline void SetCredentials(const FString & NewValue) | Sets the value of Credentials_Optional and also sets Credentials_IsSet to true. |
public inline void SetCredentials(FString && NewValue) | Sets the value of Credentials_Optional and also sets Credentials_IsSet to true using move semantics. |
public inline void ClearCredentials() | Clears the value of Credentials_Optional and sets Credentials_IsSet to false. |
public inline bool IsCredentialsSet() const | Checks whether Credentials_Optional has been set. |
Members
public FGuid LeaderPersonId_Optional
Person ID of the leader to link to. If not provided, the person will be found from the leader_platform and leader_platform_user_id
public bool LeaderPersonId_IsSet
true if LeaderPersonId_Optional has been set to a value
public ERHAPI_Platform LeaderPlatform_Optional
Platform of the leader to link to. If not provided, the leader will be found from the scheme and credentials
public bool LeaderPlatform_IsSet
true if LeaderPlatform_Optional has been set to a value
public FString LeaderPlatformUserId_Optional
Platform user ID of the leader to link to. If not provided, the leader will be found from the scheme and credentials
public bool LeaderPlatformUserId_IsSet
true if LeaderPlatformUserId_Optional has been set to a value
public ERHAPI_Platform FollowerPlatform_Optional
Platform of the follower to link. If not provided, the follower will be found from the Authorization header's token.
public bool FollowerPlatform_IsSet
true if FollowerPlatform_Optional has been set to a value
public FString FollowerPlatformUserId_Optional
Platform user ID of the follower to link. If not provided, the follower will be found from the Authorization header's token.
public bool FollowerPlatformUserId_IsSet
true if FollowerPlatformUserId_Optional has been set to a value
public FString Scheme_Optional
Scheme to use for the leader. For most tokens, this will be Bearer
public bool Scheme_IsSet
true if Scheme_Optional has been set to a value
public FString Credentials_Optional
Credentials to use for the leader. For most tokens, this will be the token itself.
public bool Credentials_IsSet
true if Credentials_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
JsonValueData 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
WriterJSON Writer stream to push .
public inline FGuid & GetLeaderPersonId()
Gets the value of LeaderPersonId_Optional, regardless of it having been set.
public inline const FGuid & GetLeaderPersonId() const
Gets the value of LeaderPersonId_Optional, regardless of it having been set.
public inline const FGuid & GetLeaderPersonId(const FGuid & DefaultValue) const
Gets the value of LeaderPersonId_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetLeaderPersonId(FGuid & OutValue) const
Fills OutValue with the value of LeaderPersonId_Optional and returns true if it has been set, otherwise returns false.
public inline FGuid * GetLeaderPersonIdOrNull()
Returns a pointer to LeaderPersonId_Optional, if it has been set, otherwise returns nullptr.
public inline const FGuid * GetLeaderPersonIdOrNull() const
Returns a pointer to LeaderPersonId_Optional, if it has been set, otherwise returns nullptr.
public inline void SetLeaderPersonId(const FGuid & NewValue)
Sets the value of LeaderPersonId_Optional and also sets LeaderPersonId_IsSet to true.
public inline void SetLeaderPersonId(FGuid && NewValue)
Sets the value of LeaderPersonId_Optional and also sets LeaderPersonId_IsSet to true using move semantics.
public inline void ClearLeaderPersonId()
Clears the value of LeaderPersonId_Optional and sets LeaderPersonId_IsSet to false.
public inline bool IsLeaderPersonIdSet() const
Checks whether LeaderPersonId_Optional has been set.
public inline ERHAPI_Platform & GetLeaderPlatform()
Gets the value of LeaderPlatform_Optional, regardless of it having been set.
public inline const ERHAPI_Platform & GetLeaderPlatform() const
Gets the value of LeaderPlatform_Optional, regardless of it having been set.
public inline const ERHAPI_Platform & GetLeaderPlatform(const ERHAPI_Platform & DefaultValue) const
Gets the value of LeaderPlatform_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetLeaderPlatform(ERHAPI_Platform & OutValue) const
Fills OutValue with the value of LeaderPlatform_Optional and returns true if it has been set, otherwise returns false.
public inline ERHAPI_Platform * GetLeaderPlatformOrNull()
Returns a pointer to LeaderPlatform_Optional, if it has been set, otherwise returns nullptr.
public inline const ERHAPI_Platform * GetLeaderPlatformOrNull() const
Returns a pointer to LeaderPlatform_Optional, if it has been set, otherwise returns nullptr.
public inline void SetLeaderPlatform(const ERHAPI_Platform & NewValue)
Sets the value of LeaderPlatform_Optional and also sets LeaderPlatform_IsSet to true.