Class WorkExtensions

This holds all the work log related extension methods

Inheritance

System.Object

WorkExtensions

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 WorkExtensions

Methods

| Improve this Doc View Source

CreateAsync(IWorkDomain, String, Worklog, AdjustEstimate, String, CancellationToken)

Log work for the specified issue

Declaration

public static Task<Worklog> CreateAsync(this IWorkDomain jiraClient, string issueKey, Worklog worklog, AdjustEstimate adjustEstimate = AdjustEstimate.Auto, string adjustValue = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
IWorkDomain	jiraClient	IWorkDomain to bind the extension method to
System.String	issueKey	key for the issue
Worklog	worklog	Worklog with the work which needs to be logged
AdjustEstimate	adjustEstimate	allows you to provide specific instructions to update the remaining time estimate of the issue.
System.String	adjustValue	e.g. "2d". When "new" is selected for adjustEstimate the new value for the remaining estimate field. When "manual" is selected for adjustEstimate the amount to reduce the remaining estimate by.
System.Threading.CancellationToken	cancellationToken	CancellationToken

Returns

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

| Improve this Doc View Source

DeleteAsync(IWorkDomain, String, Worklog, AdjustEstimate, String, CancellationToken)

Delete the spefified Worklog

Declaration

public static Task DeleteAsync(this IWorkDomain jiraClient, string issueKey, Worklog worklog, AdjustEstimate adjustEstimate = AdjustEstimate.Auto, string adjustValue = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
IWorkDomain	jiraClient	IWorkDomain to bind the extension method to
System.String	issueKey	Key of the issue to delete to worklog for
Worklog	worklog	Worklog to delete
AdjustEstimate	adjustEstimate	allows you to provide specific instructions to update the remaining time estimate of the issue.
System.String	adjustValue	e.g. "2d". When "new" is selected for adjustEstimate the new value for the remaining estimate field. When "manual" is selected for adjustEstimate the amount to reduce the remaining estimate by.
System.Threading.CancellationToken	cancellationToken	CancellationToken

Returns

Type	Description
System.Threading.Tasks.Task

| Improve this Doc View Source

GetAsync(IWorkDomain, String, CancellationToken)

Get worklogs information

Declaration

public static Task<Worklogs> GetAsync(this IWorkDomain jiraClient, string issueKey, CancellationToken cancellationToken = null)

Parameters

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

Returns

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

| Improve this Doc View Source

UpdateAsync(IWorkDomain, String, Worklog, AdjustEstimate, String, CancellationToken)

Update work log for the specified issue

Declaration

public static Task UpdateAsync(this IWorkDomain jiraClient, string issueKey, Worklog worklog, AdjustEstimate adjustEstimate = AdjustEstimate.Auto, string adjustValue = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
IWorkDomain	jiraClient	IWorkDomain to bind the extension method to
System.String	issueKey	key for the issue
Worklog	worklog	Worklog with the work which needs to be updated
AdjustEstimate	adjustEstimate	allows you to provide specific instructions to update the remaining time estimate of the issue.
System.String	adjustValue	e.g. "2d". When "new" is selected for adjustEstimate the new value for the remaining estimate field. When "manual" is selected for adjustEstimate the amount to reduce the remaining estimate by.
System.Threading.CancellationToken	cancellationToken	CancellationToken

Returns

Type	Description
System.Threading.Tasks.Task