Class DuplicateCheckerOptions

Represents the duplicate checker settings for Aruba, using the Options pattern in ASP.NET Core.

Inheritance

object

DuplicateCheckerOptions

Implements

INearbyBugsFieldParams

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Phoenix.Aruba

Assembly: Phoenix.Plugin.Aruba.dll

Syntax

public class DuplicateCheckerOptions : INearbyBugsFieldParams

Fields

DupeCheckConfigFilename

The file name for the config file that is used to build this class.

Declaration

public const string DupeCheckConfigFilename = "ArubaDuplicateCheckerConfig.json"

Field Value

Type	Description
string

Properties

AutomaticQueryFrequencyInSeconds

Gets or sets how often the duplicate checker should automatically update in seconds.

Declaration

public int AutomaticQueryFrequencyInSeconds { get; set; }

Property Value

Type	Description
int

ConfigFileFolderPath

Gets the path to the folder that contains the config file.

Declaration

public static string ConfigFileFolderPath { get; }

Property Value

Type	Description
string

ConfigFilePath

Gets the full path to the config file.

Declaration

public static string ConfigFilePath { get; }

Property Value

Type	Description
string

DefaultConfidenceMatchThreshold

Gets or sets the default confidence match threshold that work items must meet to be shown in the duplicate checker.

Declaration

public uint DefaultConfidenceMatchThreshold { get; set; }

Property Value

Type	Description
uint

DefaultDateField

Gets or sets the date field to use in a default query.

Declaration

public string DefaultDateField { get; set; }

Property Value

Type	Description
string

DefaultFieldsToMatch

Gets or sets the fields to match in a default query.

Declaration

public List<string> DefaultFieldsToMatch { get; set; }

Property Value

Type	Description
List<string>

DefaultNearbyBugsTableRadiusThreshold

Gets or sets the distance threshold for a bug. Work Items whose location data do not fall within this radius shouldn't be shown in the view.

Declaration

public int DefaultNearbyBugsTableRadiusThreshold { get; set; }

Property Value

Type	Description
int

DefaultNumberDaysAgo

Gets or sets the number of days ago to search for work items in a default query.

Declaration

public uint DefaultNumberDaysAgo { get; set; }

Property Value

Type	Description
uint

DefaultWorkItemStates

Gets or sets the work item states to use in a default query.

Declaration

public List<string> DefaultWorkItemStates { get; set; }

Property Value

Type	Description
List<string>

DefaultWorkItemTypes

Gets or sets the work item types to use in a default query.

Declaration

public List<string> DefaultWorkItemTypes { get; set; }

Property Value

Type	Description
List<string>

DisableBackgroundDupeChecking

Gets or sets a value indicating whether duplicate checking is allowed to run when the Duplicate Check tab isn't actively in focus.

Declaration

public bool DisableBackgroundDupeChecking { get; set; }

Property Value

Type	Description
bool

DupeCheckDateFields

Gets or sets the list of possible date fields for a bug.

Declaration

public List<string> DupeCheckDateFields { get; set; }

Property Value

Type	Description
List<string>

DupeCheckWorkItemStates

Gets or sets the list of possible work item states for a bug.

Declaration

public List<string> DupeCheckWorkItemStates { get; set; }

Property Value

Type	Description
List<string>

DupeCheckWorkItemTypes

Gets or sets the list of possible work item types for a bug.

Declaration

public List<string> DupeCheckWorkItemTypes { get; set; }

Property Value

Type	Description
List<string>

HasMapField

Gets a value indicating whether the title's bug database uses a map field for their title.

Declaration

public bool HasMapField { get; set; }

Property Value

Type	Description
bool

Remarks

If this is false, the nearby bugs query will ignore the map name when sending a query

LocationDataDelimiter

Gets the delimiter that defines how location data is delimited if the data is kept in one field.

Declaration

public string LocationDataDelimiter { get; set; }

Property Value

Type	Description
string

LocationDataFilterRegex

Gets the regex that defines the characters to be stripped out of the location data.

Declaration

public string LocationDataFilterRegex { get; set; }

Property Value

Type	Description
string

LocationFieldPrefix

Gets the prefix for the location field parameter, like 'Location '.

Declaration

public string LocationFieldPrefix { get; set; }

Property Value

Type	Description
string

LocationFieldSuffixes

Gets the list of all suffixes for the location field parameters, like 'X', 'Y' and 'Z'.

Declaration

public IEnumerable<string> LocationFieldSuffixes { get; set; }

Property Value

Type	Description
IEnumerable<string>

MapFieldName

Gets the field name for the map.

Declaration

public string MapFieldName { get; set; }

Property Value

Type	Description
string

ShowNearbyBugsTable

Gets or sets a value indicating whether the nearby bugs table should be disabled. If it is disabled, it will be removed from the view.

Declaration

public bool ShowNearbyBugsTable { get; set; }

Property Value

Type	Description
bool

ShowRecentlySubmittedBugsPopup

Gets or sets a value indicating whether a pop-up should appear when a user submits a bug that lets a user know if a recent submitted bug is a potential duplicate.

Declaration

public bool ShowRecentlySubmittedBugsPopup { get; set; }

Property Value

Type	Description
bool

ShowUnsavedDupeCheckQueriesChangesPopup

Gets or sets a value indicating whether to show a pop-up that warns users about exiting the edit duplicate check queries with unsaved changes.

Declaration

public bool ShowUnsavedDupeCheckQueriesChangesPopup { get; set; }

Property Value

Type	Description
bool

UseWeightedRatio

Gets or sets a value indicating whether the duplicate checker should use a weighted ratio when matching fields.

Declaration

public bool UseWeightedRatio { get; set; }

Property Value

Type	Description
bool

Remarks

If false, the duplicate checker will use a Simple Ratio.

Methods

DisableShowRecentlySubmittedBugsPopupSetting()

Disables the settings for the showing a pop-up window with recently submitted bugs that might be a duplicate when submitting a bug with Aruba.

Declaration

public void DisableShowRecentlySubmittedBugsPopupSetting()

DisableShowUnsavedDupeCheckCheckQueriesPopupSetting()

Disables the settings for the show unsaved changes pop-up in the edit duplicate checking queries window.

Declaration

public void DisableShowUnsavedDupeCheckCheckQueriesPopupSetting()

GetDefaultQueryDefinition()

Gets a default DuplicateCheckQueryDefinition.

Declaration

public DuplicateCheckQueryDefinition GetDefaultQueryDefinition()

Returns

Type	Description
DuplicateCheckQueryDefinition	The default query definition. If the query isn't valid, this function returns null.

GetLocationFields()

Gets the full name of all location fields for a title's bug database.

Declaration

public IEnumerable<string> GetLocationFields()

Returns

Type	Description
IEnumerable<string>	A list of all location fields.

Remarks

If there are no suffixes, then the prefix will be sent by itself. This is to account for titles that only have one location field instead of having it split into multiple fields.

Implements

INearbyBugsFieldParams