Class RelativityFacade

Represents the facade over Relativity. Is a root point for RTF usage.

Inheritance
System.Object
RelativityFacade
Implements
System.IDisposable
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Relativity.Testing.Framework
Assembly: Relativity.Testing.Framework.dll
Syntax
public class RelativityFacade : IRelativityFacade, IDisposable

Properties

| Improve this Doc View Source

Instance

Gets the default RelativityFacade instance.

Declaration
public static IRelativityFacade Instance { get; }
Property Value
Type Description
IRelativityFacade

Methods

| Improve this Doc View Source

Dispose()

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

Declaration
public void Dispose()
| Improve this Doc View Source

Dispose(Boolean)

Releases unmanaged and optionally managed resources.

Declaration
protected virtual void Dispose(bool disposing)
Parameters
Type Name Description
System.Boolean disposing

true to release both managed and unmanaged resources; false to release only unmanaged resources.
| Improve this Doc View Source

ResetFacade()

Resets the RelativityFacade so that it can be recreated with a new user context.

Declaration
public void ResetFacade()

Explicit Interface Implementations

| Improve this Doc View Source

IRelativityFacade.Config

Gets the IConfigurationService that represents configuration.

Declaration
IConfigurationService IRelativityFacade.Config { get; }
Returns
Type Description
IConfigurationService
| Improve this Doc View Source

IRelativityFacade.GetComponent<T>()

Returns the IRelativityComponent of the given type that was registered.

Declaration
T IRelativityFacade.GetComponent<T>()
    where T : class, IRelativityComponent
Returns
Type Description
T

An instance of IRelativityComponent.
Type Parameters
Name Description
T

Type that implements IRelativityComponent.
| Improve this Doc View Source

IRelativityFacade.Log

Gets the ILogService that provides a set of methods for logging.

Declaration
ILogService IRelativityFacade.Log { get; }
Returns
Type Description
ILogService
| Improve this Doc View Source

IRelativityFacade.RelativityInstanceVersion

Gets the Relativity instance version.

Declaration
string IRelativityFacade.RelativityInstanceVersion { get; }
Returns
Type Description
System.String
| Improve this Doc View Source

IRelativityFacade.RelyOn<T>()

Registers an IRelativityComponent.

Declaration
IRelativityFacade IRelativityFacade.RelyOn<T>()
    where T : class, IRelativityComponent, new()
Returns
Type Description
IRelativityFacade

The same IRelativityFacade instance.
Type Parameters
Name Description
T

Type that implements IRelativityComponent.
| Improve this Doc View Source

IRelativityFacade.RelyOn<T>(T)

Registers a component.

Declaration
IRelativityFacade IRelativityFacade.RelyOn<T>(T component)
    where T : class, IRelativityComponent
Parameters
Type Name Description
T component

The component of T type implementing IRelativityComponent.
Returns
Type Description
IRelativityFacade

The same IRelativityFacade instance.
Type Parameters
Name Description
T

Type that implements IRelativityComponent.
| Improve this Doc View Source

IRelativityFacade.Resolve(Type)

Resolves and returns a service by interface type.

Declaration
object IRelativityFacade.Resolve(Type service)
Parameters
Type Name Description
System.Type service

The type of service interface.
Returns
Type Description
System.Object

The service instance.
| Improve this Doc View Source

IRelativityFacade.Resolve<T>()

Resolves and returns a service by interface.

Declaration
T IRelativityFacade.Resolve<T>()
Returns
Type Description
T

The T service.
Type Parameters
Name Description
T

The type of service interface.

Implements

System.IDisposable