Show / Hide Table of Contents

Class BaseConfigContainer<TGameClient>

Class that provides a base implementation of the IConfigContainer.

Inheritance
object
BaseConfigContainer<TGameClient>
JiraConfigContainer<TGameClient>
TfsConfigContainer<TGameClient>
Implements
IConfigContainer
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Microsoft.Internal.Studios.Aruba.Infrastructure
Assembly: Aruba.Infrastructure.dll
Syntax
public abstract class BaseConfigContainer<TGameClient> : IConfigContainer where TGameClient : class, IGameClient
Type Parameters
Name Description
TGameClient

The IGameClient for this IConfigContainer, handles initialization and connection of the game client, and token initialization.

Remarks

Use EmptyGameClient for an IConfigContainer without a game client.

Properties

View Source

BugServiceClient

Gets get the IBugServiceClient to use.

Declaration
public IBugServiceClient BugServiceClient { get; }
Property Value
Type Description
IBugServiceClient
View Source

TitleName

Gets the name of the title.

Declaration
public abstract string TitleName { get; }
Property Value
Type Description
string

Methods

View Source

CreateGameClient()

Creates an instance of TGameClient.

Declaration
protected abstract TGameClient CreateGameClient()
Returns
Type Description
TGameClient

The TGameClient instance, EmptyGameClient for an IConfigContainer without a game client.

View Source

InitializeAsync()

Initializes the BaseConfigContainer<TGameClient>.

Declaration
public virtual Task InitializeAsync()
Returns
Type Description
Task

A Task representing the asynchronous operation.

View Source

InitializeBugServiceAsync()

Method that initializes the IBugServiceClient for bug management operations.

Declaration
protected abstract Task<IBugServiceClient> InitializeBugServiceAsync()
Returns
Type Description
Task<IBugServiceClient>

A Task with the bug service client.

View Source

UninitializeAsync()

Uninitializes the BaseConfigContainer<TGameClient>.

Declaration
public virtual Task UninitializeAsync()
Returns
Type Description
Task

A Task representing the asynchronous operation.

Implements

IConfigContainer
  • View Source
In this article
Back to top Generated by DocFX