Skip to content
RallyHere Docs
GitHub

IntegrationBase

Summary

MembersDescriptions
class FRallyHereIntegrationModuleModule for the RallyHere Integration Layer.
class URH_IntegrationMain integration layer handler.

class FRallyHereIntegrationModule 

class FRallyHereIntegrationModule
  : public IModuleInterface

Module for the RallyHere Integration Layer.

Summary

MembersDescriptions
public ~FRallyHereIntegrationModule() = defaultDefault constructor.
public void StartupModule()Initializes the module.
public void ShutdownModule()Safely ends the module.
public inline URH_Integration&GetIntegration() constGets the Integration class fromt he module.

Members

public ~FRallyHereIntegrationModule() = default

Default constructor.

public void StartupModule()

Initializes the module.

public void ShutdownModule()

Safely ends the module.

public inline URH_Integration&GetIntegration() const

Gets the Integration class fromt he module.

class URH_Integration 

class URH_Integration
  : public UObject

Main integration layer handler.

Summary

MembersDescriptions
public void Initialize()Initialize the Integration layer.
public void Uninitialize()Safely tears down the Integration layer.
public inline RallyHereAPI::FRallyHereAPIAll & GetAPIs()Gets all the APIs.
public inline HttpRetryManagerPtr GetRetryManager() constGets Base Retry Manager for all RallyHereAPI calls.
public void SetSandboxId(FString InSandboxId,FString Source)Sets the sandbox for he connection.
public FString GetSandboxId()Get the current Sandbox Id (will run ResolveSandboxId if there isn’t one)
public void ResolveSandboxId()Get the Sandbox ID used for finding the base URL from the first of the following sources:
public inline void LockSandboxId(bool bLocked)Updates the locked status of the Sandbox Id.
public void SetBaseURL(FString InBaseUrl,FString Source)Set the base URL for all RallyHereAPI calls.
public FString GetBaseURL()Get the current base URL (will run ResolveBaseURL if there isn’t one)
public void ResolveBaseURL()Check for a base URL across several sources and assign the first non-empty value to the APIs:
public inline void LockBaseURL(bool bLocked)Updates the locked status of the Base URL.
public void SetClientId(FString InClientId,FString Source)Set the client ID for the AuthContext.
public FString GetClientId()Get the current client ID (will run ResolveClientId if there isn’t one).
public void ResolveClientId()Check for a client ID across several sources and assign the first non-empty value to the APIs:
public inline void LockClientId(bool bLocked)Updates the locked status of the Client Id.
public void SetClientSecret(FString InClientSecret,FString Source)Set the client secret for the AuthContext.
public FString GetClientSecret()Get the current client secret (will run ResolveClientSecret if there isn’t one).
public void ResolveClientSecret()Check for a client secret across several sources and assign the first non-empty value to the APIs:
public inline void LockClientSecret(bool bLocked)Updates the locked status of the Client Secret.
public inline class URH_WebRequests*GetWebRequestTracker() constGets the Web Request Tracker.
public inline class URH_Diagnostics*GetDiagnostics() constGets the Diagnostic Reporter.

Members

public void Initialize()

Initialize the Integration layer.

public void Uninitialize()

Safely tears down the Integration layer.

public inline RallyHereAPI::FRallyHereAPIAll & GetAPIs()

Gets all the APIs.

public inline HttpRetryManagerPtr GetRetryManager() const

Gets Base Retry Manager for all RallyHereAPI calls.

public void SetSandboxId(FString InSandboxId,FString Source)

Sets the sandbox for he connection.

Parameters

  • InSandboxId Id of the Sandbox to use.

  • Source The source of the sandbox change, for logging.

public FString GetSandboxId()

Get the current Sandbox Id (will run ResolveSandboxId if there isn’t one)

public void ResolveSandboxId()

Get the Sandbox ID used for finding the base URL from the first of the following sources:

  • Command line values from the keys in SandboxCommandLineKeys. By default these are: RallyHereSandboxX RallyHereSandbox RallyHereSandboxInternal

  • Results from GetSandboxId from the SandboxOSSName (or default if one is not provided)

public inline void LockSandboxId(bool bLocked)

Updates the locked status of the Sandbox Id.

Parameters

  • bLocked If locked, disables the ResolveSandboxId function.

public void SetBaseURL(FString InBaseUrl,FString Source)

Set the base URL for all RallyHereAPI calls.

Parameters

  • InBaseURL The base URL to use.

  • Source The source of the base URL change, for logging.

public FString GetBaseURL()

Get the current base URL (will run ResolveBaseURL if there isn’t one)

public void ResolveBaseURL()

Check for a base URL across several sources and assign the first non-empty value to the APIs:

  • Command line values from the keys in BaseURLCommandLineKeys. By default these are: RallyHereURLX RallyHereURL RallyHereURLInternal

  • ini value from the “RallyHereSandboxURL” section, where the key is the current sandboxId returned from GetSandboxId

  • ini value from the section for this class, with the “BaseUrl” key.

public inline void LockBaseURL(bool bLocked)

Updates the locked status of the Base URL.

Parameters

  • bLocked If locked, disables the ResolveBaseURL function.

public void SetClientId(FString InClientId,FString Source)

Set the client ID for the AuthContext.

Parameters

  • InClientId The client ID to use.

  • Source The source of the base Client Id Change, for logging.

public FString GetClientId()

Get the current client ID (will run ResolveClientId if there isn’t one).

public void ResolveClientId()

Check for a client ID across several sources and assign the first non-empty value to the APIs:

  • Command line values from the keys in ClientIdCommandLineKeys. By default these are: RallyHereClientIdX RallyHereClientId RallyHereClientIdInternal

  • ini value from the “RallyHere” section, with the “ClientId” key.

  • ini value from the section for this class, with the “ClientId” key.

public inline void LockClientId(bool bLocked)

Updates the locked status of the Client Id.

Parameters

  • bLocked If locked, disables the ResolveClientId function.

public void SetClientSecret(FString InClientSecret,FString Source)

Set the client secret for the AuthContext.

Parameters

  • InClientSecret The client secret to use.

  • Source The source of the base Client Secret Change, for logging.

public FString GetClientSecret()

Get the current client secret (will run ResolveClientSecret if there isn’t one).

public void ResolveClientSecret()

Check for a client secret across several sources and assign the first non-empty value to the APIs:

  • Command line values from the keys in ClientSecretCommandLineKeys. By default these are: RallyHereClientSecretX RallyHereClientSecret RallyHereClientSecretInternal

  • ini value from the “RallyHere” section, with the “ClientSecret” key.

  • ini value from the section for this class, with the “ClientSecret” key.

public inline void LockClientSecret(bool bLocked)

Updates the locked status of the Client Secret.

Parameters

  • bLocked If locked, disables the ResolveClientSecret function.

public inline class URH_WebRequests*GetWebRequestTracker() const

Gets the Web Request Tracker.

public inline class URH_Diagnostics*GetDiagnostics() const

Gets the Diagnostic Reporter.