Class IssueClient
Inheritance
Inherited Members
Namespace: Dangl.GiteaOrgManager.Client
Assembly: Dangl.GiteaOrgManager.dll
Syntax
public class IssueClient
Constructors
| Improve this Doc View SourceIssueClient(String, HttpClient)
Declaration
public IssueClient(string baseUrl, HttpClient httpClient)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | baseUrl | |
| System.Net.Http.HttpClient | httpClient |
Properties
| Improve this Doc View SourceBaseUrl
Declaration
public string BaseUrl { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String |
JsonSerializerSettings
Declaration
protected Newtonsoft.Json.JsonSerializerSettings JsonSerializerSettings { get; }
Property Value
| Type | Description |
|---|---|
| Newtonsoft.Json.JsonSerializerSettings |
ReadResponseAsString
Declaration
public bool ReadResponseAsString { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Boolean |
Methods
| Improve this Doc View SourceIssueAddLabelAsync(String, String, Int64, IssueLabelsOption)
Add a label to an issue
Declaration
public virtual Task<ICollection<Label>> IssueAddLabelAsync(string owner, string repo, long index, IssueLabelsOption body)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | owner | owner of the repo |
| System.String | repo | name of the repo |
| System.Int64 | index | index of the issue |
| IssueLabelsOption | body |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<System.Collections.Generic.ICollection<Label>> | LabelList |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
IssueAddLabelAsync(String, String, Int64, IssueLabelsOption, CancellationToken)
Add a label to an issue
Declaration
public virtual async Task<ICollection<Label>> IssueAddLabelAsync(string owner, string repo, long index, IssueLabelsOption body, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | owner | owner of the repo |
| System.String | repo | name of the repo |
| System.Int64 | index | index of the issue |
| IssueLabelsOption | body | |
| System.Threading.CancellationToken | cancellationToken | A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<System.Collections.Generic.ICollection<Label>> | LabelList |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
IssueAddSubscriptionAsync(String, String, Int64, String)
Subscribe user to issue
Declaration
public virtual Task IssueAddSubscriptionAsync(string owner, string repo, long index, string user)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | owner | owner of the repo |
| System.String | repo | name of the repo |
| System.Int64 | index | index of the issue |
| System.String | user | user to subscribe |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task | Already subscribed |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
IssueAddSubscriptionAsync(String, String, Int64, String, CancellationToken)
Subscribe user to issue
Declaration
public virtual async Task IssueAddSubscriptionAsync(string owner, string repo, long index, string user, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | owner | owner of the repo |
| System.String | repo | name of the repo |
| System.Int64 | index | index of the issue |
| System.String | user | user to subscribe |
| System.Threading.CancellationToken | cancellationToken | A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task | Already subscribed |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
IssueAddTimeAsync(String, String, Int64, AddTimeOption)
Add tracked time to a issue
Declaration
public virtual Task<TrackedTime> IssueAddTimeAsync(string owner, string repo, long index, AddTimeOption body)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | owner | owner of the repo |
| System.String | repo | name of the repo |
| System.Int64 | index | index of the issue |
| AddTimeOption | body |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<TrackedTime> | TrackedTime |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
IssueAddTimeAsync(String, String, Int64, AddTimeOption, CancellationToken)
Add tracked time to a issue
Declaration
public virtual async Task<TrackedTime> IssueAddTimeAsync(string owner, string repo, long index, AddTimeOption body, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | owner | owner of the repo |
| System.String | repo | name of the repo |
| System.Int64 | index | index of the issue |
| AddTimeOption | body | |
| System.Threading.CancellationToken | cancellationToken | A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<TrackedTime> | TrackedTime |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
IssueCheckSubscriptionAsync(String, String, Int64)
Check if user is subscribed to an issue
Declaration
public virtual Task<WatchInfo> IssueCheckSubscriptionAsync(string owner, string repo, long index)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | owner | owner of the repo |
| System.String | repo | name of the repo |
| System.Int64 | index | index of the issue |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<WatchInfo> | WatchInfo |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
IssueCheckSubscriptionAsync(String, String, Int64, CancellationToken)
Check if user is subscribed to an issue
Declaration
public virtual async Task<WatchInfo> IssueCheckSubscriptionAsync(string owner, string repo, long index, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | owner | owner of the repo |
| System.String | repo | name of the repo |
| System.Int64 | index | index of the issue |
| System.Threading.CancellationToken | cancellationToken | A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<WatchInfo> | WatchInfo |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
IssueClearLabelsAsync(String, String, Int64)
Remove all labels from an issue
Declaration
public virtual Task IssueClearLabelsAsync(string owner, string repo, long index)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | owner | owner of the repo |
| System.String | repo | name of the repo |
| System.Int64 | index | index of the issue |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task | APIEmpty is an empty response |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
IssueClearLabelsAsync(String, String, Int64, CancellationToken)
Remove all labels from an issue
Declaration
public virtual async Task IssueClearLabelsAsync(string owner, string repo, long index, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | owner | owner of the repo |
| System.String | repo | name of the repo |
| System.Int64 | index | index of the issue |
| System.Threading.CancellationToken | cancellationToken | A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task | APIEmpty is an empty response |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
IssueCreateCommentAsync(String, String, Int64, CreateIssueCommentOption)
Add a comment to an issue
Declaration
public virtual Task<Comment> IssueCreateCommentAsync(string owner, string repo, long index, CreateIssueCommentOption body)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | owner | owner of the repo |
| System.String | repo | name of the repo |
| System.Int64 | index | index of the issue |
| CreateIssueCommentOption | body |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<Comment> | Comment |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
IssueCreateCommentAsync(String, String, Int64, CreateIssueCommentOption, CancellationToken)
Add a comment to an issue
Declaration
public virtual async Task<Comment> IssueCreateCommentAsync(string owner, string repo, long index, CreateIssueCommentOption body, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | owner | owner of the repo |
| System.String | repo | name of the repo |
| System.Int64 | index | index of the issue |
| CreateIssueCommentOption | body | |
| System.Threading.CancellationToken | cancellationToken | A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<Comment> | Comment |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
IssueCreateIssueAsync(String, String, CreateIssueOption)
Create an issue. If using deadline only the date will be taken into account, and time of day ignored.
Declaration
public virtual Task<Issue> IssueCreateIssueAsync(string owner, string repo, CreateIssueOption body)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | owner | owner of the repo |
| System.String | repo | name of the repo |
| CreateIssueOption | body |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<Issue> | Issue |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
IssueCreateIssueAsync(String, String, CreateIssueOption, CancellationToken)
Create an issue. If using deadline only the date will be taken into account, and time of day ignored.
Declaration
public virtual async Task<Issue> IssueCreateIssueAsync(string owner, string repo, CreateIssueOption body, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | owner | owner of the repo |
| System.String | repo | name of the repo |
| CreateIssueOption | body | |
| System.Threading.CancellationToken | cancellationToken | A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<Issue> | Issue |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
IssueCreateIssueAttachmentAsync(String, String, Int64, String, FileParameter)
Create an issue attachment
Declaration
public virtual Task<Attachment> IssueCreateIssueAttachmentAsync(string owner, string repo, long index, string name, FileParameter attachment)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | owner | owner of the repo |
| System.String | repo | name of the repo |
| System.Int64 | index | index of the issue |
| System.String | name | name of the attachment |
| FileParameter | attachment | attachment to upload |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<Attachment> | Attachment |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
IssueCreateIssueAttachmentAsync(String, String, Int64, String, FileParameter, CancellationToken)
Create an issue attachment
Declaration
public virtual async Task<Attachment> IssueCreateIssueAttachmentAsync(string owner, string repo, long index, string name, FileParameter attachment, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | owner | owner of the repo |
| System.String | repo | name of the repo |
| System.Int64 | index | index of the issue |
| System.String | name | name of the attachment |
| FileParameter | attachment | attachment to upload |
| System.Threading.CancellationToken | cancellationToken | A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<Attachment> | Attachment |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
IssueCreateIssueBlockingAsync(String, String, String, IssueMeta)
Block the issue given in the body by the issue in path
Declaration
public virtual Task<Issue> IssueCreateIssueBlockingAsync(string owner, string repo, string index, IssueMeta body)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | owner | owner of the repo |
| System.String | repo | name of the repo |
| System.String | index | index of the issue |
| IssueMeta | body |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<Issue> | Issue |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
IssueCreateIssueBlockingAsync(String, String, String, IssueMeta, CancellationToken)
Block the issue given in the body by the issue in path
Declaration
public virtual async Task<Issue> IssueCreateIssueBlockingAsync(string owner, string repo, string index, IssueMeta body, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | owner | owner of the repo |
| System.String | repo | name of the repo |
| System.String | index | index of the issue |
| IssueMeta | body | |
| System.Threading.CancellationToken | cancellationToken | A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<Issue> | Issue |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
IssueCreateIssueCommentAttachmentAsync(String, String, Int64, String, FileParameter)
Create a comment attachment
Declaration
public virtual Task<Attachment> IssueCreateIssueCommentAttachmentAsync(string owner, string repo, long id, string name, FileParameter attachment)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | owner | owner of the repo |
| System.String | repo | name of the repo |
| System.Int64 | id | id of the comment |
| System.String | name | name of the attachment |
| FileParameter | attachment | attachment to upload |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<Attachment> | Attachment |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
IssueCreateIssueCommentAttachmentAsync(String, String, Int64, String, FileParameter, CancellationToken)
Create a comment attachment
Declaration
public virtual async Task<Attachment> IssueCreateIssueCommentAttachmentAsync(string owner, string repo, long id, string name, FileParameter attachment, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | owner | owner of the repo |
| System.String | repo | name of the repo |
| System.Int64 | id | id of the comment |
| System.String | name | name of the attachment |
| FileParameter | attachment | attachment to upload |
| System.Threading.CancellationToken | cancellationToken | A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<Attachment> | Attachment |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
IssueCreateIssueDependenciesAsync(String, String, String, IssueMeta)
Make the issue in the url depend on the issue in the form.
Declaration
public virtual Task<Issue> IssueCreateIssueDependenciesAsync(string owner, string repo, string index, IssueMeta body)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | owner | owner of the repo |
| System.String | repo | name of the repo |
| System.String | index | index of the issue |
| IssueMeta | body |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<Issue> | Issue |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
IssueCreateIssueDependenciesAsync(String, String, String, IssueMeta, CancellationToken)
Make the issue in the url depend on the issue in the form.
Declaration
public virtual async Task<Issue> IssueCreateIssueDependenciesAsync(string owner, string repo, string index, IssueMeta body, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | owner | owner of the repo |
| System.String | repo | name of the repo |
| System.String | index | index of the issue |
| IssueMeta | body | |
| System.Threading.CancellationToken | cancellationToken | A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<Issue> | Issue |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
IssueCreateLabelAsync(String, String, CreateLabelOption)
Create a label
Declaration
public virtual Task<Label> IssueCreateLabelAsync(string owner, string repo, CreateLabelOption body)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | owner | owner of the repo |
| System.String | repo | name of the repo |
| CreateLabelOption | body |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<Label> | Label |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
IssueCreateLabelAsync(String, String, CreateLabelOption, CancellationToken)
Create a label
Declaration
public virtual async Task<Label> IssueCreateLabelAsync(string owner, string repo, CreateLabelOption body, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | owner | owner of the repo |
| System.String | repo | name of the repo |
| CreateLabelOption | body | |
| System.Threading.CancellationToken | cancellationToken | A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<Label> | Label |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
IssueCreateMilestoneAsync(String, String, CreateMilestoneOption)
Create a milestone
Declaration
public virtual Task<Milestone> IssueCreateMilestoneAsync(string owner, string repo, CreateMilestoneOption body)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | owner | owner of the repo |
| System.String | repo | name of the repo |
| CreateMilestoneOption | body |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<Milestone> | Milestone |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
IssueCreateMilestoneAsync(String, String, CreateMilestoneOption, CancellationToken)
Create a milestone
Declaration
public virtual async Task<Milestone> IssueCreateMilestoneAsync(string owner, string repo, CreateMilestoneOption body, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | owner | owner of the repo |
| System.String | repo | name of the repo |
| CreateMilestoneOption | body | |
| System.Threading.CancellationToken | cancellationToken | A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<Milestone> | Milestone |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
IssueDeleteAsync(String, String, Int64)
Delete an issue
Declaration
public virtual Task IssueDeleteAsync(string owner, string repo, long index)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | owner | owner of the repo |
| System.String | repo | name of the repo |
| System.Int64 | index | index of issue to delete |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task | APIEmpty is an empty response |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
IssueDeleteAsync(String, String, Int64, CancellationToken)
Delete an issue
Declaration
public virtual async Task IssueDeleteAsync(string owner, string repo, long index, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | owner | owner of the repo |
| System.String | repo | name of the repo |
| System.Int64 | index | index of issue to delete |
| System.Threading.CancellationToken | cancellationToken | A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task | APIEmpty is an empty response |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
IssueDeleteCommentAsync(String, String, Int64)
Delete a comment
Declaration
public virtual Task IssueDeleteCommentAsync(string owner, string repo, long id)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | owner | owner of the repo |
| System.String | repo | name of the repo |
| System.Int64 | id | id of comment to delete |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task | APIEmpty is an empty response |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
IssueDeleteCommentAsync(String, String, Int64, CancellationToken)
Delete a comment
Declaration
public virtual async Task IssueDeleteCommentAsync(string owner, string repo, long id, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | owner | owner of the repo |
| System.String | repo | name of the repo |
| System.Int64 | id | id of comment to delete |
| System.Threading.CancellationToken | cancellationToken | A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task | APIEmpty is an empty response |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
IssueDeleteCommentDeprecatedAsync(String, String, Int32, Int64)
Delete a comment
Declaration
[Obsolete]
public virtual Task IssueDeleteCommentDeprecatedAsync(string owner, string repo, int index, long id)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | owner | owner of the repo |
| System.String | repo | name of the repo |
| System.Int32 | index | this parameter is ignored |
| System.Int64 | id | id of comment to delete |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task | APIEmpty is an empty response |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
IssueDeleteCommentDeprecatedAsync(String, String, Int32, Int64, CancellationToken)
Delete a comment
Declaration
[Obsolete]
public virtual async Task IssueDeleteCommentDeprecatedAsync(string owner, string repo, int index, long id, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | owner | owner of the repo |
| System.String | repo | name of the repo |
| System.Int32 | index | this parameter is ignored |
| System.Int64 | id | id of comment to delete |
| System.Threading.CancellationToken | cancellationToken | A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task | APIEmpty is an empty response |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
IssueDeleteCommentReactionAsync(String, String, Int64, EditReactionOption)
Remove a reaction from a comment of an issue
Declaration
public virtual Task IssueDeleteCommentReactionAsync(string owner, string repo, long id, EditReactionOption content)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | owner | owner of the repo |
| System.String | repo | name of the repo |
| System.Int64 | id | id of the comment to edit |
| EditReactionOption | content |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task | APIEmpty is an empty response |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
IssueDeleteCommentReactionAsync(String, String, Int64, EditReactionOption, CancellationToken)
Remove a reaction from a comment of an issue
Declaration
public virtual async Task IssueDeleteCommentReactionAsync(string owner, string repo, long id, EditReactionOption content, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | owner | owner of the repo |
| System.String | repo | name of the repo |
| System.Int64 | id | id of the comment to edit |
| EditReactionOption | content | |
| System.Threading.CancellationToken | cancellationToken | A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task | APIEmpty is an empty response |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
IssueDeleteIssueAttachmentAsync(String, String, Int64, Int64)
Delete an issue attachment
Declaration
public virtual Task IssueDeleteIssueAttachmentAsync(string owner, string repo, long index, long attachment_id)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | owner | owner of the repo |
| System.String | repo | name of the repo |
| System.Int64 | index | index of the issue |
| System.Int64 | attachment_id | id of the attachment to delete |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task | APIEmpty is an empty response |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
IssueDeleteIssueAttachmentAsync(String, String, Int64, Int64, CancellationToken)
Delete an issue attachment
Declaration
public virtual async Task IssueDeleteIssueAttachmentAsync(string owner, string repo, long index, long attachment_id, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | owner | owner of the repo |
| System.String | repo | name of the repo |
| System.Int64 | index | index of the issue |
| System.Int64 | attachment_id | id of the attachment to delete |
| System.Threading.CancellationToken | cancellationToken | A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task | APIEmpty is an empty response |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
IssueDeleteIssueCommentAttachmentAsync(String, String, Int64, Int64)
Delete a comment attachment
Declaration
public virtual Task IssueDeleteIssueCommentAttachmentAsync(string owner, string repo, long id, long attachment_id)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | owner | owner of the repo |
| System.String | repo | name of the repo |
| System.Int64 | id | id of the comment |
| System.Int64 | attachment_id | id of the attachment to delete |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task | APIEmpty is an empty response |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
IssueDeleteIssueCommentAttachmentAsync(String, String, Int64, Int64, CancellationToken)
Delete a comment attachment
Declaration
public virtual async Task IssueDeleteIssueCommentAttachmentAsync(string owner, string repo, long id, long attachment_id, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | owner | owner of the repo |
| System.String | repo | name of the repo |
| System.Int64 | id | id of the comment |
| System.Int64 | attachment_id | id of the attachment to delete |
| System.Threading.CancellationToken | cancellationToken | A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task | APIEmpty is an empty response |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
IssueDeleteIssueReactionAsync(String, String, Int64, EditReactionOption)
Remove a reaction from an issue
Declaration
public virtual Task IssueDeleteIssueReactionAsync(string owner, string repo, long index, EditReactionOption content)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | owner | owner of the repo |
| System.String | repo | name of the repo |
| System.Int64 | index | index of the issue |
| EditReactionOption | content |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task | APIEmpty is an empty response |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
IssueDeleteIssueReactionAsync(String, String, Int64, EditReactionOption, CancellationToken)
Remove a reaction from an issue
Declaration
public virtual async Task IssueDeleteIssueReactionAsync(string owner, string repo, long index, EditReactionOption content, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | owner | owner of the repo |
| System.String | repo | name of the repo |
| System.Int64 | index | index of the issue |
| EditReactionOption | content | |
| System.Threading.CancellationToken | cancellationToken | A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task | APIEmpty is an empty response |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
IssueDeleteLabelAsync(String, String, Int64)
Delete a label
Declaration
public virtual Task IssueDeleteLabelAsync(string owner, string repo, long id)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | owner | owner of the repo |
| System.String | repo | name of the repo |
| System.Int64 | id | id of the label to delete |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task | APIEmpty is an empty response |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
IssueDeleteLabelAsync(String, String, Int64, CancellationToken)
Delete a label
Declaration
public virtual async Task IssueDeleteLabelAsync(string owner, string repo, long id, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | owner | owner of the repo |
| System.String | repo | name of the repo |
| System.Int64 | id | id of the label to delete |
| System.Threading.CancellationToken | cancellationToken | A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task | APIEmpty is an empty response |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
IssueDeleteMilestoneAsync(String, String, String)
Delete a milestone
Declaration
public virtual Task IssueDeleteMilestoneAsync(string owner, string repo, string id)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | owner | owner of the repo |
| System.String | repo | name of the repo |
| System.String | id | the milestone to delete, identified by ID and if not available by name |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task | APIEmpty is an empty response |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
IssueDeleteMilestoneAsync(String, String, String, CancellationToken)
Delete a milestone
Declaration
public virtual async Task IssueDeleteMilestoneAsync(string owner, string repo, string id, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | owner | owner of the repo |
| System.String | repo | name of the repo |
| System.String | id | the milestone to delete, identified by ID and if not available by name |
| System.Threading.CancellationToken | cancellationToken | A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task | APIEmpty is an empty response |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
IssueDeleteStopWatchAsync(String, String, Int64)
Delete an issue's existing stopwatch.
Declaration
public virtual Task IssueDeleteStopWatchAsync(string owner, string repo, long index)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | owner | owner of the repo |
| System.String | repo | name of the repo |
| System.Int64 | index | index of the issue to stop the stopwatch on |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task | APIEmpty is an empty response |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
IssueDeleteStopWatchAsync(String, String, Int64, CancellationToken)
Delete an issue's existing stopwatch.
Declaration
public virtual async Task IssueDeleteStopWatchAsync(string owner, string repo, long index, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | owner | owner of the repo |
| System.String | repo | name of the repo |
| System.Int64 | index | index of the issue to stop the stopwatch on |
| System.Threading.CancellationToken | cancellationToken | A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task | APIEmpty is an empty response |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
IssueDeleteSubscriptionAsync(String, String, Int64, String)
Unsubscribe user from issue
Declaration
public virtual Task IssueDeleteSubscriptionAsync(string owner, string repo, long index, string user)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | owner | owner of the repo |
| System.String | repo | name of the repo |
| System.Int64 | index | index of the issue |
| System.String | user | user witch unsubscribe |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task | Already unsubscribed |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
IssueDeleteSubscriptionAsync(String, String, Int64, String, CancellationToken)
Unsubscribe user from issue
Declaration
public virtual async Task IssueDeleteSubscriptionAsync(string owner, string repo, long index, string user, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | owner | owner of the repo |
| System.String | repo | name of the repo |
| System.Int64 | index | index of the issue |
| System.String | user | user witch unsubscribe |
| System.Threading.CancellationToken | cancellationToken | A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task | Already unsubscribed |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
IssueDeleteTimeAsync(String, String, Int64, Int64)
Delete specific tracked time
Declaration
public virtual Task IssueDeleteTimeAsync(string owner, string repo, long index, long id)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | owner | owner of the repo |
| System.String | repo | name of the repo |
| System.Int64 | index | index of the issue |
| System.Int64 | id | id of time to delete |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task | APIEmpty is an empty response |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
IssueDeleteTimeAsync(String, String, Int64, Int64, CancellationToken)
Delete specific tracked time
Declaration
public virtual async Task IssueDeleteTimeAsync(string owner, string repo, long index, long id, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | owner | owner of the repo |
| System.String | repo | name of the repo |
| System.Int64 | index | index of the issue |
| System.Int64 | id | id of time to delete |
| System.Threading.CancellationToken | cancellationToken | A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task | APIEmpty is an empty response |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
IssueEditCommentAsync(String, String, Int64, EditIssueCommentOption)
Edit a comment
Declaration
public virtual Task<Comment> IssueEditCommentAsync(string owner, string repo, long id, EditIssueCommentOption body)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | owner | owner of the repo |
| System.String | repo | name of the repo |
| System.Int64 | id | id of the comment to edit |
| EditIssueCommentOption | body |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<Comment> | Comment |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
IssueEditCommentAsync(String, String, Int64, EditIssueCommentOption, CancellationToken)
Edit a comment
Declaration
public virtual async Task<Comment> IssueEditCommentAsync(string owner, string repo, long id, EditIssueCommentOption body, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | owner | owner of the repo |
| System.String | repo | name of the repo |
| System.Int64 | id | id of the comment to edit |
| EditIssueCommentOption | body | |
| System.Threading.CancellationToken | cancellationToken | A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<Comment> | Comment |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
IssueEditCommentDeprecatedAsync(String, String, Int32, Int64, EditIssueCommentOption)
Edit a comment
Declaration
[Obsolete]
public virtual Task<Comment> IssueEditCommentDeprecatedAsync(string owner, string repo, int index, long id, EditIssueCommentOption body)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | owner | owner of the repo |
| System.String | repo | name of the repo |
| System.Int32 | index | this parameter is ignored |
| System.Int64 | id | id of the comment to edit |
| EditIssueCommentOption | body |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<Comment> | Comment |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
IssueEditCommentDeprecatedAsync(String, String, Int32, Int64, EditIssueCommentOption, CancellationToken)
Edit a comment
Declaration
[Obsolete]
public virtual async Task<Comment> IssueEditCommentDeprecatedAsync(string owner, string repo, int index, long id, EditIssueCommentOption body, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | owner | owner of the repo |
| System.String | repo | name of the repo |
| System.Int32 | index | this parameter is ignored |
| System.Int64 | id | id of the comment to edit |
| EditIssueCommentOption | body | |
| System.Threading.CancellationToken | cancellationToken | A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<Comment> | Comment |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
IssueEditIssueAsync(String, String, Int64, EditIssueOption)
Edit an issue. If using deadline only the date will be taken into account, and time of day ignored.
Declaration
public virtual Task<Issue> IssueEditIssueAsync(string owner, string repo, long index, EditIssueOption body)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | owner | owner of the repo |
| System.String | repo | name of the repo |
| System.Int64 | index | index of the issue to edit |
| EditIssueOption | body |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<Issue> | Issue |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
IssueEditIssueAsync(String, String, Int64, EditIssueOption, CancellationToken)
Edit an issue. If using deadline only the date will be taken into account, and time of day ignored.
Declaration
public virtual async Task<Issue> IssueEditIssueAsync(string owner, string repo, long index, EditIssueOption body, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | owner | owner of the repo |
| System.String | repo | name of the repo |
| System.Int64 | index | index of the issue to edit |
| EditIssueOption | body | |
| System.Threading.CancellationToken | cancellationToken | A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<Issue> | Issue |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
IssueEditIssueAttachmentAsync(String, String, Int64, Int64, EditAttachmentOptions)
Edit an issue attachment
Declaration
public virtual Task<Attachment> IssueEditIssueAttachmentAsync(string owner, string repo, long index, long attachment_id, EditAttachmentOptions body)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | owner | owner of the repo |
| System.String | repo | name of the repo |
| System.Int64 | index | index of the issue |
| System.Int64 | attachment_id | id of the attachment to edit |
| EditAttachmentOptions | body |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<Attachment> | Attachment |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
IssueEditIssueAttachmentAsync(String, String, Int64, Int64, EditAttachmentOptions, CancellationToken)
Edit an issue attachment
Declaration
public virtual async Task<Attachment> IssueEditIssueAttachmentAsync(string owner, string repo, long index, long attachment_id, EditAttachmentOptions body, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | owner | owner of the repo |
| System.String | repo | name of the repo |
| System.Int64 | index | index of the issue |
| System.Int64 | attachment_id | id of the attachment to edit |
| EditAttachmentOptions | body | |
| System.Threading.CancellationToken | cancellationToken | A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<Attachment> | Attachment |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
IssueEditIssueCommentAttachmentAsync(String, String, Int64, Int64, EditAttachmentOptions)
Edit a comment attachment
Declaration
public virtual Task<Attachment> IssueEditIssueCommentAttachmentAsync(string owner, string repo, long id, long attachment_id, EditAttachmentOptions body)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | owner | owner of the repo |
| System.String | repo | name of the repo |
| System.Int64 | id | id of the comment |
| System.Int64 | attachment_id | id of the attachment to edit |
| EditAttachmentOptions | body |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<Attachment> | Attachment |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
IssueEditIssueCommentAttachmentAsync(String, String, Int64, Int64, EditAttachmentOptions, CancellationToken)
Edit a comment attachment
Declaration
public virtual async Task<Attachment> IssueEditIssueCommentAttachmentAsync(string owner, string repo, long id, long attachment_id, EditAttachmentOptions body, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | owner | owner of the repo |
| System.String | repo | name of the repo |
| System.Int64 | id | id of the comment |
| System.Int64 | attachment_id | id of the attachment to edit |
| EditAttachmentOptions | body | |
| System.Threading.CancellationToken | cancellationToken | A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<Attachment> | Attachment |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
IssueEditIssueDeadlineAsync(String, String, Int64, EditDeadlineOption)
Set an issue deadline. If set to null, the deadline is deleted. If using deadline only the date will be taken into account, and time of day ignored.
Declaration
public virtual Task<IssueDeadline> IssueEditIssueDeadlineAsync(string owner, string repo, long index, EditDeadlineOption body)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | owner | owner of the repo |
| System.String | repo | name of the repo |
| System.Int64 | index | index of the issue to create or update a deadline on |
| EditDeadlineOption | body |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<IssueDeadline> | IssueDeadline |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
IssueEditIssueDeadlineAsync(String, String, Int64, EditDeadlineOption, CancellationToken)
Set an issue deadline. If set to null, the deadline is deleted. If using deadline only the date will be taken into account, and time of day ignored.
Declaration
public virtual async Task<IssueDeadline> IssueEditIssueDeadlineAsync(string owner, string repo, long index, EditDeadlineOption body, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | owner | owner of the repo |
| System.String | repo | name of the repo |
| System.Int64 | index | index of the issue to create or update a deadline on |
| EditDeadlineOption | body | |
| System.Threading.CancellationToken | cancellationToken | A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<IssueDeadline> | IssueDeadline |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
IssueEditLabelAsync(String, String, Int64, EditLabelOption)
Update a label
Declaration
public virtual Task<Label> IssueEditLabelAsync(string owner, string repo, long id, EditLabelOption body)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | owner | owner of the repo |
| System.String | repo | name of the repo |
| System.Int64 | id | id of the label to edit |
| EditLabelOption | body |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<Label> | Label |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
IssueEditLabelAsync(String, String, Int64, EditLabelOption, CancellationToken)
Update a label
Declaration
public virtual async Task<Label> IssueEditLabelAsync(string owner, string repo, long id, EditLabelOption body, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | owner | owner of the repo |
| System.String | repo | name of the repo |
| System.Int64 | id | id of the label to edit |
| EditLabelOption | body | |
| System.Threading.CancellationToken | cancellationToken | A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<Label> | Label |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
IssueEditMilestoneAsync(String, String, String, EditMilestoneOption)
Update a milestone
Declaration
public virtual Task<Milestone> IssueEditMilestoneAsync(string owner, string repo, string id, EditMilestoneOption body)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | owner | owner of the repo |
| System.String | repo | name of the repo |
| System.String | id | the milestone to edit, identified by ID and if not available by name |
| EditMilestoneOption | body |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<Milestone> | Milestone |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
IssueEditMilestoneAsync(String, String, String, EditMilestoneOption, CancellationToken)
Update a milestone
Declaration
public virtual async Task<Milestone> IssueEditMilestoneAsync(string owner, string repo, string id, EditMilestoneOption body, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | owner | owner of the repo |
| System.String | repo | name of the repo |
| System.String | id | the milestone to edit, identified by ID and if not available by name |
| EditMilestoneOption | body | |
| System.Threading.CancellationToken | cancellationToken | A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<Milestone> | Milestone |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
IssueGetCommentAsync(String, String, Int64)
Get a comment
Declaration
public virtual Task<Comment> IssueGetCommentAsync(string owner, string repo, long id)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | owner | owner of the repo |
| System.String | repo | name of the repo |
| System.Int64 | id | id of the comment |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<Comment> | Comment |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
IssueGetCommentAsync(String, String, Int64, CancellationToken)
Get a comment
Declaration
public virtual async Task<Comment> IssueGetCommentAsync(string owner, string repo, long id, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | owner | owner of the repo |
| System.String | repo | name of the repo |
| System.Int64 | id | id of the comment |
| System.Threading.CancellationToken | cancellationToken | A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<Comment> | Comment |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
IssueGetCommentReactionsAsync(String, String, Int64)
Get a list of reactions from a comment of an issue
Declaration
public virtual Task<ICollection<Reaction>> IssueGetCommentReactionsAsync(string owner, string repo, long id)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | owner | owner of the repo |
| System.String | repo | name of the repo |
| System.Int64 | id | id of the comment to edit |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<System.Collections.Generic.ICollection<Reaction>> | ReactionList |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
IssueGetCommentReactionsAsync(String, String, Int64, CancellationToken)
Get a list of reactions from a comment of an issue
Declaration
public virtual async Task<ICollection<Reaction>> IssueGetCommentReactionsAsync(string owner, string repo, long id, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | owner | owner of the repo |
| System.String | repo | name of the repo |
| System.Int64 | id | id of the comment to edit |
| System.Threading.CancellationToken | cancellationToken | A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<System.Collections.Generic.ICollection<Reaction>> | ReactionList |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
IssueGetCommentsAndTimelineAsync(String, String, Int64, Nullable<DateTimeOffset>, Nullable<Int32>, Nullable<Int32>, Nullable<DateTimeOffset>)
List all comments and events on an issue
Declaration
public virtual Task<ICollection<TimelineComment>> IssueGetCommentsAndTimelineAsync(string owner, string repo, long index, DateTimeOffset? since, int? page, int? limit, DateTimeOffset? before)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | owner | owner of the repo |
| System.String | repo | name of the repo |
| System.Int64 | index | index of the issue |
| System.Nullable<System.DateTimeOffset> | since | if provided, only comments updated since the specified time are returned. |
| System.Nullable<System.Int32> | page | page number of results to return (1-based) |
| System.Nullable<System.Int32> | limit | page size of results |
| System.Nullable<System.DateTimeOffset> | before | if provided, only comments updated before the provided time are returned. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<System.Collections.Generic.ICollection<TimelineComment>> | TimelineList |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
IssueGetCommentsAndTimelineAsync(String, String, Int64, Nullable<DateTimeOffset>, Nullable<Int32>, Nullable<Int32>, Nullable<DateTimeOffset>, CancellationToken)
List all comments and events on an issue
Declaration
public virtual async Task<ICollection<TimelineComment>> IssueGetCommentsAndTimelineAsync(string owner, string repo, long index, DateTimeOffset? since, int? page, int? limit, DateTimeOffset? before, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | owner | owner of the repo |
| System.String | repo | name of the repo |
| System.Int64 | index | index of the issue |
| System.Nullable<System.DateTimeOffset> | since | if provided, only comments updated since the specified time are returned. |
| System.Nullable<System.Int32> | page | page number of results to return (1-based) |
| System.Nullable<System.Int32> | limit | page size of results |
| System.Nullable<System.DateTimeOffset> | before | if provided, only comments updated before the provided time are returned. |
| System.Threading.CancellationToken | cancellationToken | A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<System.Collections.Generic.ICollection<TimelineComment>> | TimelineList |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
IssueGetCommentsAsync(String, String, Int64, Nullable<DateTimeOffset>, Nullable<DateTimeOffset>)
List all comments on an issue
Declaration
public virtual Task<ICollection<Comment>> IssueGetCommentsAsync(string owner, string repo, long index, DateTimeOffset? since, DateTimeOffset? before)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | owner | owner of the repo |
| System.String | repo | name of the repo |
| System.Int64 | index | index of the issue |
| System.Nullable<System.DateTimeOffset> | since | if provided, only comments updated since the specified time are returned. |
| System.Nullable<System.DateTimeOffset> | before | if provided, only comments updated before the provided time are returned. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<System.Collections.Generic.ICollection<Comment>> | CommentList |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
IssueGetCommentsAsync(String, String, Int64, Nullable<DateTimeOffset>, Nullable<DateTimeOffset>, CancellationToken)
List all comments on an issue
Declaration
public virtual async Task<ICollection<Comment>> IssueGetCommentsAsync(string owner, string repo, long index, DateTimeOffset? since, DateTimeOffset? before, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | owner | owner of the repo |
| System.String | repo | name of the repo |
| System.Int64 | index | index of the issue |
| System.Nullable<System.DateTimeOffset> | since | if provided, only comments updated since the specified time are returned. |
| System.Nullable<System.DateTimeOffset> | before | if provided, only comments updated before the provided time are returned. |
| System.Threading.CancellationToken | cancellationToken | A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<System.Collections.Generic.ICollection<Comment>> | CommentList |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
IssueGetIssueAsync(String, String, Int64)
Get an issue
Declaration
public virtual Task<Issue> IssueGetIssueAsync(string owner, string repo, long index)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | owner | owner of the repo |
| System.String | repo | name of the repo |
| System.Int64 | index | index of the issue to get |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<Issue> | Issue |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
IssueGetIssueAsync(String, String, Int64, CancellationToken)
Get an issue
Declaration
public virtual async Task<Issue> IssueGetIssueAsync(string owner, string repo, long index, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | owner | owner of the repo |
| System.String | repo | name of the repo |
| System.Int64 | index | index of the issue to get |
| System.Threading.CancellationToken | cancellationToken | A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<Issue> | Issue |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
IssueGetIssueAttachmentAsync(String, String, Int64, Int64)
Get an issue attachment
Declaration
public virtual Task<Attachment> IssueGetIssueAttachmentAsync(string owner, string repo, long index, long attachment_id)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | owner | owner of the repo |
| System.String | repo | name of the repo |
| System.Int64 | index | index of the issue |
| System.Int64 | attachment_id | id of the attachment to get |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<Attachment> | Attachment |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
IssueGetIssueAttachmentAsync(String, String, Int64, Int64, CancellationToken)
Get an issue attachment
Declaration
public virtual async Task<Attachment> IssueGetIssueAttachmentAsync(string owner, string repo, long index, long attachment_id, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | owner | owner of the repo |
| System.String | repo | name of the repo |
| System.Int64 | index | index of the issue |
| System.Int64 | attachment_id | id of the attachment to get |
| System.Threading.CancellationToken | cancellationToken | A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<Attachment> | Attachment |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
IssueGetIssueCommentAttachmentAsync(String, String, Int64, Int64)
Get a comment attachment
Declaration
public virtual Task<Attachment> IssueGetIssueCommentAttachmentAsync(string owner, string repo, long id, long attachment_id)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | owner | owner of the repo |
| System.String | repo | name of the repo |
| System.Int64 | id | id of the comment |
| System.Int64 | attachment_id | id of the attachment to get |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<Attachment> | Attachment |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
IssueGetIssueCommentAttachmentAsync(String, String, Int64, Int64, CancellationToken)
Get a comment attachment
Declaration
public virtual async Task<Attachment> IssueGetIssueCommentAttachmentAsync(string owner, string repo, long id, long attachment_id, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | owner | owner of the repo |
| System.String | repo | name of the repo |
| System.Int64 | id | id of the comment |
| System.Int64 | attachment_id | id of the attachment to get |
| System.Threading.CancellationToken | cancellationToken | A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<Attachment> | Attachment |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
IssueGetIssueReactionsAsync(String, String, Int64, Nullable<Int32>, Nullable<Int32>)
Get a list reactions of an issue
Declaration
public virtual Task<ICollection<Reaction>> IssueGetIssueReactionsAsync(string owner, string repo, long index, int? page, int? limit)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | owner | owner of the repo |
| System.String | repo | name of the repo |
| System.Int64 | index | index of the issue |
| System.Nullable<System.Int32> | page | page number of results to return (1-based) |
| System.Nullable<System.Int32> | limit | page size of results |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<System.Collections.Generic.ICollection<Reaction>> | ReactionList |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
IssueGetIssueReactionsAsync(String, String, Int64, Nullable<Int32>, Nullable<Int32>, CancellationToken)
Get a list reactions of an issue
Declaration
public virtual async Task<ICollection<Reaction>> IssueGetIssueReactionsAsync(string owner, string repo, long index, int? page, int? limit, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | owner | owner of the repo |
| System.String | repo | name of the repo |
| System.Int64 | index | index of the issue |
| System.Nullable<System.Int32> | page | page number of results to return (1-based) |
| System.Nullable<System.Int32> | limit | page size of results |
| System.Threading.CancellationToken | cancellationToken | A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<System.Collections.Generic.ICollection<Reaction>> | ReactionList |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
IssueGetLabelAsync(String, String, Int64)
Get a single label
Declaration
public virtual Task<Label> IssueGetLabelAsync(string owner, string repo, long id)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | owner | owner of the repo |
| System.String | repo | name of the repo |
| System.Int64 | id | id of the label to get |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<Label> | Label |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
IssueGetLabelAsync(String, String, Int64, CancellationToken)
Get a single label
Declaration
public virtual async Task<Label> IssueGetLabelAsync(string owner, string repo, long id, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | owner | owner of the repo |
| System.String | repo | name of the repo |
| System.Int64 | id | id of the label to get |
| System.Threading.CancellationToken | cancellationToken | A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<Label> | Label |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
IssueGetLabelsAsync(String, String, Int64)
Get an issue's labels
Declaration
public virtual Task<ICollection<Label>> IssueGetLabelsAsync(string owner, string repo, long index)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | owner | owner of the repo |
| System.String | repo | name of the repo |
| System.Int64 | index | index of the issue |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<System.Collections.Generic.ICollection<Label>> | LabelList |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
IssueGetLabelsAsync(String, String, Int64, CancellationToken)
Get an issue's labels
Declaration
public virtual async Task<ICollection<Label>> IssueGetLabelsAsync(string owner, string repo, long index, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | owner | owner of the repo |
| System.String | repo | name of the repo |
| System.Int64 | index | index of the issue |
| System.Threading.CancellationToken | cancellationToken | A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<System.Collections.Generic.ICollection<Label>> | LabelList |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
IssueGetMilestoneAsync(String, String, String)
Get a milestone
Declaration
public virtual Task<Milestone> IssueGetMilestoneAsync(string owner, string repo, string id)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | owner | owner of the repo |
| System.String | repo | name of the repo |
| System.String | id | the milestone to get, identified by ID and if not available by name |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<Milestone> | Milestone |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
IssueGetMilestoneAsync(String, String, String, CancellationToken)
Get a milestone
Declaration
public virtual async Task<Milestone> IssueGetMilestoneAsync(string owner, string repo, string id, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | owner | owner of the repo |
| System.String | repo | name of the repo |
| System.String | id | the milestone to get, identified by ID and if not available by name |
| System.Threading.CancellationToken | cancellationToken | A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<Milestone> | Milestone |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
IssueGetMilestonesListAsync(String, String, String, String, Nullable<Int32>, Nullable<Int32>)
Get all of a repository's opened milestones
Declaration
public virtual Task<ICollection<Milestone>> IssueGetMilestonesListAsync(string owner, string repo, string state, string name, int? page, int? limit)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | owner | owner of the repo |
| System.String | repo | name of the repo |
| System.String | state | Milestone state, Recognized values are open, closed and all. Defaults to "open" |
| System.String | name | filter by milestone name |
| System.Nullable<System.Int32> | page | page number of results to return (1-based) |
| System.Nullable<System.Int32> | limit | page size of results |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<System.Collections.Generic.ICollection<Milestone>> | MilestoneList |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
IssueGetMilestonesListAsync(String, String, String, String, Nullable<Int32>, Nullable<Int32>, CancellationToken)
Get all of a repository's opened milestones
Declaration
public virtual async Task<ICollection<Milestone>> IssueGetMilestonesListAsync(string owner, string repo, string state, string name, int? page, int? limit, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | owner | owner of the repo |
| System.String | repo | name of the repo |
| System.String | state | Milestone state, Recognized values are open, closed and all. Defaults to "open" |
| System.String | name | filter by milestone name |
| System.Nullable<System.Int32> | page | page number of results to return (1-based) |
| System.Nullable<System.Int32> | limit | page size of results |
| System.Threading.CancellationToken | cancellationToken | A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<System.Collections.Generic.ICollection<Milestone>> | MilestoneList |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
IssueGetRepoCommentsAsync(String, String, Nullable<DateTimeOffset>, Nullable<DateTimeOffset>, Nullable<Int32>, Nullable<Int32>)
List all comments in a repository
Declaration
public virtual Task<ICollection<Comment>> IssueGetRepoCommentsAsync(string owner, string repo, DateTimeOffset? since, DateTimeOffset? before, int? page, int? limit)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | owner | owner of the repo |
| System.String | repo | name of the repo |
| System.Nullable<System.DateTimeOffset> | since | if provided, only comments updated since the provided time are returned. |
| System.Nullable<System.DateTimeOffset> | before | if provided, only comments updated before the provided time are returned. |
| System.Nullable<System.Int32> | page | page number of results to return (1-based) |
| System.Nullable<System.Int32> | limit | page size of results |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<System.Collections.Generic.ICollection<Comment>> | CommentList |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
IssueGetRepoCommentsAsync(String, String, Nullable<DateTimeOffset>, Nullable<DateTimeOffset>, Nullable<Int32>, Nullable<Int32>, CancellationToken)
List all comments in a repository
Declaration
public virtual async Task<ICollection<Comment>> IssueGetRepoCommentsAsync(string owner, string repo, DateTimeOffset? since, DateTimeOffset? before, int? page, int? limit, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | owner | owner of the repo |
| System.String | repo | name of the repo |
| System.Nullable<System.DateTimeOffset> | since | if provided, only comments updated since the provided time are returned. |
| System.Nullable<System.DateTimeOffset> | before | if provided, only comments updated before the provided time are returned. |
| System.Nullable<System.Int32> | page | page number of results to return (1-based) |
| System.Nullable<System.Int32> | limit | page size of results |
| System.Threading.CancellationToken | cancellationToken | A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<System.Collections.Generic.ICollection<Comment>> | CommentList |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
IssueListBlocksAsync(String, String, String, Nullable<Int32>, Nullable<Int32>)
List issues that are blocked by this issue
Declaration
public virtual Task<ICollection<Issue>> IssueListBlocksAsync(string owner, string repo, string index, int? page, int? limit)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | owner | owner of the repo |
| System.String | repo | name of the repo |
| System.String | index | index of the issue |
| System.Nullable<System.Int32> | page | page number of results to return (1-based) |
| System.Nullable<System.Int32> | limit | page size of results |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<System.Collections.Generic.ICollection<Issue>> | IssueList |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
IssueListBlocksAsync(String, String, String, Nullable<Int32>, Nullable<Int32>, CancellationToken)
List issues that are blocked by this issue
Declaration
public virtual async Task<ICollection<Issue>> IssueListBlocksAsync(string owner, string repo, string index, int? page, int? limit, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | owner | owner of the repo |
| System.String | repo | name of the repo |
| System.String | index | index of the issue |
| System.Nullable<System.Int32> | page | page number of results to return (1-based) |
| System.Nullable<System.Int32> | limit | page size of results |
| System.Threading.CancellationToken | cancellationToken | A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<System.Collections.Generic.ICollection<Issue>> | IssueList |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
IssueListIssueAttachmentsAsync(String, String, Int64)
List issue's attachments
Declaration
public virtual Task<ICollection<Attachment>> IssueListIssueAttachmentsAsync(string owner, string repo, long index)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | owner | owner of the repo |
| System.String | repo | name of the repo |
| System.Int64 | index | index of the issue |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<System.Collections.Generic.ICollection<Attachment>> | AttachmentList |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
IssueListIssueAttachmentsAsync(String, String, Int64, CancellationToken)
List issue's attachments
Declaration
public virtual async Task<ICollection<Attachment>> IssueListIssueAttachmentsAsync(string owner, string repo, long index, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | owner | owner of the repo |
| System.String | repo | name of the repo |
| System.Int64 | index | index of the issue |
| System.Threading.CancellationToken | cancellationToken | A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<System.Collections.Generic.ICollection<Attachment>> | AttachmentList |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
IssueListIssueCommentAttachmentsAsync(String, String, Int64)
List comment's attachments
Declaration
public virtual Task<ICollection<Attachment>> IssueListIssueCommentAttachmentsAsync(string owner, string repo, long id)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | owner | owner of the repo |
| System.String | repo | name of the repo |
| System.Int64 | id | id of the comment |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<System.Collections.Generic.ICollection<Attachment>> | AttachmentList |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
IssueListIssueCommentAttachmentsAsync(String, String, Int64, CancellationToken)
List comment's attachments
Declaration
public virtual async Task<ICollection<Attachment>> IssueListIssueCommentAttachmentsAsync(string owner, string repo, long id, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | owner | owner of the repo |
| System.String | repo | name of the repo |
| System.Int64 | id | id of the comment |
| System.Threading.CancellationToken | cancellationToken | A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<System.Collections.Generic.ICollection<Attachment>> | AttachmentList |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
IssueListIssueDependenciesAsync(String, String, String, Nullable<Int32>, Nullable<Int32>)
List an issue's dependencies, i.e all issues that block this issue.
Declaration
public virtual Task<ICollection<Issue>> IssueListIssueDependenciesAsync(string owner, string repo, string index, int? page, int? limit)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | owner | owner of the repo |
| System.String | repo | name of the repo |
| System.String | index | index of the issue |
| System.Nullable<System.Int32> | page | page number of results to return (1-based) |
| System.Nullable<System.Int32> | limit | page size of results |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<System.Collections.Generic.ICollection<Issue>> | IssueList |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
IssueListIssueDependenciesAsync(String, String, String, Nullable<Int32>, Nullable<Int32>, CancellationToken)
List an issue's dependencies, i.e all issues that block this issue.
Declaration
public virtual async Task<ICollection<Issue>> IssueListIssueDependenciesAsync(string owner, string repo, string index, int? page, int? limit, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | owner | owner of the repo |
| System.String | repo | name of the repo |
| System.String | index | index of the issue |
| System.Nullable<System.Int32> | page | page number of results to return (1-based) |
| System.Nullable<System.Int32> | limit | page size of results |
| System.Threading.CancellationToken | cancellationToken | A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<System.Collections.Generic.ICollection<Issue>> | IssueList |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
IssueListIssuesAsync(String, String, Nullable<State2>, String, String, Nullable<Type2>, String, Nullable<DateTimeOffset>, Nullable<DateTimeOffset>, String, String, String, Nullable<Int32>, Nullable<Int32>)
List a repository's issues
Declaration
public virtual Task<ICollection<Issue>> IssueListIssuesAsync(string owner, string repo, State2? state, string labels, string q, Type2? type, string milestones, DateTimeOffset? since, DateTimeOffset? before, string created_by, string assigned_by, string mentioned_by, int? page, int? limit)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | owner | owner of the repo |
| System.String | repo | name of the repo |
| System.Nullable<State2> | state | whether issue is open or closed |
| System.String | labels | comma separated list of labels. Fetch only issues that have any of this labels. Non existent labels are discarded |
| System.String | q | search string |
| System.Nullable<Type2> | type | filter by type (issues / pulls) if set |
| System.String | milestones | comma separated list of milestone names or ids. It uses names and fall back to ids. Fetch only issues that have any of this milestones. Non existent milestones are discarded |
| System.Nullable<System.DateTimeOffset> | since | Only show items updated after the given time. This is a timestamp in RFC 3339 format |
| System.Nullable<System.DateTimeOffset> | before | Only show items updated before the given time. This is a timestamp in RFC 3339 format |
| System.String | created_by | Only show items which were created by the the given user |
| System.String | assigned_by | Only show items for which the given user is assigned |
| System.String | mentioned_by | Only show items in which the given user was mentioned |
| System.Nullable<System.Int32> | page | page number of results to return (1-based) |
| System.Nullable<System.Int32> | limit | page size of results |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<System.Collections.Generic.ICollection<Issue>> | IssueList |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
IssueListIssuesAsync(String, String, Nullable<State2>, String, String, Nullable<Type2>, String, Nullable<DateTimeOffset>, Nullable<DateTimeOffset>, String, String, String, Nullable<Int32>, Nullable<Int32>, CancellationToken)
List a repository's issues
Declaration
public virtual async Task<ICollection<Issue>> IssueListIssuesAsync(string owner, string repo, State2? state, string labels, string q, Type2? type, string milestones, DateTimeOffset? since, DateTimeOffset? before, string created_by, string assigned_by, string mentioned_by, int? page, int? limit, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | owner | owner of the repo |
| System.String | repo | name of the repo |
| System.Nullable<State2> | state | whether issue is open or closed |
| System.String | labels | comma separated list of labels. Fetch only issues that have any of this labels. Non existent labels are discarded |
| System.String | q | search string |
| System.Nullable<Type2> | type | filter by type (issues / pulls) if set |
| System.String | milestones | comma separated list of milestone names or ids. It uses names and fall back to ids. Fetch only issues that have any of this milestones. Non existent milestones are discarded |
| System.Nullable<System.DateTimeOffset> | since | Only show items updated after the given time. This is a timestamp in RFC 3339 format |
| System.Nullable<System.DateTimeOffset> | before | Only show items updated before the given time. This is a timestamp in RFC 3339 format |
| System.String | created_by | Only show items which were created by the the given user |
| System.String | assigned_by | Only show items for which the given user is assigned |
| System.String | mentioned_by | Only show items in which the given user was mentioned |
| System.Nullable<System.Int32> | page | page number of results to return (1-based) |
| System.Nullable<System.Int32> | limit | page size of results |
| System.Threading.CancellationToken | cancellationToken | A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<System.Collections.Generic.ICollection<Issue>> | IssueList |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
IssueListLabelsAsync(String, String, Nullable<Int32>, Nullable<Int32>)
Get all of a repository's labels
Declaration
public virtual Task<ICollection<Label>> IssueListLabelsAsync(string owner, string repo, int? page, int? limit)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | owner | owner of the repo |
| System.String | repo | name of the repo |
| System.Nullable<System.Int32> | page | page number of results to return (1-based) |
| System.Nullable<System.Int32> | limit | page size of results |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<System.Collections.Generic.ICollection<Label>> | LabelList |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
IssueListLabelsAsync(String, String, Nullable<Int32>, Nullable<Int32>, CancellationToken)
Get all of a repository's labels
Declaration
public virtual async Task<ICollection<Label>> IssueListLabelsAsync(string owner, string repo, int? page, int? limit, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | owner | owner of the repo |
| System.String | repo | name of the repo |
| System.Nullable<System.Int32> | page | page number of results to return (1-based) |
| System.Nullable<System.Int32> | limit | page size of results |
| System.Threading.CancellationToken | cancellationToken | A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<System.Collections.Generic.ICollection<Label>> | LabelList |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
IssuePostCommentReactionAsync(String, String, Int64, EditReactionOption)
Add a reaction to a comment of an issue
Declaration
public virtual Task<Reaction> IssuePostCommentReactionAsync(string owner, string repo, long id, EditReactionOption content)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | owner | owner of the repo |
| System.String | repo | name of the repo |
| System.Int64 | id | id of the comment to edit |
| EditReactionOption | content |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<Reaction> | Reaction |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
IssuePostCommentReactionAsync(String, String, Int64, EditReactionOption, CancellationToken)
Add a reaction to a comment of an issue
Declaration
public virtual async Task<Reaction> IssuePostCommentReactionAsync(string owner, string repo, long id, EditReactionOption content, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | owner | owner of the repo |
| System.String | repo | name of the repo |
| System.Int64 | id | id of the comment to edit |
| EditReactionOption | content | |
| System.Threading.CancellationToken | cancellationToken | A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<Reaction> | Reaction |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
IssuePostIssueReactionAsync(String, String, Int64, EditReactionOption)
Add a reaction to an issue
Declaration
public virtual Task<Reaction> IssuePostIssueReactionAsync(string owner, string repo, long index, EditReactionOption content)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | owner | owner of the repo |
| System.String | repo | name of the repo |
| System.Int64 | index | index of the issue |
| EditReactionOption | content |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<Reaction> | Reaction |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
IssuePostIssueReactionAsync(String, String, Int64, EditReactionOption, CancellationToken)
Add a reaction to an issue
Declaration
public virtual async Task<Reaction> IssuePostIssueReactionAsync(string owner, string repo, long index, EditReactionOption content, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | owner | owner of the repo |
| System.String | repo | name of the repo |
| System.Int64 | index | index of the issue |
| EditReactionOption | content | |
| System.Threading.CancellationToken | cancellationToken | A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<Reaction> | Reaction |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
IssueRemoveIssueBlockingAsync(String, String, String, IssueMeta)
Unblock the issue given in the body by the issue in path
Declaration
public virtual Task<Issue> IssueRemoveIssueBlockingAsync(string owner, string repo, string index, IssueMeta body)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | owner | owner of the repo |
| System.String | repo | name of the repo |
| System.String | index | index of the issue |
| IssueMeta | body |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<Issue> | Issue |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
IssueRemoveIssueBlockingAsync(String, String, String, IssueMeta, CancellationToken)
Unblock the issue given in the body by the issue in path
Declaration
public virtual async Task<Issue> IssueRemoveIssueBlockingAsync(string owner, string repo, string index, IssueMeta body, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | owner | owner of the repo |
| System.String | repo | name of the repo |
| System.String | index | index of the issue |
| IssueMeta | body | |
| System.Threading.CancellationToken | cancellationToken | A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<Issue> | Issue |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
IssueRemoveIssueDependenciesAsync(String, String, String, IssueMeta)
Remove an issue dependency
Declaration
public virtual Task<Issue> IssueRemoveIssueDependenciesAsync(string owner, string repo, string index, IssueMeta body)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | owner | owner of the repo |
| System.String | repo | name of the repo |
| System.String | index | index of the issue |
| IssueMeta | body |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<Issue> | Issue |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
IssueRemoveIssueDependenciesAsync(String, String, String, IssueMeta, CancellationToken)
Remove an issue dependency
Declaration
public virtual async Task<Issue> IssueRemoveIssueDependenciesAsync(string owner, string repo, string index, IssueMeta body, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | owner | owner of the repo |
| System.String | repo | name of the repo |
| System.String | index | index of the issue |
| IssueMeta | body | |
| System.Threading.CancellationToken | cancellationToken | A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<Issue> | Issue |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
IssueRemoveLabelAsync(String, String, Int64, Int64)
Remove a label from an issue
Declaration
public virtual Task IssueRemoveLabelAsync(string owner, string repo, long index, long id)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | owner | owner of the repo |
| System.String | repo | name of the repo |
| System.Int64 | index | index of the issue |
| System.Int64 | id | id of the label to remove |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task | APIEmpty is an empty response |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
IssueRemoveLabelAsync(String, String, Int64, Int64, CancellationToken)
Remove a label from an issue
Declaration
public virtual async Task IssueRemoveLabelAsync(string owner, string repo, long index, long id, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | owner | owner of the repo |
| System.String | repo | name of the repo |
| System.Int64 | index | index of the issue |
| System.Int64 | id | id of the label to remove |
| System.Threading.CancellationToken | cancellationToken | A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task | APIEmpty is an empty response |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
IssueReplaceLabelsAsync(String, String, Int64, IssueLabelsOption)
Replace an issue's labels
Declaration
public virtual Task<ICollection<Label>> IssueReplaceLabelsAsync(string owner, string repo, long index, IssueLabelsOption body)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | owner | owner of the repo |
| System.String | repo | name of the repo |
| System.Int64 | index | index of the issue |
| IssueLabelsOption | body |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<System.Collections.Generic.ICollection<Label>> | LabelList |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
IssueReplaceLabelsAsync(String, String, Int64, IssueLabelsOption, CancellationToken)
Replace an issue's labels
Declaration
public virtual async Task<ICollection<Label>> IssueReplaceLabelsAsync(string owner, string repo, long index, IssueLabelsOption body, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | owner | owner of the repo |
| System.String | repo | name of the repo |
| System.Int64 | index | index of the issue |
| IssueLabelsOption | body | |
| System.Threading.CancellationToken | cancellationToken | A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<System.Collections.Generic.ICollection<Label>> | LabelList |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
IssueResetTimeAsync(String, String, Int64)
Reset a tracked time of an issue
Declaration
public virtual Task IssueResetTimeAsync(string owner, string repo, long index)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | owner | owner of the repo |
| System.String | repo | name of the repo |
| System.Int64 | index | index of the issue to add tracked time to |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task | APIEmpty is an empty response |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
IssueResetTimeAsync(String, String, Int64, CancellationToken)
Reset a tracked time of an issue
Declaration
public virtual async Task IssueResetTimeAsync(string owner, string repo, long index, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | owner | owner of the repo |
| System.String | repo | name of the repo |
| System.Int64 | index | index of the issue to add tracked time to |
| System.Threading.CancellationToken | cancellationToken | A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task | APIEmpty is an empty response |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
IssueSearchIssuesAsync(String, String, String, String, Nullable<Int64>, String, Nullable<DateTimeOffset>, Nullable<DateTimeOffset>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, String, String, Nullable<Int32>, Nullable<Int32>)
Search for issues across the repositories that the user has access to
Declaration
public virtual Task<ICollection<Issue>> IssueSearchIssuesAsync(string state, string labels, string milestones, string q, long? priority_repo_id, string type, DateTimeOffset? since, DateTimeOffset? before, bool? assigned, bool? created, bool? mentioned, bool? review_requested, bool? reviewed, string owner, string team, int? page, int? limit)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | state | whether issue is open or closed |
| System.String | labels | comma separated list of labels. Fetch only issues that have any of this labels. Non existent labels are discarded |
| System.String | milestones | comma separated list of milestone names. Fetch only issues that have any of this milestones. Non existent are discarded |
| System.String | q | search string |
| System.Nullable<System.Int64> | priority_repo_id | repository to prioritize in the results |
| System.String | type | filter by type (issues / pulls) if set |
| System.Nullable<System.DateTimeOffset> | since | Only show notifications updated after the given time. This is a timestamp in RFC 3339 format |
| System.Nullable<System.DateTimeOffset> | before | Only show notifications updated before the given time. This is a timestamp in RFC 3339 format |
| System.Nullable<System.Boolean> | assigned | filter (issues / pulls) assigned to you, default is false |
| System.Nullable<System.Boolean> | created | filter (issues / pulls) created by you, default is false |
| System.Nullable<System.Boolean> | mentioned | filter (issues / pulls) mentioning you, default is false |
| System.Nullable<System.Boolean> | review_requested | filter pulls requesting your review, default is false |
| System.Nullable<System.Boolean> | reviewed | filter pulls reviewed by you, default is false |
| System.String | owner | filter by owner |
| System.String | team | filter by team (requires organization owner parameter to be provided) |
| System.Nullable<System.Int32> | page | page number of results to return (1-based) |
| System.Nullable<System.Int32> | limit | page size of results |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<System.Collections.Generic.ICollection<Issue>> | IssueList |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
IssueSearchIssuesAsync(String, String, String, String, Nullable<Int64>, String, Nullable<DateTimeOffset>, Nullable<DateTimeOffset>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, String, String, Nullable<Int32>, Nullable<Int32>, CancellationToken)
Search for issues across the repositories that the user has access to
Declaration
public virtual async Task<ICollection<Issue>> IssueSearchIssuesAsync(string state, string labels, string milestones, string q, long? priority_repo_id, string type, DateTimeOffset? since, DateTimeOffset? before, bool? assigned, bool? created, bool? mentioned, bool? review_requested, bool? reviewed, string owner, string team, int? page, int? limit, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | state | whether issue is open or closed |
| System.String | labels | comma separated list of labels. Fetch only issues that have any of this labels. Non existent labels are discarded |
| System.String | milestones | comma separated list of milestone names. Fetch only issues that have any of this milestones. Non existent are discarded |
| System.String | q | search string |
| System.Nullable<System.Int64> | priority_repo_id | repository to prioritize in the results |
| System.String | type | filter by type (issues / pulls) if set |
| System.Nullable<System.DateTimeOffset> | since | Only show notifications updated after the given time. This is a timestamp in RFC 3339 format |
| System.Nullable<System.DateTimeOffset> | before | Only show notifications updated before the given time. This is a timestamp in RFC 3339 format |
| System.Nullable<System.Boolean> | assigned | filter (issues / pulls) assigned to you, default is false |
| System.Nullable<System.Boolean> | created | filter (issues / pulls) created by you, default is false |
| System.Nullable<System.Boolean> | mentioned | filter (issues / pulls) mentioning you, default is false |
| System.Nullable<System.Boolean> | review_requested | filter pulls requesting your review, default is false |
| System.Nullable<System.Boolean> | reviewed | filter pulls reviewed by you, default is false |
| System.String | owner | filter by owner |
| System.String | team | filter by team (requires organization owner parameter to be provided) |
| System.Nullable<System.Int32> | page | page number of results to return (1-based) |
| System.Nullable<System.Int32> | limit | page size of results |
| System.Threading.CancellationToken | cancellationToken | A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<System.Collections.Generic.ICollection<Issue>> | IssueList |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
IssueStartStopWatchAsync(String, String, Int64)
Start stopwatch on an issue.
Declaration
public virtual Task IssueStartStopWatchAsync(string owner, string repo, long index)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | owner | owner of the repo |
| System.String | repo | name of the repo |
| System.Int64 | index | index of the issue to create the stopwatch on |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task | APIEmpty is an empty response |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
IssueStartStopWatchAsync(String, String, Int64, CancellationToken)
Start stopwatch on an issue.
Declaration
public virtual async Task IssueStartStopWatchAsync(string owner, string repo, long index, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | owner | owner of the repo |
| System.String | repo | name of the repo |
| System.Int64 | index | index of the issue to create the stopwatch on |
| System.Threading.CancellationToken | cancellationToken | A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task | APIEmpty is an empty response |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
IssueStopStopWatchAsync(String, String, Int64)
Stop an issue's existing stopwatch.
Declaration
public virtual Task IssueStopStopWatchAsync(string owner, string repo, long index)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | owner | owner of the repo |
| System.String | repo | name of the repo |
| System.Int64 | index | index of the issue to stop the stopwatch on |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task | APIEmpty is an empty response |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
IssueStopStopWatchAsync(String, String, Int64, CancellationToken)
Stop an issue's existing stopwatch.
Declaration
public virtual async Task IssueStopStopWatchAsync(string owner, string repo, long index, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | owner | owner of the repo |
| System.String | repo | name of the repo |
| System.Int64 | index | index of the issue to stop the stopwatch on |
| System.Threading.CancellationToken | cancellationToken | A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task | APIEmpty is an empty response |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
IssueSubscriptionsAsync(String, String, Int64, Nullable<Int32>, Nullable<Int32>)
Get users who subscribed on an issue.
Declaration
public virtual Task<ICollection<User>> IssueSubscriptionsAsync(string owner, string repo, long index, int? page, int? limit)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | owner | owner of the repo |
| System.String | repo | name of the repo |
| System.Int64 | index | index of the issue |
| System.Nullable<System.Int32> | page | page number of results to return (1-based) |
| System.Nullable<System.Int32> | limit | page size of results |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<System.Collections.Generic.ICollection<User>> | UserList |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
IssueSubscriptionsAsync(String, String, Int64, Nullable<Int32>, Nullable<Int32>, CancellationToken)
Get users who subscribed on an issue.
Declaration
public virtual async Task<ICollection<User>> IssueSubscriptionsAsync(string owner, string repo, long index, int? page, int? limit, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | owner | owner of the repo |
| System.String | repo | name of the repo |
| System.Int64 | index | index of the issue |
| System.Nullable<System.Int32> | page | page number of results to return (1-based) |
| System.Nullable<System.Int32> | limit | page size of results |
| System.Threading.CancellationToken | cancellationToken | A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<System.Collections.Generic.ICollection<User>> | UserList |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
IssueTrackedTimesAsync(String, String, Int64, String, Nullable<DateTimeOffset>, Nullable<DateTimeOffset>, Nullable<Int32>, Nullable<Int32>)
List an issue's tracked times
Declaration
public virtual Task<ICollection<TrackedTime>> IssueTrackedTimesAsync(string owner, string repo, long index, string user, DateTimeOffset? since, DateTimeOffset? before, int? page, int? limit)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | owner | owner of the repo |
| System.String | repo | name of the repo |
| System.Int64 | index | index of the issue |
| System.String | user | optional filter by user (available for issue managers) |
| System.Nullable<System.DateTimeOffset> | since | Only show times updated after the given time. This is a timestamp in RFC 3339 format |
| System.Nullable<System.DateTimeOffset> | before | Only show times updated before the given time. This is a timestamp in RFC 3339 format |
| System.Nullable<System.Int32> | page | page number of results to return (1-based) |
| System.Nullable<System.Int32> | limit | page size of results |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<System.Collections.Generic.ICollection<TrackedTime>> | TrackedTimeList |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
IssueTrackedTimesAsync(String, String, Int64, String, Nullable<DateTimeOffset>, Nullable<DateTimeOffset>, Nullable<Int32>, Nullable<Int32>, CancellationToken)
List an issue's tracked times
Declaration
public virtual async Task<ICollection<TrackedTime>> IssueTrackedTimesAsync(string owner, string repo, long index, string user, DateTimeOffset? since, DateTimeOffset? before, int? page, int? limit, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | owner | owner of the repo |
| System.String | repo | name of the repo |
| System.Int64 | index | index of the issue |
| System.String | user | optional filter by user (available for issue managers) |
| System.Nullable<System.DateTimeOffset> | since | Only show times updated after the given time. This is a timestamp in RFC 3339 format |
| System.Nullable<System.DateTimeOffset> | before | Only show times updated before the given time. This is a timestamp in RFC 3339 format |
| System.Nullable<System.Int32> | page | page number of results to return (1-based) |
| System.Nullable<System.Int32> | limit | page size of results |
| System.Threading.CancellationToken | cancellationToken | A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<System.Collections.Generic.ICollection<TrackedTime>> | TrackedTimeList |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
MoveIssuePinAsync(String, String, Int64, Int64)
Moves the Pin to the given Position
Declaration
public virtual Task MoveIssuePinAsync(string owner, string repo, long index, long position)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | owner | owner of the repo |
| System.String | repo | name of the repo |
| System.Int64 | index | index of issue |
| System.Int64 | position | the new position |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task | APIEmpty is an empty response |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
MoveIssuePinAsync(String, String, Int64, Int64, CancellationToken)
Moves the Pin to the given Position
Declaration
public virtual async Task MoveIssuePinAsync(string owner, string repo, long index, long position, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | owner | owner of the repo |
| System.String | repo | name of the repo |
| System.Int64 | index | index of issue |
| System.Int64 | position | the new position |
| System.Threading.CancellationToken | cancellationToken | A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task | APIEmpty is an empty response |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
PinIssueAsync(String, String, Int64)
Pin an Issue
Declaration
public virtual Task PinIssueAsync(string owner, string repo, long index)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | owner | owner of the repo |
| System.String | repo | name of the repo |
| System.Int64 | index | index of issue to pin |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task | APIEmpty is an empty response |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
PinIssueAsync(String, String, Int64, CancellationToken)
Pin an Issue
Declaration
public virtual async Task PinIssueAsync(string owner, string repo, long index, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | owner | owner of the repo |
| System.String | repo | name of the repo |
| System.Int64 | index | index of issue to pin |
| System.Threading.CancellationToken | cancellationToken | A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task | APIEmpty is an empty response |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
ReadObjectResponseAsync<T>(HttpResponseMessage, IReadOnlyDictionary<String, IEnumerable<String>>, CancellationToken)
Declaration
protected virtual async Task<IssueClient.ObjectResponseResult<T>> ReadObjectResponseAsync<T>(HttpResponseMessage response, IReadOnlyDictionary<string, IEnumerable<string>> headers, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Net.Http.HttpResponseMessage | response | |
| System.Collections.Generic.IReadOnlyDictionary<System.String, System.Collections.Generic.IEnumerable<System.String>> | headers | |
| System.Threading.CancellationToken | cancellationToken |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<IssueClient.ObjectResponseResult<T>> |
Type Parameters
| Name | Description |
|---|---|
| T |
UnpinIssueAsync(String, String, Int64)
Unpin an Issue
Declaration
public virtual Task UnpinIssueAsync(string owner, string repo, long index)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | owner | owner of the repo |
| System.String | repo | name of the repo |
| System.Int64 | index | index of issue to unpin |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task | APIEmpty is an empty response |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
UnpinIssueAsync(String, String, Int64, CancellationToken)
Unpin an Issue
Declaration
public virtual async Task UnpinIssueAsync(string owner, string repo, long index, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | owner | owner of the repo |
| System.String | repo | name of the repo |
| System.Int64 | index | index of issue to unpin |
| System.Threading.CancellationToken | cancellationToken | A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task | APIEmpty is an empty response |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |