Session

Summary

Members	Descriptions
`class` `URH_PlatformSessionSyncer`	Synchronization object to sync state between a Rally Here Session and a Platform Session (such as a Steam session)
`class` `URH_SessionBrowserCache`	Simple container class to hold session view data, does not have its own auth context, relies upon getting it from elsewhere during calls, so that it can be used to cache across multiple players.
`class` `URH_SessionView`	Base class providing functionality for viewing session data and interacting with it from blueprint. Specifically does not have an “owner” meaning it cannot do “work” - it is read only. The subclasses have owners.
`class` `URH_InvitedSession`	Invited Sessions are sessions that the player has been invited to.
`class` `URH_OfflineSession`	Offline Sessions are sessions the session owner is actively a member of that are unsynchronized with the API. This is primarily intended as a utility class to allow for the session flow to be used globally, even when not running API based sessions (ex: tutorial / practice area before login).
`class` `URH_OnlineSession`	Online Sessions are sessions that are synchronized from the API (and since it is a joined session, the Session Owner is a member)
`class` `URH_SessionOwnerInterface`	Session Owner Interface class.
`class` `IRH_SessionOwnerInterface`	Session Owner Interface.
`struct` `FRH_SessionBrowserSearchParams`	Struct containing the search paramaters for Session Browsers.
`struct` `FRH_SessionMemberStatusState`	Utility struct to wrapper a player state for a player state update change.
`struct` `TRH_DataWithETagWrapper`	Utility struct to wrapper the tuple of a data typeand etag.
`struct` `FRH_DeferredSessionPoll`	Poll for deferred sessions.

class `URH_PlatformSessionSyncer`

class URH_PlatformSessionSyncer
  : public UObject

Synchronization object to sync state between a Rally Here Session and a Platform Session (such as a Steam session)

Summary

Members	Descriptions
`public FRH_PlatformSessionSyncerCleanupDelegate` `OnCleanupComplete`	Notification delegates for when cleanup of this object has completed.
`public FRH_PlatformSessionSyncerCleanupDynamicDelegate` `BLUEPRINT_OnCleanupComplete`
`public FRH_PlatformSessionSyncerStateChangedDelegate` `OnStateChanged`	Notification delegates for when cleanup of this object has completed.
`public FRH_PlatformSessionSyncerStateChangedDynamicDelegate` `BLUEPRINT_OnStateChanged`
`public bool` `Initialize(const FString & InSessionId,FRH_SessionOwnerPtr InOwner)`	Initialize the sycnrhonization object with a RallyHere session id and a session owner - requires that the owner contain that session.
`public void` `Cleanup(const FSimpleDelegate & CompletionDelegate)`	Clean up the synchronization object, typically used when the RallyHere session is expired.
`public inline FORCEINLINE FString` `GetRHSessionId() const`	Get the RallyHere session id that this object is synchronizing to.
`public virtual` `URH_JoinedSession*GetRHSession() const`	Helper function to get the RallyHere session objcet from the session owner (based on the result of GetRHSessionId())
`public virtual bool` `GetPlatformSessionIdFromRHSession(FUniqueNetIdRepl & PlatformSessionId) const`	Helper function to get the Platform Session Id from the RallyHere session object (based on the result of GetRHSession())
`public inline FName` `GetPlatformSessionName() const`	Get the platform session name that this object is synchronizing to from the OnlineSubsystem (useful for OSS calls) Note that this is set before OSS session is valid. If you want to make sure the name is for a valid session, use GetPlatformSession()->SessionName instead (GetPlatformSession() may return nullptr)
`public FNamedOnlineSession *` `GetPlatformSession() const`	Get the platform session object that this object is synchronizing to from the OnlineSubsystem.
`public bool` `GetPlatformSessionIdFromPlatformSession(FUniqueNetIdRepl & PlatformSessionId) const`	Helper function to get the Platform Session Id from the platform session object (based on the result of GetPlatformSession())
`public inline TScriptInterface<` `IRH_SessionOwnerInterface>GetSessionOwner() const`	Get the session owner interface that this object is using to look up session information.
`public virtual bool` `IsLocalPlayerScout() const`	Get whether the local player is the “scout” - the player responsible for creation of the platform session if one does not exist.
`public inline virtual` `ESyncActionState` `GetCurrentSyncActionState() const`	Get the current sync action state of this object.
`public inline virtual bool` `IsSynchronized() const`	Whether this object is in the process of, or has completed, synchronization.
`public inline virtual bool` `IsCleaningUp() const`	Whether this object is in the process of, or has completed, cleanup.
`public inline virtual bool` `IsCleanupComplete() const`	Whether this object has completed, cleanup.
`public virtual bool` `StartPlatformSession()`	Marks the session as started (note - asynchronous)
`public virtual bool` `EndPlatformSession()`	Marks the session as ended (note - asynchronous)
`public virtual void` `OnPlatformSessionCreated(bool bSuccess)`	Notification helper to let the synchronization object know that a session has been created (from the session owner, as the synchronization object does not bind the callback directly)
`public virtual void` `OnPlatformSessionJoined(EOnJoinSessionCompleteResult::Type Result)`	Notification helper to let the synchronization object know that a session has been joined (from the session owner, as the synchronization object does not bind the callback directly)
`public virtual void` `OnPlatformSessionStarted(bool bSuccess)`	Notification helper to let the synchronization object know that a session has been started (from the session owner, as the synchronization object does not bind the callback directly)
`public virtual void` `OnPlatformSessionEnded(bool bSuccess)`	Notification helper to let the synchronization object know that a session has been ended (from the session owner, as the synchronization object does not bind the callback directly)
`public virtual void` `OnPlatformSessionDestroyed(bool bSuccess)`	Notification helper to let the synchronization object know that a session has been destroyed (from the session owner, as the synchronization object does not bind the callback directly)
`public void` `OnRHSessionUpdated(URH_SessionView` `* UpdatedSession)`	Handler for whenever the associated session is updated.
`public void` `SetCachedPlatformSessionInvite(const FOnlineSessionSearchResult & SessionInvite)`
`public virtual IOnlineSubsystem *` `GetOSS() const`	Get the online subsystem for the platform session.
`protected` `ESyncActionState` `CurrentSyncActionState`	The current state of the syncer.
`protected FRH_SessionOwnerPtr` `SessionOwner`	Owner of the session.
`protected FString` `RHSessionId`	Rally Here session Id.
`protected FName` `OSSSessionName`	Name of the session.
`protected ERHAPI_Platform` `RHPlatform`	Internal platoform for the session.
`protected TOptional< FOnlineSessionSearchResult >` `CachedSessionInvite`	The cached platform session invite.
`protected TWeakObjectPtr<` `URH_JoinedSession>CleanupRHSession`	Backup pointer used during cleanup in case session has already been removed from owner when cleanup is triggered (ex: expiration has begun)
`protected bool` `bDeferCleanup`	whether cleanup is deferred until the end of the current action
`protected virtual void` `CheckState()`	Check our current state against the session, and decide if we need to take any action.
`protected virtual void` `KickOffState(ESyncActionState` `NewState)`	Change to a new state.
`protected virtual void` `SyncActionComplete(bool bSuccess,bool bDeferFrame)`	Called when a Sync Action State is complete.
`protected virtual void` `UpdateRHSessionWithPlatformSession()`	Take in information from the paired platform session into the RH Session.
`protected virtual void` `CreatePlatformSession()`	Create a platform session.
`protected virtual void` `JoinPlatformSession()`	Join the platform session.
`protected virtual void` `JoinFoundPlatformSession(const FOnlineSessionSearchResult & SearchResult)`	Used by Join Platform session once found to join it.
`protected virtual void` `OnScoutFailedToJoin()`	Handler for if scout fails to successfully join a specified session. Attempt to rectify by clearing out session (which should trigger a new session creation)
`protected virtual void` `LeavePlatformSession()`	Leave the platform session.
`protected virtual void` `CleanupInternal()`	Cleanup internal state of the session syncer.
`protected virtual bool` `SetSyncActionState(ESyncActionState` `NewState)`	Sets the new action state for the syncer.
`protected virtual FUniqueNetIdWrapper` `GetOSSUniqueId() const`	Get the unique net id of the session owner.
`protected virtual IOnlineSessionPtr` `GetOSSSessionInterface() const`	Get the online subsystem session interface for the platform session.

Members

`public FRH_PlatformSessionSyncerCleanupDelegate` `OnCleanupComplete`

Notification delegates for when cleanup of this object has completed.

#### `public FRH_PlatformSessionSyncerCleanupDynamicDelegate `[`BLUEPRINT_OnCleanupComplete`](#classURH__PlatformSessionSyncer_1a3be5a8c4afc63c37631b32ab867af2ba)
#### `public FRH_PlatformSessionSyncerStateChangedDelegate `[`OnStateChanged`](#classURH__PlatformSessionSyncer_1a1a1ded57262ed2320eeb66e852cb8e21)

Notification delegates for when cleanup of this object has completed.

#### `public FRH_PlatformSessionSyncerStateChangedDynamicDelegate `[`BLUEPRINT_OnStateChanged`](#classURH__PlatformSessionSyncer_1a22f87dbe7cf96e477c6b91ff686d203a)
#### `public bool `[`Initialize`](#classURH__PlatformSessionSyncer_1a672a8526678c8c22c968c2eb5d5f1334)`(const FString & InSessionId,FRH_SessionOwnerPtr InOwner)`

Initialize the sycnrhonization object with a RallyHere session id and a session owner - requires that the owner contain that session.

Parameters

InSessionId The Rally Here session id for which we are synchronizing state
InOwner Session owner interface for use in looking up the session and other information

Returns

Whether initialization was successful. If initialization was successful, Cleanup() must be called to properly clean up state

#### `public void `[`Cleanup`](#classURH__PlatformSessionSyncer_1ac45a6144ac79b3024c9a5eb0c63ab981)`(const FSimpleDelegate & CompletionDelegate)`

Clean up the synchronization object, typically used when the RallyHere session is expired.

Parameters

CompletionDelegate Delegate to call when cleanup is complete

#### `public inline FORCEINLINE FString `[`GetRHSessionId`](#classURH__PlatformSessionSyncer_1aa02905d5d2f2951c693d6ff1ac9a9e08)`() const`

Get the RallyHere session id that this object is synchronizing to.

#### `public virtual `[`URH_JoinedSession`](undefined.md#classURH__JoinedSession)` * `[`GetRHSession`](#classURH__PlatformSessionSyncer_1ad9f453ea3f81edb0b87d9f3ba6950c57)`() const`

Helper function to get the RallyHere session objcet from the session owner (based on the result of GetRHSessionId())

#### `public virtual bool `[`GetPlatformSessionIdFromRHSession`](#classURH__PlatformSessionSyncer_1aea73e377334a657438cc1fdc74839891)`(FUniqueNetIdRepl & PlatformSessionId) const`

Helper function to get the Platform Session Id from the RallyHere session object (based on the result of GetRHSession())

Parameters

PlatformSessionId The platform session id to fill in

Returns

Whether the platform session id was successfully filled in

#### `public inline FName `[`GetPlatformSessionName`](#classURH__PlatformSessionSyncer_1ab8864e7affb0cb4cf22bd81869b60c72)`() const`

Get the platform session name that this object is synchronizing to from the OnlineSubsystem (useful for OSS calls) Note that this is set before OSS session is valid. If you want to make sure the name is for a valid session, use GetPlatformSession()->SessionName instead (GetPlatformSession() may return nullptr)

#### `public FNamedOnlineSession * `[`GetPlatformSession`](#classURH__PlatformSessionSyncer_1ab67a1eed0ca3fe1c09672f3de8fcb44c)`() const`

Get the platform session object that this object is synchronizing to from the OnlineSubsystem.

#### `public bool `[`GetPlatformSessionIdFromPlatformSession`](#classURH__PlatformSessionSyncer_1a6be06ee04e5ea7001ed014cc1fbbec65)`(FUniqueNetIdRepl & PlatformSessionId) const`

Helper function to get the Platform Session Id from the platform session object (based on the result of GetPlatformSession())

Parameters

PlatformSessionId The platform session id to fill in

Returns

Whether the platform session id was successfully filled in

#### `public inline TScriptInterface< `[`IRH_SessionOwnerInterface`](Session.md#classIRH__SessionOwnerInterface)` > `[`GetSessionOwner`](#classURH__PlatformSessionSyncer_1a93019be39c8791d4b38444fb211bd358)`() const`

Get the session owner interface that this object is using to look up session information.

#### `public virtual bool `[`IsLocalPlayerScout`](#classURH__PlatformSessionSyncer_1a4c35be7c6e9a7c44101d34615e34a89a)`() const`

Get whether the local player is the “scout” - the player responsible for creation of the platform session if one does not exist.

#### `public inline virtual `[`ESyncActionState`](undefined.md#group__Session_1gaa60e236caf03784c17c443c4a520d642)` `[`GetCurrentSyncActionState`](#classURH__PlatformSessionSyncer_1ab09f660e7e04da39fc24fb451935b677)`() const`

Get the current sync action state of this object.

#### `public inline virtual bool `[`IsSynchronized`](#classURH__PlatformSessionSyncer_1a89ba08022b1c6406db0d5d763b544ac9)`() const`

Whether this object is in the process of, or has completed, synchronization.

#### `public inline virtual bool `[`IsCleaningUp`](#classURH__PlatformSessionSyncer_1aecc90ce5a81b6ff023f107fd353906d6)`() const`

Whether this object is in the process of, or has completed, cleanup.

#### `public inline virtual bool `[`IsCleanupComplete`](#classURH__PlatformSessionSyncer_1acbfb387b2d0cea91154faec908def601)`() const`

Whether this object has completed, cleanup.

#### `public virtual bool `[`StartPlatformSession`](#classURH__PlatformSessionSyncer_1a422d3660def6c54c7fa45e521149adc7)`()`

Marks the session as started (note - asynchronous)

#### `public virtual bool `[`EndPlatformSession`](#classURH__PlatformSessionSyncer_1ac26c84cdcdfa44eac105d878a8f7fce7)`()`

Marks the session as ended (note - asynchronous)

#### `public virtual void `[`OnPlatformSessionCreated`](#classURH__PlatformSessionSyncer_1adf45b673cebb3d4f667ca33a2d2a4abd)`(bool bSuccess)`

Notification helper to let the synchronization object know that a session has been created (from the session owner, as the synchronization object does not bind the callback directly)

#### `public virtual void `[`OnPlatformSessionJoined`](#classURH__PlatformSessionSyncer_1a6533c4f9e5b84ab7893ee0f002bee8fa)`(EOnJoinSessionCompleteResult::Type Result)`

Notification helper to let the synchronization object know that a session has been joined (from the session owner, as the synchronization object does not bind the callback directly)

#### `public virtual void `[`OnPlatformSessionStarted`](#classURH__PlatformSessionSyncer_1ada7c87ae46e8fe0c99a06de53284695a)`(bool bSuccess)`

Notification helper to let the synchronization object know that a session has been started (from the session owner, as the synchronization object does not bind the callback directly)

#### `public virtual void `[`OnPlatformSessionEnded`](#classURH__PlatformSessionSyncer_1a29afb3b5b1bda91905c85ed56004294f)`(bool bSuccess)`

Notification helper to let the synchronization object know that a session has been ended (from the session owner, as the synchronization object does not bind the callback directly)

#### `public virtual void `[`OnPlatformSessionDestroyed`](#classURH__PlatformSessionSyncer_1a600318f388b1d368077bd7c9090c8bc9)`(bool bSuccess)`

Notification helper to let the synchronization object know that a session has been destroyed (from the session owner, as the synchronization object does not bind the callback directly)

#### `public void `[`OnRHSessionUpdated`](#classURH__PlatformSessionSyncer_1a6359fb4330ea231ed32cb6b66e5ff270)`(`[`URH_SessionView`](Session.md#classURH__SessionView)` * UpdatedSession)`

Handler for whenever the associated session is updated.

Parameters

UpdatedSession The session that was updated.

#### `public void `[`SetCachedPlatformSessionInvite`](#classURH__PlatformSessionSyncer_1ad88b73abe387bfd9433def9d3416f001)`(const FOnlineSessionSearchResult & SessionInvite)`
#### `public virtual IOnlineSubsystem * `[`GetOSS`](#classURH__PlatformSessionSyncer_1aba1b0f5be0fbcafbc48c0ad0c7ec3baa)`() const`

Get the online subsystem for the platform session.

#### `protected `[`ESyncActionState`](undefined.md#group__Session_1gaa60e236caf03784c17c443c4a520d642)` `[`CurrentSyncActionState`](#classURH__PlatformSessionSyncer_1a0a8fd13fe93d1aac1b94e7dc0e3715ea)

The current state of the syncer.

#### `protected FRH_SessionOwnerPtr `[`SessionOwner`](#classURH__PlatformSessionSyncer_1abdc13532c721a2d0593b177ae19833e5)

Owner of the session.

#### `protected FString `[`RHSessionId`](#classURH__PlatformSessionSyncer_1a2782a9152c7bf68ed0bd908b95c4301f)

Rally Here session Id.

#### `protected FName `[`OSSSessionName`](#classURH__PlatformSessionSyncer_1ac4bc77d7e8275889c8050bf1a09f2e97)

Name of the session.

#### `protected ERHAPI_Platform `[`RHPlatform`](#classURH__PlatformSessionSyncer_1ae2dda53f9229c02025c41c2203792892)

Internal platoform for the session.

#### `protected TOptional< FOnlineSessionSearchResult > `[`CachedSessionInvite`](#classURH__PlatformSessionSyncer_1afd327c8b4ac82aabcdd3063ca15432f2)

The cached platform session invite.

#### `protected TWeakObjectPtr< `[`URH_JoinedSession`](undefined.md#classURH__JoinedSession)` > `[`CleanupRHSession`](#classURH__PlatformSessionSyncer_1a8fefa6f56080ef0462ae6b04178eb42b)

Backup pointer used during cleanup in case session has already been removed from owner when cleanup is triggered (ex: expiration has begun)

#### `protected bool `[`bDeferCleanup`](#classURH__PlatformSessionSyncer_1a1339e4f23791197848afeed8d7169651)

whether cleanup is deferred until the end of the current action

#### `protected virtual void `[`CheckState`](#classURH__PlatformSessionSyncer_1a83d87592ba8d798950d6f21be450ff8d)`()`

Check our current state against the session, and decide if we need to take any action.

#### `protected virtual void `[`KickOffState`](#classURH__PlatformSessionSyncer_1a05410c9acd749de9855906064dec3f1d)`(`[`ESyncActionState`](undefined.md#group__Session_1gaa60e236caf03784c17c443c4a520d642)` NewState)`

Change to a new state.

Parameters

NewState Target new state.

#### `protected virtual void `[`SyncActionComplete`](#classURH__PlatformSessionSyncer_1aac8fc53affd478438fc1fc8f0cc4e14e)`(bool bSuccess,bool bDeferFrame)`

Called when a Sync Action State is complete.

Parameters

bSuccess Whether the action was successful.
bDeferFrame Whether to defer the frame before checking the state again.

#### `protected virtual void `[`UpdateRHSessionWithPlatformSession`](#classURH__PlatformSessionSyncer_1a32ba9f36bebfb6f263b73da0c9520267)`()`

Take in information from the paired platform session into the RH Session.

#### `protected virtual void `[`CreatePlatformSession`](#classURH__PlatformSessionSyncer_1a4c610d83e5a229ffc45db3eed437f886)`()`

Create a platform session.

#### `protected virtual void `[`JoinPlatformSession`](#classURH__PlatformSessionSyncer_1ab9709b439531ace0d8e4b49501bd8991)`()`

Join the platform session.

#### `protected virtual void `[`JoinFoundPlatformSession`](#classURH__PlatformSessionSyncer_1aa2d3557381e75ef893c848667ac53b09)`(const FOnlineSessionSearchResult & SearchResult)`

Used by Join Platform session once found to join it.

Parameters

SearchResult The search result to join.

#### `protected virtual void `[`OnScoutFailedToJoin`](#classURH__PlatformSessionSyncer_1a71c2f843e4f7fe8c3727240fd9051d9d)`()`

Handler for if scout fails to successfully join a specified session. Attempt to rectify by clearing out session (which should trigger a new session creation)

#### `protected virtual void `[`LeavePlatformSession`](#classURH__PlatformSessionSyncer_1ad1a4c32ab4b51df8dd639a2c01d2d947)`()`

Leave the platform session.

#### `protected virtual void `[`CleanupInternal`](#classURH__PlatformSessionSyncer_1a51bed2712c80a6f92f1c8c5c1e1904f1)`()`

Cleanup internal state of the session syncer.

#### `protected virtual bool `[`SetSyncActionState`](#classURH__PlatformSessionSyncer_1a1261e4cc0e9cf808324785ca5e7fdf9f)`(`[`ESyncActionState`](undefined.md#group__Session_1gaa60e236caf03784c17c443c4a520d642)` NewState)`

Sets the new action state for the syncer.

Parameters

NewState New State to be in.

#### `protected virtual FUniqueNetIdWrapper `[`GetOSSUniqueId`](#classURH__PlatformSessionSyncer_1aebf1a29ac22a2919aed0b76d15f4bd51)`() const`

Get the unique net id of the session owner.

#### `protected virtual IOnlineSessionPtr `[`GetOSSSessionInterface`](#classURH__PlatformSessionSyncer_1addd7c5606ca5ca5d95d9d78cd89c7bd1)`() const`

Get the online subsystem session interface for the platform session.

## class `URH_SessionBrowserCache`

class URH_SessionBrowserCache
  : public URH_SandboxedSubsystemPlugin
  : public IRH_SessionOwnerInterface

Simple container class to hold session view data, does not have its own auth context, relies upon getting it from elsewhere during calls, so that it can be used to cache across multiple players.

Summary

Members	Descriptions
`public` `URH_SessionBrowserCache()`	Default constructor.
`public void` `Search(const` `FRH_SessionBrowserSearchParams` `& params,const FRH_OnSessionSearchCompleteDelegateBlock & Delegate)`	Makes a call to search for session browsers.
`public inline void` `BLUEPRINT_Search(const` `FRH_SessionBrowserSearchParams` `& params,FRH_OnSessionSearchCompleteDynamicDelegate Delegate)`
`public inline void` `ClearCache(bool bClearTemplates)`	Clears the cached sessions, and optionally the cached templates.
`public virtual FAuthContextPtr` `GetSessionAuthContext() const`	Gets the auth context to use for API calls for the session owner.
`public virtual void` `ImportAPISession(const` `FRH_APISessionWithETag` `& Session)`	Adds a session into the session cache.
`public virtual void` `ImportAPITemplate(const` `FRHAPI_SessionTemplate` `& Template)`	Adds a new session template type to the templates.
`public inline virtual void` `ReconcileAPISessions(const TArray< FString > & SessionIds,const TOptional< FString > & ETag)`	Updates the list of sessions to only those that are active.
`public inline virtual void` `ReconcileAPITemplates(const TArray< FString > & InTemplates,const TOptional< FString > & ETag)`	Updates the list of session templates to those that are active.
`public virtual class` `URH_PlayerInfoSubsystem*GetPlayerInfoSubsystem() const`	Gets the PlayerInfo Subsystem.
`public inline virtual IOnlineSubsystem *` `GetOSS() const`	Gets the Online Subsystem to use for OSS calls.
`public inline virtual FUniqueNetIdWrapper` `GetOSSUniqueId() const`	Gets the Online Subsystem Unique Id to use for OSS calls.
`public inline virtual FPlatformUserId` `GetOSSPlatformUserId() const`	Gets the Online Subsystem PlatformUserId to use for OSS calls (equivalent to controller index)
`public inline virtual TOptional< FString >` `GetETagForAllTemplatesPoll() const`	Gets the etag to use for a “Get all Templates” type query.
`public inline virtual TOptional< FString >` `GetETagForAllSessionsPoll() const`	Gets the etag to use for a “Get all Sessions” type query.
`public inline virtual TArray<` `URH_SessionView* >GetAllSessionsForPolling() const`	Used to get all sessions, primarily for get all sessions polling where etag matches.
`public inline virtual` `URH_SessionView*GetSessionById(const FString & SessionId) const`	Gets a session by its id.
`public virtual void` `RemoveSessionById(const FString & SessionId)`	Removes a cached session for the local player, this does NOT try to leave it.
`public virtual bool` `GetTemplate(const FString & Type,FRHAPI_SessionTemplate` `& Template) const`	Gets a session template by type.
`public inline virtual` `URH_PlatformSessionSyncer*GetPlatformSyncerByRHSessionId(const FString & SessionId) const`	Gets the platform synchronization object using the rally here session id.
`public inline virtual` `URH_PlatformSessionSyncer*GetPlatformSyncerByPlatformSessionId(const FUniqueNetIdRepl & PlatformSessionId) const`	Gets the platform synchronization object using the platform session id.

Members

`public` `URH_SessionBrowserCache()`

Default constructor.

#### `public void `[`Search`](#classURH__SessionBrowserCache_1a7c3c586c5d3de3fb1511be825c8840c9)`(const `[`FRH_SessionBrowserSearchParams`](Session.md#structFRH__SessionBrowserSearchParams)` & params,const FRH_OnSessionSearchCompleteDelegateBlock & Delegate)`

Makes a call to search for session browsers.

Parameters

params The search paramaters to use.
Delegate Callback delegate for when the search is completed.

#### `public inline void `[`BLUEPRINT_Search`](#classURH__SessionBrowserCache_1aef57a504c6238f35f6040a3c8b0f2b13)`(const `[`FRH_SessionBrowserSearchParams`](Session.md#structFRH__SessionBrowserSearchParams)` & params,FRH_OnSessionSearchCompleteDynamicDelegate Delegate)`
#### `public inline void `[`ClearCache`](#classURH__SessionBrowserCache_1ab6fc51bbfa94876b68dc96846fe3c920)`(bool bClearTemplates)`

Clears the cached sessions, and optionally the cached templates.

Parameters

bClearTemplates If true, clear the templates as well.

#### `public virtual FAuthContextPtr `[`GetSessionAuthContext`](#classURH__SessionBrowserCache_1a097ea9b50702c214574c512697427337)`() const`

Gets the auth context to use for API calls for the session owner.

#### `public virtual void `[`ImportAPISession`](#classURH__SessionBrowserCache_1ad7879d7762f0c548483d4b0f04558b97)`(const `[`FRH_APISessionWithETag`](Session.md#structTRH__DataWithETagWrapper)` & Session)`

Adds a session into the session cache.

Parameters

Session The session to add.

#### `public virtual void `[`ImportAPITemplate`](#classURH__SessionBrowserCache_1a59bae44be9047e2b2e107c27644eb6b0)`(const `[`FRHAPI_SessionTemplate`](models/RHAPI_SessionTemplate.md#structFRHAPI__SessionTemplate)` & Template)`

Adds a new session template type to the templates.

Parameters

Template The template ot add.

#### `public inline virtual void `[`ReconcileAPISessions`](#classURH__SessionBrowserCache_1aec55593cc0c5248cb9a2eacab2c5e484)`(const TArray< FString > & SessionIds,const TOptional< FString > & ETag)`

Updates the list of sessions to only those that are active.

Parameters

SessionIds The list of sessions that we are reconciling against.
ETag The ETag to use for the update.

#### `public inline virtual void `[`ReconcileAPITemplates`](#classURH__SessionBrowserCache_1a599273fe6e4ea36ab930c56f077eff91)`(const TArray< FString > & InTemplates,const TOptional< FString > & ETag)`

Updates the list of session templates to those that are active.

Parameters

InTemplates The list of templates that we are reconciling against.
ETag The ETag to use for the update.

#### `public virtual class `[`URH_PlayerInfoSubsystem`](PlayerInfo.md#classURH__PlayerInfoSubsystem)` * `[`GetPlayerInfoSubsystem`](#classURH__SessionBrowserCache_1ac59f177acf3996badf4dd9907c0e66e8)`() const`

Gets the PlayerInfo Subsystem.

#### `public inline virtual IOnlineSubsystem * `[`GetOSS`](#classURH__SessionBrowserCache_1a83aee966f46fa0846e717d03fd9d9963)`() const`

Gets the Online Subsystem to use for OSS calls.

#### `public inline virtual FUniqueNetIdWrapper `[`GetOSSUniqueId`](#classURH__SessionBrowserCache_1a65fc8b708ead7613eccfff0845f4c131)`() const`

Gets the Online Subsystem Unique Id to use for OSS calls.

#### `public inline virtual FPlatformUserId `[`GetOSSPlatformUserId`](#classURH__SessionBrowserCache_1a207b2edbcb716481408845eae51f31a8)`() const`

Gets the Online Subsystem PlatformUserId to use for OSS calls (equivalent to controller index)

#### `public inline virtual TOptional< FString > `[`GetETagForAllTemplatesPoll`](#classURH__SessionBrowserCache_1aa76b9eb09fb687bff5252effe7da2b0e)`() const`

Gets the etag to use for a “Get all Templates” type query.

#### `public inline virtual TOptional< FString > `[`GetETagForAllSessionsPoll`](#classURH__SessionBrowserCache_1af673c57a58cd96f48687778033b0c9e4)`() const`

Gets the etag to use for a “Get all Sessions” type query.

#### `public inline virtual TArray< `[`URH_SessionView`](Session.md#classURH__SessionView)` * > `[`GetAllSessionsForPolling`](#classURH__SessionBrowserCache_1aa05dd036c2dacc629cbf2d55b90efcdf)`() const`

Used to get all sessions, primarily for get all sessions polling where etag matches.

#### `public inline virtual `[`URH_SessionView`](Session.md#classURH__SessionView)` * `[`GetSessionById`](#classURH__SessionBrowserCache_1aa64b3bc0c50822dfc08403fa30416907)`(const FString & SessionId) const`

Gets a session by its id.

Parameters

SessionId The Session Id to get.

Returns

The Session with the given Id.

#### `public virtual void `[`RemoveSessionById`](#classURH__SessionBrowserCache_1ac417818631c93603c294d653811d3948)`(const FString & SessionId)`

Removes a cached session for the local player, this does NOT try to leave it.

Parameters

SessionId The Session Id to remove.

#### `public virtual bool `[`GetTemplate`](#classURH__SessionBrowserCache_1aa529f70a678eb8569e794a9366d8e4fd)`(const FString & Type,`[`FRHAPI_SessionTemplate`](models/RHAPI_SessionTemplate.md#structFRHAPI__SessionTemplate)` & Template) const`

Gets a session template by type.

Parameters

Type the Type of template to get.
Template The session template being retrieved.

Returns

If true, the template was found.

#### `public inline virtual `[`URH_PlatformSessionSyncer`](Session.md#classURH__PlatformSessionSyncer)` * `[`GetPlatformSyncerByRHSessionId`](#classURH__SessionBrowserCache_1a7315ff647e9507c03a8e4b4b22657fed)`(const FString & SessionId) const`

Gets the platform synchronization object using the rally here session id.

#### `public inline virtual `[`URH_PlatformSessionSyncer`](Session.md#classURH__PlatformSessionSyncer)` * `[`GetPlatformSyncerByPlatformSessionId`](#classURH__SessionBrowserCache_1a363341b102359f9b6d90bfd1f3f73b3b)`(const FUniqueNetIdRepl & PlatformSessionId) const`

Gets the platform synchronization object using the platform session id.

## class `URH_SessionView`

class URH_SessionView
  : public UObject

Base class providing functionality for viewing session data and interacting with it from blueprint. Specifically does not have an “owner” meaning it cannot do “work” - it is read only. The subclasses have owners.

Summary

Members	Descriptions
`public FRH_OnSessionUpdatedMulticastDelegate` `OnSessionUpdatedDelegate`	Delegate fired whenever the session is updated.
`public FRH_OnSessionUpdatedMulticastDynamicDelegate` `BLUEPRINT_OnSessionUpdatedDelegate`	Blueprint compatible delegate fired whenever the session is updated.
`public FRH_OnSessionUpdatedMulticastDelegate` `OnSessionNotFoundDelegate`	Delegate fired whenever the session is not found.
`public FRH_OnSessionUpdatedMulticastDynamicDelegate` `BLUEPRINT_OnSessionNotFoundDelegate`	Blueprint compatible delegate fired whenever the session is not found.
`public FRH_OnSessionMemberStateChangedDelegate` `OnSessionMemberStateChangedDelegate`	Delegate fired whenever the session member list changes with details about the change.
`public FRH_OnSessionMemberStateChangedDynamicDelegate` `BLUEPRINT_OnSessionMemberStateChangedDelegate`	Blueprint compatible delegate fired whenever the session member list changes with details about the change.
`public inline FORCEINLINE const` `FRH_APISessionWithETag&GetSessionWithETag() const`	Gets the Session Data and its ETag.
`public inline const` `FRHAPI_Session&GetSessionData() const`	Gets the Session Data.
`public inline const` `FRHAPI_InstanceInfo*GetInstanceData() const`	Gets the Instance Data.
`public inline FORCEINLINE const` `FRHAPI_SessionPlayer*GetSessionPlayer(const FGuid & PlayerUuid) const`	Gets a session player if they are part of the session.
`public inline FORCEINLINE bool` `GetSessionPlayer(const FGuid & PlayerUuid,FRHAPI_SessionPlayer` `& OutPlayer) const`	Gets a session player if they are part of the session.
`public inline FORCEINLINE const` `FRHAPI_SessionPlayer*GetSessionLeader() const`	Gets the leader of the session if one exists.
`public inline FORCEINLINE bool` `GetSessionLeader(FRHAPI_SessionPlayer` `& OutPlayer) const`	Gets the leader of the session if one exists.
`public inline FORCEINLINE int32` `GetSessionPlayerTeamId(const FGuid & PlayerUuid) const`	Gets the team id of a player if they are part of the session.
`public inline FORCEINLINE bool` `IsCreatedByMatchmaking() const`	Gets if the session was created through matchmaking.
`public inline FORCEINLINE int32` `GetSessionPlayerCount() const`	Gets the number of players in the session.
`public inline virtual bool` `IsOffline() const`	Gets if the session is offline.
`public inline FORCEINLINE bool` `IsOnline() const`	Gets if the session is online.
`public inline virtual bool` `IsJoined() const`	Gets if the session is a one the local player has joined.
`public inline bool` `IsInQueue() const`	Gets if the session is currently in matchmaking.
`public inline FORCEINLINE` `FRHAPI_SessionTemplate` `GetTemplate() const`	Gets the session template.
`public inline FORCEINLINE FString` `GetETag() const`	Gets the session ETag.
`public inline FORCEINLINE FString` `GetSessionId() const`	Gets the session Id.
`public inline FORCEINLINE FString` `GetSessionType() const`	Gets the session type.
`public TMap< FString, FString >` `GetCustomData() const`	Gets session custom data.
`public bool` `GetCustomDataValue(const FString & Key,FString & OutValue) const`	Gets a session custom data value.
`public TMap< FString, FString >` `GetInstanceCustomData() const`	Gets intance custom data.
`public bool` `GetInstanceCustomDataValue(const FString & Key,FString & OutValue) const`	Gets an instance custom data value.
`public TMap< FString, FString >` `GetBrowserCustomData() const`	Gets session browser custom data.
`public bool` `GetPlatformSession(ERHAPI_Platform Platform,FRHAPI_PlatformSession` `& OutPlatformSession) const`	Get the platform session data for a specific platform id
`public virtual void` `ImportAPISession(const` `FRH_APISessionWithETag& newSessionData,constFRHAPI_SessionTemplate` `& newTemplate)`	Update a session from the owner, implies a template update.
`public virtual void` `ImportTemplate(const` `FRHAPI_SessionTemplate` `& newTemplate)`	Update the session template .
`public virtual void` `Expire(const FRH_OnSessionExpiredDelegate & Delegate)`	Called when the session was removed from our session list. Cleans up state then trigger callback on owner.
`public TScriptInterface<` `IRH_SessionOwnerInterface>GetSessionOwner() const`	Gets the session owner.
`public void` `StartPolling()`	Starts the polling of session updates.
`public void` `StopPolling()`	Stops the polling for session updates.
`public void` `DeferPolling()`	Defers the polling for session updates (in case an out-of-band update was received)
`public float` `GetPollTimeRemaining()`	Gets the current time remaining in the poll cycle in seconds. Returns -1.f if poll is inactive or is executing.
`public void` `ForcePollForUpdate(bool bClearETag)`	Forces a polling call even if the polling is waiting till next time to pulse.
`public void` `AddDeferredPoll(const` `FRH_DeferredSessionPoll` `& DeferredPoll)`	Add a deferred poll to the list of polls to run in sequence.
`public void` `CheckDeferredPolls()`	Check and potentially kick off a deferred poll.
`protected` `FRH_APISessionWithETag` `SessionData`	The Session Data with Etag.
`protected` `FRHAPI_SessionTemplate` `Template`	A reference copy of the Template (in case the template is deleted from the managed template list)
`protected FRH_AutoPollerPtr` `Poller`	Poller in charge of polling for the session.
`protected TArray<` `FRH_DeferredSessionPoll>DeferredPolls`	Array of stored poll requests that have not yet been processed.
`protected TArray<` `FRH_DeferredSessionPoll>WaitingPolls`	Array of stored poll requests that are waiting on the result of the current poll.
`protected void` `PollForUpdate(const FRH_PollCompleteFunc & Delegate)`	Triggers a poll for a session update, automatically called as part of the polling loop.

Members

`public FRH_OnSessionUpdatedMulticastDelegate` `OnSessionUpdatedDelegate`

Delegate fired whenever the session is updated.

#### `public FRH_OnSessionUpdatedMulticastDynamicDelegate `[`BLUEPRINT_OnSessionUpdatedDelegate`](#classURH__SessionView_1ad4bcea359be2cf5f8083d27088c6db7a)

Blueprint compatible delegate fired whenever the session is updated.

#### `public FRH_OnSessionUpdatedMulticastDelegate `[`OnSessionNotFoundDelegate`](#classURH__SessionView_1a8426fe031d4f2711140ce31aa5eaf0a0)

Delegate fired whenever the session is not found.

#### `public FRH_OnSessionUpdatedMulticastDynamicDelegate `[`BLUEPRINT_OnSessionNotFoundDelegate`](#classURH__SessionView_1a6672874c5fffb498ed5f19cfa6805751)

Blueprint compatible delegate fired whenever the session is not found.

#### `public FRH_OnSessionMemberStateChangedDelegate `[`OnSessionMemberStateChangedDelegate`](#classURH__SessionView_1aaab8a60729077d368e1cabf44c10167f)

Delegate fired whenever the session member list changes with details about the change.

#### `public FRH_OnSessionMemberStateChangedDynamicDelegate `[`BLUEPRINT_OnSessionMemberStateChangedDelegate`](#classURH__SessionView_1aa2d2de09bbcdd4b464f7f144f5f90920)

Blueprint compatible delegate fired whenever the session member list changes with details about the change.

#### `public inline FORCEINLINE const `[`FRH_APISessionWithETag`](Session.md#structTRH__DataWithETagWrapper)` & `[`GetSessionWithETag`](#classURH__SessionView_1a82784931fa5147876f93a3096d38417f)`() const`

Gets the Session Data and its ETag.

#### `public inline const `[`FRHAPI_Session`](models/RHAPI_Session.md#structFRHAPI__Session)` & `[`GetSessionData`](#classURH__SessionView_1adc1e64df9d89153b96f912abaf54ed4f)`() const`

Gets the Session Data.

#### `public inline const `[`FRHAPI_InstanceInfo`](models/RHAPI_InstanceInfo.md#structFRHAPI__InstanceInfo)` * `[`GetInstanceData`](#classURH__SessionView_1aa41fa4e0e20493b0b89ca0976c72330e)`() const`

Gets the Instance Data.

#### `public inline FORCEINLINE const `[`FRHAPI_SessionPlayer`](models/RHAPI_SessionPlayer.md#structFRHAPI__SessionPlayer)` * `[`GetSessionPlayer`](#classURH__SessionView_1a3c11043ff5ae46b22f47442734758773)`(const FGuid & PlayerUuid) const`

Gets a session player if they are part of the session.

Parameters

PlayerUuid The unique Id of the player to get.

Returns

The player if they exist in the session, otherwise null.

#### `public inline FORCEINLINE bool `[`GetSessionPlayer`](#classURH__SessionView_1abf7a2c182bbf41b82a158fc111598aad)`(const FGuid & PlayerUuid,`[`FRHAPI_SessionPlayer`](models/RHAPI_SessionPlayer.md#structFRHAPI__SessionPlayer)` & OutPlayer) const`

Gets a session player if they are part of the session.

Parameters

PlayerUuid The unique Id of the player to get.
OutPlayer The player if they exist in the session.

Returns

If true, the player was found.

#### `public inline FORCEINLINE const `[`FRHAPI_SessionPlayer`](models/RHAPI_SessionPlayer.md#structFRHAPI__SessionPlayer)` * `[`GetSessionLeader`](#classURH__SessionView_1a4c24806b4e7e37ce2f3716330f82fed9)`() const`

Gets the leader of the session if one exists.

#### `public inline FORCEINLINE bool `[`GetSessionLeader`](#classURH__SessionView_1a31765b2d8138d16349615492bfd46bee)`(`[`FRHAPI_SessionPlayer`](models/RHAPI_SessionPlayer.md#structFRHAPI__SessionPlayer)` & OutPlayer) const`

Gets the leader of the session if one exists.

Parameters

OutPlayer The leader if they exist in the session.

Returns

If true, the leader was found.

#### `public inline FORCEINLINE int32 `[`GetSessionPlayerTeamId`](#classURH__SessionView_1a0bfd9114186b65e9d6ab6b4c97552fa5)`(const FGuid & PlayerUuid) const`

Gets the team id of a player if they are part of the session.

Parameters

PlayerUuid The unique Id of the player to get.

Returns

The player’s team id if they exist in the session, otherwise INDEX_NONE.

#### `public inline FORCEINLINE bool `[`IsCreatedByMatchmaking`](#classURH__SessionView_1a64970cbfe9adb2a065749a4e48b349df)`() const`

Gets if the session was created through matchmaking.

#### `public inline FORCEINLINE int32 `[`GetSessionPlayerCount`](#classURH__SessionView_1aceaf6db4198c0defac9c87bbc32574fb)`() const`

Gets the number of players in the session.

#### `public inline virtual bool `[`IsOffline`](#classURH__SessionView_1a7b855a2b8ac702d05cf3efe3263519b2)`() const`

Gets if the session is offline.

#### `public inline FORCEINLINE bool `[`IsOnline`](#classURH__SessionView_1a165bf0e2a2f4a73041daa0ebbaf082c2)`() const`

Gets if the session is online.

#### `public inline virtual bool `[`IsJoined`](#classURH__SessionView_1ae77e9295b2e867940d1fe31abd88a347)`() const`

Gets if the session is a one the local player has joined.

#### `public inline bool `[`IsInQueue`](#classURH__SessionView_1a5a36dda3d9b0c6049a26ce951f586d9d)`() const`

Gets if the session is currently in matchmaking.

#### `public inline FORCEINLINE `[`FRHAPI_SessionTemplate`](models/RHAPI_SessionTemplate.md#structFRHAPI__SessionTemplate)` `[`GetTemplate`](#classURH__SessionView_1a293350d46d361b42df4e83c7a4f9bf9c)`() const`

Gets the session template.

#### `public inline FORCEINLINE FString `[`GetETag`](#classURH__SessionView_1abd96670c8e2f44b233af9322bd2a06fc)`() const`

Gets the session ETag.

#### `public inline FORCEINLINE FString `[`GetSessionId`](#classURH__SessionView_1a6aedf3a6656fcde76b8e18d0f2b297fe)`() const`

Gets the session Id.

#### `public inline FORCEINLINE FString `[`GetSessionType`](#classURH__SessionView_1a450529876e3c21928d4fbc9925d1bb68)`() const`

Gets the session type.

#### `public TMap< FString, FString > `[`GetCustomData`](#classURH__SessionView_1a4cea1471adcb445c7f71cb5d1ef0f86c)`() const`

Gets session custom data.

#### `public bool `[`GetCustomDataValue`](#classURH__SessionView_1a278a3291ea20e0ce736da8ea4db8e767)`(const FString & Key,FString & OutValue) const`

Gets a session custom data value.

Parameters

Key The custom data being requested.
Value The value of the custom data.

Returns

If true, the custom data was found.

#### `public TMap< FString, FString > `[`GetInstanceCustomData`](#classURH__SessionView_1a5b3e04566785eea12417d84737177555)`() const`

Gets intance custom data.

#### `public bool `[`GetInstanceCustomDataValue`](#classURH__SessionView_1a887bb0b311f4d9554e73419f9be81aad)`(const FString & Key,FString & OutValue) const`

Gets an instance custom data value.

Parameters

Key The custom data being requested.
Value The value of the custom data.

Returns

If true, the custom data was found.

#### `public TMap< FString, FString > `[`GetBrowserCustomData`](#classURH__SessionView_1a4691063225ba4ad458aa12a14020c7d7)`() const`

Gets session browser custom data.

#### `public bool `[`GetPlatformSession`](#classURH__SessionView_1aa477ffc8b54fb7d355664615900a6603)`(ERHAPI_Platform Platform,`[`FRHAPI_PlatformSession`](models/RHAPI_PlatformSession.md#structFRHAPI__PlatformSession)` & OutPlatformSession) const`

Get the platform session data for a specific platform id

Parameters

Platform The platform id to get the session data for
OutPlatformSession The platform session data for the specified platform id

Returns

If true, the platform session data was found

#### `public virtual void `[`ImportAPISession`](#classURH__SessionView_1a92790b540906943bf8501049b45222b3)`(const `[`FRH_APISessionWithETag`](Session.md#structTRH__DataWithETagWrapper)` & newSessionData,const `[`FRHAPI_SessionTemplate`](models/RHAPI_SessionTemplate.md#structFRHAPI__SessionTemplate)` & newTemplate)`

Update a session from the owner, implies a template update.

Parameters

newSessionData The new session data.
newTemplate The new session template.

#### `public virtual void `[`ImportTemplate`](#classURH__SessionView_1aa910b3892253ae47a3eedf5f91eae252)`(const `[`FRHAPI_SessionTemplate`](models/RHAPI_SessionTemplate.md#structFRHAPI__SessionTemplate)` & newTemplate)`

Update the session template .

Parameters

newTemplate The new session template.

#### `public virtual void `[`Expire`](#classURH__SessionView_1a81b861028c8b998005d3627752cce51f)`(const FRH_OnSessionExpiredDelegate & Delegate)`

Called when the session was removed from our session list. Cleans up state then trigger callback on owner.

Parameters

Delegate The delegate to call when the session is removed.

#### `public TScriptInterface< `[`IRH_SessionOwnerInterface`](Session.md#classIRH__SessionOwnerInterface)` > `[`GetSessionOwner`](#classURH__SessionView_1ab4c61212a9d10507d2aab3d645b4b985)`() const`

Gets the session owner.

#### `public void `[`StartPolling`](#classURH__SessionView_1a488f1c164e31d30c17d98f13226c6079)`()`

Starts the polling of session updates.

#### `public void `[`StopPolling`](#classURH__SessionView_1aa34ca34af04d8bcb3200d48395c242c2)`()`

Stops the polling for session updates.

#### `public void `[`DeferPolling`](#classURH__SessionView_1a09c8faf3934af2d317d955cbd5da5ed3)`()`

Defers the polling for session updates (in case an out-of-band update was received)

#### `public float `[`GetPollTimeRemaining`](#classURH__SessionView_1aa57cc3f86e075380283f9a7a22d07a06)`()`

Gets the current time remaining in the poll cycle in seconds. Returns -1.f if poll is inactive or is executing.

#### `public void `[`ForcePollForUpdate`](#classURH__SessionView_1a3dcdea9537922b7c533929b05dc5c885)`(bool bClearETag)`

Forces a polling call even if the polling is waiting till next time to pulse.

Parameters

bClearETag If true, the ETag will be cleared before the poll.

#### `public void `[`AddDeferredPoll`](#classURH__SessionView_1a7e207452f3a5b71dcf74642d7d15aa9e)`(const `[`FRH_DeferredSessionPoll`](Session.md#structFRH__DeferredSessionPoll)` & DeferredPoll)`

Add a deferred poll to the list of polls to run in sequence.

#### `public void `[`CheckDeferredPolls`](#classURH__SessionView_1aaf1a897f37236897e788f33d2c34304a)`()`

Check and potentially kick off a deferred poll.

#### `protected `[`FRH_APISessionWithETag`](Session.md#structTRH__DataWithETagWrapper)` `[`SessionData`](#classURH__SessionView_1a2323a589459ab11bb6ee7596d234d7df)

The Session Data with Etag.

#### `protected `[`FRHAPI_SessionTemplate`](models/RHAPI_SessionTemplate.md#structFRHAPI__SessionTemplate)` `[`Template`](#classURH__SessionView_1a4726a534a0d2c8f2de41f9ad5963d64f)

A reference copy of the Template (in case the template is deleted from the managed template list)

#### `protected FRH_AutoPollerPtr `[`Poller`](#classURH__SessionView_1aae3d3ebab134537e289fe4340777b47d)

Poller in charge of polling for the session.

#### `protected TArray< `[`FRH_DeferredSessionPoll`](Session.md#structFRH__DeferredSessionPoll)` > `[`DeferredPolls`](#classURH__SessionView_1a6519f00b229dbd0cad4be5907e937b15)

Array of stored poll requests that have not yet been processed.

#### `protected TArray< `[`FRH_DeferredSessionPoll`](Session.md#structFRH__DeferredSessionPoll)` > `[`WaitingPolls`](#classURH__SessionView_1ae0ea80e3394fe77f996d00bc692169c6)

Array of stored poll requests that are waiting on the result of the current poll.

#### `protected void `[`PollForUpdate`](#classURH__SessionView_1a4ccf0aaf6734e2e5638ab257c1451480)`(const FRH_PollCompleteFunc & Delegate)`

Triggers a poll for a session update, automatically called as part of the polling loop.

Parameters

Delegate Callback delegate for when the poll completes.

## class `URH_InvitedSession`

class URH_InvitedSession
  : public URH_SessionView

Invited Sessions are sessions that the player has been invited to.

Summary

Members	Descriptions
`public inline virtual bool` `IsOffline() const`	Gets that an invited session is not an offline session.
`public virtual void` `Join(const FRH_OnSessionUpdatedDelegateBlock & Delegate)`	Accepts to join the session.
`public inline void` `BLUEPRINT_Join(const FRH_OnSessionUpdatedDynamicDelegate & Delegate)`	Blueprint compatible version of Join.
`public virtual void` `Leave(const FRH_OnSessionUpdatedDelegateBlock & Delegate)`	Declines to join the session.
`public inline void` `BLUEPRINT_Leave(const FRH_OnSessionUpdatedDynamicDelegate & Delegate)`	Blueprint compatible version of Leave.
`public virtual void` `QueryInviterBlockedOnPlatformAsync(const FRH_OnSessionPlayerIsBlockedDelegateBlock & Delegate)`	Determines if the Inviter of this session is blocked by the player on their current platform.
`public inline void` `BLUEPRINT_QueryInviterBlockedOnPlatformAsync(const FRH_OnSessionPlayerIsBlockedDynamicDelegate & Delegate)`	Blueprint compatible version of QueryInviterBlockedOnPlatformAsync.

Members

`public inline virtual bool` `IsOffline() const`

Gets that an invited session is not an offline session.

#### `public virtual void `[`Join`](#classURH__InvitedSession_1a533ddfa3135881b4b4ed6b7f57cb809e)`(const FRH_OnSessionUpdatedDelegateBlock & Delegate)`

Accepts to join the session.

Parameters

Delegate The callback delegate for the session being updated by the join.

#### `public inline void `[`BLUEPRINT_Join`](#classURH__InvitedSession_1ae695534cc3653e4cf7374b54a030133b)`(const FRH_OnSessionUpdatedDynamicDelegate & Delegate)`

Blueprint compatible version of Join.

Parameters

Delegate The callback delegate for the session being updated by the join.

#### `public virtual void `[`Leave`](#classURH__InvitedSession_1ac9e1131d672b7e6f7dd4a476d54e80aa)`(const FRH_OnSessionUpdatedDelegateBlock & Delegate)`

Declines to join the session.

Parameters

Delegate The callback delegate for the session being updated by the leave.

#### `public inline void `[`BLUEPRINT_Leave`](#classURH__InvitedSession_1a5710f9c6987179ca0489029cb3bced79)`(const FRH_OnSessionUpdatedDynamicDelegate & Delegate)`

Blueprint compatible version of Leave.

Parameters

Delegate The callback delegate for the session being updated by the leave.

#### `public virtual void `[`QueryInviterBlockedOnPlatformAsync`](#classURH__InvitedSession_1a3caca59784784c406ee3df3a800492e6)`(const FRH_OnSessionPlayerIsBlockedDelegateBlock & Delegate)`

Determines if the Inviter of this session is blocked by the player on their current platform.

Parameters

Delegate The callback delegate for the results of querying if the inviter is blocked on the current platform

#### `public inline void `[`BLUEPRINT_QueryInviterBlockedOnPlatformAsync`](#classURH__InvitedSession_1a44a414d25a7a6581a2de28c861ffa0d7)`(const FRH_OnSessionPlayerIsBlockedDynamicDelegate & Delegate)`

Blueprint compatible version of QueryInviterBlockedOnPlatformAsync.

Parameters

Delegate The callback delegate for the results of querying if the inviter is blocked on the current platform

## class `URH_OfflineSession`

class URH_OfflineSession
  : public URH_JoinedSession

Offline Sessions are sessions the session owner is actively a member of that are unsynchronized with the API. This is primarily intended as a utility class to allow for the session flow to be used globally, even when not running API based sessions (ex: tutorial / practice area before login).

Summary

Members	Descriptions
`public inline virtual bool` `IsOffline() const`	Gets that the session is offline.
`public virtual void` `InvitePlayer(const FGuid & PlayerUuid,int32 Team,const TMap< FString, FString > & CustomData,const FRH_OnSessionUpdatedDelegateBlock & Delegate)`	Currently not supported for offline sessions.
`public virtual void` `KickPlayer(const FGuid & PlayerUuid,const FRH_OnSessionUpdatedDelegateBlock & Delegate)`	Currently not supported for offline sessions.
`public virtual void` `InviteOtherSession(const FString & InvitedSessionId,const` `FRHAPI_SessionInviteRequest` `& SessionInviteRequest,const FRH_OnSessionUpdatedDelegateBlock & Delegate)`	Currently not supported for offline sessions.
`public virtual void` `KickOtherSession(const FString & KickedSessionId,const FRH_OnSessionUpdatedDelegateBlock & Delegate)`	Currently not supported for offline sessions.
`public virtual void` `SetLeader(const FGuid & PlayerUuid,const FRH_OnSessionUpdatedDelegateBlock & Delegate)`	Currently not supported for offline sessions.
`public virtual void` `ChangePlayerTeam(const FGuid & PlayerUuid,int32 Team,const FRH_OnSessionUpdatedDelegateBlock & Delegate)`	Changes the team a given player is associated with in the session.
`public virtual void` `UpdatePlayerCustomData(const FGuid & PlayerUuid,const TMap< FString, FString > & CustomData,const FRH_OnSessionUpdatedDelegateBlock & Delegate)`	Currently not supported for offline sessions.
`public virtual void` `Leave(bool bFromOSSSession,const FRH_OnSessionUpdatedDelegateBlock & Delegate)`	Leaves the session.
`public virtual void` `RequestInstance(const` `FRHAPI_InstanceRequest` `& InstanceRequest,const FRH_OnSessionUpdatedDelegateBlock & Delegate)`	Attempt to create a new instance for the session.
`public virtual void` `EndInstance(const FRH_OnSessionUpdatedDelegateBlock & Delegate)`	Shutdown the existing instance for the session.
`public virtual void` `GenerateVoipLoginToken(const FRH_OnSessionGetVoipTokenDelegateBlock & Delegate)`	Generate a VOIP login token.
`public virtual void` `GenerateVoipActionToken(ERHAPI_VivoxSessionActionSingle VivoxAction,ERHAPI_VoipSessionType VoipSessionType,const FRH_OnSessionGetVoipTokenDelegateBlock & Delegate)`	Generate a VOIP action token.
`public virtual void` `UpdateSessionInfo(const` `FRHAPI_SessionUpdate` `& Update,const FRH_OnSessionUpdatedDelegateBlock & Delegate)`	Updates the session info.
`public virtual void` `UpdateInstanceInfo(const` `FRHAPI_InstanceInfoUpdate` `& Update,const FRH_OnSessionUpdatedDelegateBlock & Delegate)`	Updates the sessions instance info.
`public virtual void` `UpdateBrowserInfo(bool bEnable,const TMap< FString, FString > & CustomData,const FRH_OnSessionUpdatedDelegateBlock & Delegate)`	Updates the sessions browser info.
`public virtual void` `UpdateInstanceHealth(ERHAPI_InstanceHealthStatus HealthStatus,const FRH_GenericSuccessWithErrorBlock & Delegate)`	Update the instance health of the session.
`public virtual void` `AcknowledgeBackfill(bool bEnable,const FRH_OnSessionUpdatedDelegateBlock & Delegate)`	Acknowledge backfill for the session, keeping it alive and processing updates.
`public virtual void` `DeleteBackfill(const FRH_OnSessionUpdatedDelegateBlock & Delegate)`	Delete active backfill request for the session.
`public virtual void` `EmitAuditEvent(const` `FRHAPI_CreateAuditRequest` `& AuditEvent,const FRH_GenericSuccessWithErrorBlock & Delegate) const`	Emit an event to the session audit log.
`protected void` `ImportSessionUpdateToAllPlayers(const` `FRH_APISessionWithETag` `& Update)`

Members

`public inline virtual bool` `IsOffline() const`

Gets that the session is offline.

#### `public virtual void `[`InvitePlayer`](#classURH__OfflineSession_1af16376f4dc510808b79aa74cf2ea461d)`(const FGuid & PlayerUuid,int32 Team,const TMap< FString, FString > & CustomData,const FRH_OnSessionUpdatedDelegateBlock & Delegate)`