Interface IJiraIssueService

Provides methods to manage Jira issues for Unity projects.

Namespace: Unity.Cloud.Collaboration.Services.JiraIssueService

Assembly: Unity.Cloud.Collaboration.dll

Syntax

public interface IJiraIssueService

Methods

CreateIssueAsync(ProjectId, AnnotationId, JiraProjectConfigId, JiraIssueTypeId, string, string, JiraUserId, JiraUserId, JiraIssueId, CancellationToken)

Creates a new Jira Issue

Declaration

Task<JiraIssueId> CreateIssueAsync(ProjectId projectId, AnnotationId annotationId, JiraProjectConfigId jiraProjectConfigId, JiraIssueTypeId issueTypeId, string summary, string description = null, JiraUserId reporterUserId = default, JiraUserId assigneeUserId = default, JiraIssueId parentIssueId = default, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
ProjectId	projectId	The project id.
AnnotationId	annotationId	The annotation id.
JiraProjectConfigId	jiraProjectConfigId	The Jira ProjectConfig Id to use for creating the Jira issue (required)
JiraIssueTypeId	issueTypeId	The Id of type of the Jira issue to create (required)
string	summary	The summary of the Jira issue to create. (required)
string	description	The description of the Jira issue to create
JiraUserId	reporterUserId	The Jira UserId of the reporter of the Jira issue to create
JiraUserId	assigneeUserId	The Jira UserId of the assignee of the Jira issue to create
JiraIssueId	parentIssueId	The Jira Id of the parent issue if creating a sub-task
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<JiraIssueId>	Task of JiraIssueId

GetIssueDetailsAsync(ProjectId, JiraProjectConfigId, JiraIssueId, CancellationToken)

Get Jira issue details.

Declaration

Task<GetTaskManagementIssueDetailsResult> GetIssueDetailsAsync(ProjectId projectId, JiraProjectConfigId jiraProjectConfigId, JiraIssueId jiraIssueId, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
ProjectId	projectId	The project id.
JiraProjectConfigId	jiraProjectConfigId	The Jira ProjectConfig id.
JiraIssueId	jiraIssueId	The Jira Issue id or key.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<GetTaskManagementIssueDetailsResult>	Task of GetTaskManagementIssueDetailsResult

GetIssueTypesAsync(ProjectId, JiraProjectConfigId, CancellationToken)

Get issue types from Jira ProjectConfig.

Declaration

Task<GetTaskManagementIssueTypesResult> GetIssueTypesAsync(ProjectId projectId, JiraProjectConfigId jiraProjectConfigId, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
ProjectId	projectId	The project id.
JiraProjectConfigId	jiraProjectConfigId	The Jira ProjectConfig id.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<GetTaskManagementIssueTypesResult>	Task of GetTaskManagementIssueTypesResult

LinkIssueToAnnotationAsync(ProjectId, AnnotationId, JiraIssueId, JiraProjectConfigId, CancellationToken)

Link a Jira issue to an Annotation.

Declaration

Task LinkIssueToAnnotationAsync(ProjectId projectId, AnnotationId annotationId, JiraIssueId jiraIssueId, JiraProjectConfigId jiraProjectConfigId = default, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
ProjectId	projectId	The project id.
AnnotationId	annotationId	The annotation id.
JiraIssueId	jiraIssueId	The Jira Issue id.
JiraProjectConfigId	jiraProjectConfigId	The Id of the JiraProjectConfig..
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task	Task of void

SearchIssuesAsync(ProjectId, JiraProjectConfigId, string, bool?, CancellationToken)

Search issues from Jira ProjectConfig.

Declaration

Task<SearchTaskManagementIssuesResult> SearchIssuesAsync(ProjectId projectId, JiraProjectConfigId jiraProjectConfigId, string query = null, bool? includeSubTasks = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
ProjectId	projectId	The project id.
JiraProjectConfigId	jiraProjectConfigId	The Jira ProjectConfig id.
string	query	The query to search for. (optional)
bool?	includeSubTasks	Indicate whether to include subtasks in the issue list. (optional)
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<SearchTaskManagementIssuesResult>	Task of SearchTaskManagementIssuesResult

UnlinkIssueFromAnnotationAsync(ProjectId, AnnotationId, JiraIssueId, CancellationToken)

Unlink a Jira issue from an Annotation.

Declaration

Task UnlinkIssueFromAnnotationAsync(ProjectId projectId, AnnotationId annotationId, JiraIssueId jiraIssueId, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
ProjectId	projectId	The project id.
AnnotationId	annotationId	The annotation id.
JiraIssueId	jiraIssueId	The Id of the Jira issue.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task	Task of void