Interface IBugServiceClient

An interface to represent the client for a bug service.

Namespace: Microsoft.Internal.Studios.Aruba.Infrastructure

Assembly: Aruba.Infrastructure.dll

Syntax

public interface IBugServiceClient

Properties

MultiselectControlDelimiter

Gets the delimiter for the multi-select control.

Declaration

string MultiselectControlDelimiter { get; }

Property Value

Type	Description
string

Methods

AddAttachmentToExistingBugAsync(string, string)

Adds an attachment to an existing bug.

Declaration

Task AddAttachmentToExistingBugAsync(string filePath, string bugID)

Parameters

Type	Name	Description
string	filePath	The filepath of the attachment to add.
string	bugID	The ID of the bug.

Returns

Type	Description
Task	The task.

CreateBugAsync(BugCreationParams)

Create a bug using the given parameters. This need not validate on the client side. If validation is required on the client side, use ValidateBugCreationParamsAsync(BugCreationParams) instead.

Declaration

Task<string> CreateBugAsync(BugCreationParams creationParams)

Parameters

Type	Name	Description
BugCreationParams	creationParams	The bug creation parameters.

Returns

Type	Description
Task<string>	A task resulting in a string representing the newly created bug id/key

FollowBugAsync(string)

Follows a bug given its key.

Declaration

ValueTask<bool> FollowBugAsync(string bugKey)

Parameters

Type	Name	Description
string	bugKey	The bug key.

Returns

Type	Description
ValueTask<bool>	True if it was followed.

GetArrayFieldNames()

Some fields may be array fields, taking in an array of values on bug creation. This returns a set of such field names.

Declaration

HashSet<string> GetArrayFieldNames()

Returns

Type	Description
HashSet<string>	The HashSet of strings with the field names.

GetBrowseUriFromBugKeyAsync(string)

Get the Uri to browse a bug, given the bug key.

Declaration

ValueTask<Uri?> GetBrowseUriFromBugKeyAsync(string bugKey)

Parameters

Type	Name	Description
string	bugKey	The bug key.

Returns

Type	Description
ValueTask<Uri>	The Uri if found, null otherwise.

GetBugInfoFromKeyAsync(string, CancellationToken)

Gets info about a bug gives its key.

Declaration

Task<BugInfo?> GetBugInfoFromKeyAsync(string key, CancellationToken cancellationToken)

Parameters

Type	Name	Description
string	key	The bug key.
CancellationToken	cancellationToken	The cancellation token.

Returns

Type	Description
Task<BugInfo>	The BugInfo task.

GetBugLinkTypesAsync()

Gets a list of the bug link types available to add to a bug.

Declaration

Task<List<BugLinkType>> GetBugLinkTypesAsync()

Returns

Type	Description
Task<List<BugLinkType>>	A list of BugLinkType.

GetDefaultTemplateFields()

Generate a "default" list of TemplateFieldDefinitions.

Declaration

IList<TemplateFieldDefinition> GetDefaultTemplateFields()

Returns

Type	Description
IList<TemplateFieldDefinition>	The template field definition.

GetTags()

Gets all the tags available in the database.

Declaration

List<string> GetTags()

Returns

Type	Description
List<string>	Tags as a list of strings.

GetValueRestrictedFieldInfo()

Get the fields for which values are restricted to be one in a specific list.

Declaration

Dictionary<string, IEnumerable<object>> GetValueRestrictedFieldInfo()

Returns

Type	Description
Dictionary<string, IEnumerable<object>>	A map of field names to a list of their allowed values

RefreshBugFieldValuesAsync()

Refreshes the available field values from the bug database.

Declaration

Task RefreshBugFieldValuesAsync()

Returns

Type	Description
Task	A Task representing the asynchronous operation.

ValidateBugCreationParamsAsync(BugCreationParams)

Validate on the client side (as much as possible) if the bug service will be able to create a bug with the given parameters.

Declaration

Task ValidateBugCreationParamsAsync(BugCreationParams creationParams)

Parameters

Type	Name	Description
BugCreationParams	creationParams	The bug creation parameters.

Returns

Type	Description
Task	The task.