Interface IJiraManagementService

Provides methods to manage Jira users and project within Unity organizations.

Namespace: Unity.Cloud.Collaboration.Services.JiraManagementService

Assembly: Unity.Cloud.Collaboration.dll

Syntax

public interface IJiraManagementService

Methods

CheckCredentialsAsync(OrganizationId, string, string, string, CancellationToken)

Validates that the given credentials can be used to connect to the Jira server

Declaration

Task CheckCredentialsAsync(OrganizationId organizationId, string url, string username, string key, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
OrganizationId	organizationId	The Organization id.
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	Task of void

GetProjectsAsync(OrganizationId, JiraServerConfigId, CancellationToken)

Get projects from Jira ServerConfig.

Declaration

Task<GetTaskManagementProjectsResult> GetProjectsAsync(OrganizationId organizationId, JiraServerConfigId jiraServerConfigId, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
OrganizationId	organizationId	The organization id.
JiraServerConfigId	jiraServerConfigId	The Id of the JiraServerConfig to get Projects from.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<GetTaskManagementProjectsResult>	Task of GetTaskManagementProjectsResult

HasRequiredPermissionsAsync(OrganizationId, JiraServerConfigId, JiraProjectId, CancellationToken)

Check if the configuration has the required permissions.

Declaration

Task<HasRequiredPermissionsResult> HasRequiredPermissionsAsync(OrganizationId organizationId, JiraServerConfigId jiraServerConfigId, JiraProjectId jiraProjectId, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
OrganizationId	organizationId	The organization id.
JiraServerConfigId	jiraServerConfigId	The ID of the Jira ServerConfig to get credentials from.
JiraProjectId	jiraProjectId	The ID of the Jira project we are testing permissions in.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<HasRequiredPermissionsResult>	Task of HasRequiredPermissionsResult

LinkProjectAsync(ProjectId, JiraProjectConfigId, CancellationToken)

Link a Unity project to a Jira ProjectConfig.

Declaration

Task LinkProjectAsync(ProjectId projectId, JiraProjectConfigId jiraProjectConfigId, CancellationToken cancellationToken = default)

Parameters

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

Returns

Type	Description
Task	Task of void

SearchUsersByOrganizationAsync(OrganizationId, JiraServerConfigId, string, CancellationToken)

Search users from Jira ServerConfig.

Declaration

Task<SearchTaskManagementUsersResult> SearchUsersByOrganizationAsync(OrganizationId organizationId, JiraServerConfigId jiraServerConfigId, string query = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
OrganizationId	organizationId	The organization id.
JiraServerConfigId	jiraServerConfigId	The Jira ServerConfig id.
string	query	The query to search for. (optional)
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<SearchTaskManagementUsersResult>	Task of SearchTaskManagementUsersResult

SearchUsersByProjectAsync(ProjectId, JiraServerConfigId, string, CancellationToken)

Search users from Jira ServerConfig.

Declaration

Task<SearchTaskManagementUsersResult> SearchUsersByProjectAsync(ProjectId projectId, JiraServerConfigId jiraServerConfigId, string query = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
ProjectId	projectId	The project id.
JiraServerConfigId	jiraServerConfigId	The Jira ServerConfig id.
string	query	The query to search for. (optional)
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<SearchTaskManagementUsersResult>	Task of SearchTaskManagementUsersResult

UnlinkProjectAsync(ProjectId, JiraProjectConfigId, CancellationToken)

Unlink a Unity project from a Jira ProjectConfig.

Declaration

Task UnlinkProjectAsync(ProjectId projectId, JiraProjectConfigId jiraProjectConfigId, CancellationToken cancellationToken = default)

Parameters

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

Returns

Type	Description
Task	Task of void