InedoSDK Reference

Version:

IssueTrackerService Class

Provides information and utility methods for an Issue Tracker, such as JIRA or YouTrack

Inheritance Hierarchy

object
- Inedo.Extensibility.IssueTrackers.IssueTrackerService
  - Inedo.Extensibility.IssueTrackers.IssueTrackerService<TProject, TCredential>

Syntax

public class IssueTrackerService : Inedo.Diagnostics.ILogSink

Events

	Name	Description
	MessageLogged

Properties

	Name	Description
	ApiUrlDisplayName	Gets the service-specific name for API Url, such as "Root server"
	ApiUrlPlaceholderText	Gets the service-specific Placeholder text for the ApiUrl field.
	CredentialType	Gets the IIssueTrackerServiceCredentials type that is used by the service.
	DefaultVersionFieldName	Gets the service-specific field name used for release mapping, such as "Milestone" or "Fix version"
	HasDefaultApiUrl	Indicates whether the service has a well-known public API, such a GitHub.com.
	NamespaceDisplayName	Gets the service-specific name for the namespace, such as "Organization" or "Namespace"
	PasswordDisplayName	Gets the service-specific name for passwords, such as "API Token"
	ProjectDisplayName	Gets the service-specific name for projects, which is usually just "Project"
	ProjectType	Gets the IssueTrackerProject type that is used by the service.
	ServiceName	Gets the name of the service, like JIRA, YouTrack, GitHub Issues
	UsernameDisplayName	Gets the service-specific name for usernames, such as "Username".
	VersionClosedDescription	Gets the service-specific description to describe how a version is closed, such as "Version is \"Archived\" and \"Released\""
	VersionDisplayName	Gets the service-specific name for versions, which is usually "Version" or "Milestone

Methods

	Name	Description
	GetNamespacesAsync(IIssueTrackerServiceCredentials credentials, System.Threading.CancellationToken cancellationToken)
	GetProjectNamesAsync(IIssueTrackerServiceCredentials credentials, string serviceNamespace, System.Threading.CancellationToken cancellationToken)
	ValidateCredentialsAsync(IIssueTrackerServiceCredentials credentials, System.Threading.CancellationToken cancellationToken)
	ValidateProjectAsync(IIssueTrackerServiceCredentials credentials, string projectName, System.Threading.CancellationToken cancellationToken)

Remarks

Implementers should inherit from IssueTrackerService<TProject, TCredential>