Class RemoteRepoIssueApi

Implements the friendly GitHub repository issue related APIs.

Inheritance

object

RemoteRepoIssueApi

Namespace: Neon.GitHub

Assembly: Neon.GitHub.dll

Syntax

public class RemoteRepoIssueApi

Properties

Comment

Returns the RemoteRepoIssueCommentApi which can be used to manage issue comments.

Declaration

public RemoteRepoIssueCommentApi Comment { get; }

Property Value

Type	Description
RemoteRepoIssueCommentApi

Methods

CreateAsync(NewIssue)

Creates a new repo issue.

Declaration

public Task<Issue> CreateAsync(NewIssue newIssue)

Parameters

Type	Name	Description
NewIssue	newIssue	Specifies the new issue.

Returns

Type	Description
Task<Issue>	The new Octokit.Issue.

Exceptions

Type	Condition
ObjectDisposedException	Thrown when the GitHubRepo has been disposed.

GetAllAsync(ApiOptions)

Returns all repository issues, potentially filtered.

Declaration

public Task<IEnumerable<Issue>> GetAllAsync(ApiOptions options = null)

Parameters

Type	Name	Description
ApiOptions	options	Optionally specfies result pagination ootions.

Returns

Type	Description
Task<IEnumerable<Issue>>	The issues.

GetAllAsync(RepositoryIssueRequest, ApiOptions)

Returns repository issues that satisfy a filter.

Declaration

public Task<IEnumerable<Issue>> GetAllAsync(RepositoryIssueRequest request, ApiOptions options = null)

Parameters

Type	Name	Description
RepositoryIssueRequest	request	Used to filter issues by assignee, mileston, etc.
ApiOptions	options	Optionally specfies result pagination ootions.

Returns

Type	Description
Task<IEnumerable<Issue>>	The issues.

GetAsync(int)

Returns an issue by number.

Declaration

public Task<Issue> GetAsync(int number)

Parameters

Type	Name	Description
int	number	Specifies the issue number.

Returns

Type	Description
Task<Issue>	The Octokit.Issue.

Exceptions

Type	Condition
ObjectDisposedException	Thrown when the GitHubRepo has been disposed.
NotFoundException	Thrown when the issue doesn't exist

SearchAllAsync(SearchIssuesRequest)

Searches the repository for issues satisfying a search request, returning all results (not paged).

Declaration

public Task<IEnumerable<Issue>> SearchAllAsync(SearchIssuesRequest request)

Parameters

Type	Name	Description
SearchIssuesRequest	request	Specifies the search parameters.

Returns

Type	Description
Task<IEnumerable<Issue>>	The Octokit.SearchIssuesResult

SearchAsync(SearchIssuesRequest)

Searches the repository for issues satisfying a search request, returning pages of results.

Declaration

public Task<SearchIssuesResult> SearchAsync(SearchIssuesRequest request)

Parameters

Type	Name	Description
SearchIssuesRequest	request	Specifies the search parameters.

Returns

Type	Description
Task<SearchIssuesResult>	The Octokit.SearchIssuesResult

UpdateAsync(int, IssueUpdate)

Updates an existing issue.

Declaration

public Task<Issue> UpdateAsync(int number, IssueUpdate issueUpdate)

Parameters

Type	Name	Description
int	number	Specifies the issue number.
IssueUpdate	issueUpdate	Specifies the issue update.

Returns

Type	Description
Task<Issue>	The updated Octokit.Issue.

Exceptions

Type	Condition
ObjectDisposedException	Thrown when the GitHubRepo has been disposed.