Class ProjectExtensions
This holds all the project related extensions methods
Inheritance
Inherited Members
Namespace: Dapplo.Jira
Assembly: Dapplo.Jira.dll
Syntax
public static class ProjectExtensions
Methods
| Improve this Doc View SourceCreateComponentAsync(IProjectDomain, Component, CancellationToken)
Create a component, More information here
Declaration
public static Task<Component> CreateComponentAsync(this IProjectDomain jiraClient, Component component, CancellationToken cancellationToken = default(CancellationToken))
Parameters
Type | Name | Description |
---|---|---|
IProjectDomain | jiraClient | IProjectDomain to bind the extension method to |
Component | component | Component to create |
System.Threading.CancellationToken | cancellationToken | CancellationToken |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<Component> | Component with the details, like id |
DeleteComponentAsync(IProjectDomain, Int64, CancellationToken)
Delete a component More information here
Declaration
public static Task DeleteComponentAsync(this IProjectDomain jiraClient, long componentId, CancellationToken cancellationToken = default(CancellationToken))
Parameters
Type | Name | Description |
---|---|---|
IProjectDomain | jiraClient | IProjectDomain to bind the extension method to |
System.Int64 | componentId | long with id of the component to delete |
System.Threading.CancellationToken | cancellationToken | CancellationToken |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task |
GetAllAsync(IProjectDomain, Nullable<Int32>, CancellationToken)
Get all visible projects More information here
Declaration
public static Task<IList<ProjectDigest>> GetAllAsync(this IProjectDomain jiraClient, int? recent = default(int? ), CancellationToken cancellationToken = default(CancellationToken))
Parameters
Type | Name | Description |
---|---|---|
IProjectDomain | jiraClient | IProjectDomain to bind the extension method to |
System.Nullable<System.Int32> | recent | if this parameter is set then only projects recently accessed by the current user (if not logged in then based on HTTP session) will be returned (maximum count limited to the specified number but no more than 20). |
System.Threading.CancellationToken | cancellationToken | CancellationToken |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<System.Collections.Generic.IList<ProjectDigest>> | list of ProjectDigest |
GetAsync(IProjectDomain, String, CancellationToken)
Get projects information See: https://docs.atlassian.com/jira/REST/latest/#d2e2779
Declaration
public static Task<Project> GetAsync(this IProjectDomain jiraClient, string projectKey, CancellationToken cancellationToken = default(CancellationToken))
Parameters
Type | Name | Description |
---|---|---|
IProjectDomain | jiraClient | IProjectDomain to bind the extension method to |
System.String | projectKey | key of the project |
System.Threading.CancellationToken | cancellationToken | CancellationToken |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<Project> | ProjectDetails |
GetComponentAsync(IProjectDomain, Int64, CancellationToken)
Get component information More information here
Declaration
public static Task<Component> GetComponentAsync(this IProjectDomain jiraClient, long componentId, CancellationToken cancellationToken = default(CancellationToken))
Parameters
Type | Name | Description |
---|---|---|
IProjectDomain | jiraClient | IProjectDomain to bind the extension method to |
System.Int64 | componentId | long with ID of the component to retrieve |
System.Threading.CancellationToken | cancellationToken | CancellationToken |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<Component> | Component |
GetIssueCreatorsAsync(IProjectDomain, String, String, Nullable<Int32>, Nullable<Int32>, CancellationToken)
Retrieve the users who can create issues for the specified project
Declaration
public static Task<IEnumerable<User>> GetIssueCreatorsAsync(this IProjectDomain jiraClient, string projectKey, string userpattern = null, int? startAt = default(int? ), int? maxResults = default(int? ), CancellationToken cancellationToken = default(CancellationToken))
Parameters
Type | Name | Description |
---|---|---|
IProjectDomain | jiraClient | IProjectDomain |
System.String | projectKey | string with the key of the project |
System.String | userpattern | optional string with a pattern to match the user to |
System.Nullable<System.Int32> | startAt | optional int with the start, used for paging |
System.Nullable<System.Int32> | maxResults | optional int with the maximum number of results, default is 50 |
System.Threading.CancellationToken | cancellationToken | CancellationToken |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<User>> | IEnumerable with User |
UpdateComponentAsync(IProjectDomain, Component, CancellationToken)
Update a component, if Lead is an empty string ("") the component lead will be removed. More information here
Declaration
public static Task<Component> UpdateComponentAsync(this IProjectDomain jiraClient, Component component, CancellationToken cancellationToken = default(CancellationToken))
Parameters
Type | Name | Description |
---|---|---|
IProjectDomain | jiraClient | IProjectDomain to bind the extension method to |
Component | component | Component to update |
System.Threading.CancellationToken | cancellationToken | CancellationToken |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<Component> | Component |