C# Class Octokit.IssueCommentsClient

A client for GitHub's Issue Comments API.
See the Issue Comments API documentation for more information.
Inheritance: Octokit.ApiClient, IIssueCommentsClient
Show file Open project: octokit/octokit.net Class Usage Examples

Public Methods

Method Description
Create ( long repositoryId, int number, string newComment ) : Task

Creates a new Issue Comment for a specified Issue.

http://developer.github.com/v3/issues/comments/#create-a-comment

Create ( string owner, string name, int number, string newComment ) : Task

Creates a new Issue Comment for a specified Issue.

http://developer.github.com/v3/issues/comments/#create-a-comment

Delete ( long repositoryId, int id ) : System.Threading.Tasks.Task

Deletes the specified Issue Comment

http://developer.github.com/v3/issues/comments/#delete-a-comment

Delete ( string owner, string name, int id ) : System.Threading.Tasks.Task

Deletes the specified Issue Comment

http://developer.github.com/v3/issues/comments/#delete-a-comment

Get ( long repositoryId, int id ) : Task

Gets a single Issue Comment by id.

http://developer.github.com/v3/issues/comments/#get-a-single-comment

Get ( string owner, string name, int id ) : Task

Gets a single Issue Comment by id.

http://developer.github.com/v3/issues/comments/#get-a-single-comment

GetAllForIssue ( long repositoryId, int number ) : Task>

Gets Issue Comments for a specified Issue.

http://developer.github.com/v3/issues/comments/#list-comments-on-an-issue

GetAllForIssue ( long repositoryId, int number, Octokit.ApiOptions options ) : Task>

Gets Issue Comments for a specified Issue.

http://developer.github.com/v3/issues/comments/#list-comments-on-an-issue

GetAllForIssue ( string owner, string name, int number ) : Task>

Gets Issue Comments for a specified Issue.

http://developer.github.com/v3/issues/comments/#list-comments-on-an-issue

GetAllForIssue ( string owner, string name, int number, Octokit.ApiOptions options ) : Task>

Gets Issue Comments for a specified Issue.

http://developer.github.com/v3/issues/comments/#list-comments-on-an-issue

GetAllForRepository ( long repositoryId ) : Task>

Gets Issue Comments for a repository.

http://developer.github.com/v3/issues/comments/#list-comments-in-a-repository

GetAllForRepository ( long repositoryId, Octokit.ApiOptions options ) : Task>

Gets Issue Comments for a repository.

http://developer.github.com/v3/issues/comments/#list-comments-in-a-repository

GetAllForRepository ( long repositoryId, IssueCommentRequest request ) : Task>

Gets Issue Comments for a repository.

http://developer.github.com/v3/issues/comments/#list-comments-in-a-repository

GetAllForRepository ( long repositoryId, IssueCommentRequest request, Octokit.ApiOptions options ) : Task>

Gets Issue Comments for a repository.

http://developer.github.com/v3/issues/comments/#list-comments-in-a-repository

GetAllForRepository ( string owner, string name ) : Task>

Gets Issue Comments for a repository.

http://developer.github.com/v3/issues/comments/#list-comments-in-a-repository

GetAllForRepository ( string owner, string name, Octokit.ApiOptions options ) : Task>

Gets Issue Comments for a repository.

http://developer.github.com/v3/issues/comments/#list-comments-in-a-repository

GetAllForRepository ( string owner, string name, IssueCommentRequest request ) : Task>

Gets Issue Comments for a repository.

http://developer.github.com/v3/issues/comments/#list-comments-in-a-repository

GetAllForRepository ( string owner, string name, IssueCommentRequest request, Octokit.ApiOptions options ) : Task>

Gets Issue Comments for a repository.

http://developer.github.com/v3/issues/comments/#list-comments-in-a-repository

IssueCommentsClient ( IApiConnection apiConnection ) : System.Collections.Generic

Instantiates a new GitHub Issue Comments API client.
Update ( long repositoryId, int id, string commentUpdate ) : Task

Updates a specified Issue Comment.

http://developer.github.com/v3/issues/comments/#edit-a-comment

Update ( string owner, string name, int id, string commentUpdate ) : Task

Updates a specified Issue Comment.

http://developer.github.com/v3/issues/comments/#edit-a-comment

Method Details

Create() public method

Creates a new Issue Comment for a specified Issue.
http://developer.github.com/v3/issues/comments/#create-a-comment
public Create ( long repositoryId, int number, string newComment ) : Task
repositoryId long The Id of the repository
number int The number of the issue
newComment string The new comment to add to the issue
return Task

Create() public method

Creates a new Issue Comment for a specified Issue.
http://developer.github.com/v3/issues/comments/#create-a-comment
public Create ( string owner, string name, int number, string newComment ) : Task
owner string The owner of the repository
name string The name of the repository
number int The number of the issue
newComment string The new comment to add to the issue
return Task

Delete() public method

Deletes the specified Issue Comment
http://developer.github.com/v3/issues/comments/#delete-a-comment
public Delete ( long repositoryId, int id ) : System.Threading.Tasks.Task
repositoryId long The Id of the repository
id int The comment id
return System.Threading.Tasks.Task

Delete() public method

Deletes the specified Issue Comment
http://developer.github.com/v3/issues/comments/#delete-a-comment
public Delete ( string owner, string name, int id ) : System.Threading.Tasks.Task
owner string The owner of the repository
name string The name of the repository
id int The comment id
return System.Threading.Tasks.Task

Get() public method

Gets a single Issue Comment by id.
http://developer.github.com/v3/issues/comments/#get-a-single-comment
public Get ( long repositoryId, int id ) : Task
repositoryId long The Id of the repository
id int The issue comment id
return Task

Get() public method

Gets a single Issue Comment by id.
http://developer.github.com/v3/issues/comments/#get-a-single-comment
public Get ( string owner, string name, int id ) : Task
owner string The owner of the repository
name string The name of the repository
id int The issue comment id
return Task

GetAllForIssue() public method

Gets Issue Comments for a specified Issue.
http://developer.github.com/v3/issues/comments/#list-comments-on-an-issue
public GetAllForIssue ( long repositoryId, int number ) : Task>
repositoryId long The Id of the repository
number int The issue number
return Task>

GetAllForIssue() public method

Gets Issue Comments for a specified Issue.
http://developer.github.com/v3/issues/comments/#list-comments-on-an-issue
public GetAllForIssue ( long repositoryId, int number, Octokit.ApiOptions options ) : Task>
repositoryId long The Id of the repository
number int The issue number
options Octokit.ApiOptions Options for changing the API response
return Task>

GetAllForIssue() public method

Gets Issue Comments for a specified Issue.
http://developer.github.com/v3/issues/comments/#list-comments-on-an-issue
public GetAllForIssue ( string owner, string name, int number ) : Task>
owner string The owner of the repository
name string The name of the repository
number int The issue number
return Task>

GetAllForIssue() public method

Gets Issue Comments for a specified Issue.
http://developer.github.com/v3/issues/comments/#list-comments-on-an-issue
public GetAllForIssue ( string owner, string name, int number, Octokit.ApiOptions options ) : Task>
owner string The owner of the repository
name string The name of the repository
number int The issue number
options Octokit.ApiOptions Options for changing the API response
return Task>

GetAllForRepository() public method

Gets Issue Comments for a repository.
http://developer.github.com/v3/issues/comments/#list-comments-in-a-repository
public GetAllForRepository ( long repositoryId ) : Task>
repositoryId long The Id of the repository
return Task>

GetAllForRepository() public method

Gets Issue Comments for a repository.
http://developer.github.com/v3/issues/comments/#list-comments-in-a-repository
public GetAllForRepository ( long repositoryId, Octokit.ApiOptions options ) : Task>
repositoryId long The Id of the repository
options Octokit.ApiOptions Options for changing the API response
return Task>

GetAllForRepository() public method

Gets Issue Comments for a repository.
http://developer.github.com/v3/issues/comments/#list-comments-in-a-repository
public GetAllForRepository ( long repositoryId, IssueCommentRequest request ) : Task>
repositoryId long The Id of the repository
request IssueCommentRequest The sorting parameters
return Task>

GetAllForRepository() public method

Gets Issue Comments for a repository.
http://developer.github.com/v3/issues/comments/#list-comments-in-a-repository
public GetAllForRepository ( long repositoryId, IssueCommentRequest request, Octokit.ApiOptions options ) : Task>
repositoryId long The Id of the repository
request IssueCommentRequest The sorting parameters
options Octokit.ApiOptions Options for changing the API response
return Task>

GetAllForRepository() public method

Gets Issue Comments for a repository.
http://developer.github.com/v3/issues/comments/#list-comments-in-a-repository
public GetAllForRepository ( string owner, string name ) : Task>
owner string The owner of the repository
name string The name of the repository
return Task>

GetAllForRepository() public method

Gets Issue Comments for a repository.
http://developer.github.com/v3/issues/comments/#list-comments-in-a-repository
public GetAllForRepository ( string owner, string name, Octokit.ApiOptions options ) : Task>
owner string The owner of the repository
name string The name of the repository
options Octokit.ApiOptions Options for changing the API response
return Task>

GetAllForRepository() public method

Gets Issue Comments for a repository.
http://developer.github.com/v3/issues/comments/#list-comments-in-a-repository
public GetAllForRepository ( string owner, string name, IssueCommentRequest request ) : Task>
owner string The owner of the repository
name string The name of the repository
request IssueCommentRequest The sorting parameters
return Task>

GetAllForRepository() public method

Gets Issue Comments for a repository.
http://developer.github.com/v3/issues/comments/#list-comments-in-a-repository
public GetAllForRepository ( string owner, string name, IssueCommentRequest request, Octokit.ApiOptions options ) : Task>
owner string The owner of the repository
name string The name of the repository
request IssueCommentRequest The sorting parameters
options Octokit.ApiOptions Options for changing the API response
return Task>

IssueCommentsClient() public method

Instantiates a new GitHub Issue Comments API client.
public IssueCommentsClient ( IApiConnection apiConnection ) : System.Collections.Generic
apiConnection IApiConnection An API connection
return System.Collections.Generic

Update() public method

Updates a specified Issue Comment.
http://developer.github.com/v3/issues/comments/#edit-a-comment
public Update ( long repositoryId, int id, string commentUpdate ) : Task
repositoryId long The Id of the repository
id int The comment id
commentUpdate string The modified comment
return Task

Update() public method

Updates a specified Issue Comment.
http://developer.github.com/v3/issues/comments/#edit-a-comment
public Update ( string owner, string name, int id, string commentUpdate ) : Task
owner string The owner of the repository
name string The name of the repository
id int The comment id
commentUpdate string The modified comment
return Task