Skip to content
RallyHere Docs
GitHub

RHAPI_LookupResults

Summary

MembersDescriptions
struct FRHAPI_LookupResultsLookup results for a player query.

struct FRHAPI_LookupResults

struct FRHAPI_LookupResults
  : public FRHAPI_Model

Lookup results for a player query.

Summary

MembersDescriptions
public TArray< TMap< FString, TArray< FRHAPI_PlayerResponse> > >DisplayNames_OptionalList of display names and the players that match that display name.
public bool DisplayNames_IsSettrue if DisplayNames_Optional has been set to a value
public TMap< FString, TArray< FRHAPI_PlatformIdentityLookupResults> >IdentityPlatforms_OptionalDEPRECATED Use identity_platforms_by_platform instead. List of platforms and the players that match that platform user id
public bool IdentityPlatforms_IsSettrue if IdentityPlatforms_Optional has been set to a value
public TMap< FString, TArray< FRHAPI_PlatformIdentityLookupResults> >IdentityPlatformsByPlatform_OptionalList of platforms and the players that match that platform user id.
public bool IdentityPlatformsByPlatform_IsSettrue if IdentityPlatformsByPlatform_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 TArray< TMap< FString, TArray< FRHAPI_PlayerResponse> > > &GetDisplayNames()Gets the value of DisplayNames_Optional, regardless of it having been set.
public inline const TArray< TMap< FString, TArray< FRHAPI_PlayerResponse> > > &GetDisplayNames() constGets the value of DisplayNames_Optional, regardless of it having been set.
public inline const TArray< TMap< FString, TArray< FRHAPI_PlayerResponse> > > &GetDisplayNames(const TArray< TMap< FString, TArray< FRHAPI_PlayerResponse >>> & DefaultValue) constGets the value of DisplayNames_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetDisplayNames(TArray< TMap< FString, TArray< FRHAPI_PlayerResponse >>> & OutValue) constFills OutValue with the value of DisplayNames_Optional and returns true if it has been set, otherwise returns false.
public inline TArray< TMap< FString, TArray< FRHAPI_PlayerResponse> > > *GetDisplayNamesOrNull()Returns a pointer to DisplayNames_Optional, if it has been set, otherwise returns nullptr.
public inline const TArray< TMap< FString, TArray< FRHAPI_PlayerResponse> > > *GetDisplayNamesOrNull() constReturns a pointer to DisplayNames_Optional, if it has been set, otherwise returns nullptr.
public inline void SetDisplayNames(TArray< TMap< FString, TArray< FRHAPI_PlayerResponse >>> NewValue)Sets the value of DisplayNames_Optional and also sets DisplayNames_IsSet to true.
public inline void ClearDisplayNames()Clears the value of DisplayNames_Optional and sets DisplayNames_IsSet to false.
public inline TMap< FString, TArray< FRHAPI_PlatformIdentityLookupResults> > &GetIdentityPlatforms()Gets the value of IdentityPlatforms_Optional, regardless of it having been set.
public inline const TMap< FString, TArray< FRHAPI_PlatformIdentityLookupResults> > &GetIdentityPlatforms() constGets the value of IdentityPlatforms_Optional, regardless of it having been set.
public inline const TMap< FString, TArray< FRHAPI_PlatformIdentityLookupResults> > &GetIdentityPlatforms(const TMap< FString, TArray< FRHAPI_PlatformIdentityLookupResults >> & DefaultValue) constGets the value of IdentityPlatforms_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetIdentityPlatforms(TMap< FString, TArray< FRHAPI_PlatformIdentityLookupResults >> & OutValue) constFills OutValue with the value of IdentityPlatforms_Optional and returns true if it has been set, otherwise returns false.
public inline TMap< FString, TArray< FRHAPI_PlatformIdentityLookupResults> > *GetIdentityPlatformsOrNull()Returns a pointer to IdentityPlatforms_Optional, if it has been set, otherwise returns nullptr.
public inline const TMap< FString, TArray< FRHAPI_PlatformIdentityLookupResults> > *GetIdentityPlatformsOrNull() constReturns a pointer to IdentityPlatforms_Optional, if it has been set, otherwise returns nullptr.
public inline void SetIdentityPlatforms(TMap< FString, TArray< FRHAPI_PlatformIdentityLookupResults >> NewValue)Sets the value of IdentityPlatforms_Optional and also sets IdentityPlatforms_IsSet to true.
public inline void ClearIdentityPlatforms()Clears the value of IdentityPlatforms_Optional and sets IdentityPlatforms_IsSet to false.
public inline TMap< FString, TArray< FRHAPI_PlatformIdentityLookupResults> > &GetIdentityPlatformsByPlatform()Gets the value of IdentityPlatformsByPlatform_Optional, regardless of it having been set.
public inline const TMap< FString, TArray< FRHAPI_PlatformIdentityLookupResults> > &GetIdentityPlatformsByPlatform() constGets the value of IdentityPlatformsByPlatform_Optional, regardless of it having been set.
public inline const TMap< FString, TArray< FRHAPI_PlatformIdentityLookupResults> > &GetIdentityPlatformsByPlatform(const TMap< FString, TArray< FRHAPI_PlatformIdentityLookupResults >> & DefaultValue) constGets the value of IdentityPlatformsByPlatform_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetIdentityPlatformsByPlatform(TMap< FString, TArray< FRHAPI_PlatformIdentityLookupResults >> & OutValue) constFills OutValue with the value of IdentityPlatformsByPlatform_Optional and returns true if it has been set, otherwise returns false.
public inline TMap< FString, TArray< FRHAPI_PlatformIdentityLookupResults> > *GetIdentityPlatformsByPlatformOrNull()Returns a pointer to IdentityPlatformsByPlatform_Optional, if it has been set, otherwise returns nullptr.
public inline const TMap< FString, TArray< FRHAPI_PlatformIdentityLookupResults> > *GetIdentityPlatformsByPlatformOrNull() constReturns a pointer to IdentityPlatformsByPlatform_Optional, if it has been set, otherwise returns nullptr.
public inline void SetIdentityPlatformsByPlatform(TMap< FString, TArray< FRHAPI_PlatformIdentityLookupResults >> NewValue)Sets the value of IdentityPlatformsByPlatform_Optional and also sets IdentityPlatformsByPlatform_IsSet to true.
public inline void ClearIdentityPlatformsByPlatform()Clears the value of IdentityPlatformsByPlatform_Optional and sets IdentityPlatformsByPlatform_IsSet to false.

Members

public TArray< TMap< FString, TArray< FRHAPI_PlayerResponse> > >DisplayNames_Optional

List of display names and the players that match that display name.

public bool DisplayNames_IsSet

true if DisplayNames_Optional has been set to a value

public TMap< FString, TArray< FRHAPI_PlatformIdentityLookupResults> >IdentityPlatforms_Optional

DEPRECATED Use identity_platforms_by_platform instead. List of platforms and the players that match that platform user id

public bool IdentityPlatforms_IsSet

true if IdentityPlatforms_Optional has been set to a value

public TMap< FString, TArray< FRHAPI_PlatformIdentityLookupResults> >IdentityPlatformsByPlatform_Optional

List of platforms and the players that match that platform user id.

public bool IdentityPlatformsByPlatform_IsSet

true if IdentityPlatformsByPlatform_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 TArray< TMap< FString, TArray< FRHAPI_PlayerResponse> > > &GetDisplayNames()

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

public inline const TArray< TMap< FString, TArray< FRHAPI_PlayerResponse> > > &GetDisplayNames() const

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

public inline const TArray< TMap< FString, TArray< FRHAPI_PlayerResponse> > > &GetDisplayNames(const TArray< TMap< FString, TArray< FRHAPI_PlayerResponse >>> & DefaultValue) const

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

public inline bool GetDisplayNames(TArray< TMap< FString, TArray< FRHAPI_PlayerResponse >>> & OutValue) const

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

public inline TArray< TMap< FString, TArray< FRHAPI_PlayerResponse> > > *GetDisplayNamesOrNull()

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

public inline const TArray< TMap< FString, TArray< FRHAPI_PlayerResponse> > > *GetDisplayNamesOrNull() const

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

public inline void SetDisplayNames(TArray< TMap< FString, TArray< FRHAPI_PlayerResponse >>> NewValue)

Sets the value of DisplayNames_Optional and also sets DisplayNames_IsSet to true.

public inline void ClearDisplayNames()

Clears the value of DisplayNames_Optional and sets DisplayNames_IsSet to false.

public inline TMap< FString, TArray< FRHAPI_PlatformIdentityLookupResults> > &GetIdentityPlatforms()

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

public inline const TMap< FString, TArray< FRHAPI_PlatformIdentityLookupResults> > &GetIdentityPlatforms() const

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

public inline const TMap< FString, TArray< FRHAPI_PlatformIdentityLookupResults> > &GetIdentityPlatforms(const TMap< FString, TArray< FRHAPI_PlatformIdentityLookupResults >> & DefaultValue) const

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

public inline bool GetIdentityPlatforms(TMap< FString, TArray< FRHAPI_PlatformIdentityLookupResults >> & OutValue) const

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

public inline TMap< FString, TArray< FRHAPI_PlatformIdentityLookupResults> > *GetIdentityPlatformsOrNull()

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

public inline const TMap< FString, TArray< FRHAPI_PlatformIdentityLookupResults> > *GetIdentityPlatformsOrNull() const

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

public inline void SetIdentityPlatforms(TMap< FString, TArray< FRHAPI_PlatformIdentityLookupResults >> NewValue)

Sets the value of IdentityPlatforms_Optional and also sets IdentityPlatforms_IsSet to true.

public inline void ClearIdentityPlatforms()

Clears the value of IdentityPlatforms_Optional and sets IdentityPlatforms_IsSet to false.

public inline TMap< FString, TArray< FRHAPI_PlatformIdentityLookupResults> > &GetIdentityPlatformsByPlatform()

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

public inline const TMap< FString, TArray< FRHAPI_PlatformIdentityLookupResults> > &GetIdentityPlatformsByPlatform() const

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

public inline const TMap< FString, TArray< FRHAPI_PlatformIdentityLookupResults> > &GetIdentityPlatformsByPlatform(const TMap< FString, TArray< FRHAPI_PlatformIdentityLookupResults >> & DefaultValue) const

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

public inline bool GetIdentityPlatformsByPlatform(TMap< FString, TArray< FRHAPI_PlatformIdentityLookupResults >> & OutValue) const

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

public inline TMap< FString, TArray< FRHAPI_PlatformIdentityLookupResults> > *GetIdentityPlatformsByPlatformOrNull()

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

public inline const TMap< FString, TArray< FRHAPI_PlatformIdentityLookupResults> > *GetIdentityPlatformsByPlatformOrNull() const

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

public inline void SetIdentityPlatformsByPlatform(TMap< FString, TArray< FRHAPI_PlatformIdentityLookupResults >> NewValue)

Sets the value of IdentityPlatformsByPlatform_Optional and also sets IdentityPlatformsByPlatform_IsSet to true.

public inline void ClearIdentityPlatformsByPlatform()

Clears the value of IdentityPlatformsByPlatform_Optional and sets IdentityPlatformsByPlatform_IsSet to false.