Interface IJiraConfigService

Provides methods to manage Jira server and project configurations for Unity organizations and projects.

Namespace: Unity.Cloud.Collaboration.Services.JiraConfigService

Assembly: Unity.Cloud.Collaboration.dll

Syntax

public interface IJiraConfigService

Methods

CreateProjectConfigAsync(OrganizationId, JiraServerConfigId, JiraProjectId, JiraUserId, List<ProjectId>, CancellationToken)

Creates a new Jira ProjectConfig

Declaration

Task<JiraProjectConfigId> CreateProjectConfigAsync(OrganizationId organizationId, JiraServerConfigId jiraServerConfigId, JiraProjectId jiraProjectId, JiraUserId defaultReporterId, List<ProjectId> linkedUnityProjectIds = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
OrganizationId	organizationId	The organization id.
JiraServerConfigId	jiraServerConfigId	The Jira ServerConfig id.
JiraProjectId	jiraProjectId	Unique Id for the Jira project (required)
JiraUserId	defaultReporterId	Used when creating a new issue, if the creator of the Annotation cannot be matched to a Jira users, this user will be used instead as the reporter (required)
List<ProjectId>	linkedUnityProjectIds	Link this ProjectConfig to a list of Unity projects. If IsRestricted is true, this ProjectConfig will only be available to the linked projects
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<JiraProjectConfigId>	Task of JiraProjectConfigId

CreateServerConfigAsync(OrganizationId, string, string, string, string, CancellationToken)

Creates a new ServerConfig in a Unity organization

Declaration

Task<JiraServerConfigId> CreateServerConfigAsync(OrganizationId organizationId, string name, string url, string username, string key, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
OrganizationId	organizationId	The Organization id.
string	name	User provided name for the configuration. (required).
string	url	The URL of the Jira server we are configuring. (required).
string	username	Username used to connect to the Jira server. (required).
string	key	Key used to connect to the Jira server. (required).
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<JiraServerConfigId>	Task of JiraServerConfigId

DeleteProjectConfigAsync(OrganizationId, JiraProjectConfigId, CancellationToken)

Delete a Jira ProjectConfig.

Declaration

Task DeleteProjectConfigAsync(OrganizationId organizationId, JiraProjectConfigId jiraProjectConfigId, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
OrganizationId	organizationId	The organization id.
JiraProjectConfigId	jiraProjectConfigId	The Jira ProjectConfig id.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task	Task of void

DeleteServerConfigAsync(OrganizationId, JiraServerConfigId, CancellationToken)

Delete a Jira ServerConfig.

Declaration

Task DeleteServerConfigAsync(OrganizationId organizationId, JiraServerConfigId jiraServerConfigId, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
OrganizationId	organizationId	The organization id.
JiraServerConfigId	jiraServerConfigId	The Jira ServerConfig id.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task	Task of void

GetConfigsForProjectAsync(ProjectId, CancellationToken)

Get available Jira configurations for Unity project.

Declaration

Task<GetConfigsForProjectResult> GetConfigsForProjectAsync(ProjectId projectId, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
ProjectId	projectId	The Unity project we are getting the configurations for.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<GetConfigsForProjectResult>	Task of GetConfigsForProjectResult

ReadConfigsAsync(OrganizationId, CancellationToken)

Get all Jira configurations (servers + projects) for the given Unity Organization.

Declaration

Task<ReadServerConfigsResult> ReadConfigsAsync(OrganizationId organizationId, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
OrganizationId	organizationId	The organization id.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ReadServerConfigsResult>	Task of ReadServerConfigsResult

UpdateProjectConfigAsync(OrganizationId, JiraProjectConfigId, JiraUserId, List<ProjectId>, CancellationToken)

Update a Jira ProjectConfig.

Declaration

Task UpdateProjectConfigAsync(OrganizationId organizationId, JiraProjectConfigId jiraProjectConfigId, JiraUserId defaultReporterId = default, List<ProjectId> linkedUnityProjectIds = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
OrganizationId	organizationId	The organization id.
JiraProjectConfigId	jiraProjectConfigId	The Jira ProjectConfig id.
JiraUserId	defaultReporterId	Used when creating a new issue, if the creator of the Annotation cannot be matched to a Jira users, this user will be used instead as the reporter..
List<ProjectId>	linkedUnityProjectIds	List of Unity Project Ids that this Jira ProjectConfig is linked to. If this value is set, it will replace the existing list of linked Unity projects with given list of Unity project Ids..
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task	Task of void

UpdateServerConfigAsync(OrganizationId, JiraServerConfigId, string, string, string, string, CancellationToken)

Update a Jira ServerConfig.

Declaration

Task UpdateServerConfigAsync(OrganizationId organizationId, JiraServerConfigId jiraServerConfigId, string name = null, string url = null, string username = null, string key = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
OrganizationId	organizationId	The organization id.
JiraServerConfigId	jiraServerConfigId	The Jira ServerConfig id.
string	name	User provided name for the configuration..
string	url	The URL of the Jira server we are configuring..
string	username	Username used to connect to the Jira server..
string	key	Key used to connect to the Jira server..
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task	Task of void