Skip to content
RallyHere Docs

IntegrationBase

Summary

MembersDescriptions
class FRallyHereIntegrationModuleModule for the Rally Here Integration Layer.
class FRH_IntegrationMain integration layer handler.

class FRallyHereIntegrationModule 

class FRallyHereIntegrationModule
  : public IModuleInterface

Module for the Rally Here Integration Layer.

Summary

MembersDescriptions
public ~FRallyHereIntegrationModule() = defaultDefault constructor.
public void StartupModule()Initializes the module.
public void ShutdownModule()Safely ends the module.
public inline FRH_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 FRH_Integration&GetIntegration() const

Gets the Integration class fromt he module.

class FRH_Integration

Main integration layer handler.

Summary

MembersDescriptions
public FRH_Integration()
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 SetEnvironmentId(FString InEnvironmentId,const FString & Source)Sets the environment for he connection.
public FString GetEnvironmentId()Get the current Environment Id (will run ResolveEnvironmentId if there isn’t one)
public void ResolveEnvironmentId()Get the Environment ID used for finding the base URL from the first of the following sources:
public inline void LockEnvironmentId(bool bLocked)Updates the locked status of the Environment Id.
public void SetBaseURL(FString InBaseUrl,const 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,const 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,const 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 FRH_WebRequests*GetWebRequestTracker() constGets the Web Request Tracker.
public inline FRH_Diagnostics*GetDiagnostics() constGets the Diagnostic Reporter.

Members

public FRH_Integration()

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 SetEnvironmentId(FString InEnvironmentId,const FString & Source)

Sets the environment for he connection.

Parameters

  • InEnvironmentId Id of the Environment to use.

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

public FString GetEnvironmentId()

Get the current Environment Id (will run ResolveEnvironmentId if there isn’t one)

public void ResolveEnvironmentId()

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

  • Command line values from the keys in EnvironmentCommandLineKeysInternal. By default these are: RallyHereEnvX RallyHereEnv RallyHereEnvInternal

  • Command line values from the keys in EnvironmentCommandLineKeys, which are configured by ini

  • Results from GetEnvironmentId from the EnvironmentOSSName (or default if one is not provided)

public inline void LockEnvironmentId(bool bLocked)

Updates the locked status of the Environment Id.

Parameters

  • bLocked If locked, disables the ResolveEnvironmentId function.

public void SetBaseURL(FString InBaseUrl,const 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 BaseURLCommandLineKeysInternal. By default these are: RallyHereURLX RallyHereURL RallyHereURLInternal

  • Command line values from the keys in BaseURLCommandLineKeys, which are configured by ini

  • ini value from the “RallyHereEnvURL” section, where the key is the current EnvironmentId returned from GetEnvironmentId

  • 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,const 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 ClientIdCommandLineKeysInternal. By default these are: RallyHereClientIdX RallyHereClientId RallyHereClientIdInternal

  • Command line values from the keys in ClientIdCommandLineKeys, which are configured by ini

  • 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,const 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 ClientSecretCommandLineKeysInternal. By default these are: RallyHereClientSecretX RallyHereClientSecret RallyHereClientSecretInternal

  • Command line values from the keys in ClientSecretCommandLineKeys, which are configured by ini

  • 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 FRH_WebRequests*GetWebRequestTracker() const

Gets the Web Request Tracker.

public inline FRH_Diagnostics*GetDiagnostics() const

Gets the Diagnostic Reporter.