Show / Hide Table of Contents

Class JiraConfigContainer<TGameClient>

Base class for a Jira Config Container.

Inheritance
object
BaseConfigContainer<TGameClient>
JiraConfigContainer<TGameClient>
TestJiraTitleConfigContainer
DefaultJiraConfigContainer
Implements
IConfigContainer
Inherited Members
BaseConfigContainer<TGameClient>.TitleName
BaseConfigContainer<TGameClient>.BugServiceClient
BaseConfigContainer<TGameClient>.InitializeAsync()
BaseConfigContainer<TGameClient>.UninitializeAsync()
BaseConfigContainer<TGameClient>.CreateGameClient()
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Microsoft.Internal.Studios.Aruba.Jira
Assembly: Aruba.Jira.dll
Syntax
public abstract class JiraConfigContainer<TGameClient> : 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.

Constructors

View Source

JiraConfigContainer(IEventAggregator)

Base class for a Jira Config Container.

Declaration
protected JiraConfigContainer(IEventAggregator eventAggregator)
Parameters
Type Name Description
IEventAggregator eventAggregator

The event aggregator for Jira configuration.

Remarks

Use EmptyGameClient for an IConfigContainer without a game client.

Properties

View Source

EnableRichText

Gets a value indicating whether or not to enable rich text.

Declaration
public virtual bool EnableRichText { get; }
Property Value
Type Description
bool
View Source

ProjectName

Gets the name of the project on Jira.

Declaration
public abstract string ProjectName { get; }
Property Value
Type Description
string
View Source

ServiceEndpoint

Gets the Jira uri for the bug service.

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

Methods

View Source

InitializeBugServiceAsync()

Method that initializes the IBugServiceClient for bug management operations.

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

A Task with the bug service client.

Overrides
BaseConfigContainer<TGameClient>.InitializeBugServiceAsync()
View Source

Logline(string)

Method for logging a message.

Declaration
protected abstract void Logline(string message)
Parameters
Type Name Description
string message

The message to log.

Implements

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