IntegrationSettings

Summary

Members	Descriptions
class URH_IntegrationSettings	Main settings for the Integration.
struct FRH_EnvironmentConfiguration	Settings for Environment Configuration. If set, these override the defaults when the EnvironmentId matches the specified environment id.

class URH_IntegrationSettings

class URH_IntegrationSettings
  : public UDeveloperSettings

Main settings for the Integration.

Summary

Members	Descriptions
public FRH_EnvironmentConfiguration DefaultEnvironmentConfiguration	RallyHere default environment configuration.
public TArray< FRH_EnvironmentConfiguration>EnvironmentConfigurations	Per-Environment configuration overrides. These environments are alias names used for a BaseURL, and by default will automatically be looked up based on the OnlineEnvironment from the engine (Development, Certification, etc), but can be overridden via commandline (see EnvironmentCommandLineKeys)
public TArray< FString > BaseURLCommandLineKeysInternal	Internal/Hardcoded Keys to check for on the command line for an override to the default BaseURL. These are potentially used by RallyHere’s automation and internal processes.
public TArray< FString > BaseURLCommandLineKeys	Keys to check for on the command line for an override to the default BaseURL.
public TArray< FString > EnvironmentCommandLineKeysInternal	Internal/Hardcoded Keys to check for on the command line for an override to the default Environment. These are potentially used by RallyHere’s automation and internal processes.
public TArray< FString > EnvironmentCommandLineKeys	Keys to check for on the command line for an override to the default Environment when using EnvironmentConfigurations.
public TArray< FString > DefaultOSSCommandLineKeysInternal	Internal/Hardcoded Keys to check for on the command line for an override to the default OSS. These are potentially used by RallyHere’s automation and internal processes.
public TArray< FString > DefaultOSSCommandLineKeys	Keys to check for on the command line for an override to the default OSS.
public TArray< FString > ClientIdCommandLineKeysInternal	Internal/Hardcoded Keys to check for on the command line for an override to the default ClientId. These are potentially used by RallyHere’s automation and internal processes.
public TArray< FString > ClientIdCommandLineKeys	Keys to check for on the command line for an override to the default ClientId.
public TArray< FString > ClientSecretCommandLineKeysInternal	Internal/Hardcoded Keys to check for on the command line for an override to the default ClientSecret. These are potentially used by RallyHere’s automation and internal processes.
public TArray< FString > ClientSecretCommandLineKeys	Keys to check for on the command line for an override to the default ClientSecret.
public FName EnvironmentOSSName	Online Subsystem to use for selecting the base URL environment. If not provided, will use the default OSS.
public bool bAutomaticallyPollConfigurationData	If set, automatically poll for KV data.
public bool bAutomaticallyApplyHotfixData	If set, automatically apply hotfix data from the config subystem.
public bool bHotfixTestValue	debug value to test if the hotfix system is working properly. Do not set!
public bool bAutoStartSessionsAfterJoin	Whether to automatically start platform sessions after joining them.
public bool bAutoJoinPlatformSessionsAfterUserChange	Whether to automatically join platform sessions after a user change when invites were received while logged out.
public bool bAutoMakeSessionsJoinableOnHostMapLoadComplete	Whether to automatically mark hosted sessions as joinable after map load completes.
public bool bUseSecurityTokenForJoining	If set, the connection attempt must have a valid security token to be allowed to connect.
public bool bRequireImportedPlayerIdsForJoining	If set, the Player Id must have been imported to the instance before being allowed to connect.
public bool bRequireValidPlayerIdsForJoining	If set, the Player Id must be valid before being allowed to connect.
public bool bAutoWatchPlayersOnSessionActive	If set, automatically call SetWatchingPlayers() on the session when it is set as the active gameplay session, to enable presence polling for the session.
public int32 PlayerMatchesPageSize	Sets the default page size when requesting a player’s match history.
public int32 PlayerMatchesMaxPageCount	Sets the default page size when requesting a player’s match history.
public FTimespan PlayerMatchesMaxAge	Sets the default page size when requesting a player’s match history.
public bool bAutoCreateMatches	Whether to automatically create a match when a session becomes active if the host.
public bool bAutoAddConnectedPlayersToMatches	Whether to automatically add players who connect to the match.
public bool bAutoCloseMatchOnSessionInactive	Whether to automatically close a match when a session becomes inactive if the host.
public bool bAutoCreateInventorySessionOnLogin	Whether to automatically create an inventory session when a player logs in.
public bool bAutoProcessPlatformEntitlementsOnLogin	Whether to automatically process platform entitlements on login (will wait for inventory session creation if using bAutoCreateInventorySessionOnLogin)
public int32 WebRequestsMaxSimultaneousRequests	Sets the maximum number of Http Requests that can be made simultaneously. 0 = No Limit.
public int32 WebRequestsDefaultRetryCount	Sets the number of retries that the retry manager uses. 0 = Do not set a limit.
public int32 WebRequestsDefaultRetryTimeout	Sets the maximum number of Http Requests that can be made simultaneously. 0 = Do not set a limit.
public int WebRequestsTrackedRequestsCountLimit	Sets the maximum number of web requests for which tracking data is kept.
public int32 WebRequestsBurstCountThreshold	Sets the count above which web traffic is considered a burst.
public int32 WebRequestsBurstTimeThresholdInSeconds	Sets the time threshold for web traffic burst detection.
public FString ClientDeviceIpEndpoint	Sets an endpoint to use to determine public IP of a client for analytics.
public FSoftClassPath LocalPlayerLoginSubsystemClass	Extensible LocalPlayerLoginSubsystem class path.
public FSoftClassPath AdSubsystemClass	Extensible AdSubsystem class path.
public FSoftClassPath FriendSubsystemClass	Extensible FriendSubsystem class path.
public FSoftClassPath LocalPlayerSessionSubsystemClass	Extensible LocalPlayerSessionSubsystem class path.
public FSoftClassPath SessionPlatformSyncerClass	Extensible PlayerSessionSyncer class path.
public FSoftClassPath LocalPlayerPresenceSubsystemClass	Extensible LocalPlayerPresenceSubsystem class path.
public FSoftClassPath PurgeSubsystemClass	Extensible PurgeSubsystem class path.
public FSoftClassPath EntitlementSubsystemClass	Extensible EntitlementSubsystem class path.
public FSoftClassPath GameInstanceSessionInfoSubsystemClass	Extensible GameInstanceSessionInfoSubsystem class path.
public FSoftClassPath GameInstanceServerBootstrapperClass	Extensible GameInstanceServerBootstrapper class path.
public FSoftClassPath GameInstanceClientBootstrapperClass	Extensible GameInstanceClientBootstrapper class path.
public FSoftClassPath PlayerInfoSubsystemClass	Extensible PlayerInfoSubsystem class path.
public FSoftClassPath PlayerInfoClass	Extensible PlayerInfo class path.
public FSoftClassPath CatalogSubsystemClass	Extensible CatalogSubsystem class path.
public FSoftClassPath ConfigSubsystemClass	Extensible ConfigSubsystem class path.
public FSoftClassPath SettingsSubsystemClass	Extensible ConfigSubsystem class path.
public FSoftClassPath SessionBrowserCacheClass	Extensible SessionBrowserCache class path.
public FSoftClassPath MatchmakingBrowserCacheClass	Extensible MatchmakingBrowserCache class path.
public FSoftClassPath MatchSubsystemClass	Extensible MatchSubsystem class path.
public FSoftClassPath RemoteFileSubsystemClass	Extensible RemoteFileSubsystem class path.
public bool bLocalPlayerSubsystemSandboxing	Flag to determine if the local player subsystem should use its own subsystems instead of relying on GameInstanceSubsystem shared caches.
public bool bAutoUploadServerFiles	Whether to automatically upload files to the RallyHere API from Dedicated Servers.
public bool bAutoUploadLogFiles	Whether to automatically upload files to the RallyHere API. Requires bAutoUploadServerFiles to have an effect.
public bool bAutoUploadTraceFiles	Whether to automatically upload files to the RallyHere API. Requires bAutoUploadServerFiles to have an effect.
public int32 BeginNewAdSessionPriority	Sets the request priority of Begin New Session calls, lower number is higher priority.
public int32 FindAdOppertunitiesPriority	Sets the request priority of Find Oppertunities calls, lower number is higher priority.
public int32 UpdateAdOppertunitiesPriority	Sets the request priority of Update Oppertunities calls, lower number is higher priority.
public int32 AuthLogoutPriority	Sets the request priority of Logouts calls, lower number is higher priority.
public int32 AuthLoginPriority	Sets the request priority of Login calls, lower number is higher priority.
public int32 GetCatalogAllPriority	Sets the request priority of Get Catalog All calls, lower number is higher priority.
public int32 GetCatalogXpAllPriority	Sets the request priority of Get Catalog Xp All calls, lower number is higher priority.
public int32 GetCatalogItemPriority	Sets the request priority of Get Catalog Item calls, lower number is higher priority.
public int32 GetCatalogInventoryBucketUseRuleSetsAllPriority	Sets the request priority of Get Catalog Inventory Bucket Use Rulesets All calls, lower number is higher priority.
public int32 GetCatalogPricePointsAllPriority	Sets the request priority of Get Catalog Price Points All calls, lower number is higher priority.
public int32 GetCatalogTimeFramesAllPriority	Sets the request priority of Get Catalog Time Frame All calls, lower number is higher priority.
public int32 GetCatalogVendorPriority	Sets the request priority of Get Catalog Vendor calls, lower number is higher priority.
public int32 GetCatalogVendorsAllPriority	Sets the request priority of Get Catalog Vendor All calls, lower number is higher priority.
public int32 FetchAppSettingsPriority	Sets the request priority of Fetch App Settings calls, lower number is higher priority.
public int32 ProcessPlatformEntitlementsPriority	Sets the request priority of Process Platform Entitlements calls, lower number is higher priority.
public int32 RetrievePlatformEntitlementsPriority	Sets the request priority of Retrieve Platform Entitlements calls, lower number is higher priority.
public int32 FetchFriendListPriority	Sets the request priority of Fetch Friend List calls, lower number is higher priority.
public int32 FetchFriendPriority	Sets the request priority of Fetch Friend calls, lower number is higher priority.
public int32 AddFriendPriority	Sets the request priority of Add Friend calls, lower number is higher priority.
public int32 RemoveFriendPriority	Sets the request priority of Remove Friend calls, lower number is higher priority.
public int32 AddFriendNotesPriority	Sets the request priority of Add Friend Notes calls, lower number is higher priority.
public int32 DeleteFriendNotesPriority	Sets the request priority of Delete Friend Notes calls, lower number is higher priority.
public int32 FetchBlockedListPriority	Sets the request priority of Fetch Blocked List calls, lower number is higher priority.
public int32 FetchBlockedPlayerPriority	Sets the request priority of Fetch Blocked Player calls, lower number is higher priority.
public int32 BlockUnblockPlayerPriority	Sets the request priority of Block/Unblock Player calls, lower number is higher priority.
public int32 InventoryCreateSessionPriority	Sets the request priority of Create Inventory Session calls, lower number is higher priority.
public int32 InventoryGetSessionPriority	Sets the request priority of Get Inventory Session calls, lower number is higher priority.
public int32 InventoryGetPriority	Sets the request priority of Get Inventory calls, lower number is higher priority.
public int32 InventoryCreatePriority	Sets the request priority of Create Inventory calls, lower number is higher priority.
public int32 InventoryUpdatePriority	Sets the request priority of Update Inventory calls, lower number is higher priority.
public int32 InventoryCreateOrderPriority	Sets the request priority of Create Inventory Order calls, lower number is higher priority.
public int32 InventoryGetOrdersPriority	Sets the request priority of Get Inventory Orders calls, lower number is higher priority.
public int32 NotificationPollSelfPriority	Sets the request priority of Polling Notifications for Self calls, lower number is higher priority.
public int32 NotificationPollOtherPriority	Sets the request priority of Polling Notifications for Others calls, lower number is higher priority.
public int32 NotificationCreatePriority	Sets the request priority of Create Notifications calls, lower number is higher priority.
public int32 PresenceUpdatePriority	Sets the request priority of Updating Presence calls, lower number is higher priority.
public int32 PresenceGetSelfPriority	Sets the request priority of Get Self Presence calls, lower number is higher priority.
public int32 PresenceGetOtherPriority	Sets the request priority of Get Other Presence calls, lower number is higher priority.
public int32 PresenceGetSettingsPriority	Sets the request priority of Get Presence Settings calls, lower number is higher priority.
public int32 PurgeQueuePriority	Sets the request priority of Queue/Dequeue for Purge calls, lower number is higher priority.
public int32 PurgeGetStatusPriority	Sets the request priority of Get Purge Status calls, lower number is higher priority.
public int32 GetAllQueueInfoPriority	Sets the request priority of Get Queue Info calls, lower number is higher priority.
public int32 GetMatchmakingTemplatePriority	Sets the request priority of Get Matchmaking Template calls, lower number is higher priority.
public int32 GetMapGameInfoPriority	Sets the request priority of Get Map Game Info calls, lower number is higher priority.
public int32 RankingGetPriority	Sets the request priority of Get Rank calls, lower number is higher priority.
public int32 RankingUpdatePriority	Sets the request priority of Update Rank calls, lower number is higher priority.
public int32 SessionPollPriority	Sets the request priority of Session Polling calls, lower number is higher priority.
public int32 SessionJoinPriority	Sets the request priority of Session Joining calls, lower number is higher priority.
public int32 SessionLeavePriority	Sets the request priority of Session Leave calls, lower number is higher priority.
public int32 SessionInvitePriority	Sets the request priority of Session Invite calls, lower number is higher priority.
public int32 SessionKickPriority	Sets the request priority of Session Kick calls, lower number is higher priority.
public int32 SessionLeaderChangePriority	Sets the request priority of Session Leader Change calls, lower number is higher priority.
public int32 SessionChangeTeamsPriority	Sets the request priority of Session Change Teams calls, lower number is higher priority.
public int32 SessionLeaveQueuePriority	Sets the request priority of Session Leave Queue calls, lower number is higher priority.
public int32 SessionRequestInstancePriority	Sets the request priority of Session Request Instance calls, lower number is higher priority.
public int32 SessionEndInstancePriority	Sets the request priority of Session End Instance calls, lower number is higher priority.
public int32 SessionStartMatchPriority	Sets the request priority of Session Start Match calls, lower number is higher priority.
public int32 SessionEndMatchPriority	Sets the request priority of Session End Match calls, lower number is higher priority.
public int32 SessionUpdateSessionInfoPriority	Sets the request priority of Update Session Info calls, lower number is higher priority.
public int32 SessionUpdateInstanceInfoPriority	Sets the request priority of Update Instance Info calls, lower number is higher priority.
public int32 SessionUpdateBrowserInfoPriority	Sets the request priority of Update Browser Info calls, lower number is higher priority.
public int32 SessionDeleteBrowserInfoPriority	Sets the request priority of Delete Browser Info calls, lower number is higher priority.
public int32 SessionInstanceHealthUpdatePriority	Sets the request priority of Instance Health update calls, lower number is higher priority.
public int32 SessionBackfillUpdatePriority	Sets the request priority of Backfill update calls, lower number is higher priority.
public int32 SessionUpdateWithPlatformSessionPriority	Sets the request priority of Session Update With Platform Session calls, lower number is higher priority.
public int32 SessionGetTemplatePriority	Sets the request priority of Session Get Template calls, lower number is higher priority.
public int32 SessionGetByAllocationIdPriority	Sets the request priority of Session By Allocation Id calls, lower number is higher priority.
public int32 SessionGetBySessionIdPriority	Sets the request priority of Session By Session Id calls, lower number is higher priority.
public int32 SessionGetByTypePriority	Sets the request priority of Session By Type calls, lower number is higher priority.
public int32 SessionsGetOtherPriority	Sets the request priority of Get Other Sessions calls, lower number is higher priority.
public int32 SessionVoipLoginTokenPriority	Sets the request priority of VOIP Login calls, lower number is higher priority.
public int32 SessionVoipActionTokenPriority	Sets the request priority of VOIP Action calls, lower number is higher priority.
public int32 SettingsGetPriority	Sets the request priority of Get Settings calls, lower number is higher priority.
public int32 SettingsGetTypesPriority	Sets the request priority of Get Settings Types calls, lower number is higher priority.
public int32 SettingsUpdatePriority	Sets the request priority of Update Settings calls, lower number is higher priority.
public int32 GetRegionsPriority	Sets the request priority of Get Site Settings calls, lower number is higher priority.
public int32 SessionAuditPriority	Sets the request priority of Session Audit calls, lower number is higher priority.
public int32 UsersLookupPlayerPriority	Sets the request priority of Lookup Users calls, lower number is higher priority.
public int32 UsersGetLinkedPlatformsPriority	Sets the request priority of Get Linked Platforms calls, lower number is higher priority.
public int32 EventsReceiveEventPriority	Sets the request priority of ReceiveEvent, which is the GETS endpoint, lower number is higher priority.
public int32 MatchesGetOtherPriority	Sets the request priority of Get Player Matches calls, lower number is higher priority.
public int32 MatchesSearchPriority	Sets the request priority of Get Player Matches calls, lower number is higher priority.
public int32 MatchesLookupPriority	Sets the request priority of Get Player Matches calls, lower number is higher priority.
public int32 MatchesUpdatePriority	Sets the request priority of Create and Update Match calls, lower number is higher priority.
public int32 MatchesUpdatePlayerPriority	Sets the request priority of Create Match calls, lower number is higher priority.
public int32 GetPlayerReportsSentPriority	Sets the request priority of Player Report calls, lower number is higher priority.
public int32 GetPlayerReportsReceivedPriority	Sets the request priority of Player Report calls, lower number is higher priority.
public int32 CreatePlayerReportPriority	Sets the request priority of Player Report calls, lower number is higher priority.
public int32 FileUploadPriority	Sets the request priority of File Upload calls, lower number is higher priority.
public int32 FileDownloadPriority	Sets the request priority of File Download calls, lower number is higher priority.
public int32 FileBrowsePriority	Sets the request priority of File Browse calls, lower number is higher priority.
public int32 FileDeletePriority	Sets the request priority of File Delete calls, lower number is higher priority.
public const FRH_EnvironmentConfiguration*GetEnvironmentConfiguration(const FString & EnvironmentId) const	Helper to get the configuration for a given environment by EnvironmentId.

Members

public FRH_EnvironmentConfiguration DefaultEnvironmentConfiguration

RallyHere default environment configuration.

public TArray< FRH_EnvironmentConfiguration>EnvironmentConfigurations

Per-Environment configuration overrides. These environments are alias names used for a BaseURL, and by default will automatically be looked up based on the OnlineEnvironment from the engine (Development, Certification, etc), but can be overridden via commandline (see EnvironmentCommandLineKeys)

public TArray< FString > BaseURLCommandLineKeysInternal

Internal/Hardcoded Keys to check for on the command line for an override to the default BaseURL. These are potentially used by RallyHere’s automation and internal processes.

public TArray< FString > BaseURLCommandLineKeys

Keys to check for on the command line for an override to the default BaseURL.

public TArray< FString > EnvironmentCommandLineKeysInternal

Internal/Hardcoded Keys to check for on the command line for an override to the default Environment. These are potentially used by RallyHere’s automation and internal processes.

public TArray< FString > EnvironmentCommandLineKeys

Keys to check for on the command line for an override to the default Environment when using EnvironmentConfigurations.

public TArray< FString > DefaultOSSCommandLineKeysInternal

Internal/Hardcoded Keys to check for on the command line for an override to the default OSS. These are potentially used by RallyHere’s automation and internal processes.

public TArray< FString > DefaultOSSCommandLineKeys

Keys to check for on the command line for an override to the default OSS.

public TArray< FString > ClientIdCommandLineKeysInternal

Internal/Hardcoded Keys to check for on the command line for an override to the default ClientId. These are potentially used by RallyHere’s automation and internal processes.

public TArray< FString > ClientIdCommandLineKeys

Keys to check for on the command line for an override to the default ClientId.

public TArray< FString > ClientSecretCommandLineKeysInternal

Internal/Hardcoded Keys to check for on the command line for an override to the default ClientSecret. These are potentially used by RallyHere’s automation and internal processes.

public TArray< FString > ClientSecretCommandLineKeys

Keys to check for on the command line for an override to the default ClientSecret.

public FName EnvironmentOSSName

Online Subsystem to use for selecting the base URL environment. If not provided, will use the default OSS.

public bool bAutomaticallyPollConfigurationData

If set, automatically poll for KV data.

public bool bAutomaticallyApplyHotfixData

If set, automatically apply hotfix data from the config subystem.

public bool bHotfixTestValue

debug value to test if the hotfix system is working properly. Do not set!

public bool bAutoStartSessionsAfterJoin

Whether to automatically start platform sessions after joining them.

public bool bAutoJoinPlatformSessionsAfterUserChange

Whether to automatically join platform sessions after a user change when invites were received while logged out.

public bool bAutoMakeSessionsJoinableOnHostMapLoadComplete

Whether to automatically mark hosted sessions as joinable after map load completes.

public bool bUseSecurityTokenForJoining

If set, the connection attempt must have a valid security token to be allowed to connect.

public bool bRequireImportedPlayerIdsForJoining

If set, the Player Id must have been imported to the instance before being allowed to connect.

public bool bRequireValidPlayerIdsForJoining

If set, the Player Id must be valid before being allowed to connect.

public bool bAutoWatchPlayersOnSessionActive

If set, automatically call SetWatchingPlayers() on the session when it is set as the active gameplay session, to enable presence polling for the session.

public int32 PlayerMatchesPageSize

Sets the default page size when requesting a player’s match history.

public int32 PlayerMatchesMaxPageCount

Sets the default page size when requesting a player’s match history.

public FTimespan PlayerMatchesMaxAge

Sets the default page size when requesting a player’s match history.

public bool bAutoCreateMatches

Whether to automatically create a match when a session becomes active if the host.

public bool bAutoAddConnectedPlayersToMatches

Whether to automatically add players who connect to the match.

public bool bAutoCloseMatchOnSessionInactive

Whether to automatically close a match when a session becomes inactive if the host.

public bool bAutoCreateInventorySessionOnLogin

Whether to automatically create an inventory session when a player logs in.

public bool bAutoProcessPlatformEntitlementsOnLogin

Whether to automatically process platform entitlements on login (will wait for inventory session creation if using bAutoCreateInventorySessionOnLogin)

public int32 WebRequestsMaxSimultaneousRequests

Sets the maximum number of Http Requests that can be made simultaneously. 0 = No Limit.

public int32 WebRequestsDefaultRetryCount

Sets the number of retries that the retry manager uses. 0 = Do not set a limit.

public int32 WebRequestsDefaultRetryTimeout

Sets the maximum number of Http Requests that can be made simultaneously. 0 = Do not set a limit.

public int WebRequestsTrackedRequestsCountLimit

Sets the maximum number of web requests for which tracking data is kept.

public int32 WebRequestsBurstCountThreshold

Sets the count above which web traffic is considered a burst.

public int32 WebRequestsBurstTimeThresholdInSeconds

Sets the time threshold for web traffic burst detection.

public FString ClientDeviceIpEndpoint

Sets an endpoint to use to determine public IP of a client for analytics.

public FSoftClassPath LocalPlayerLoginSubsystemClass

Extensible LocalPlayerLoginSubsystem class path.

public FSoftClassPath AdSubsystemClass

Extensible AdSubsystem class path.

public FSoftClassPath FriendSubsystemClass

Extensible FriendSubsystem class path.

public FSoftClassPath LocalPlayerSessionSubsystemClass

Extensible LocalPlayerSessionSubsystem class path.

public FSoftClassPath SessionPlatformSyncerClass

Extensible PlayerSessionSyncer class path.

public FSoftClassPath LocalPlayerPresenceSubsystemClass

Extensible LocalPlayerPresenceSubsystem class path.

public FSoftClassPath PurgeSubsystemClass

Extensible PurgeSubsystem class path.

public FSoftClassPath EntitlementSubsystemClass

Extensible EntitlementSubsystem class path.

public FSoftClassPath GameInstanceSessionInfoSubsystemClass

Extensible GameInstanceSessionInfoSubsystem class path.

public FSoftClassPath GameInstanceServerBootstrapperClass

Extensible GameInstanceServerBootstrapper class path.

public FSoftClassPath GameInstanceClientBootstrapperClass

Extensible GameInstanceClientBootstrapper class path.

public FSoftClassPath PlayerInfoSubsystemClass

Extensible PlayerInfoSubsystem class path.

public FSoftClassPath PlayerInfoClass

Extensible PlayerInfo class path.

public FSoftClassPath CatalogSubsystemClass

Extensible CatalogSubsystem class path.

public FSoftClassPath ConfigSubsystemClass

Extensible ConfigSubsystem class path.

public FSoftClassPath SettingsSubsystemClass

Extensible ConfigSubsystem class path.

public FSoftClassPath SessionBrowserCacheClass

Extensible SessionBrowserCache class path.

public FSoftClassPath MatchmakingBrowserCacheClass

Extensible MatchmakingBrowserCache class path.

public FSoftClassPath MatchSubsystemClass

Extensible MatchSubsystem class path.

public FSoftClassPath RemoteFileSubsystemClass

Extensible RemoteFileSubsystem class path.

public bool bLocalPlayerSubsystemSandboxing

Flag to determine if the local player subsystem should use its own subsystems instead of relying on GameInstanceSubsystem shared caches.

public bool bAutoUploadServerFiles

Whether to automatically upload files to the RallyHere API from Dedicated Servers.

public bool bAutoUploadLogFiles

Whether to automatically upload files to the RallyHere API. Requires bAutoUploadServerFiles to have an effect.

public bool bAutoUploadTraceFiles

Whether to automatically upload files to the RallyHere API. Requires bAutoUploadServerFiles to have an effect.

public int32 BeginNewAdSessionPriority

Sets the request priority of Begin New Session calls, lower number is higher priority.

public int32 FindAdOppertunitiesPriority

Sets the request priority of Find Oppertunities calls, lower number is higher priority.

public int32 UpdateAdOppertunitiesPriority

Sets the request priority of Update Oppertunities calls, lower number is higher priority.

public int32 AuthLogoutPriority

Sets the request priority of Logouts calls, lower number is higher priority.

public int32 AuthLoginPriority

Sets the request priority of Login calls, lower number is higher priority.

public int32 GetCatalogAllPriority

Sets the request priority of Get Catalog All calls, lower number is higher priority.

public int32 GetCatalogXpAllPriority

Sets the request priority of Get Catalog Xp All calls, lower number is higher priority.

public int32 GetCatalogItemPriority

Sets the request priority of Get Catalog Item calls, lower number is higher priority.

public int32 GetCatalogInventoryBucketUseRuleSetsAllPriority

Sets the request priority of Get Catalog Inventory Bucket Use Rulesets All calls, lower number is higher priority.

public int32 GetCatalogPricePointsAllPriority

Sets the request priority of Get Catalog Price Points All calls, lower number is higher priority.

public int32 GetCatalogTimeFramesAllPriority

Sets the request priority of Get Catalog Time Frame All calls, lower number is higher priority.

public int32 GetCatalogVendorPriority

Sets the request priority of Get Catalog Vendor calls, lower number is higher priority.

public int32 GetCatalogVendorsAllPriority

Sets the request priority of Get Catalog Vendor All calls, lower number is higher priority.

public int32 FetchAppSettingsPriority

Sets the request priority of Fetch App Settings calls, lower number is higher priority.

public int32 ProcessPlatformEntitlementsPriority

Sets the request priority of Process Platform Entitlements calls, lower number is higher priority.

public int32 RetrievePlatformEntitlementsPriority

Sets the request priority of Retrieve Platform Entitlements calls, lower number is higher priority.

public int32 FetchFriendListPriority

Sets the request priority of Fetch Friend List calls, lower number is higher priority.

public int32 FetchFriendPriority

Sets the request priority of Fetch Friend calls, lower number is higher priority.

public int32 AddFriendPriority

Sets the request priority of Add Friend calls, lower number is higher priority.

public int32 RemoveFriendPriority

Sets the request priority of Remove Friend calls, lower number is higher priority.

public int32 AddFriendNotesPriority

Sets the request priority of Add Friend Notes calls, lower number is higher priority.

public int32 DeleteFriendNotesPriority

Sets the request priority of Delete Friend Notes calls, lower number is higher priority.

public int32 FetchBlockedListPriority

Sets the request priority of Fetch Blocked List calls, lower number is higher priority.

public int32 FetchBlockedPlayerPriority

Sets the request priority of Fetch Blocked Player calls, lower number is higher priority.

public int32 BlockUnblockPlayerPriority

Sets the request priority of Block/Unblock Player calls, lower number is higher priority.

public int32 InventoryCreateSessionPriority

Sets the request priority of Create Inventory Session calls, lower number is higher priority.

public int32 InventoryGetSessionPriority

Sets the request priority of Get Inventory Session calls, lower number is higher priority.

public int32 InventoryGetPriority

Sets the request priority of Get Inventory calls, lower number is higher priority.

public int32 InventoryCreatePriority

Sets the request priority of Create Inventory calls, lower number is higher priority.

public int32 InventoryUpdatePriority

Sets the request priority of Update Inventory calls, lower number is higher priority.

public int32 InventoryCreateOrderPriority

Sets the request priority of Create Inventory Order calls, lower number is higher priority.

public int32 InventoryGetOrdersPriority

Sets the request priority of Get Inventory Orders calls, lower number is higher priority.

public int32 NotificationPollSelfPriority

Sets the request priority of Polling Notifications for Self calls, lower number is higher priority.

public int32 NotificationPollOtherPriority

Sets the request priority of Polling Notifications for Others calls, lower number is higher priority.

public int32 NotificationCreatePriority

Sets the request priority of Create Notifications calls, lower number is higher priority.

public int32 PresenceUpdatePriority

Sets the request priority of Updating Presence calls, lower number is higher priority.

public int32 PresenceGetSelfPriority

Sets the request priority of Get Self Presence calls, lower number is higher priority.

public int32 PresenceGetOtherPriority

Sets the request priority of Get Other Presence calls, lower number is higher priority.

public int32 PresenceGetSettingsPriority

Sets the request priority of Get Presence Settings calls, lower number is higher priority.

public int32 PurgeQueuePriority

Sets the request priority of Queue/Dequeue for Purge calls, lower number is higher priority.

public int32 PurgeGetStatusPriority

Sets the request priority of Get Purge Status calls, lower number is higher priority.

public int32 GetAllQueueInfoPriority

Sets the request priority of Get Queue Info calls, lower number is higher priority.

public int32 GetMatchmakingTemplatePriority

Sets the request priority of Get Matchmaking Template calls, lower number is higher priority.

public int32 GetMapGameInfoPriority

Sets the request priority of Get Map Game Info calls, lower number is higher priority.

public int32 RankingGetPriority

Sets the request priority of Get Rank calls, lower number is higher priority.

public int32 RankingUpdatePriority

Sets the request priority of Update Rank calls, lower number is higher priority.

public int32 SessionPollPriority

Sets the request priority of Session Polling calls, lower number is higher priority.

public int32 SessionJoinPriority

Sets the request priority of Session Joining calls, lower number is higher priority.

public int32 SessionLeavePriority

Sets the request priority of Session Leave calls, lower number is higher priority.

public int32 SessionInvitePriority

Sets the request priority of Session Invite calls, lower number is higher priority.

public int32 SessionKickPriority

Sets the request priority of Session Kick calls, lower number is higher priority.

public int32 SessionLeaderChangePriority

Sets the request priority of Session Leader Change calls, lower number is higher priority.

public int32 SessionChangeTeamsPriority

Sets the request priority of Session Change Teams calls, lower number is higher priority.

public int32 SessionLeaveQueuePriority

Sets the request priority of Session Leave Queue calls, lower number is higher priority.

public int32 SessionRequestInstancePriority

Sets the request priority of Session Request Instance calls, lower number is higher priority.

public int32 SessionEndInstancePriority

Sets the request priority of Session End Instance calls, lower number is higher priority.

public int32 SessionStartMatchPriority

Sets the request priority of Session Start Match calls, lower number is higher priority.

public int32 SessionEndMatchPriority

Sets the request priority of Session End Match calls, lower number is higher priority.

public int32 SessionUpdateSessionInfoPriority

Sets the request priority of Update Session Info calls, lower number is higher priority.

public int32 SessionUpdateInstanceInfoPriority

Sets the request priority of Update Instance Info calls, lower number is higher priority.

public int32 SessionUpdateBrowserInfoPriority

Sets the request priority of Update Browser Info calls, lower number is higher priority.

public int32 SessionDeleteBrowserInfoPriority

Sets the request priority of Delete Browser Info calls, lower number is higher priority.

public int32 SessionInstanceHealthUpdatePriority

Sets the request priority of Instance Health update calls, lower number is higher priority.

public int32 SessionBackfillUpdatePriority

Sets the request priority of Backfill update calls, lower number is higher priority.

public int32 SessionUpdateWithPlatformSessionPriority

Sets the request priority of Session Update With Platform Session calls, lower number is higher priority.

public int32 SessionGetTemplatePriority

Sets the request priority of Session Get Template calls, lower number is higher priority.

public int32 SessionGetByAllocationIdPriority

Sets the request priority of Session By Allocation Id calls, lower number is higher priority.

public int32 SessionGetBySessionIdPriority

Sets the request priority of Session By Session Id calls, lower number is higher priority.

public int32 SessionGetByTypePriority

Sets the request priority of Session By Type calls, lower number is higher priority.

public int32 SessionsGetOtherPriority

Sets the request priority of Get Other Sessions calls, lower number is higher priority.

public int32 SessionVoipLoginTokenPriority

Sets the request priority of VOIP Login calls, lower number is higher priority.

public int32 SessionVoipActionTokenPriority

Sets the request priority of VOIP Action calls, lower number is higher priority.

public int32 SettingsGetPriority

Sets the request priority of Get Settings calls, lower number is higher priority.

public int32 SettingsGetTypesPriority

Sets the request priority of Get Settings Types calls, lower number is higher priority.

public int32 SettingsUpdatePriority

Sets the request priority of Update Settings calls, lower number is higher priority.

public int32 GetRegionsPriority

Sets the request priority of Get Site Settings calls, lower number is higher priority.

public int32 SessionAuditPriority

Sets the request priority of Session Audit calls, lower number is higher priority.

public int32 UsersLookupPlayerPriority

Sets the request priority of Lookup Users calls, lower number is higher priority.

public int32 UsersGetLinkedPlatformsPriority

Sets the request priority of Get Linked Platforms calls, lower number is higher priority.

public int32 EventsReceiveEventPriority

Sets the request priority of ReceiveEvent, which is the GETS endpoint, lower number is higher priority.

public int32 MatchesGetOtherPriority

Sets the request priority of Get Player Matches calls, lower number is higher priority.

public int32 MatchesSearchPriority

Sets the request priority of Get Player Matches calls, lower number is higher priority.

public int32 MatchesLookupPriority

Sets the request priority of Get Player Matches calls, lower number is higher priority.

public int32 MatchesUpdatePriority

Sets the request priority of Create and Update Match calls, lower number is higher priority.

public int32 MatchesUpdatePlayerPriority

Sets the request priority of Create Match calls, lower number is higher priority.

public int32 GetPlayerReportsSentPriority

Sets the request priority of Player Report calls, lower number is higher priority.

public int32 GetPlayerReportsReceivedPriority

Sets the request priority of Player Report calls, lower number is higher priority.

public int32 CreatePlayerReportPriority

Sets the request priority of Player Report calls, lower number is higher priority.

public int32 FileUploadPriority

Sets the request priority of File Upload calls, lower number is higher priority.

public int32 FileDownloadPriority

Sets the request priority of File Download calls, lower number is higher priority.

public int32 FileBrowsePriority

Sets the request priority of File Browse calls, lower number is higher priority.

public int32 FileDeletePriority

Sets the request priority of File Delete calls, lower number is higher priority.

public const FRH_EnvironmentConfiguration*GetEnvironmentConfiguration(const FString & EnvironmentId) const

Helper to get the configuration for a given environment by EnvironmentId.

struct FRH_EnvironmentConfiguration

Settings for Environment Configuration. If set, these override the defaults when the EnvironmentId matches the specified environment id.

Summary

Members	Descriptions
public FString EnvironmentId	Environment Name, for use with client side environment lookups and overrides.
public FString BaseUrl	RallyHere BaseURL. Determines the base URL to use when connecting to the RallyHere API.
public FString ClientId	RallyHere Client ID. Determines the available permissions for RallyHere APIs.
public FString ClientSecret	RallyHere Client secret. Must be associated with the defined client ID.

Members

public FString EnvironmentId

Environment Name, for use with client side environment lookups and overrides.

public FString BaseUrl

RallyHere BaseURL. Determines the base URL to use when connecting to the RallyHere API.

public FString ClientId

RallyHere Client ID. Determines the available permissions for RallyHere APIs.

public FString ClientSecret

RallyHere Client secret. Must be associated with the defined client ID.