Skip to main content

Match

Summary​

MembersDescriptions
public DECLARE_DYNAMIC_DELEGATE_ThreeParams(FRH_OnMatchSearchCompleteDynamicDelegate,bool,bSuccess,const FRH_MatchSearchResult&,SearchResult,constFRH_ErrorInfo &,ErrorInfo)
public DECLARE_DELEGATE_ThreeParams(FRH_OnMatchSearchCompleteDelegate,bool,const FRH_MatchSearchResult&,constFRH_ErrorInfo &)
public DECLARE_RH_DELEGATE_BLOCK(FRH_OnMatchSearchCompleteDelegateBlock,FRH_OnMatchSearchCompleteDelegate,FRH_OnMatchSearchCompleteDynamicDelegate,bool,const FRH_MatchSearchResult&,constFRH_ErrorInfo &)
public DECLARE_DYNAMIC_DELEGATE_ThreeParams(FRH_OnMatchLookupCompleteDynamicDelegate,bool,bSuccess,const FRHAPI_MatchWithPlayers&,SearchResult,constFRH_ErrorInfo &,ErrorInfo)
public DECLARE_DELEGATE_ThreeParams(FRH_OnMatchLookupCompleteDelegate,bool,const FRHAPI_MatchWithPlayers&,constFRH_ErrorInfo &)
public DECLARE_RH_DELEGATE_BLOCK(FRH_OnMatchLookupCompleteDelegateBlock,FRH_OnMatchLookupCompleteDelegate,FRH_OnMatchLookupCompleteDynamicDelegate,bool,const FRHAPI_MatchWithPlayers&,constFRH_ErrorInfo &)
public DECLARE_DYNAMIC_DELEGATE_ThreeParams(FRH_OnMatchUpdateCompleteDynamicDelegate,bool,bSuccess,const FRHAPI_MatchWithPlayers&,Match,constFRH_ErrorInfo &,ErrorInfo)
public DECLARE_DELEGATE_ThreeParams(FRH_OnMatchUpdateCompleteDelegate,bool,const FRHAPI_MatchWithPlayers&,constFRH_ErrorInfo &)
public DECLARE_RH_DELEGATE_BLOCK(FRH_OnMatchUpdateCompleteDelegateBlock,FRH_OnMatchUpdateCompleteDelegate,FRH_OnMatchUpdateCompleteDynamicDelegate,bool,const FRHAPI_MatchWithPlayers&,constFRH_ErrorInfo &)
public DECLARE_DYNAMIC_DELEGATE_ThreeParams(FRH_OnMatchPlayerUpdatedCompleteDynamicDelegate,bool,bSuccess,const FRHAPI_MatchPlayerWithMatch&,Match,constFRH_ErrorInfo &,ErrorInfo)
public DECLARE_DELEGATE_ThreeParams(FRH_OnMatchPlayerUpdateCompleteDelegate,bool,const FRHAPI_MatchPlayerWithMatch&,constFRH_ErrorInfo &)
public DECLARE_RH_DELEGATE_BLOCK(FRH_OnMatchPlayerUpdateCompleteDelegateBlock,FRH_OnMatchPlayerUpdateCompleteDelegate,FRH_OnMatchPlayerUpdatedCompleteDynamicDelegate,bool,const FRHAPI_MatchPlayerWithMatch&,constFRH_ErrorInfo &)
class URH_MatchSubsystemMatch Subsystem used for match API calls.
struct FRH_MatchSearchParams
struct FRH_MatchSearchResultStruct containint the results of a Session Browser search.

Members​

public DECLARE_DYNAMIC_DELEGATE_ThreeParams(FRH_OnMatchSearchCompleteDynamicDelegate,bool,bSuccess,const FRH_MatchSearchResult&,SearchResult,constFRH_ErrorInfo &,ErrorInfo) ​

public DECLARE_DELEGATE_ThreeParams(FRH_OnMatchSearchCompleteDelegate,bool,const FRH_MatchSearchResult&,constFRH_ErrorInfo &) ​

public DECLARE_RH_DELEGATE_BLOCK(FRH_OnMatchSearchCompleteDelegateBlock,FRH_OnMatchSearchCompleteDelegate,FRH_OnMatchSearchCompleteDynamicDelegate,bool,const FRH_MatchSearchResult&,constFRH_ErrorInfo &) ​

public DECLARE_DYNAMIC_DELEGATE_ThreeParams(FRH_OnMatchLookupCompleteDynamicDelegate,bool,bSuccess,const FRHAPI_MatchWithPlayers&,SearchResult,constFRH_ErrorInfo &,ErrorInfo) ​

public DECLARE_DELEGATE_ThreeParams(FRH_OnMatchLookupCompleteDelegate,bool,const FRHAPI_MatchWithPlayers&,constFRH_ErrorInfo &) ​

public DECLARE_RH_DELEGATE_BLOCK(FRH_OnMatchLookupCompleteDelegateBlock,FRH_OnMatchLookupCompleteDelegate,FRH_OnMatchLookupCompleteDynamicDelegate,bool,const FRHAPI_MatchWithPlayers&,constFRH_ErrorInfo &) ​

public DECLARE_DYNAMIC_DELEGATE_ThreeParams(FRH_OnMatchUpdateCompleteDynamicDelegate,bool,bSuccess,const FRHAPI_MatchWithPlayers&,Match,constFRH_ErrorInfo &,ErrorInfo) ​

public DECLARE_DELEGATE_ThreeParams(FRH_OnMatchUpdateCompleteDelegate,bool,const FRHAPI_MatchWithPlayers&,constFRH_ErrorInfo &) ​

public DECLARE_RH_DELEGATE_BLOCK(FRH_OnMatchUpdateCompleteDelegateBlock,FRH_OnMatchUpdateCompleteDelegate,FRH_OnMatchUpdateCompleteDynamicDelegate,bool,const FRHAPI_MatchWithPlayers&,constFRH_ErrorInfo &) ​

public DECLARE_DYNAMIC_DELEGATE_ThreeParams(FRH_OnMatchPlayerUpdatedCompleteDynamicDelegate,bool,bSuccess,const FRHAPI_MatchPlayerWithMatch&,Match,constFRH_ErrorInfo &,ErrorInfo) ​

public DECLARE_DELEGATE_ThreeParams(FRH_OnMatchPlayerUpdateCompleteDelegate,bool,const FRHAPI_MatchPlayerWithMatch&,constFRH_ErrorInfo &) ​

public DECLARE_RH_DELEGATE_BLOCK(FRH_OnMatchPlayerUpdateCompleteDelegateBlock,FRH_OnMatchPlayerUpdateCompleteDelegate,FRH_OnMatchPlayerUpdatedCompleteDynamicDelegate,bool,const FRHAPI_MatchPlayerWithMatch&,constFRH_ErrorInfo &) ​

class URH_MatchSubsystem ​

class URH_MatchSubsystem
  : public URH_GameInstanceSubsystemPlugin

Match Subsystem used for match API calls.

Summary​

MembersDescriptions
public bool bIgnoreCache
public bool const FRH_OnMatchLookupCompleteDynamicDelegate & Delegate
public virtual void Initialize()Initialize the subsystem.
public virtual void Deinitialize()Safely tears down the subsystem.
public virtual void SearchMatches(const FRH_MatchSearchParams & params,const FRH_OnMatchSearchCompleteDelegateBlock & Delegate)Search for Matches.
public virtual void GetMatchAsync(const FString & MatchId,bool bIgnoreCache,const FRH_OnMatchLookupCompleteDelegateBlock & Delegate)Lookup a specific match.
public inline bool GetMatch(const FString & MatchId,FRHAPI_MatchWithPlayers & OutMatch)Lookup a specific match from the cache.
public inline const TMap< FString, FRHAPI_MatchWithPlayers> &GetAllMatches() constGet all matches from the cache.
public inline void ClearMatchesCache()Clear the match cache.
public virtual void CreateMatch(const FRHAPI_MatchRequest & Match,const FRH_OnMatchUpdateCompleteDelegateBlock & Delegate)Create a match (POST)
public virtual void UpdateMatch(const FString & MatchId,const FRHAPI_MatchRequest & Match,const FRH_OnMatchUpdateCompleteDelegateBlock & Delegate)Update a match (PATCH w/ UPSERT)
public virtual void UpdateMatchPlayer(const FString & MatchId,const FGuid & PlayerId,const FRHAPI_MatchPlayerRequest & Player,const FRH_OnMatchPlayerUpdateCompleteDelegateBlock & Delegate)Update a player in a match (PATCH w/ UPSERT)
public virtual void UpdateMatchSegment(const FString & MatchId,const FString & SegmentId,const FRHAPI_MatchSegmentPatchRequest & Segment,const FRH_OnMatchUpdateCompleteDelegateBlock & Delegate)Update a specific match segment (PATCH w/ UPSERT)
protected TMap< FString, FRHAPI_MatchWithPlayers>MatchesCache
protected TOptional< FString > ActiveMatchIdThe last match created with bSetActive = true, for ease of use.

Members​

public bool bIgnoreCache ​

public bool const FRH_OnMatchLookupCompleteDynamicDelegate & Delegate ​

public virtual void Initialize() ​

Initialize the subsystem.

public virtual void Deinitialize() ​

Safely tears down the subsystem.

public virtual void SearchMatches(const FRH_MatchSearchParams & params,const FRH_OnMatchSearchCompleteDelegateBlock & Delegate) ​

Search for Matches.

Parameters​

  • params The search params to use for the given search.

  • Delegate Callback with the results of the search.

public virtual void GetMatchAsync(const FString & MatchId,bool bIgnoreCache,const FRH_OnMatchLookupCompleteDelegateBlock & Delegate) ​

Lookup a specific match.

public inline bool GetMatch(const FString & MatchId,FRHAPI_MatchWithPlayers & OutMatch) ​

Lookup a specific match from the cache.

public inline const TMap< FString, FRHAPI_MatchWithPlayers> &GetAllMatches() const ​

Get all matches from the cache.

public inline void ClearMatchesCache() ​

Clear the match cache.

public virtual void CreateMatch(const FRHAPI_MatchRequest & Match,const FRH_OnMatchUpdateCompleteDelegateBlock & Delegate) ​

Create a match (POST)

Parameters​

  • Match The match to create

  • Players The players to add to the match

  • bSetActiveMatchId Whether to set the match as the active match

  • Delegate Callback with the results of the match creation

public virtual void UpdateMatch(const FString & MatchId,const FRHAPI_MatchRequest & Match,const FRH_OnMatchUpdateCompleteDelegateBlock & Delegate) ​

Update a match (PATCH w/ UPSERT)

Parameters​

  • MatchId The match to update

  • Match The match to update

  • Delegate Callback with the results of the match update

public virtual void UpdateMatchPlayer(const FString & MatchId,const FGuid & PlayerId,const FRHAPI_MatchPlayerRequest & Player,const FRH_OnMatchPlayerUpdateCompleteDelegateBlock & Delegate) ​

Update a player in a match (PATCH w/ UPSERT)

Parameters​

  • MatchId The match to update

  • PlayerId The player id to update

  • Player The player data request to update

  • Delegate Callback with the results of the player update

public virtual void UpdateMatchSegment(const FString & MatchId,const FString & SegmentId,const FRHAPI_MatchSegmentPatchRequest & Segment,const FRH_OnMatchUpdateCompleteDelegateBlock & Delegate) ​

Update a specific match segment (PATCH w/ UPSERT)

Parameters​

  • MatchId The match to update

  • SegmentId The segment id to update

  • Segment The segment data to update

  • Delegate Callback with the results of the match update

protected TMap< FString, FRHAPI_MatchWithPlayers>MatchesCache ​

protected TOptional< FString > ActiveMatchId ​

The last match created with bSetActive = true, for ease of use.

struct FRH_MatchSearchParams ​

Summary​

MembersDescriptions
public int32 PageSizeThe maximum number of elements to be returned per call, ignored if 0.
public FString InstanceIdThe instance id to search on, ignored if empty.
public FString AllocationIdThe allocation id to search on, ignored if empty.
public FString SessionIdThe session id to search on, ignored if empty.
public FString HostPlayerUuidThe host player id to search on, ignored if empty.
public FString RegionIdThe region id to search on, ignored if empty.
public FString PlayerUuidThe participant player id to search on, ignored if empty.
public bool bIncludeSegmentsWhether to include segments in the search results.
public bool bIncludePlayersWhether to include players in the search results.
public FString CursorCursor to designate where you are in iterating through values. Start with '0', and pass this on subsequent calls to continue iteration.
public inline FRH_MatchSearchParams()
public inline FString GetDescription() constReturns summary of params for tooling/logging.
public inline bool CanCacheResults() const
public inline RallyHereAPI::FRequest_GetMatches ToAPIRequest(FAuthContextPtr AuthContext) constConverts the search params to an API request.

Members​

public int32 PageSize ​

The maximum number of elements to be returned per call, ignored if 0.

public FString InstanceId ​

The instance id to search on, ignored if empty.

public FString AllocationId ​

The allocation id to search on, ignored if empty.

public FString SessionId ​

The session id to search on, ignored if empty.

public FString HostPlayerUuid ​

The host player id to search on, ignored if empty.

public FString RegionId ​

The region id to search on, ignored if empty.

public FString PlayerUuid ​

The participant player id to search on, ignored if empty.

public bool bIncludeSegments ​

Whether to include segments in the search results.

public bool bIncludePlayers ​

Whether to include players in the search results.

public FString Cursor ​

Cursor to designate where you are in iterating through values. Start with '0', and pass this on subsequent calls to continue iteration.

public inline FRH_MatchSearchParams() ​

public inline FString GetDescription() const ​

Returns summary of params for tooling/logging.

public inline bool CanCacheResults() const ​

public inline RallyHereAPI::FRequest_GetMatches ToAPIRequest(FAuthContextPtr AuthContext) const ​

Converts the search params to an API request.

struct FRH_MatchSearchResult ​

Struct containint the results of a Session Browser search.

Summary​

MembersDescriptions
public FRH_MatchSearchParams SearchParamsThe paramaters used to make the search.
public TArray< FRHAPI_MatchWithPlayers>MatchesArray of match results found by the search.
public FString NextPageCursorCursor to use to request the next page of data.
public inline FString GetDescription() constReturns summary of search results for tooling/logging.
public inline FRH_MatchSearchResult()

Members​

public FRH_MatchSearchParams SearchParams ​

The paramaters used to make the search.

public TArray< FRHAPI_MatchWithPlayers>Matches ​

Array of match results found by the search.

public FString NextPageCursor ​

Cursor to use to request the next page of data.

public inline FString GetDescription() const ​

Returns summary of search results for tooling/logging.

public inline FRH_MatchSearchResult() ​