Class AgileExtensions

This holds all the issue related extensions methods

Inheritance

System.Object

AgileExtensions

Inherited Members

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace:Dapplo.Jira

Assembly:Dapplo.Jira.dll

Syntax

public static class AgileExtensions

Methods

| Improve this Doc View Source

CreateBoardAsync(IAgileDomain, Board, CancellationToken)

Creates a new board. Board name, type and filter Id is required. See create board

Declaration

public static Task<Board> CreateBoardAsync(this IAgileDomain jiraClient, Board board, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
IAgileDomain	jiraClient	IAgileDomain to bind the extension method to
Board	board	Board to create
System.Threading.CancellationToken	cancellationToken	CancellationToken

Returns

Type	Description
System.Threading.Tasks.Task<Board>

| Improve this Doc View Source

DeleteBoardAsync(IAgileDomain, Int64, CancellationToken)

Deletes the board. See delete board

Declaration

public static Task DeleteBoardAsync(this IAgileDomain jiraClient, long boardId, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
IAgileDomain	jiraClient	IAgileDomain to bind the extension method to
System.Int64	boardId	Id of the board to return
System.Threading.CancellationToken	cancellationToken	CancellationToken

Returns

Type	Description
System.Threading.Tasks.Task

| Improve this Doc View Source

GetBacklogAsync(IAgileDomain, Int64, Pageable, CancellationToken)

Get backlog of a board See get issues for backlog

Declaration

public static Task<SearchResult<AgileIssue>> GetBacklogAsync(this IAgileDomain jiraClient, long boardId, Pageable page = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
IAgileDomain	jiraClient	IAgileDomain to bind the extension method to
System.Int64	boardId	Id of the board to get the backlog for
Pageable	page	optional Pageable
System.Threading.CancellationToken	cancellationToken	CancellationToken

Returns

Type	Description
System.Threading.Tasks.Task<SearchResult<AgileIssue>>	Results with Sprint objects

| Improve this Doc View Source

GetBoardAsync(IAgileDomain, Int64, CancellationToken)

Returns the board for the given board Id. This board will only be returned if the user has permission to view it. See get board

Declaration

public static Task<Board> GetBoardAsync(this IAgileDomain jiraClient, long boardId, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
IAgileDomain	jiraClient	IAgileDomain to bind the extension method to
System.Int64	boardId	Id of the board to return
System.Threading.CancellationToken	cancellationToken	CancellationToken

Returns

Type	Description
System.Threading.Tasks.Task<Board>	Board

| Improve this Doc View Source

GetBoardConfigurationAsync(IAgileDomain, Int64, CancellationToken)

Get board configuration See get board configuration

Declaration

public static Task<BoardConfiguration> GetBoardConfigurationAsync(this IAgileDomain jiraClient, long boardId, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
IAgileDomain	jiraClient	IAgileDomain to bind the extension method to
System.Int64	boardId	Id of the board to get the sprints for
System.Threading.CancellationToken	cancellationToken	CancellationToken

Returns

Type	Description
System.Threading.Tasks.Task<BoardConfiguration>	BoardConfiguration

| Improve this Doc View Source

GetBoardsAsync(IAgileDomain, String, String, String, Pageable, CancellationToken)

Get all boards See get all boards

Declaration

public static Task<Results<Board>> GetBoardsAsync(this IAgileDomain jiraClient, string type = null, string name = null, string projectKeyOrId = null, Pageable page = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
IAgileDomain	jiraClient	IAgileDomain to bind the extension method to
System.String	type	Filters results to boards of the specified type. Valid values: scrum, kanban.
System.String	name	Filters results to boards that match or partially match the specified name.
System.String	projectKeyOrId	Filters results to boards that are relevant to a project. Relevance means that the jql filter defined in board contains a reference to a project.
Pageable	page	optional Pageable
System.Threading.CancellationToken	cancellationToken	CancellationToken

Returns

Type	Description
System.Threading.Tasks.Task<Results<Board>>	Results with Board objects

| Improve this Doc View Source

GetEpicAsync(IAgileDomain, Int64, CancellationToken)

Get an Epic See Get epic

Declaration

public static Task<Epic> GetEpicAsync(this IAgileDomain jiraClient, long epicId, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
IAgileDomain	jiraClient	IAgileDomain to bind the extension method to
System.Int64	epicId	Id of the epic to get
System.Threading.CancellationToken	cancellationToken	CancellationToken

Returns

Type	Description
System.Threading.Tasks.Task<Epic>	Epic

| Improve this Doc View Source

GetEpicsAsync(IAgileDomain, Int64, Pageable, CancellationToken)

Get all epics for a board See get epics on board

Declaration

public static Task<Results<Epic>> GetEpicsAsync(this IAgileDomain jiraClient, long boardId, Pageable page = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
IAgileDomain	jiraClient	IAgileDomain to bind the extension method to
System.Int64	boardId	Id of the board to get the epics for
Pageable	page	optional Pageable
System.Threading.CancellationToken	cancellationToken	CancellationToken

Returns

Type	Description
System.Threading.Tasks.Task<Results<Epic>>	Results with Epic objects

| Improve this Doc View Source

GetIssueAsync(IAgileDomain, String, CancellationToken)

Add comment to the specified issue See: https://docs.atlassian.com/jira/REST/latest/#d2e1139

Declaration

public static Task<AgileIssue> GetIssueAsync(this IAgileDomain jiraClient, string issueKey, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
IAgileDomain	jiraClient	IAgileDomain to bind the extension method to
System.String	issueKey	key for the issue
System.Threading.CancellationToken	cancellationToken	CancellationToken

Returns

Type	Description
System.Threading.Tasks.Task<AgileIssue>	AgileIssue

| Improve this Doc View Source

GetIssuesForEpicAsync(IAgileDomain, Int64, Pageable, CancellationToken)

Returns all issues that belong to the epic, for the given epic Id. This only includes issues that the user has permission to view. Issues returned from this resource include Agile fields, like sprint, closedSprints, flagged, and epic. By default, the returned issues are ordered by rank. See get issues for epic

Declaration

public static Task<SearchResult<AgileIssue>> GetIssuesForEpicAsync(this IAgileDomain jiraClient, long epicId, Pageable page = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
IAgileDomain	jiraClient	IAgileDomain to bind the extension method to
System.Int64	epicId	Id of the epic to get the issues for
Pageable	page	optional Pageable
System.Threading.CancellationToken	cancellationToken	CancellationToken

Returns

Type	Description
System.Threading.Tasks.Task<SearchResult<AgileIssue>>	SearchResult with AgileIssue objects

| Improve this Doc View Source

GetIssuesForEpicAsync(IAgileDomain, Int64, Int64, Pageable, CancellationToken)

Get all issues for an Epic See get issues for epic

Declaration

public static Task<SearchResult<AgileIssue>> GetIssuesForEpicAsync(this IAgileDomain jiraClient, long boardId, long epicId, Pageable page = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
IAgileDomain	jiraClient	IAgileDomain to bind the extension method to
System.Int64	boardId	Id of the board to get the issues for
System.Int64	epicId	Id of the epic to get the issues for
Pageable	page	optional Pageable
System.Threading.CancellationToken	cancellationToken	CancellationToken

Returns

Type	Description
System.Threading.Tasks.Task<SearchResult<AgileIssue>>	SearchResult with AgileIssue objects

| Improve this Doc View Source

GetIssuesInSprintAsync(IAgileDomain, Int64, Int64, Pageable, CancellationToken)

Get all issues for a spring See get issues for spring

Declaration

public static Task<SearchResult<AgileIssue>> GetIssuesInSprintAsync(this IAgileDomain jiraClient, long boardId, long sprintId, Pageable page = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
IAgileDomain	jiraClient	IAgileDomain to bind the extension method to
System.Int64	boardId	Id of the board to get the issues for
System.Int64	sprintId	Id of the sprint to get the issues for
Pageable	page	optional Pageable
System.Threading.CancellationToken	cancellationToken	CancellationToken

Returns

Type	Description
System.Threading.Tasks.Task<SearchResult<AgileIssue>>	SearchResult with AgileIssue objects

| Improve this Doc View Source

GetIssuesOnBoardAsync(IAgileDomain, Int64, Pageable, CancellationToken)

Get all issues on a board See get issues for board

Declaration

public static Task<SearchResult<AgileIssue>> GetIssuesOnBoardAsync(this IAgileDomain jiraClient, long boardId, Pageable page = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
IAgileDomain	jiraClient	IAgileDomain to bind the extension method to
System.Int64	boardId	Id of the board to get the issues for
Pageable	page	optional Pageable
System.Threading.CancellationToken	cancellationToken	CancellationToken

Returns

Type	Description
System.Threading.Tasks.Task<SearchResult<AgileIssue>>	SearchResult with AgileIssue objects

| Improve this Doc View Source

GetIssuesWithoutEpicAsync(IAgileDomain, Int64, Pageable, CancellationToken)

Get all issues without an Epic See get issues without epic

Declaration

public static Task<SearchResult<AgileIssue>> GetIssuesWithoutEpicAsync(this IAgileDomain jiraClient, long boardId, Pageable page = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
IAgileDomain	jiraClient	IAgileDomain to bind the extension method to
System.Int64	boardId	Id of the board to get the issues for
Pageable	page	optional Pageable
System.Threading.CancellationToken	cancellationToken	CancellationToken

Returns

Type	Description
System.Threading.Tasks.Task<SearchResult<AgileIssue>>	SearchResult with AgileIssue objects

| Improve this Doc View Source

GetSprintsAsync(IAgileDomain, Int64, String, Pageable, CancellationToken)

Get all sprints See: https://docs.atlassian.com/jira/REST/latest/#d2e1139

Declaration

public static Task<Results<Sprint>> GetSprintsAsync(this IAgileDomain jiraClient, long boardId, string stateFilter = null, Pageable page = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
IAgileDomain	jiraClient	IAgileDomain to bind the extension method to
System.Int64	boardId	Id of the board to get the sprints for
System.String	stateFilter	Filters results to sprints in specified states. Valid values: future, active, closed. You can define multiple states separated by commas, e.g. state=active,closed
Pageable	page	optional Pageable
System.Threading.CancellationToken	cancellationToken	CancellationToken

Returns

Type	Description
System.Threading.Tasks.Task<Results<Sprint>>	Results with Sprint objects

| Improve this Doc View Source

UpdateEpicAsync(IAgileDomain, Epic, CancellationToken)

Update an Epic See Partially update epic

Declaration

public static Task<Epic> UpdateEpicAsync(this IAgileDomain jiraClient, Epic epic, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
IAgileDomain	jiraClient	IAgileDomain to bind the extension method to
Epic	epic	Epic to update
System.Threading.CancellationToken	cancellationToken	CancellationToken

Returns

Type	Description
System.Threading.Tasks.Task<Epic>	Epic