Search Results for

    Show / Hide Table of Contents

    Class RepositoryClient

    Inheritance
    System.Object
    RepositoryClient
    Inherited Members
    System.Object.Equals(System.Object)
    System.Object.Equals(System.Object, System.Object)
    System.Object.GetHashCode()
    System.Object.GetType()
    System.Object.MemberwiseClone()
    System.Object.ReferenceEquals(System.Object, System.Object)
    System.Object.ToString()
    Namespace: Dangl.GiteaOrgManager.Client
    Assembly: Dangl.GiteaOrgManager.dll
    Syntax
    public class RepositoryClient

    Constructors

    | Improve this Doc View Source

    RepositoryClient(String, HttpClient)

    Declaration
    public RepositoryClient(string baseUrl, HttpClient httpClient)
    Parameters
    Type Name Description
    System.String baseUrl
    System.Net.Http.HttpClient httpClient

    Properties

    | Improve this Doc View Source

    BaseUrl

    Declaration
    public string BaseUrl { get; set; }
    Property Value
    Type Description
    System.String
    | Improve this Doc View Source

    JsonSerializerSettings

    Declaration
    protected Newtonsoft.Json.JsonSerializerSettings JsonSerializerSettings { get; }
    Property Value
    Type Description
    Newtonsoft.Json.JsonSerializerSettings
    | Improve this Doc View Source

    ReadResponseAsString

    Declaration
    public bool ReadResponseAsString { get; set; }
    Property Value
    Type Description
    System.Boolean

    Methods

    | Improve this Doc View Source

    AcceptRepoTransferAsync(String, String)

    Accept a repo transfer

    Declaration
    public virtual Task<Repository> AcceptRepoTransferAsync(string owner, string repo)
    Parameters
    Type Name Description
    System.String owner

    owner of the repo to transfer

    System.String repo

    name of the repo to transfer

    Returns
    Type Description
    System.Threading.Tasks.Task<Repository>

    Repository

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    AcceptRepoTransferAsync(String, String, CancellationToken)

    Accept a repo transfer

    Declaration
    public virtual async Task<Repository> AcceptRepoTransferAsync(string owner, string repo, CancellationToken cancellationToken)
    Parameters
    Type Name Description
    System.String owner

    owner of the repo to transfer

    System.String repo

    name of the repo to transfer

    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<Repository>

    Repository

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    CreateCurrentUserRepoAsync(CreateRepoOption)

    Create a repository

    Declaration
    public virtual Task<Repository> CreateCurrentUserRepoAsync(CreateRepoOption body)
    Parameters
    Type Name Description
    CreateRepoOption body
    Returns
    Type Description
    System.Threading.Tasks.Task<Repository>

    Repository

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    CreateCurrentUserRepoAsync(CreateRepoOption, CancellationToken)

    Create a repository

    Declaration
    public virtual async Task<Repository> CreateCurrentUserRepoAsync(CreateRepoOption body, CancellationToken cancellationToken)
    Parameters
    Type Name Description
    CreateRepoOption 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<Repository>

    Repository

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    CreateForkAsync(String, String, CreateForkOption)

    Fork a repository

    Declaration
    public virtual Task<Repository> CreateForkAsync(string owner, string repo, CreateForkOption body)
    Parameters
    Type Name Description
    System.String owner

    owner of the repo to fork

    System.String repo

    name of the repo to fork

    CreateForkOption body
    Returns
    Type Description
    System.Threading.Tasks.Task<Repository>

    Repository

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    CreateForkAsync(String, String, CreateForkOption, CancellationToken)

    Fork a repository

    Declaration
    public virtual async Task<Repository> CreateForkAsync(string owner, string repo, CreateForkOption body, CancellationToken cancellationToken)
    Parameters
    Type Name Description
    System.String owner

    owner of the repo to fork

    System.String repo

    name of the repo to fork

    CreateForkOption 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<Repository>

    Repository

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    GenerateRepoAsync(String, String, GenerateRepoOption)

    Create a repository using a template

    Declaration
    public virtual Task<Repository> GenerateRepoAsync(string template_owner, string template_repo, GenerateRepoOption body)
    Parameters
    Type Name Description
    System.String template_owner

    name of the template repository owner

    System.String template_repo

    name of the template repository

    GenerateRepoOption body
    Returns
    Type Description
    System.Threading.Tasks.Task<Repository>

    Repository

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    GenerateRepoAsync(String, String, GenerateRepoOption, CancellationToken)

    Create a repository using a template

    Declaration
    public virtual async Task<Repository> GenerateRepoAsync(string template_owner, string template_repo, GenerateRepoOption body, CancellationToken cancellationToken)
    Parameters
    Type Name Description
    System.String template_owner

    name of the template repository owner

    System.String template_repo

    name of the template repository

    GenerateRepoOption 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<Repository>

    Repository

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    GetAnnotatedTagAsync(String, String, String)

    Gets the tag object of an annotated tag (not lightweight tags)

    Declaration
    public virtual Task<AnnotatedTag> GetAnnotatedTagAsync(string owner, string repo, string sha)
    Parameters
    Type Name Description
    System.String owner

    owner of the repo

    System.String repo

    name of the repo

    System.String sha

    sha of the tag. The Git tags API only supports annotated tag objects, not lightweight tags.

    Returns
    Type Description
    System.Threading.Tasks.Task<AnnotatedTag>

    AnnotatedTag

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    GetAnnotatedTagAsync(String, String, String, CancellationToken)

    Gets the tag object of an annotated tag (not lightweight tags)

    Declaration
    public virtual async Task<AnnotatedTag> GetAnnotatedTagAsync(string owner, string repo, string sha, CancellationToken cancellationToken)
    Parameters
    Type Name Description
    System.String owner

    owner of the repo

    System.String repo

    name of the repo

    System.String sha

    sha of the tag. The Git tags API only supports annotated tag objects, not lightweight tags.

    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<AnnotatedTag>

    AnnotatedTag

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    GetBlobAsync(String, String, String)

    Gets the blob of a repository.

    Declaration
    public virtual Task<GitBlobResponse> GetBlobAsync(string owner, string repo, string sha)
    Parameters
    Type Name Description
    System.String owner

    owner of the repo

    System.String repo

    name of the repo

    System.String sha

    sha of the commit

    Returns
    Type Description
    System.Threading.Tasks.Task<GitBlobResponse>

    GitBlobResponse

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    GetBlobAsync(String, String, String, CancellationToken)

    Gets the blob of a repository.

    Declaration
    public virtual async Task<GitBlobResponse> GetBlobAsync(string owner, string repo, string sha, CancellationToken cancellationToken)
    Parameters
    Type Name Description
    System.String owner

    owner of the repo

    System.String repo

    name of the repo

    System.String sha

    sha of the commit

    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<GitBlobResponse>

    GitBlobResponse

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    GetTreeAsync(String, String, String, Nullable<Boolean>, Nullable<Int32>, Nullable<Int32>)

    Gets the tree of a repository.

    Declaration
    public virtual Task<GitTreeResponse> GetTreeAsync(string owner, string repo, string sha, bool? recursive, int? page, int? per_page)
    Parameters
    Type Name Description
    System.String owner

    owner of the repo

    System.String repo

    name of the repo

    System.String sha

    sha of the commit

    System.Nullable<System.Boolean> recursive

    show all directories and files

    System.Nullable<System.Int32> page

    page number; the 'truncated' field in the response will be true if there are still more items after this page, false if the last page

    System.Nullable<System.Int32> per_page

    number of items per page

    Returns
    Type Description
    System.Threading.Tasks.Task<GitTreeResponse>

    GitTreeResponse

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    GetTreeAsync(String, String, String, Nullable<Boolean>, Nullable<Int32>, Nullable<Int32>, CancellationToken)

    Gets the tree of a repository.

    Declaration
    public virtual async Task<GitTreeResponse> GetTreeAsync(string owner, string repo, string sha, bool? recursive, int? page, int? per_page, CancellationToken cancellationToken)
    Parameters
    Type Name Description
    System.String owner

    owner of the repo

    System.String repo

    name of the repo

    System.String sha

    sha of the commit

    System.Nullable<System.Boolean> recursive

    show all directories and files

    System.Nullable<System.Int32> page

    page number; the 'truncated' field in the response will be true if there are still more items after this page, false if the last page

    System.Nullable<System.Int32> per_page

    number of items per page

    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<GitTreeResponse>

    GitTreeResponse

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    ListForksAsync(String, String, Nullable<Int32>, Nullable<Int32>)

    List a repository's forks

    Declaration
    public virtual Task<ICollection<Repository>> ListForksAsync(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<Repository>>

    RepositoryList

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    ListForksAsync(String, String, Nullable<Int32>, Nullable<Int32>, CancellationToken)

    List a repository's forks

    Declaration
    public virtual async Task<ICollection<Repository>> ListForksAsync(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<Repository>>

    RepositoryList

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    ReadObjectResponseAsync<T>(HttpResponseMessage, IReadOnlyDictionary<String, IEnumerable<String>>, CancellationToken)

    Declaration
    protected virtual async Task<RepositoryClient.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<RepositoryClient.ObjectResponseResult<T>>
    Type Parameters
    Name Description
    T
    | Improve this Doc View Source

    RejectRepoTransferAsync(String, String)

    Reject a repo transfer

    Declaration
    public virtual Task<Repository> RejectRepoTransferAsync(string owner, string repo)
    Parameters
    Type Name Description
    System.String owner

    owner of the repo to transfer

    System.String repo

    name of the repo to transfer

    Returns
    Type Description
    System.Threading.Tasks.Task<Repository>

    Repository

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RejectRepoTransferAsync(String, String, CancellationToken)

    Reject a repo transfer

    Declaration
    public virtual async Task<Repository> RejectRepoTransferAsync(string owner, string repo, CancellationToken cancellationToken)
    Parameters
    Type Name Description
    System.String owner

    owner of the repo to transfer

    System.String repo

    name of the repo to transfer

    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<Repository>

    Repository

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoAddCollaboratorAsync(String, String, String, AddCollaboratorOption)

    Add a collaborator to a repository

    Declaration
    public virtual Task RepoAddCollaboratorAsync(string owner, string repo, string collaborator, AddCollaboratorOption body)
    Parameters
    Type Name Description
    System.String owner

    owner of the repo

    System.String repo

    name of the repo

    System.String collaborator

    username of the collaborator to add

    AddCollaboratorOption body
    Returns
    Type Description
    System.Threading.Tasks.Task

    APIEmpty is an empty response

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoAddCollaboratorAsync(String, String, String, AddCollaboratorOption, CancellationToken)

    Add a collaborator to a repository

    Declaration
    public virtual async Task RepoAddCollaboratorAsync(string owner, string repo, string collaborator, AddCollaboratorOption body, CancellationToken cancellationToken)
    Parameters
    Type Name Description
    System.String owner

    owner of the repo

    System.String repo

    name of the repo

    System.String collaborator

    username of the collaborator to add

    AddCollaboratorOption 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

    APIEmpty is an empty response

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoAddPushMirrorAsync(String, String, CreatePushMirrorOption)

    add a push mirror to the repository

    Declaration
    public virtual Task<PushMirror> RepoAddPushMirrorAsync(string owner, string repo, CreatePushMirrorOption body)
    Parameters
    Type Name Description
    System.String owner

    owner of the repo

    System.String repo

    name of the repo

    CreatePushMirrorOption body
    Returns
    Type Description
    System.Threading.Tasks.Task<PushMirror>

    PushMirror

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoAddPushMirrorAsync(String, String, CreatePushMirrorOption, CancellationToken)

    add a push mirror to the repository

    Declaration
    public virtual async Task<PushMirror> RepoAddPushMirrorAsync(string owner, string repo, CreatePushMirrorOption body, CancellationToken cancellationToken)
    Parameters
    Type Name Description
    System.String owner

    owner of the repo

    System.String repo

    name of the repo

    CreatePushMirrorOption 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<PushMirror>

    PushMirror

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoAddTeamAsync(String, String, String)

    Add a team to a repository

    Declaration
    public virtual Task RepoAddTeamAsync(string owner, string repo, string team)
    Parameters
    Type Name Description
    System.String owner

    owner of the repo

    System.String repo

    name of the repo

    System.String team

    team name

    Returns
    Type Description
    System.Threading.Tasks.Task

    APIEmpty is an empty response

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoAddTeamAsync(String, String, String, CancellationToken)

    Add a team to a repository

    Declaration
    public virtual async Task RepoAddTeamAsync(string owner, string repo, string team, CancellationToken cancellationToken)
    Parameters
    Type Name Description
    System.String owner

    owner of the repo

    System.String repo

    name of the repo

    System.String team

    team 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.

    | Improve this Doc View Source

    RepoAddTopicAsync(String, String, String)

    Add a topic to a repository

    Declaration
    public virtual Task RepoAddTopicAsync(string owner, string repo, string topic)
    Parameters
    Type Name Description
    System.String owner

    owner of the repo

    System.String repo

    name of the repo

    System.String topic

    name of the topic to add

    Returns
    Type Description
    System.Threading.Tasks.Task

    APIEmpty is an empty response

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoAddTopicAsync(String, String, String, CancellationToken)

    Add a topic to a repository

    Declaration
    public virtual async Task RepoAddTopicAsync(string owner, string repo, string topic, CancellationToken cancellationToken)
    Parameters
    Type Name Description
    System.String owner

    owner of the repo

    System.String repo

    name of the repo

    System.String topic

    name of the topic to add

    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.

    | Improve this Doc View Source

    RepoApplyDiffPatchAsync(String, String, UpdateFileOptions)

    Apply diff patch to repository

    Declaration
    public virtual Task<FileResponse> RepoApplyDiffPatchAsync(string owner, string repo, UpdateFileOptions body)
    Parameters
    Type Name Description
    System.String owner

    owner of the repo

    System.String repo

    name of the repo

    UpdateFileOptions body
    Returns
    Type Description
    System.Threading.Tasks.Task<FileResponse>

    FileResponse

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoApplyDiffPatchAsync(String, String, UpdateFileOptions, CancellationToken)

    Apply diff patch to repository

    Declaration
    public virtual async Task<FileResponse> RepoApplyDiffPatchAsync(string owner, string repo, UpdateFileOptions body, CancellationToken cancellationToken)
    Parameters
    Type Name Description
    System.String owner

    owner of the repo

    System.String repo

    name of the repo

    UpdateFileOptions 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<FileResponse>

    FileResponse

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoCancelScheduledAutoMergeAsync(String, String, Int64)

    Cancel the scheduled auto merge for the given pull request

    Declaration
    public virtual Task RepoCancelScheduledAutoMergeAsync(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 pull request to merge

    Returns
    Type Description
    System.Threading.Tasks.Task

    APIEmpty is an empty response

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoCancelScheduledAutoMergeAsync(String, String, Int64, CancellationToken)

    Cancel the scheduled auto merge for the given pull request

    Declaration
    public virtual async Task RepoCancelScheduledAutoMergeAsync(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 pull request to merge

    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.

    | Improve this Doc View Source

    RepoChangeFilesAsync(String, String, ChangeFilesOptions)

    Modify multiple files in a repository

    Declaration
    public virtual Task<FilesResponse> RepoChangeFilesAsync(string owner, string repo, ChangeFilesOptions body)
    Parameters
    Type Name Description
    System.String owner

    owner of the repo

    System.String repo

    name of the repo

    ChangeFilesOptions body
    Returns
    Type Description
    System.Threading.Tasks.Task<FilesResponse>

    FilesResponse

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoChangeFilesAsync(String, String, ChangeFilesOptions, CancellationToken)

    Modify multiple files in a repository

    Declaration
    public virtual async Task<FilesResponse> RepoChangeFilesAsync(string owner, string repo, ChangeFilesOptions body, CancellationToken cancellationToken)
    Parameters
    Type Name Description
    System.String owner

    owner of the repo

    System.String repo

    name of the repo

    ChangeFilesOptions 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<FilesResponse>

    FilesResponse

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoCheckCollaboratorAsync(String, String, String)

    Check if a user is a collaborator of a repository

    Declaration
    public virtual Task RepoCheckCollaboratorAsync(string owner, string repo, string collaborator)
    Parameters
    Type Name Description
    System.String owner

    owner of the repo

    System.String repo

    name of the repo

    System.String collaborator

    username of the collaborator

    Returns
    Type Description
    System.Threading.Tasks.Task

    APIEmpty is an empty response

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoCheckCollaboratorAsync(String, String, String, CancellationToken)

    Check if a user is a collaborator of a repository

    Declaration
    public virtual async Task RepoCheckCollaboratorAsync(string owner, string repo, string collaborator, CancellationToken cancellationToken)
    Parameters
    Type Name Description
    System.String owner

    owner of the repo

    System.String repo

    name of the repo

    System.String collaborator

    username of the collaborator

    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.

    | Improve this Doc View Source

    RepoCheckTeamAsync(String, String, String)

    Check if a team is assigned to a repository

    Declaration
    public virtual Task<Team> RepoCheckTeamAsync(string owner, string repo, string team)
    Parameters
    Type Name Description
    System.String owner

    owner of the repo

    System.String repo

    name of the repo

    System.String team

    team name

    Returns
    Type Description
    System.Threading.Tasks.Task<Team>

    Team

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoCheckTeamAsync(String, String, String, CancellationToken)

    Check if a team is assigned to a repository

    Declaration
    public virtual async Task<Team> RepoCheckTeamAsync(string owner, string repo, string team, CancellationToken cancellationToken)
    Parameters
    Type Name Description
    System.String owner

    owner of the repo

    System.String repo

    name of the repo

    System.String team

    team 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<Team>

    Team

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoCreateBranchAsync(String, String, CreateBranchRepoOption)

    Create a branch

    Declaration
    public virtual Task<Branch> RepoCreateBranchAsync(string owner, string repo, CreateBranchRepoOption body)
    Parameters
    Type Name Description
    System.String owner

    owner of the repo

    System.String repo

    name of the repo

    CreateBranchRepoOption body
    Returns
    Type Description
    System.Threading.Tasks.Task<Branch>

    Branch

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoCreateBranchAsync(String, String, CreateBranchRepoOption, CancellationToken)

    Create a branch

    Declaration
    public virtual async Task<Branch> RepoCreateBranchAsync(string owner, string repo, CreateBranchRepoOption body, CancellationToken cancellationToken)
    Parameters
    Type Name Description
    System.String owner

    owner of the repo

    System.String repo

    name of the repo

    CreateBranchRepoOption 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<Branch>

    Branch

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoCreateBranchProtectionAsync(String, String, CreateBranchProtectionOption)

    Create a branch protections for a repository

    Declaration
    public virtual Task<BranchProtection> RepoCreateBranchProtectionAsync(string owner, string repo, CreateBranchProtectionOption body)
    Parameters
    Type Name Description
    System.String owner

    owner of the repo

    System.String repo

    name of the repo

    CreateBranchProtectionOption body
    Returns
    Type Description
    System.Threading.Tasks.Task<BranchProtection>

    BranchProtection

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoCreateBranchProtectionAsync(String, String, CreateBranchProtectionOption, CancellationToken)

    Create a branch protections for a repository

    Declaration
    public virtual async Task<BranchProtection> RepoCreateBranchProtectionAsync(string owner, string repo, CreateBranchProtectionOption body, CancellationToken cancellationToken)
    Parameters
    Type Name Description
    System.String owner

    owner of the repo

    System.String repo

    name of the repo

    CreateBranchProtectionOption 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<BranchProtection>

    BranchProtection

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoCreateFileAsync(String, String, String, CreateFileOptions)

    Create a file in a repository

    Declaration
    public virtual Task<FileResponse> RepoCreateFileAsync(string owner, string repo, string filepath, CreateFileOptions body)
    Parameters
    Type Name Description
    System.String owner

    owner of the repo

    System.String repo

    name of the repo

    System.String filepath

    path of the file to create

    CreateFileOptions body
    Returns
    Type Description
    System.Threading.Tasks.Task<FileResponse>

    FileResponse

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoCreateFileAsync(String, String, String, CreateFileOptions, CancellationToken)

    Create a file in a repository

    Declaration
    public virtual async Task<FileResponse> RepoCreateFileAsync(string owner, string repo, string filepath, CreateFileOptions body, CancellationToken cancellationToken)
    Parameters
    Type Name Description
    System.String owner

    owner of the repo

    System.String repo

    name of the repo

    System.String filepath

    path of the file to create

    CreateFileOptions 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<FileResponse>

    FileResponse

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoCreateHookAsync(String, String, CreateHookOption)

    Create a hook

    Declaration
    public virtual Task<Hook> RepoCreateHookAsync(string owner, string repo, CreateHookOption body)
    Parameters
    Type Name Description
    System.String owner

    owner of the repo

    System.String repo

    name of the repo

    CreateHookOption body
    Returns
    Type Description
    System.Threading.Tasks.Task<Hook>

    Hook

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoCreateHookAsync(String, String, CreateHookOption, CancellationToken)

    Create a hook

    Declaration
    public virtual async Task<Hook> RepoCreateHookAsync(string owner, string repo, CreateHookOption body, CancellationToken cancellationToken)
    Parameters
    Type Name Description
    System.String owner

    owner of the repo

    System.String repo

    name of the repo

    CreateHookOption 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<Hook>

    Hook

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoCreateKeyAsync(String, String, CreateKeyOption)

    Add a key to a repository

    Declaration
    public virtual Task<DeployKey> RepoCreateKeyAsync(string owner, string repo, CreateKeyOption body)
    Parameters
    Type Name Description
    System.String owner

    owner of the repo

    System.String repo

    name of the repo

    CreateKeyOption body
    Returns
    Type Description
    System.Threading.Tasks.Task<DeployKey>

    DeployKey

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoCreateKeyAsync(String, String, CreateKeyOption, CancellationToken)

    Add a key to a repository

    Declaration
    public virtual async Task<DeployKey> RepoCreateKeyAsync(string owner, string repo, CreateKeyOption body, CancellationToken cancellationToken)
    Parameters
    Type Name Description
    System.String owner

    owner of the repo

    System.String repo

    name of the repo

    CreateKeyOption 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<DeployKey>

    DeployKey

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoCreatePullRequestAsync(String, String, CreatePullRequestOption)

    Create a pull request

    Declaration
    public virtual Task<PullRequest> RepoCreatePullRequestAsync(string owner, string repo, CreatePullRequestOption body)
    Parameters
    Type Name Description
    System.String owner

    owner of the repo

    System.String repo

    name of the repo

    CreatePullRequestOption body
    Returns
    Type Description
    System.Threading.Tasks.Task<PullRequest>

    PullRequest

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoCreatePullRequestAsync(String, String, CreatePullRequestOption, CancellationToken)

    Create a pull request

    Declaration
    public virtual async Task<PullRequest> RepoCreatePullRequestAsync(string owner, string repo, CreatePullRequestOption body, CancellationToken cancellationToken)
    Parameters
    Type Name Description
    System.String owner

    owner of the repo

    System.String repo

    name of the repo

    CreatePullRequestOption 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<PullRequest>

    PullRequest

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoCreatePullReviewAsync(String, String, Int64, CreatePullReviewOptions)

    Create a review to an pull request

    Declaration
    public virtual Task<PullReview> RepoCreatePullReviewAsync(string owner, string repo, long index, CreatePullReviewOptions 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 pull request

    CreatePullReviewOptions body
    Returns
    Type Description
    System.Threading.Tasks.Task<PullReview>

    PullReview

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoCreatePullReviewAsync(String, String, Int64, CreatePullReviewOptions, CancellationToken)

    Create a review to an pull request

    Declaration
    public virtual async Task<PullReview> RepoCreatePullReviewAsync(string owner, string repo, long index, CreatePullReviewOptions 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 pull request

    CreatePullReviewOptions 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<PullReview>

    PullReview

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoCreatePullReviewRequestsAsync(String, String, Int64, PullReviewRequestOptions)

    create review requests for a pull request

    Declaration
    public virtual Task<ICollection<PullReview>> RepoCreatePullReviewRequestsAsync(string owner, string repo, long index, PullReviewRequestOptions 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 pull request

    PullReviewRequestOptions body
    Returns
    Type Description
    System.Threading.Tasks.Task<System.Collections.Generic.ICollection<PullReview>>

    PullReviewList

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoCreatePullReviewRequestsAsync(String, String, Int64, PullReviewRequestOptions, CancellationToken)

    create review requests for a pull request

    Declaration
    public virtual async Task<ICollection<PullReview>> RepoCreatePullReviewRequestsAsync(string owner, string repo, long index, PullReviewRequestOptions 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 pull request

    PullReviewRequestOptions 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<PullReview>>

    PullReviewList

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoCreateReleaseAsync(String, String, CreateReleaseOption)

    Create a release

    Declaration
    public virtual Task<Release> RepoCreateReleaseAsync(string owner, string repo, CreateReleaseOption body)
    Parameters
    Type Name Description
    System.String owner

    owner of the repo

    System.String repo

    name of the repo

    CreateReleaseOption body
    Returns
    Type Description
    System.Threading.Tasks.Task<Release>

    Release

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoCreateReleaseAsync(String, String, CreateReleaseOption, CancellationToken)

    Create a release

    Declaration
    public virtual async Task<Release> RepoCreateReleaseAsync(string owner, string repo, CreateReleaseOption body, CancellationToken cancellationToken)
    Parameters
    Type Name Description
    System.String owner

    owner of the repo

    System.String repo

    name of the repo

    CreateReleaseOption 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<Release>

    Release

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoCreateReleaseAttachmentAsync(String, String, Int64, String, FileParameter)

    Create a release attachment

    Declaration
    public virtual Task<Attachment> RepoCreateReleaseAttachmentAsync(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 release

    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.

    | Improve this Doc View Source

    RepoCreateReleaseAttachmentAsync(String, String, Int64, String, FileParameter, CancellationToken)

    Create a release attachment

    Declaration
    public virtual async Task<Attachment> RepoCreateReleaseAttachmentAsync(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 release

    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.

    | Improve this Doc View Source

    RepoCreateStatusAsync(String, String, String, CreateStatusOption)

    Create a commit status

    Declaration
    public virtual Task<CommitStatus> RepoCreateStatusAsync(string owner, string repo, string sha, CreateStatusOption body)
    Parameters
    Type Name Description
    System.String owner

    owner of the repo

    System.String repo

    name of the repo

    System.String sha

    sha of the commit

    CreateStatusOption body
    Returns
    Type Description
    System.Threading.Tasks.Task<CommitStatus>

    CommitStatus

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoCreateStatusAsync(String, String, String, CreateStatusOption, CancellationToken)

    Create a commit status

    Declaration
    public virtual async Task<CommitStatus> RepoCreateStatusAsync(string owner, string repo, string sha, CreateStatusOption body, CancellationToken cancellationToken)
    Parameters
    Type Name Description
    System.String owner

    owner of the repo

    System.String repo

    name of the repo

    System.String sha

    sha of the commit

    CreateStatusOption 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<CommitStatus>

    CommitStatus

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoCreateTagAsync(String, String, CreateTagOption)

    Create a new git tag in a repository

    Declaration
    public virtual Task<Tag> RepoCreateTagAsync(string owner, string repo, CreateTagOption body)
    Parameters
    Type Name Description
    System.String owner

    owner of the repo

    System.String repo

    name of the repo

    CreateTagOption body
    Returns
    Type Description
    System.Threading.Tasks.Task<Tag>

    Tag

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoCreateTagAsync(String, String, CreateTagOption, CancellationToken)

    Create a new git tag in a repository

    Declaration
    public virtual async Task<Tag> RepoCreateTagAsync(string owner, string repo, CreateTagOption body, CancellationToken cancellationToken)
    Parameters
    Type Name Description
    System.String owner

    owner of the repo

    System.String repo

    name of the repo

    CreateTagOption 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<Tag>

    Tag

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoCreateWikiPageAsync(String, String, CreateWikiPageOptions)

    Create a wiki page

    Declaration
    public virtual Task<WikiPage> RepoCreateWikiPageAsync(string owner, string repo, CreateWikiPageOptions body)
    Parameters
    Type Name Description
    System.String owner

    owner of the repo

    System.String repo

    name of the repo

    CreateWikiPageOptions body
    Returns
    Type Description
    System.Threading.Tasks.Task<WikiPage>

    WikiPage

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoCreateWikiPageAsync(String, String, CreateWikiPageOptions, CancellationToken)

    Create a wiki page

    Declaration
    public virtual async Task<WikiPage> RepoCreateWikiPageAsync(string owner, string repo, CreateWikiPageOptions body, CancellationToken cancellationToken)
    Parameters
    Type Name Description
    System.String owner

    owner of the repo

    System.String repo

    name of the repo

    CreateWikiPageOptions 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<WikiPage>

    WikiPage

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoDeleteAsync(String, String)

    Delete a repository

    Declaration
    public virtual Task RepoDeleteAsync(string owner, string repo)
    Parameters
    Type Name Description
    System.String owner

    owner of the repo to delete

    System.String repo

    name of the repo to delete

    Returns
    Type Description
    System.Threading.Tasks.Task

    APIEmpty is an empty response

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoDeleteAsync(String, String, CancellationToken)

    Delete a repository

    Declaration
    public virtual async Task RepoDeleteAsync(string owner, string repo, CancellationToken cancellationToken)
    Parameters
    Type Name Description
    System.String owner

    owner of the repo to delete

    System.String repo

    name of the repo 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.

    | Improve this Doc View Source

    RepoDeleteBranchAsync(String, String, String)

    Delete a specific branch from a repository

    Declaration
    public virtual Task RepoDeleteBranchAsync(string owner, string repo, string branch)
    Parameters
    Type Name Description
    System.String owner

    owner of the repo

    System.String repo

    name of the repo

    System.String branch

    branch to delete

    Returns
    Type Description
    System.Threading.Tasks.Task

    APIEmpty is an empty response

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoDeleteBranchAsync(String, String, String, CancellationToken)

    Delete a specific branch from a repository

    Declaration
    public virtual async Task RepoDeleteBranchAsync(string owner, string repo, string branch, CancellationToken cancellationToken)
    Parameters
    Type Name Description
    System.String owner

    owner of the repo

    System.String repo

    name of the repo

    System.String branch

    branch 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.

    | Improve this Doc View Source

    RepoDeleteBranchProtectionAsync(String, String, String)

    Delete a specific branch protection for the repository

    Declaration
    public virtual Task RepoDeleteBranchProtectionAsync(string owner, string repo, string name)
    Parameters
    Type Name Description
    System.String owner

    owner of the repo

    System.String repo

    name of the repo

    System.String name

    name of protected branch

    Returns
    Type Description
    System.Threading.Tasks.Task

    APIEmpty is an empty response

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoDeleteBranchProtectionAsync(String, String, String, CancellationToken)

    Delete a specific branch protection for the repository

    Declaration
    public virtual async Task RepoDeleteBranchProtectionAsync(string owner, string repo, string name, CancellationToken cancellationToken)
    Parameters
    Type Name Description
    System.String owner

    owner of the repo

    System.String repo

    name of the repo

    System.String name

    name of protected branch

    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.

    | Improve this Doc View Source

    RepoDeleteCollaboratorAsync(String, String, String)

    Delete a collaborator from a repository

    Declaration
    public virtual Task RepoDeleteCollaboratorAsync(string owner, string repo, string collaborator)
    Parameters
    Type Name Description
    System.String owner

    owner of the repo

    System.String repo

    name of the repo

    System.String collaborator

    username of the collaborator to delete

    Returns
    Type Description
    System.Threading.Tasks.Task

    APIEmpty is an empty response

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoDeleteCollaboratorAsync(String, String, String, CancellationToken)

    Delete a collaborator from a repository

    Declaration
    public virtual async Task RepoDeleteCollaboratorAsync(string owner, string repo, string collaborator, CancellationToken cancellationToken)
    Parameters
    Type Name Description
    System.String owner

    owner of the repo

    System.String repo

    name of the repo

    System.String collaborator

    username of the collaborator 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.

    | Improve this Doc View Source

    RepoDeleteFileAsync(String, String, String, DeleteFileOptions)

    Delete a file in a repository

    Declaration
    public virtual Task<FileDeleteResponse> RepoDeleteFileAsync(string owner, string repo, string filepath, DeleteFileOptions body)
    Parameters
    Type Name Description
    System.String owner

    owner of the repo

    System.String repo

    name of the repo

    System.String filepath

    path of the file to delete

    DeleteFileOptions body
    Returns
    Type Description
    System.Threading.Tasks.Task<FileDeleteResponse>

    FileDeleteResponse

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoDeleteFileAsync(String, String, String, DeleteFileOptions, CancellationToken)

    Delete a file in a repository

    Declaration
    public virtual async Task<FileDeleteResponse> RepoDeleteFileAsync(string owner, string repo, string filepath, DeleteFileOptions body, CancellationToken cancellationToken)
    Parameters
    Type Name Description
    System.String owner

    owner of the repo

    System.String repo

    name of the repo

    System.String filepath

    path of the file to delete

    DeleteFileOptions 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<FileDeleteResponse>

    FileDeleteResponse

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoDeleteGitHookAsync(String, String, String)

    Delete a Git hook in a repository

    Declaration
    public virtual Task RepoDeleteGitHookAsync(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

    id of the hook to get

    Returns
    Type Description
    System.Threading.Tasks.Task

    APIEmpty is an empty response

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoDeleteGitHookAsync(String, String, String, CancellationToken)

    Delete a Git hook in a repository

    Declaration
    public virtual async Task RepoDeleteGitHookAsync(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

    id of the hook 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

    APIEmpty is an empty response

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoDeleteHookAsync(String, String, Int64)

    Delete a hook in a repository

    Declaration
    public virtual Task RepoDeleteHookAsync(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 hook to delete

    Returns
    Type Description
    System.Threading.Tasks.Task

    APIEmpty is an empty response

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoDeleteHookAsync(String, String, Int64, CancellationToken)

    Delete a hook in a repository

    Declaration
    public virtual async Task RepoDeleteHookAsync(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 hook 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.

    | Improve this Doc View Source

    RepoDeleteKeyAsync(String, String, Int64)

    Delete a key from a repository

    Declaration
    public virtual Task RepoDeleteKeyAsync(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 key to delete

    Returns
    Type Description
    System.Threading.Tasks.Task

    APIEmpty is an empty response

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoDeleteKeyAsync(String, String, Int64, CancellationToken)

    Delete a key from a repository

    Declaration
    public virtual async Task RepoDeleteKeyAsync(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 key 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.

    | Improve this Doc View Source

    RepoDeletePullReviewAsync(String, String, Int64, Int64)

    Delete a specific review from a pull request

    Declaration
    public virtual Task RepoDeletePullReviewAsync(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 pull request

    System.Int64 id

    id of the review

    Returns
    Type Description
    System.Threading.Tasks.Task

    APIEmpty is an empty response

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoDeletePullReviewAsync(String, String, Int64, Int64, CancellationToken)

    Delete a specific review from a pull request

    Declaration
    public virtual async Task RepoDeletePullReviewAsync(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 pull request

    System.Int64 id

    id of the review

    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.

    | Improve this Doc View Source

    RepoDeletePullReviewRequestsAsync(String, String, Int64, PullReviewRequestOptions)

    cancel review requests for a pull request

    Declaration
    public virtual Task RepoDeletePullReviewRequestsAsync(string owner, string repo, long index, PullReviewRequestOptions 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 pull request

    PullReviewRequestOptions body
    Returns
    Type Description
    System.Threading.Tasks.Task

    APIEmpty is an empty response

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoDeletePullReviewRequestsAsync(String, String, Int64, PullReviewRequestOptions, CancellationToken)

    cancel review requests for a pull request

    Declaration
    public virtual async Task RepoDeletePullReviewRequestsAsync(string owner, string repo, long index, PullReviewRequestOptions 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 pull request

    PullReviewRequestOptions 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

    APIEmpty is an empty response

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoDeletePushMirrorAsync(String, String, String)

    deletes a push mirror from a repository by remoteName

    Declaration
    public virtual Task RepoDeletePushMirrorAsync(string owner, string repo, string name)
    Parameters
    Type Name Description
    System.String owner

    owner of the repo

    System.String repo

    name of the repo

    System.String name

    remote name of the pushMirror

    Returns
    Type Description
    System.Threading.Tasks.Task

    APIEmpty is an empty response

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoDeletePushMirrorAsync(String, String, String, CancellationToken)

    deletes a push mirror from a repository by remoteName

    Declaration
    public virtual async Task RepoDeletePushMirrorAsync(string owner, string repo, string name, CancellationToken cancellationToken)
    Parameters
    Type Name Description
    System.String owner

    owner of the repo

    System.String repo

    name of the repo

    System.String name

    remote name of the pushMirror

    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.

    | Improve this Doc View Source

    RepoDeleteReleaseAsync(String, String, Int64)

    Delete a release

    Declaration
    public virtual Task RepoDeleteReleaseAsync(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 release to delete

    Returns
    Type Description
    System.Threading.Tasks.Task

    APIEmpty is an empty response

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoDeleteReleaseAsync(String, String, Int64, CancellationToken)

    Delete a release

    Declaration
    public virtual async Task RepoDeleteReleaseAsync(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 release 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.

    | Improve this Doc View Source

    RepoDeleteReleaseAttachmentAsync(String, String, Int64, Int64)

    Delete a release attachment

    Declaration
    public virtual Task RepoDeleteReleaseAttachmentAsync(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 release

    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.

    | Improve this Doc View Source

    RepoDeleteReleaseAttachmentAsync(String, String, Int64, Int64, CancellationToken)

    Delete a release attachment

    Declaration
    public virtual async Task RepoDeleteReleaseAttachmentAsync(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 release

    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.

    | Improve this Doc View Source

    RepoDeleteReleaseByTagAsync(String, String, String)

    Delete a release by tag name

    Declaration
    public virtual Task RepoDeleteReleaseByTagAsync(string owner, string repo, string tag)
    Parameters
    Type Name Description
    System.String owner

    owner of the repo

    System.String repo

    name of the repo

    System.String tag

    tag name of the release to delete

    Returns
    Type Description
    System.Threading.Tasks.Task

    APIEmpty is an empty response

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoDeleteReleaseByTagAsync(String, String, String, CancellationToken)

    Delete a release by tag name

    Declaration
    public virtual async Task RepoDeleteReleaseByTagAsync(string owner, string repo, string tag, CancellationToken cancellationToken)
    Parameters
    Type Name Description
    System.String owner

    owner of the repo

    System.String repo

    name of the repo

    System.String tag

    tag name of the release 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.

    | Improve this Doc View Source

    RepoDeleteTagAsync(String, String, String)

    Delete a repository's tag by name

    Declaration
    public virtual Task RepoDeleteTagAsync(string owner, string repo, string tag)
    Parameters
    Type Name Description
    System.String owner

    owner of the repo

    System.String repo

    name of the repo

    System.String tag

    name of tag to delete

    Returns
    Type Description
    System.Threading.Tasks.Task

    APIEmpty is an empty response

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoDeleteTagAsync(String, String, String, CancellationToken)

    Delete a repository's tag by name

    Declaration
    public virtual async Task RepoDeleteTagAsync(string owner, string repo, string tag, CancellationToken cancellationToken)
    Parameters
    Type Name Description
    System.String owner

    owner of the repo

    System.String repo

    name of the repo

    System.String tag

    name of tag 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.

    | Improve this Doc View Source

    RepoDeleteTeamAsync(String, String, String)

    Delete a team from a repository

    Declaration
    public virtual Task RepoDeleteTeamAsync(string owner, string repo, string team)
    Parameters
    Type Name Description
    System.String owner

    owner of the repo

    System.String repo

    name of the repo

    System.String team

    team name

    Returns
    Type Description
    System.Threading.Tasks.Task

    APIEmpty is an empty response

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoDeleteTeamAsync(String, String, String, CancellationToken)

    Delete a team from a repository

    Declaration
    public virtual async Task RepoDeleteTeamAsync(string owner, string repo, string team, CancellationToken cancellationToken)
    Parameters
    Type Name Description
    System.String owner

    owner of the repo

    System.String repo

    name of the repo

    System.String team

    team 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.

    | Improve this Doc View Source

    RepoDeleteTopicAsync(String, String, String)

    Delete a topic from a repository

    Declaration
    public virtual Task RepoDeleteTopicAsync(string owner, string repo, string topic)
    Parameters
    Type Name Description
    System.String owner

    owner of the repo

    System.String repo

    name of the repo

    System.String topic

    name of the topic to delete

    Returns
    Type Description
    System.Threading.Tasks.Task

    APIEmpty is an empty response

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoDeleteTopicAsync(String, String, String, CancellationToken)

    Delete a topic from a repository

    Declaration
    public virtual async Task RepoDeleteTopicAsync(string owner, string repo, string topic, CancellationToken cancellationToken)
    Parameters
    Type Name Description
    System.String owner

    owner of the repo

    System.String repo

    name of the repo

    System.String topic

    name of the topic 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.

    | Improve this Doc View Source

    RepoDeleteWikiPageAsync(String, String, String)

    Delete a wiki page

    Declaration
    public virtual Task RepoDeleteWikiPageAsync(string owner, string repo, string pageName)
    Parameters
    Type Name Description
    System.String owner

    owner of the repo

    System.String repo

    name of the repo

    System.String pageName

    name of the page

    Returns
    Type Description
    System.Threading.Tasks.Task

    APIEmpty is an empty response

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoDeleteWikiPageAsync(String, String, String, CancellationToken)

    Delete a wiki page

    Declaration
    public virtual async Task RepoDeleteWikiPageAsync(string owner, string repo, string pageName, CancellationToken cancellationToken)
    Parameters
    Type Name Description
    System.String owner

    owner of the repo

    System.String repo

    name of the repo

    System.String pageName

    name of the page

    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.

    | Improve this Doc View Source

    RepoDismissPullReviewAsync(String, String, Int64, Int64, DismissPullReviewOptions)

    Dismiss a review for a pull request

    Declaration
    public virtual Task<PullReview> RepoDismissPullReviewAsync(string owner, string repo, long index, long id, DismissPullReviewOptions 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 pull request

    System.Int64 id

    id of the review

    DismissPullReviewOptions body
    Returns
    Type Description
    System.Threading.Tasks.Task<PullReview>

    PullReview

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoDismissPullReviewAsync(String, String, Int64, Int64, DismissPullReviewOptions, CancellationToken)

    Dismiss a review for a pull request

    Declaration
    public virtual async Task<PullReview> RepoDismissPullReviewAsync(string owner, string repo, long index, long id, DismissPullReviewOptions 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 pull request

    System.Int64 id

    id of the review

    DismissPullReviewOptions 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<PullReview>

    PullReview

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoDownloadCommitDiffOrPatchAsync(String, String, String, DiffType)

    Get a commit's diff or patch

    Declaration
    public virtual Task<string> RepoDownloadCommitDiffOrPatchAsync(string owner, string repo, string sha, DiffType diffType)
    Parameters
    Type Name Description
    System.String owner

    owner of the repo

    System.String repo

    name of the repo

    System.String sha

    SHA of the commit to get

    DiffType diffType

    whether the output is diff or patch

    Returns
    Type Description
    System.Threading.Tasks.Task<System.String>

    APIString is a string response

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoDownloadCommitDiffOrPatchAsync(String, String, String, DiffType, CancellationToken)

    Get a commit's diff or patch

    Declaration
    public virtual async Task<string> RepoDownloadCommitDiffOrPatchAsync(string owner, string repo, string sha, DiffType diffType, CancellationToken cancellationToken)
    Parameters
    Type Name Description
    System.String owner

    owner of the repo

    System.String repo

    name of the repo

    System.String sha

    SHA of the commit to get

    DiffType diffType

    whether the output is diff or patch

    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.String>

    APIString is a string response

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoDownloadPullDiffOrPatchAsync(String, String, Int64, DiffType2, Nullable<Boolean>)

    Get a pull request diff or patch

    Declaration
    public virtual Task<string> RepoDownloadPullDiffOrPatchAsync(string owner, string repo, long index, DiffType2 diffType, bool? binary)
    Parameters
    Type Name Description
    System.String owner

    owner of the repo

    System.String repo

    name of the repo

    System.Int64 index

    index of the pull request to get

    DiffType2 diffType

    whether the output is diff or patch

    System.Nullable<System.Boolean> binary

    whether to include binary file changes. if true, the diff is applicable with git apply

    Returns
    Type Description
    System.Threading.Tasks.Task<System.String>

    APIString is a string response

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoDownloadPullDiffOrPatchAsync(String, String, Int64, DiffType2, Nullable<Boolean>, CancellationToken)

    Get a pull request diff or patch

    Declaration
    public virtual async Task<string> RepoDownloadPullDiffOrPatchAsync(string owner, string repo, long index, DiffType2 diffType, bool? binary, 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 pull request to get

    DiffType2 diffType

    whether the output is diff or patch

    System.Nullable<System.Boolean> binary

    whether to include binary file changes. if true, the diff is applicable with git apply

    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.String>

    APIString is a string response

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoEditAsync(String, String, EditRepoOption)

    Edit a repository's properties. Only fields that are set will be changed.

    Declaration
    public virtual Task<Repository> RepoEditAsync(string owner, string repo, EditRepoOption body)
    Parameters
    Type Name Description
    System.String owner

    owner of the repo to edit

    System.String repo

    name of the repo to edit

    EditRepoOption body

    Properties of a repo that you can edit

    Returns
    Type Description
    System.Threading.Tasks.Task<Repository>

    Repository

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoEditAsync(String, String, EditRepoOption, CancellationToken)

    Edit a repository's properties. Only fields that are set will be changed.

    Declaration
    public virtual async Task<Repository> RepoEditAsync(string owner, string repo, EditRepoOption body, CancellationToken cancellationToken)
    Parameters
    Type Name Description
    System.String owner

    owner of the repo to edit

    System.String repo

    name of the repo to edit

    EditRepoOption body

    Properties of a repo that you can 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<Repository>

    Repository

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoEditBranchProtectionAsync(String, String, String, EditBranchProtectionOption)

    Edit a branch protections for a repository. Only fields that are set will be changed

    Declaration
    public virtual Task<BranchProtection> RepoEditBranchProtectionAsync(string owner, string repo, string name, EditBranchProtectionOption body)
    Parameters
    Type Name Description
    System.String owner

    owner of the repo

    System.String repo

    name of the repo

    System.String name

    name of protected branch

    EditBranchProtectionOption body
    Returns
    Type Description
    System.Threading.Tasks.Task<BranchProtection>

    BranchProtection

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoEditBranchProtectionAsync(String, String, String, EditBranchProtectionOption, CancellationToken)

    Edit a branch protections for a repository. Only fields that are set will be changed

    Declaration
    public virtual async Task<BranchProtection> RepoEditBranchProtectionAsync(string owner, string repo, string name, EditBranchProtectionOption body, CancellationToken cancellationToken)
    Parameters
    Type Name Description
    System.String owner

    owner of the repo

    System.String repo

    name of the repo

    System.String name

    name of protected branch

    EditBranchProtectionOption 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<BranchProtection>

    BranchProtection

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoEditGitHookAsync(String, String, String, EditGitHookOption)

    Edit a Git hook in a repository

    Declaration
    public virtual Task<GitHook> RepoEditGitHookAsync(string owner, string repo, string id, EditGitHookOption body)
    Parameters
    Type Name Description
    System.String owner

    owner of the repo

    System.String repo

    name of the repo

    System.String id

    id of the hook to get

    EditGitHookOption body
    Returns
    Type Description
    System.Threading.Tasks.Task<GitHook>

    GitHook

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoEditGitHookAsync(String, String, String, EditGitHookOption, CancellationToken)

    Edit a Git hook in a repository

    Declaration
    public virtual async Task<GitHook> RepoEditGitHookAsync(string owner, string repo, string id, EditGitHookOption body, CancellationToken cancellationToken)
    Parameters
    Type Name Description
    System.String owner

    owner of the repo

    System.String repo

    name of the repo

    System.String id

    id of the hook to get

    EditGitHookOption 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<GitHook>

    GitHook

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoEditHookAsync(String, String, Int64, EditHookOption)

    Edit a hook in a repository

    Declaration
    public virtual Task<Hook> RepoEditHookAsync(string owner, string repo, long id, EditHookOption body)
    Parameters
    Type Name Description
    System.String owner

    owner of the repo

    System.String repo

    name of the repo

    System.Int64 id

    index of the hook

    EditHookOption body
    Returns
    Type Description
    System.Threading.Tasks.Task<Hook>

    Hook

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoEditHookAsync(String, String, Int64, EditHookOption, CancellationToken)

    Edit a hook in a repository

    Declaration
    public virtual async Task<Hook> RepoEditHookAsync(string owner, string repo, long id, EditHookOption body, CancellationToken cancellationToken)
    Parameters
    Type Name Description
    System.String owner

    owner of the repo

    System.String repo

    name of the repo

    System.Int64 id

    index of the hook

    EditHookOption 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<Hook>

    Hook

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoEditPullRequestAsync(String, String, Int64, EditPullRequestOption)

    Update a pull request. If using deadline only the date will be taken into account, and time of day ignored.

    Declaration
    public virtual Task<PullRequest> RepoEditPullRequestAsync(string owner, string repo, long index, EditPullRequestOption 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 pull request to edit

    EditPullRequestOption body
    Returns
    Type Description
    System.Threading.Tasks.Task<PullRequest>

    PullRequest

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoEditPullRequestAsync(String, String, Int64, EditPullRequestOption, CancellationToken)

    Update a pull request. If using deadline only the date will be taken into account, and time of day ignored.

    Declaration
    public virtual async Task<PullRequest> RepoEditPullRequestAsync(string owner, string repo, long index, EditPullRequestOption 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 pull request to edit

    EditPullRequestOption 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<PullRequest>

    PullRequest

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoEditReleaseAsync(String, String, Int64, EditReleaseOption)

    Update a release

    Declaration
    public virtual Task<Release> RepoEditReleaseAsync(string owner, string repo, long id, EditReleaseOption 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 release to edit

    EditReleaseOption body
    Returns
    Type Description
    System.Threading.Tasks.Task<Release>

    Release

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoEditReleaseAsync(String, String, Int64, EditReleaseOption, CancellationToken)

    Update a release

    Declaration
    public virtual async Task<Release> RepoEditReleaseAsync(string owner, string repo, long id, EditReleaseOption 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 release to edit

    EditReleaseOption 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<Release>

    Release

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoEditReleaseAttachmentAsync(String, String, Int64, Int64, EditAttachmentOptions)

    Edit a release attachment

    Declaration
    public virtual Task<Attachment> RepoEditReleaseAttachmentAsync(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 release

    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.

    | Improve this Doc View Source

    RepoEditReleaseAttachmentAsync(String, String, Int64, Int64, EditAttachmentOptions, CancellationToken)

    Edit a release attachment

    Declaration
    public virtual async Task<Attachment> RepoEditReleaseAttachmentAsync(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 release

    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.

    | Improve this Doc View Source

    RepoEditWikiPageAsync(String, String, String, CreateWikiPageOptions)

    Edit a wiki page

    Declaration
    public virtual Task<WikiPage> RepoEditWikiPageAsync(string owner, string repo, string pageName, CreateWikiPageOptions body)
    Parameters
    Type Name Description
    System.String owner

    owner of the repo

    System.String repo

    name of the repo

    System.String pageName

    name of the page

    CreateWikiPageOptions body
    Returns
    Type Description
    System.Threading.Tasks.Task<WikiPage>

    WikiPage

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoEditWikiPageAsync(String, String, String, CreateWikiPageOptions, CancellationToken)

    Edit a wiki page

    Declaration
    public virtual async Task<WikiPage> RepoEditWikiPageAsync(string owner, string repo, string pageName, CreateWikiPageOptions body, CancellationToken cancellationToken)
    Parameters
    Type Name Description
    System.String owner

    owner of the repo

    System.String repo

    name of the repo

    System.String pageName

    name of the page

    CreateWikiPageOptions 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<WikiPage>

    WikiPage

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoGetAllCommitsAsync(String, String, String, String, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Int32>, Nullable<Int32>, String)

    Get a list of all commits from a repository

    Declaration
    public virtual Task<ICollection<Commit>> RepoGetAllCommitsAsync(string owner, string repo, string sha, string path, bool? stat, bool? verification, bool? files, int? page, int? limit, string not)
    Parameters
    Type Name Description
    System.String owner

    owner of the repo

    System.String repo

    name of the repo

    System.String sha

    SHA or branch to start listing commits from (usually 'master')

    System.String path

    filepath of a file/dir

    System.Nullable<System.Boolean> stat

    include diff stats for every commit (disable for speedup, default 'true')

    System.Nullable<System.Boolean> verification

    include verification for every commit (disable for speedup, default 'true')

    System.Nullable<System.Boolean> files

    include a list of affected files for every commit (disable for speedup, default 'true')

    System.Nullable<System.Int32> page

    page number of results to return (1-based)

    System.Nullable<System.Int32> limit

    page size of results (ignored if used with 'path')

    System.String not

    commits that match the given specifier will not be listed.

    Returns
    Type Description
    System.Threading.Tasks.Task<System.Collections.Generic.ICollection<Commit>>

    CommitList

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoGetAllCommitsAsync(String, String, String, String, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Int32>, Nullable<Int32>, String, CancellationToken)

    Get a list of all commits from a repository

    Declaration
    public virtual async Task<ICollection<Commit>> RepoGetAllCommitsAsync(string owner, string repo, string sha, string path, bool? stat, bool? verification, bool? files, int? page, int? limit, string not, CancellationToken cancellationToken)
    Parameters
    Type Name Description
    System.String owner

    owner of the repo

    System.String repo

    name of the repo

    System.String sha

    SHA or branch to start listing commits from (usually 'master')

    System.String path

    filepath of a file/dir

    System.Nullable<System.Boolean> stat

    include diff stats for every commit (disable for speedup, default 'true')

    System.Nullable<System.Boolean> verification

    include verification for every commit (disable for speedup, default 'true')

    System.Nullable<System.Boolean> files

    include a list of affected files for every commit (disable for speedup, default 'true')

    System.Nullable<System.Int32> page

    page number of results to return (1-based)

    System.Nullable<System.Int32> limit

    page size of results (ignored if used with 'path')

    System.String not

    commits that match the given specifier will not be listed.

    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<Commit>>

    CommitList

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoGetArchiveAsync(String, String, String)

    Get an archive of a repository

    Declaration
    public virtual Task RepoGetArchiveAsync(string owner, string repo, string archive)
    Parameters
    Type Name Description
    System.String owner

    owner of the repo

    System.String repo

    name of the repo

    System.String archive

    the git reference for download with attached archive format (e.g. master.zip)

    Returns
    Type Description
    System.Threading.Tasks.Task

    success

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoGetArchiveAsync(String, String, String, CancellationToken)

    Get an archive of a repository

    Declaration
    public virtual async Task RepoGetArchiveAsync(string owner, string repo, string archive, CancellationToken cancellationToken)
    Parameters
    Type Name Description
    System.String owner

    owner of the repo

    System.String repo

    name of the repo

    System.String archive

    the git reference for download with attached archive format (e.g. master.zip)

    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

    success

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoGetAssigneesAsync(String, String)

    Return all users that have write access and can be assigned to issues

    Declaration
    public virtual Task<ICollection<User>> RepoGetAssigneesAsync(string owner, string repo)
    Parameters
    Type Name Description
    System.String owner

    owner of the repo

    System.String repo

    name of the repo

    Returns
    Type Description
    System.Threading.Tasks.Task<System.Collections.Generic.ICollection<User>>

    UserList

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoGetAssigneesAsync(String, String, CancellationToken)

    Return all users that have write access and can be assigned to issues

    Declaration
    public virtual async Task<ICollection<User>> RepoGetAssigneesAsync(string owner, string repo, CancellationToken cancellationToken)
    Parameters
    Type Name Description
    System.String owner

    owner of the repo

    System.String repo

    name of the repo

    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.

    | Improve this Doc View Source

    RepoGetAsync(String, String)

    Get a repository

    Declaration
    public virtual Task<Repository> RepoGetAsync(string owner, string repo)
    Parameters
    Type Name Description
    System.String owner

    owner of the repo

    System.String repo

    name of the repo

    Returns
    Type Description
    System.Threading.Tasks.Task<Repository>

    Repository

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoGetAsync(String, String, CancellationToken)

    Get a repository

    Declaration
    public virtual async Task<Repository> RepoGetAsync(string owner, string repo, CancellationToken cancellationToken)
    Parameters
    Type Name Description
    System.String owner

    owner of the repo

    System.String repo

    name of the repo

    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<Repository>

    Repository

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoGetBranchAsync(String, String, String)

    Retrieve a specific branch from a repository, including its effective branch protection

    Declaration
    public virtual Task<Branch> RepoGetBranchAsync(string owner, string repo, string branch)
    Parameters
    Type Name Description
    System.String owner

    owner of the repo

    System.String repo

    name of the repo

    System.String branch

    branch to get

    Returns
    Type Description
    System.Threading.Tasks.Task<Branch>

    Branch

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoGetBranchAsync(String, String, String, CancellationToken)

    Retrieve a specific branch from a repository, including its effective branch protection

    Declaration
    public virtual async Task<Branch> RepoGetBranchAsync(string owner, string repo, string branch, CancellationToken cancellationToken)
    Parameters
    Type Name Description
    System.String owner

    owner of the repo

    System.String repo

    name of the repo

    System.String branch

    branch 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<Branch>

    Branch

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoGetBranchProtectionAsync(String, String, String)

    Get a specific branch protection for the repository

    Declaration
    public virtual Task<BranchProtection> RepoGetBranchProtectionAsync(string owner, string repo, string name)
    Parameters
    Type Name Description
    System.String owner

    owner of the repo

    System.String repo

    name of the repo

    System.String name

    name of protected branch

    Returns
    Type Description
    System.Threading.Tasks.Task<BranchProtection>

    BranchProtection

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoGetBranchProtectionAsync(String, String, String, CancellationToken)

    Get a specific branch protection for the repository

    Declaration
    public virtual async Task<BranchProtection> RepoGetBranchProtectionAsync(string owner, string repo, string name, CancellationToken cancellationToken)
    Parameters
    Type Name Description
    System.String owner

    owner of the repo

    System.String repo

    name of the repo

    System.String name

    name of protected branch

    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<BranchProtection>

    BranchProtection

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoGetByIDAsync(Int64)

    Get a repository by id

    Declaration
    public virtual Task<Repository> RepoGetByIDAsync(long id)
    Parameters
    Type Name Description
    System.Int64 id

    id of the repo to get

    Returns
    Type Description
    System.Threading.Tasks.Task<Repository>

    Repository

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoGetByIDAsync(Int64, CancellationToken)

    Get a repository by id

    Declaration
    public virtual async Task<Repository> RepoGetByIDAsync(long id, CancellationToken cancellationToken)
    Parameters
    Type Name Description
    System.Int64 id

    id of the repo 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<Repository>

    Repository

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoGetCombinedStatusByRefAsync(String, String, String, Nullable<Int32>, Nullable<Int32>)

    Get a commit's combined status, by branch/tag/commit reference

    Declaration
    public virtual Task<CombinedStatus> RepoGetCombinedStatusByRefAsync(string owner, string repo, string ref, int? page, int? limit)
    Parameters
    Type Name Description
    System.String owner

    owner of the repo

    System.String repo

    name of the repo

    System.String ref

    name of branch/tag/commit

    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<CombinedStatus>

    CombinedStatus

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoGetCombinedStatusByRefAsync(String, String, String, Nullable<Int32>, Nullable<Int32>, CancellationToken)

    Get a commit's combined status, by branch/tag/commit reference

    Declaration
    public virtual async Task<CombinedStatus> RepoGetCombinedStatusByRefAsync(string owner, string repo, string ref, 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 ref

    name of branch/tag/commit

    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<CombinedStatus>

    CombinedStatus

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoGetContentsAsync(String, String, String, String)

    Gets the metadata and contents (if a file) of an entry in a repository, or a list of entries if a dir

    Declaration
    public virtual Task<ContentsResponse> RepoGetContentsAsync(string owner, string repo, string filepath, string ref)
    Parameters
    Type Name Description
    System.String owner

    owner of the repo

    System.String repo

    name of the repo

    System.String filepath

    path of the dir, file, symlink or submodule in the repo

    System.String ref

    The name of the commit/branch/tag. Default the repository’s default branch (usually master)

    Returns
    Type Description
    System.Threading.Tasks.Task<ContentsResponse>

    ContentsResponse

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoGetContentsAsync(String, String, String, String, CancellationToken)

    Gets the metadata and contents (if a file) of an entry in a repository, or a list of entries if a dir

    Declaration
    public virtual async Task<ContentsResponse> RepoGetContentsAsync(string owner, string repo, string filepath, string ref, CancellationToken cancellationToken)
    Parameters
    Type Name Description
    System.String owner

    owner of the repo

    System.String repo

    name of the repo

    System.String filepath

    path of the dir, file, symlink or submodule in the repo

    System.String ref

    The name of the commit/branch/tag. Default the repository’s default branch (usually master)

    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<ContentsResponse>

    ContentsResponse

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoGetContentsListAsync(String, String, String)

    Gets the metadata of all the entries of the root dir

    Declaration
    public virtual Task<ICollection<ContentsResponse>> RepoGetContentsListAsync(string owner, string repo, string ref)
    Parameters
    Type Name Description
    System.String owner

    owner of the repo

    System.String repo

    name of the repo

    System.String ref

    The name of the commit/branch/tag. Default the repository’s default branch (usually master)

    Returns
    Type Description
    System.Threading.Tasks.Task<System.Collections.Generic.ICollection<ContentsResponse>>

    ContentsListResponse

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoGetContentsListAsync(String, String, String, CancellationToken)

    Gets the metadata of all the entries of the root dir

    Declaration
    public virtual async Task<ICollection<ContentsResponse>> RepoGetContentsListAsync(string owner, string repo, string ref, CancellationToken cancellationToken)
    Parameters
    Type Name Description
    System.String owner

    owner of the repo

    System.String repo

    name of the repo

    System.String ref

    The name of the commit/branch/tag. Default the repository’s default branch (usually master)

    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<ContentsResponse>>

    ContentsListResponse

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoGetEditorConfigAsync(String, String, String, String)

    Get the EditorConfig definitions of a file in a repository

    Declaration
    public virtual Task RepoGetEditorConfigAsync(string owner, string repo, string filepath, string ref)
    Parameters
    Type Name Description
    System.String owner

    owner of the repo

    System.String repo

    name of the repo

    System.String filepath

    filepath of file to get

    System.String ref

    The name of the commit/branch/tag. Default the repository’s default branch (usually master)

    Returns
    Type Description
    System.Threading.Tasks.Task

    success

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoGetEditorConfigAsync(String, String, String, String, CancellationToken)

    Get the EditorConfig definitions of a file in a repository

    Declaration
    public virtual async Task RepoGetEditorConfigAsync(string owner, string repo, string filepath, string ref, CancellationToken cancellationToken)
    Parameters
    Type Name Description
    System.String owner

    owner of the repo

    System.String repo

    name of the repo

    System.String filepath

    filepath of file to get

    System.String ref

    The name of the commit/branch/tag. Default the repository’s default branch (usually master)

    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

    success

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoGetGitHookAsync(String, String, String)

    Get a Git hook

    Declaration
    public virtual Task<GitHook> RepoGetGitHookAsync(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

    id of the hook to get

    Returns
    Type Description
    System.Threading.Tasks.Task<GitHook>

    GitHook

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoGetGitHookAsync(String, String, String, CancellationToken)

    Get a Git hook

    Declaration
    public virtual async Task<GitHook> RepoGetGitHookAsync(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

    id of the hook 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<GitHook>

    GitHook

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoGetHookAsync(String, String, Int64)

    Get a hook

    Declaration
    public virtual Task<Hook> RepoGetHookAsync(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 hook to get

    Returns
    Type Description
    System.Threading.Tasks.Task<Hook>

    Hook

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoGetHookAsync(String, String, Int64, CancellationToken)

    Get a hook

    Declaration
    public virtual async Task<Hook> RepoGetHookAsync(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 hook 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<Hook>

    Hook

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoGetIssueConfigAsync(String, String)

    Returns the issue config for a repo

    Declaration
    public virtual Task<IssueConfig> RepoGetIssueConfigAsync(string owner, string repo)
    Parameters
    Type Name Description
    System.String owner

    owner of the repo

    System.String repo

    name of the repo

    Returns
    Type Description
    System.Threading.Tasks.Task<IssueConfig>

    RepoIssueConfig

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoGetIssueConfigAsync(String, String, CancellationToken)

    Returns the issue config for a repo

    Declaration
    public virtual async Task<IssueConfig> RepoGetIssueConfigAsync(string owner, string repo, CancellationToken cancellationToken)
    Parameters
    Type Name Description
    System.String owner

    owner of the repo

    System.String repo

    name of the repo

    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<IssueConfig>

    RepoIssueConfig

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoGetIssueTemplatesAsync(String, String)

    Get available issue templates for a repository

    Declaration
    public virtual Task<ICollection<IssueTemplate>> RepoGetIssueTemplatesAsync(string owner, string repo)
    Parameters
    Type Name Description
    System.String owner

    owner of the repo

    System.String repo

    name of the repo

    Returns
    Type Description
    System.Threading.Tasks.Task<System.Collections.Generic.ICollection<IssueTemplate>>

    IssueTemplates

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoGetIssueTemplatesAsync(String, String, CancellationToken)

    Get available issue templates for a repository

    Declaration
    public virtual async Task<ICollection<IssueTemplate>> RepoGetIssueTemplatesAsync(string owner, string repo, CancellationToken cancellationToken)
    Parameters
    Type Name Description
    System.String owner

    owner of the repo

    System.String repo

    name of the repo

    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<IssueTemplate>>

    IssueTemplates

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoGetKeyAsync(String, String, Int64)

    Get a repository's key by id

    Declaration
    public virtual Task<DeployKey> RepoGetKeyAsync(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 key to get

    Returns
    Type Description
    System.Threading.Tasks.Task<DeployKey>

    DeployKey

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoGetKeyAsync(String, String, Int64, CancellationToken)

    Get a repository's key by id

    Declaration
    public virtual async Task<DeployKey> RepoGetKeyAsync(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 key 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<DeployKey>

    DeployKey

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoGetLanguagesAsync(String, String)

    Get languages and number of bytes of code written

    Declaration
    public virtual Task<IDictionary<string, long>> RepoGetLanguagesAsync(string owner, string repo)
    Parameters
    Type Name Description
    System.String owner

    owner of the repo

    System.String repo

    name of the repo

    Returns
    Type Description
    System.Threading.Tasks.Task<System.Collections.Generic.IDictionary<System.String, System.Int64>>

    LanguageStatistics

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoGetLanguagesAsync(String, String, CancellationToken)

    Get languages and number of bytes of code written

    Declaration
    public virtual async Task<IDictionary<string, long>> RepoGetLanguagesAsync(string owner, string repo, CancellationToken cancellationToken)
    Parameters
    Type Name Description
    System.String owner

    owner of the repo

    System.String repo

    name of the repo

    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.IDictionary<System.String, System.Int64>>

    LanguageStatistics

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoGetLatestReleaseAsync(String, String)

    Gets the most recent non-prerelease, non-draft release of a repository, sorted by created_at

    Declaration
    public virtual Task<Release> RepoGetLatestReleaseAsync(string owner, string repo)
    Parameters
    Type Name Description
    System.String owner

    owner of the repo

    System.String repo

    name of the repo

    Returns
    Type Description
    System.Threading.Tasks.Task<Release>

    Release

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoGetLatestReleaseAsync(String, String, CancellationToken)

    Gets the most recent non-prerelease, non-draft release of a repository, sorted by created_at

    Declaration
    public virtual async Task<Release> RepoGetLatestReleaseAsync(string owner, string repo, CancellationToken cancellationToken)
    Parameters
    Type Name Description
    System.String owner

    owner of the repo

    System.String repo

    name of the repo

    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<Release>

    Release

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoGetNoteAsync(String, String, String)

    Get a note corresponding to a single commit from a repository

    Declaration
    public virtual Task<Note> RepoGetNoteAsync(string owner, string repo, string sha)
    Parameters
    Type Name Description
    System.String owner

    owner of the repo

    System.String repo

    name of the repo

    System.String sha

    a git ref or commit sha

    Returns
    Type Description
    System.Threading.Tasks.Task<Note>

    Note

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoGetNoteAsync(String, String, String, CancellationToken)

    Get a note corresponding to a single commit from a repository

    Declaration
    public virtual async Task<Note> RepoGetNoteAsync(string owner, string repo, string sha, CancellationToken cancellationToken)
    Parameters
    Type Name Description
    System.String owner

    owner of the repo

    System.String repo

    name of the repo

    System.String sha

    a git ref or commit sha

    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<Note>

    Note

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoGetPullRequestAsync(String, String, Int64)

    Get a pull request

    Declaration
    public virtual Task<PullRequest> RepoGetPullRequestAsync(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 pull request to get

    Returns
    Type Description
    System.Threading.Tasks.Task<PullRequest>

    PullRequest

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoGetPullRequestAsync(String, String, Int64, CancellationToken)

    Get a pull request

    Declaration
    public virtual async Task<PullRequest> RepoGetPullRequestAsync(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 pull request 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<PullRequest>

    PullRequest

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoGetPullRequestCommitsAsync(String, String, Int64, Nullable<Int32>, Nullable<Int32>)

    Get commits for a pull request

    Declaration
    public virtual Task<ICollection<Commit>> RepoGetPullRequestCommitsAsync(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 pull request to get

    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<Commit>>

    CommitList

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoGetPullRequestCommitsAsync(String, String, Int64, Nullable<Int32>, Nullable<Int32>, CancellationToken)

    Get commits for a pull request

    Declaration
    public virtual async Task<ICollection<Commit>> RepoGetPullRequestCommitsAsync(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 pull request to get

    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<Commit>>

    CommitList

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoGetPullRequestFilesAsync(String, String, Int64, String, Nullable<Whitespace>, Nullable<Int32>, Nullable<Int32>)

    Get changed files for a pull request

    Declaration
    public virtual Task<ICollection<ChangedFile>> RepoGetPullRequestFilesAsync(string owner, string repo, long index, string skip_to, Whitespace? whitespace, 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 pull request to get

    System.String skip_to

    skip to given file

    System.Nullable<Whitespace> whitespace

    whitespace behavior

    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<ChangedFile>>

    ChangedFileList

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoGetPullRequestFilesAsync(String, String, Int64, String, Nullable<Whitespace>, Nullable<Int32>, Nullable<Int32>, CancellationToken)

    Get changed files for a pull request

    Declaration
    public virtual async Task<ICollection<ChangedFile>> RepoGetPullRequestFilesAsync(string owner, string repo, long index, string skip_to, Whitespace? whitespace, 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 pull request to get

    System.String skip_to

    skip to given file

    System.Nullable<Whitespace> whitespace

    whitespace behavior

    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<ChangedFile>>

    ChangedFileList

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoGetPullReviewAsync(String, String, Int64, Int64)

    Get a specific review for a pull request

    Declaration
    public virtual Task<PullReview> RepoGetPullReviewAsync(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 pull request

    System.Int64 id

    id of the review

    Returns
    Type Description
    System.Threading.Tasks.Task<PullReview>

    PullReview

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoGetPullReviewAsync(String, String, Int64, Int64, CancellationToken)

    Get a specific review for a pull request

    Declaration
    public virtual async Task<PullReview> RepoGetPullReviewAsync(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 pull request

    System.Int64 id

    id of the review

    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<PullReview>

    PullReview

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoGetPullReviewCommentsAsync(String, String, Int64, Int64)

    Get a specific review for a pull request

    Declaration
    public virtual Task<ICollection<PullReviewComment>> RepoGetPullReviewCommentsAsync(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 pull request

    System.Int64 id

    id of the review

    Returns
    Type Description
    System.Threading.Tasks.Task<System.Collections.Generic.ICollection<PullReviewComment>>

    PullCommentList

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoGetPullReviewCommentsAsync(String, String, Int64, Int64, CancellationToken)

    Get a specific review for a pull request

    Declaration
    public virtual async Task<ICollection<PullReviewComment>> RepoGetPullReviewCommentsAsync(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 pull request

    System.Int64 id

    id of the review

    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<PullReviewComment>>

    PullCommentList

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoGetPushMirrorByRemoteNameAsync(String, String, String)

    Get push mirror of the repository by remoteName

    Declaration
    public virtual Task<PushMirror> RepoGetPushMirrorByRemoteNameAsync(string owner, string repo, string name)
    Parameters
    Type Name Description
    System.String owner

    owner of the repo

    System.String repo

    name of the repo

    System.String name

    remote name of push mirror

    Returns
    Type Description
    System.Threading.Tasks.Task<PushMirror>

    PushMirror

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoGetPushMirrorByRemoteNameAsync(String, String, String, CancellationToken)

    Get push mirror of the repository by remoteName

    Declaration
    public virtual async Task<PushMirror> RepoGetPushMirrorByRemoteNameAsync(string owner, string repo, string name, CancellationToken cancellationToken)
    Parameters
    Type Name Description
    System.String owner

    owner of the repo

    System.String repo

    name of the repo

    System.String name

    remote name of push mirror

    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<PushMirror>

    PushMirror

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoGetRawFileAsync(String, String, String, String)

    Get a file from a repository

    Declaration
    public virtual Task RepoGetRawFileAsync(string owner, string repo, string filepath, string ref)
    Parameters
    Type Name Description
    System.String owner

    owner of the repo

    System.String repo

    name of the repo

    System.String filepath

    filepath of the file to get

    System.String ref

    The name of the commit/branch/tag. Default the repository’s default branch (usually master)

    Returns
    Type Description
    System.Threading.Tasks.Task

    Returns raw file content.

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoGetRawFileAsync(String, String, String, String, CancellationToken)

    Get a file from a repository

    Declaration
    public virtual async Task RepoGetRawFileAsync(string owner, string repo, string filepath, string ref, CancellationToken cancellationToken)
    Parameters
    Type Name Description
    System.String owner

    owner of the repo

    System.String repo

    name of the repo

    System.String filepath

    filepath of the file to get

    System.String ref

    The name of the commit/branch/tag. Default the repository’s default branch (usually master)

    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

    Returns raw file content.

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoGetRawFileOrLFSAsync(String, String, String, String)

    Get a file or it's LFS object from a repository

    Declaration
    public virtual Task RepoGetRawFileOrLFSAsync(string owner, string repo, string filepath, string ref)
    Parameters
    Type Name Description
    System.String owner

    owner of the repo

    System.String repo

    name of the repo

    System.String filepath

    filepath of the file to get

    System.String ref

    The name of the commit/branch/tag. Default the repository’s default branch (usually master)

    Returns
    Type Description
    System.Threading.Tasks.Task

    Returns raw file content.

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoGetRawFileOrLFSAsync(String, String, String, String, CancellationToken)

    Get a file or it's LFS object from a repository

    Declaration
    public virtual async Task RepoGetRawFileOrLFSAsync(string owner, string repo, string filepath, string ref, CancellationToken cancellationToken)
    Parameters
    Type Name Description
    System.String owner

    owner of the repo

    System.String repo

    name of the repo

    System.String filepath

    filepath of the file to get

    System.String ref

    The name of the commit/branch/tag. Default the repository’s default branch (usually master)

    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

    Returns raw file content.

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoGetReleaseAsync(String, String, Int64)

    Get a release

    Declaration
    public virtual Task<Release> RepoGetReleaseAsync(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 release to get

    Returns
    Type Description
    System.Threading.Tasks.Task<Release>

    Release

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoGetReleaseAsync(String, String, Int64, CancellationToken)

    Get a release

    Declaration
    public virtual async Task<Release> RepoGetReleaseAsync(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 release 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<Release>

    Release

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoGetReleaseAttachmentAsync(String, String, Int64, Int64)

    Get a release attachment

    Declaration
    public virtual Task<Attachment> RepoGetReleaseAttachmentAsync(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 release

    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.

    | Improve this Doc View Source

    RepoGetReleaseAttachmentAsync(String, String, Int64, Int64, CancellationToken)

    Get a release attachment

    Declaration
    public virtual async Task<Attachment> RepoGetReleaseAttachmentAsync(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 release

    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.

    | Improve this Doc View Source

    RepoGetReleaseByTagAsync(String, String, String)

    Get a release by tag name

    Declaration
    public virtual Task<Release> RepoGetReleaseByTagAsync(string owner, string repo, string tag)
    Parameters
    Type Name Description
    System.String owner

    owner of the repo

    System.String repo

    name of the repo

    System.String tag

    tag name of the release to get

    Returns
    Type Description
    System.Threading.Tasks.Task<Release>

    Release

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoGetReleaseByTagAsync(String, String, String, CancellationToken)

    Get a release by tag name

    Declaration
    public virtual async Task<Release> RepoGetReleaseByTagAsync(string owner, string repo, string tag, CancellationToken cancellationToken)
    Parameters
    Type Name Description
    System.String owner

    owner of the repo

    System.String repo

    name of the repo

    System.String tag

    tag name of the release 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<Release>

    Release

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoGetRepoPermissionsAsync(String, String, String)

    Get repository permissions for a user

    Declaration
    public virtual Task<RepoCollaboratorPermission> RepoGetRepoPermissionsAsync(string owner, string repo, string collaborator)
    Parameters
    Type Name Description
    System.String owner

    owner of the repo

    System.String repo

    name of the repo

    System.String collaborator

    username of the collaborator

    Returns
    Type Description
    System.Threading.Tasks.Task<RepoCollaboratorPermission>

    RepoCollaboratorPermission

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoGetRepoPermissionsAsync(String, String, String, CancellationToken)

    Get repository permissions for a user

    Declaration
    public virtual async Task<RepoCollaboratorPermission> RepoGetRepoPermissionsAsync(string owner, string repo, string collaborator, CancellationToken cancellationToken)
    Parameters
    Type Name Description
    System.String owner

    owner of the repo

    System.String repo

    name of the repo

    System.String collaborator

    username of the collaborator

    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<RepoCollaboratorPermission>

    RepoCollaboratorPermission

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoGetReviewersAsync(String, String)

    Return all users that can be requested to review in this repo

    Declaration
    public virtual Task<ICollection<User>> RepoGetReviewersAsync(string owner, string repo)
    Parameters
    Type Name Description
    System.String owner

    owner of the repo

    System.String repo

    name of the repo

    Returns
    Type Description
    System.Threading.Tasks.Task<System.Collections.Generic.ICollection<User>>

    UserList

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoGetReviewersAsync(String, String, CancellationToken)

    Return all users that can be requested to review in this repo

    Declaration
    public virtual async Task<ICollection<User>> RepoGetReviewersAsync(string owner, string repo, CancellationToken cancellationToken)
    Parameters
    Type Name Description
    System.String owner

    owner of the repo

    System.String repo

    name of the repo

    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.

    | Improve this Doc View Source

    RepoGetSingleCommitAsync(String, String, String, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>)

    Get a single commit from a repository

    Declaration
    public virtual Task<Commit> RepoGetSingleCommitAsync(string owner, string repo, string sha, bool? stat, bool? verification, bool? files)
    Parameters
    Type Name Description
    System.String owner

    owner of the repo

    System.String repo

    name of the repo

    System.String sha

    a git ref or commit sha

    System.Nullable<System.Boolean> stat

    include diff stats for every commit (disable for speedup, default 'true')

    System.Nullable<System.Boolean> verification

    include verification for every commit (disable for speedup, default 'true')

    System.Nullable<System.Boolean> files

    include a list of affected files for every commit (disable for speedup, default 'true')

    Returns
    Type Description
    System.Threading.Tasks.Task<Commit>

    Commit

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoGetSingleCommitAsync(String, String, String, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, CancellationToken)

    Get a single commit from a repository

    Declaration
    public virtual async Task<Commit> RepoGetSingleCommitAsync(string owner, string repo, string sha, bool? stat, bool? verification, bool? files, CancellationToken cancellationToken)
    Parameters
    Type Name Description
    System.String owner

    owner of the repo

    System.String repo

    name of the repo

    System.String sha

    a git ref or commit sha

    System.Nullable<System.Boolean> stat

    include diff stats for every commit (disable for speedup, default 'true')

    System.Nullable<System.Boolean> verification

    include verification for every commit (disable for speedup, default 'true')

    System.Nullable<System.Boolean> files

    include a list of affected files for every commit (disable for speedup, default 'true')

    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<Commit>

    Commit

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoGetTagAsync(String, String, String)

    Get the tag of a repository by tag name

    Declaration
    public virtual Task<Tag> RepoGetTagAsync(string owner, string repo, string tag)
    Parameters
    Type Name Description
    System.String owner

    owner of the repo

    System.String repo

    name of the repo

    System.String tag

    name of tag

    Returns
    Type Description
    System.Threading.Tasks.Task<Tag>

    Tag

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoGetTagAsync(String, String, String, CancellationToken)

    Get the tag of a repository by tag name

    Declaration
    public virtual async Task<Tag> RepoGetTagAsync(string owner, string repo, string tag, CancellationToken cancellationToken)
    Parameters
    Type Name Description
    System.String owner

    owner of the repo

    System.String repo

    name of the repo

    System.String tag

    name of tag

    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<Tag>

    Tag

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoGetWikiPageAsync(String, String, String)

    Get a wiki page

    Declaration
    public virtual Task<WikiPage> RepoGetWikiPageAsync(string owner, string repo, string pageName)
    Parameters
    Type Name Description
    System.String owner

    owner of the repo

    System.String repo

    name of the repo

    System.String pageName

    name of the page

    Returns
    Type Description
    System.Threading.Tasks.Task<WikiPage>

    WikiPage

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoGetWikiPageAsync(String, String, String, CancellationToken)

    Get a wiki page

    Declaration
    public virtual async Task<WikiPage> RepoGetWikiPageAsync(string owner, string repo, string pageName, CancellationToken cancellationToken)
    Parameters
    Type Name Description
    System.String owner

    owner of the repo

    System.String repo

    name of the repo

    System.String pageName

    name of the page

    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<WikiPage>

    WikiPage

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoGetWikiPageRevisionsAsync(String, String, String, Nullable<Int32>)

    Get revisions of a wiki page

    Declaration
    public virtual Task<WikiCommitList> RepoGetWikiPageRevisionsAsync(string owner, string repo, string pageName, int? page)
    Parameters
    Type Name Description
    System.String owner

    owner of the repo

    System.String repo

    name of the repo

    System.String pageName

    name of the page

    System.Nullable<System.Int32> page

    page number of results to return (1-based)

    Returns
    Type Description
    System.Threading.Tasks.Task<WikiCommitList>

    WikiCommitList

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoGetWikiPageRevisionsAsync(String, String, String, Nullable<Int32>, CancellationToken)

    Get revisions of a wiki page

    Declaration
    public virtual async Task<WikiCommitList> RepoGetWikiPageRevisionsAsync(string owner, string repo, string pageName, int? page, CancellationToken cancellationToken)
    Parameters
    Type Name Description
    System.String owner

    owner of the repo

    System.String repo

    name of the repo

    System.String pageName

    name of the page

    System.Nullable<System.Int32> page

    page number of results to return (1-based)

    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<WikiCommitList>

    WikiCommitList

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoGetWikiPagesAsync(String, String, Nullable<Int32>, Nullable<Int32>)

    Get all wiki pages

    Declaration
    public virtual Task<ICollection<WikiPageMetaData>> RepoGetWikiPagesAsync(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<WikiPageMetaData>>

    WikiPageList

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoGetWikiPagesAsync(String, String, Nullable<Int32>, Nullable<Int32>, CancellationToken)

    Get all wiki pages

    Declaration
    public virtual async Task<ICollection<WikiPageMetaData>> RepoGetWikiPagesAsync(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<WikiPageMetaData>>

    WikiPageList

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoListActivityFeedsAsync(String, String, Nullable<DateTimeOffset>, Nullable<Int32>, Nullable<Int32>)

    List a repository's activity feeds

    Declaration
    public virtual Task<ICollection<Activity>> RepoListActivityFeedsAsync(string owner, string repo, DateTimeOffset? date, 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> date

    the date of the activities to be found

    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<Activity>>

    ActivityFeedsList

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoListActivityFeedsAsync(String, String, Nullable<DateTimeOffset>, Nullable<Int32>, Nullable<Int32>, CancellationToken)

    List a repository's activity feeds

    Declaration
    public virtual async Task<ICollection<Activity>> RepoListActivityFeedsAsync(string owner, string repo, DateTimeOffset? date, 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> date

    the date of the activities to be found

    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<Activity>>

    ActivityFeedsList

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoListAllGitRefsAsync(String, String)

    Get specified ref or filtered repository's refs

    Declaration
    public virtual Task<ICollection<Reference>> RepoListAllGitRefsAsync(string owner, string repo)
    Parameters
    Type Name Description
    System.String owner

    owner of the repo

    System.String repo

    name of the repo

    Returns
    Type Description
    System.Threading.Tasks.Task<System.Collections.Generic.ICollection<Reference>>

    ReferenceList

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoListAllGitRefsAsync(String, String, CancellationToken)

    Get specified ref or filtered repository's refs

    Declaration
    public virtual async Task<ICollection<Reference>> RepoListAllGitRefsAsync(string owner, string repo, CancellationToken cancellationToken)
    Parameters
    Type Name Description
    System.String owner

    owner of the repo

    System.String repo

    name of the repo

    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<Reference>>

    ReferenceList

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoListBranchesAsync(String, String, Nullable<Int32>, Nullable<Int32>)

    List a repository's branches

    Declaration
    public virtual Task<ICollection<Branch>> RepoListBranchesAsync(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<Branch>>

    BranchList

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoListBranchesAsync(String, String, Nullable<Int32>, Nullable<Int32>, CancellationToken)

    List a repository's branches

    Declaration
    public virtual async Task<ICollection<Branch>> RepoListBranchesAsync(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<Branch>>

    BranchList

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoListBranchProtectionAsync(String, String)

    List branch protections for a repository

    Declaration
    public virtual Task<ICollection<BranchProtection>> RepoListBranchProtectionAsync(string owner, string repo)
    Parameters
    Type Name Description
    System.String owner

    owner of the repo

    System.String repo

    name of the repo

    Returns
    Type Description
    System.Threading.Tasks.Task<System.Collections.Generic.ICollection<BranchProtection>>

    BranchProtectionList

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoListBranchProtectionAsync(String, String, CancellationToken)

    List branch protections for a repository

    Declaration
    public virtual async Task<ICollection<BranchProtection>> RepoListBranchProtectionAsync(string owner, string repo, CancellationToken cancellationToken)
    Parameters
    Type Name Description
    System.String owner

    owner of the repo

    System.String repo

    name of the repo

    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<BranchProtection>>

    BranchProtectionList

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoListCollaboratorsAsync(String, String, Nullable<Int32>, Nullable<Int32>)

    List a repository's collaborators

    Declaration
    public virtual Task<ICollection<User>> RepoListCollaboratorsAsync(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<User>>

    UserList

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoListCollaboratorsAsync(String, String, Nullable<Int32>, Nullable<Int32>, CancellationToken)

    List a repository's collaborators

    Declaration
    public virtual async Task<ICollection<User>> RepoListCollaboratorsAsync(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<User>>

    UserList

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoListGitHooksAsync(String, String)

    List the Git hooks in a repository

    Declaration
    public virtual Task<ICollection<GitHook>> RepoListGitHooksAsync(string owner, string repo)
    Parameters
    Type Name Description
    System.String owner

    owner of the repo

    System.String repo

    name of the repo

    Returns
    Type Description
    System.Threading.Tasks.Task<System.Collections.Generic.ICollection<GitHook>>

    GitHookList

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoListGitHooksAsync(String, String, CancellationToken)

    List the Git hooks in a repository

    Declaration
    public virtual async Task<ICollection<GitHook>> RepoListGitHooksAsync(string owner, string repo, CancellationToken cancellationToken)
    Parameters
    Type Name Description
    System.String owner

    owner of the repo

    System.String repo

    name of the repo

    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<GitHook>>

    GitHookList

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoListGitRefsAsync(String, String, String)

    Get specified ref or filtered repository's refs

    Declaration
    public virtual Task<ICollection<Reference>> RepoListGitRefsAsync(string owner, string repo, string ref)
    Parameters
    Type Name Description
    System.String owner

    owner of the repo

    System.String repo

    name of the repo

    System.String ref

    part or full name of the ref

    Returns
    Type Description
    System.Threading.Tasks.Task<System.Collections.Generic.ICollection<Reference>>

    ReferenceList

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoListGitRefsAsync(String, String, String, CancellationToken)

    Get specified ref or filtered repository's refs

    Declaration
    public virtual async Task<ICollection<Reference>> RepoListGitRefsAsync(string owner, string repo, string ref, CancellationToken cancellationToken)
    Parameters
    Type Name Description
    System.String owner

    owner of the repo

    System.String repo

    name of the repo

    System.String ref

    part or full name of the ref

    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<Reference>>

    ReferenceList

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoListHooksAsync(String, String, Nullable<Int32>, Nullable<Int32>)

    List the hooks in a repository

    Declaration
    public virtual Task<ICollection<Hook>> RepoListHooksAsync(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<Hook>>

    HookList

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoListHooksAsync(String, String, Nullable<Int32>, Nullable<Int32>, CancellationToken)

    List the hooks in a repository

    Declaration
    public virtual async Task<ICollection<Hook>> RepoListHooksAsync(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<Hook>>

    HookList

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoListKeysAsync(String, String, Nullable<Int32>, String, Nullable<Int32>, Nullable<Int32>)

    List a repository's keys

    Declaration
    public virtual Task<ICollection<DeployKey>> RepoListKeysAsync(string owner, string repo, int? key_id, string fingerprint, 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> key_id

    the key_id to search for

    System.String fingerprint

    fingerprint of the key

    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<DeployKey>>

    DeployKeyList

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoListKeysAsync(String, String, Nullable<Int32>, String, Nullable<Int32>, Nullable<Int32>, CancellationToken)

    List a repository's keys

    Declaration
    public virtual async Task<ICollection<DeployKey>> RepoListKeysAsync(string owner, string repo, int? key_id, string fingerprint, 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> key_id

    the key_id to search for

    System.String fingerprint

    fingerprint of the key

    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<DeployKey>>

    DeployKeyList

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoListPinnedIssuesAsync(String, String)

    List a repo's pinned issues

    Declaration
    public virtual Task<ICollection<Issue>> RepoListPinnedIssuesAsync(string owner, string repo)
    Parameters
    Type Name Description
    System.String owner

    owner of the repo

    System.String repo

    name of the repo

    Returns
    Type Description
    System.Threading.Tasks.Task<System.Collections.Generic.ICollection<Issue>>

    IssueList

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoListPinnedIssuesAsync(String, String, CancellationToken)

    List a repo's pinned issues

    Declaration
    public virtual async Task<ICollection<Issue>> RepoListPinnedIssuesAsync(string owner, string repo, CancellationToken cancellationToken)
    Parameters
    Type Name Description
    System.String owner

    owner of the repo

    System.String repo

    name of the repo

    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.

    | Improve this Doc View Source

    RepoListPinnedPullRequestsAsync(String, String)

    List a repo's pinned pull requests

    Declaration
    public virtual Task<ICollection<PullRequest>> RepoListPinnedPullRequestsAsync(string owner, string repo)
    Parameters
    Type Name Description
    System.String owner

    owner of the repo

    System.String repo

    name of the repo

    Returns
    Type Description
    System.Threading.Tasks.Task<System.Collections.Generic.ICollection<PullRequest>>

    PullRequestList

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoListPinnedPullRequestsAsync(String, String, CancellationToken)

    List a repo's pinned pull requests

    Declaration
    public virtual async Task<ICollection<PullRequest>> RepoListPinnedPullRequestsAsync(string owner, string repo, CancellationToken cancellationToken)
    Parameters
    Type Name Description
    System.String owner

    owner of the repo

    System.String repo

    name of the repo

    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<PullRequest>>

    PullRequestList

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoListPullRequestsAsync(String, String, Nullable<State3>, Nullable<Sort2>, Nullable<Int64>, IEnumerable<Int64>, Nullable<Int32>, Nullable<Int32>)

    List a repo's pull requests

    Declaration
    public virtual Task<ICollection<PullRequest>> RepoListPullRequestsAsync(string owner, string repo, State3? state, Sort2? sort, long? milestone, IEnumerable<long> labels, int? page, int? limit)
    Parameters
    Type Name Description
    System.String owner

    owner of the repo

    System.String repo

    name of the repo

    System.Nullable<State3> state

    State of pull request: open or closed (optional)

    System.Nullable<Sort2> sort

    Type of sort

    System.Nullable<System.Int64> milestone

    ID of the milestone

    System.Collections.Generic.IEnumerable<System.Int64> labels

    Label IDs

    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<PullRequest>>

    PullRequestList

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoListPullRequestsAsync(String, String, Nullable<State3>, Nullable<Sort2>, Nullable<Int64>, IEnumerable<Int64>, Nullable<Int32>, Nullable<Int32>, CancellationToken)

    List a repo's pull requests

    Declaration
    public virtual async Task<ICollection<PullRequest>> RepoListPullRequestsAsync(string owner, string repo, State3? state, Sort2? sort, long? milestone, IEnumerable<long> labels, 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<State3> state

    State of pull request: open or closed (optional)

    System.Nullable<Sort2> sort

    Type of sort

    System.Nullable<System.Int64> milestone

    ID of the milestone

    System.Collections.Generic.IEnumerable<System.Int64> labels

    Label IDs

    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<PullRequest>>

    PullRequestList

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoListPullReviewsAsync(String, String, Int64, Nullable<Int32>, Nullable<Int32>)

    List all reviews for a pull request

    Declaration
    public virtual Task<ICollection<PullReview>> RepoListPullReviewsAsync(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 pull request

    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<PullReview>>

    PullReviewList

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoListPullReviewsAsync(String, String, Int64, Nullable<Int32>, Nullable<Int32>, CancellationToken)

    List all reviews for a pull request

    Declaration
    public virtual async Task<ICollection<PullReview>> RepoListPullReviewsAsync(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 pull request

    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<PullReview>>

    PullReviewList

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoListPushMirrorsAsync(String, String, Nullable<Int32>, Nullable<Int32>)

    Get all push mirrors of the repository

    Declaration
    public virtual Task<ICollection<PushMirror>> RepoListPushMirrorsAsync(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<PushMirror>>

    PushMirrorList

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoListPushMirrorsAsync(String, String, Nullable<Int32>, Nullable<Int32>, CancellationToken)

    Get all push mirrors of the repository

    Declaration
    public virtual async Task<ICollection<PushMirror>> RepoListPushMirrorsAsync(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<PushMirror>>

    PushMirrorList

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoListReleaseAttachmentsAsync(String, String, Int64)

    List release's attachments

    Declaration
    public virtual Task<ICollection<Attachment>> RepoListReleaseAttachmentsAsync(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 release

    Returns
    Type Description
    System.Threading.Tasks.Task<System.Collections.Generic.ICollection<Attachment>>

    AttachmentList

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoListReleaseAttachmentsAsync(String, String, Int64, CancellationToken)

    List release's attachments

    Declaration
    public virtual async Task<ICollection<Attachment>> RepoListReleaseAttachmentsAsync(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 release

    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.

    | Improve this Doc View Source

    RepoListReleasesAsync(String, String, Nullable<Boolean>, Nullable<Boolean>, Nullable<Int32>, Nullable<Int32>, Nullable<Int32>)

    List a repo's releases

    Declaration
    public virtual Task<ICollection<Release>> RepoListReleasesAsync(string owner, string repo, bool? draft, bool? pre_release, int? per_page, 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.Boolean> draft

    filter (exclude / include) drafts, if you dont have repo write access none will show

    System.Nullable<System.Boolean> pre_release

    filter (exclude / include) pre-releases

    System.Nullable<System.Int32> per_page

    page size of results, deprecated - use limit

    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<Release>>

    ReleaseList

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoListReleasesAsync(String, String, Nullable<Boolean>, Nullable<Boolean>, Nullable<Int32>, Nullable<Int32>, Nullable<Int32>, CancellationToken)

    List a repo's releases

    Declaration
    public virtual async Task<ICollection<Release>> RepoListReleasesAsync(string owner, string repo, bool? draft, bool? pre_release, int? per_page, 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.Boolean> draft

    filter (exclude / include) drafts, if you dont have repo write access none will show

    System.Nullable<System.Boolean> pre_release

    filter (exclude / include) pre-releases

    System.Nullable<System.Int32> per_page

    page size of results, deprecated - use limit

    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<Release>>

    ReleaseList

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoListStargazersAsync(String, String, Nullable<Int32>, Nullable<Int32>)

    List a repo's stargazers

    Declaration
    public virtual Task<ICollection<User>> RepoListStargazersAsync(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<User>>

    UserList

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoListStargazersAsync(String, String, Nullable<Int32>, Nullable<Int32>, CancellationToken)

    List a repo's stargazers

    Declaration
    public virtual async Task<ICollection<User>> RepoListStargazersAsync(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<User>>

    UserList

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoListStatusesAsync(String, String, String, Nullable<Sort3>, Nullable<State4>, Nullable<Int32>, Nullable<Int32>)

    Get a commit's statuses

    Declaration
    public virtual Task<ICollection<CommitStatus>> RepoListStatusesAsync(string owner, string repo, string sha, Sort3? sort, State4? state, int? page, int? limit)
    Parameters
    Type Name Description
    System.String owner

    owner of the repo

    System.String repo

    name of the repo

    System.String sha

    sha of the commit

    System.Nullable<Sort3> sort

    type of sort

    System.Nullable<State4> state

    type of state

    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<CommitStatus>>

    CommitStatusList

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoListStatusesAsync(String, String, String, Nullable<Sort3>, Nullable<State4>, Nullable<Int32>, Nullable<Int32>, CancellationToken)

    Get a commit's statuses

    Declaration
    public virtual async Task<ICollection<CommitStatus>> RepoListStatusesAsync(string owner, string repo, string sha, Sort3? sort, State4? state, 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 sha

    sha of the commit

    System.Nullable<Sort3> sort

    type of sort

    System.Nullable<State4> state

    type of state

    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<CommitStatus>>

    CommitStatusList

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoListStatusesByRefAsync(String, String, String, Nullable<Sort>, Nullable<State>, Nullable<Int32>, Nullable<Int32>)

    Get a commit's statuses, by branch/tag/commit reference

    Declaration
    public virtual Task<ICollection<CommitStatus>> RepoListStatusesByRefAsync(string owner, string repo, string ref, Sort? sort, State? state, int? page, int? limit)
    Parameters
    Type Name Description
    System.String owner

    owner of the repo

    System.String repo

    name of the repo

    System.String ref

    name of branch/tag/commit

    System.Nullable<Sort> sort

    type of sort

    System.Nullable<State> state

    type of state

    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<CommitStatus>>

    CommitStatusList

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoListStatusesByRefAsync(String, String, String, Nullable<Sort>, Nullable<State>, Nullable<Int32>, Nullable<Int32>, CancellationToken)

    Get a commit's statuses, by branch/tag/commit reference

    Declaration
    public virtual async Task<ICollection<CommitStatus>> RepoListStatusesByRefAsync(string owner, string repo, string ref, Sort? sort, State? state, 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 ref

    name of branch/tag/commit

    System.Nullable<Sort> sort

    type of sort

    System.Nullable<State> state

    type of state

    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<CommitStatus>>

    CommitStatusList

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoListSubscribersAsync(String, String, Nullable<Int32>, Nullable<Int32>)

    List a repo's watchers

    Declaration
    public virtual Task<ICollection<User>> RepoListSubscribersAsync(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<User>>

    UserList

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoListSubscribersAsync(String, String, Nullable<Int32>, Nullable<Int32>, CancellationToken)

    List a repo's watchers

    Declaration
    public virtual async Task<ICollection<User>> RepoListSubscribersAsync(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<User>>

    UserList

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoListTagsAsync(String, String, Nullable<Int32>, Nullable<Int32>)

    List a repository's tags

    Declaration
    public virtual Task<ICollection<Tag>> RepoListTagsAsync(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, default maximum page size is 50

    Returns
    Type Description
    System.Threading.Tasks.Task<System.Collections.Generic.ICollection<Tag>>

    TagList

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoListTagsAsync(String, String, Nullable<Int32>, Nullable<Int32>, CancellationToken)

    List a repository's tags

    Declaration
    public virtual async Task<ICollection<Tag>> RepoListTagsAsync(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, default maximum page size is 50

    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<Tag>>

    TagList

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoListTeamsAsync(String, String)

    List a repository's teams

    Declaration
    public virtual Task<ICollection<Team>> RepoListTeamsAsync(string owner, string repo)
    Parameters
    Type Name Description
    System.String owner

    owner of the repo

    System.String repo

    name of the repo

    Returns
    Type Description
    System.Threading.Tasks.Task<System.Collections.Generic.ICollection<Team>>

    TeamList

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoListTeamsAsync(String, String, CancellationToken)

    List a repository's teams

    Declaration
    public virtual async Task<ICollection<Team>> RepoListTeamsAsync(string owner, string repo, CancellationToken cancellationToken)
    Parameters
    Type Name Description
    System.String owner

    owner of the repo

    System.String repo

    name of the repo

    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<Team>>

    TeamList

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoListTopicsAsync(String, String, Nullable<Int32>, Nullable<Int32>)

    Get list of topics that a repository has

    Declaration
    public virtual Task<TopicName> RepoListTopicsAsync(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<TopicName>

    TopicNames

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoListTopicsAsync(String, String, Nullable<Int32>, Nullable<Int32>, CancellationToken)

    Get list of topics that a repository has

    Declaration
    public virtual async Task<TopicName> RepoListTopicsAsync(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<TopicName>

    TopicNames

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoMergePullRequestAsync(String, String, Int64, MergePullRequestOption)

    Merge a pull request

    Declaration
    public virtual Task RepoMergePullRequestAsync(string owner, string repo, long index, MergePullRequestOption 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 pull request to merge

    MergePullRequestOption body
    Returns
    Type Description
    System.Threading.Tasks.Task

    APIEmpty is an empty response

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoMergePullRequestAsync(String, String, Int64, MergePullRequestOption, CancellationToken)

    Merge a pull request

    Declaration
    public virtual async Task RepoMergePullRequestAsync(string owner, string repo, long index, MergePullRequestOption 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 pull request to merge

    MergePullRequestOption 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

    APIEmpty is an empty response

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoMigrateAsync(MigrateRepoOptions)

    Migrate a remote git repository

    Declaration
    public virtual Task<Repository> RepoMigrateAsync(MigrateRepoOptions body)
    Parameters
    Type Name Description
    MigrateRepoOptions body
    Returns
    Type Description
    System.Threading.Tasks.Task<Repository>

    Repository

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoMigrateAsync(MigrateRepoOptions, CancellationToken)

    Migrate a remote git repository

    Declaration
    public virtual async Task<Repository> RepoMigrateAsync(MigrateRepoOptions body, CancellationToken cancellationToken)
    Parameters
    Type Name Description
    MigrateRepoOptions 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<Repository>

    Repository

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoMirrorSyncAsync(String, String)

    Sync a mirrored repository

    Declaration
    public virtual Task RepoMirrorSyncAsync(string owner, string repo)
    Parameters
    Type Name Description
    System.String owner

    owner of the repo to sync

    System.String repo

    name of the repo to sync

    Returns
    Type Description
    System.Threading.Tasks.Task

    APIEmpty is an empty response

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoMirrorSyncAsync(String, String, CancellationToken)

    Sync a mirrored repository

    Declaration
    public virtual async Task RepoMirrorSyncAsync(string owner, string repo, CancellationToken cancellationToken)
    Parameters
    Type Name Description
    System.String owner

    owner of the repo to sync

    System.String repo

    name of the repo to sync

    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.

    | Improve this Doc View Source

    RepoNewPinAllowedAsync(String, String)

    Returns if new Issue Pins are allowed

    Declaration
    public virtual Task<NewIssuePinsAllowed> RepoNewPinAllowedAsync(string owner, string repo)
    Parameters
    Type Name Description
    System.String owner

    owner of the repo

    System.String repo

    name of the repo

    Returns
    Type Description
    System.Threading.Tasks.Task<NewIssuePinsAllowed>

    RepoNewIssuePinsAllowed

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoNewPinAllowedAsync(String, String, CancellationToken)

    Returns if new Issue Pins are allowed

    Declaration
    public virtual async Task<NewIssuePinsAllowed> RepoNewPinAllowedAsync(string owner, string repo, CancellationToken cancellationToken)
    Parameters
    Type Name Description
    System.String owner

    owner of the repo

    System.String repo

    name of the repo

    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<NewIssuePinsAllowed>

    RepoNewIssuePinsAllowed

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoPullRequestIsMergedAsync(String, String, Int64)

    Check if a pull request has been merged

    Declaration
    public virtual Task RepoPullRequestIsMergedAsync(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 pull request

    Returns
    Type Description
    System.Threading.Tasks.Task

    pull request has been merged

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoPullRequestIsMergedAsync(String, String, Int64, CancellationToken)

    Check if a pull request has been merged

    Declaration
    public virtual async Task RepoPullRequestIsMergedAsync(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 pull request

    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

    pull request has been merged

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoPushMirrorSyncAsync(String, String)

    Sync all push mirrored repository

    Declaration
    public virtual Task RepoPushMirrorSyncAsync(string owner, string repo)
    Parameters
    Type Name Description
    System.String owner

    owner of the repo to sync

    System.String repo

    name of the repo to sync

    Returns
    Type Description
    System.Threading.Tasks.Task

    APIEmpty is an empty response

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoPushMirrorSyncAsync(String, String, CancellationToken)

    Sync all push mirrored repository

    Declaration
    public virtual async Task RepoPushMirrorSyncAsync(string owner, string repo, CancellationToken cancellationToken)
    Parameters
    Type Name Description
    System.String owner

    owner of the repo to sync

    System.String repo

    name of the repo to sync

    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.

    | Improve this Doc View Source

    RepoSearchAsync(String, Nullable<Boolean>, Nullable<Boolean>, Nullable<Int64>, Nullable<Int64>, Nullable<Int64>, Nullable<Int64>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, String, Nullable<Boolean>, String, String, Nullable<Int32>, Nullable<Int32>)

    Search for repositories

    Declaration
    public virtual Task<SearchResults> RepoSearchAsync(string q, bool? topic, bool? includeDesc, long? uid, long? priority_owner_id, long? team_id, long? starredBy, bool? private, bool? is_private, bool? template, bool? archived, string mode, bool? exclusive, string sort, string order, int? page, int? limit)
    Parameters
    Type Name Description
    System.String q

    keyword

    System.Nullable<System.Boolean> topic

    Limit search to repositories with keyword as topic

    System.Nullable<System.Boolean> includeDesc

    include search of keyword within repository description

    System.Nullable<System.Int64> uid

    search only for repos that the user with the given id owns or contributes to

    System.Nullable<System.Int64> priority_owner_id

    repo owner to prioritize in the results

    System.Nullable<System.Int64> team_id

    search only for repos that belong to the given team id

    System.Nullable<System.Int64> starredBy

    search only for repos that the user with the given id has starred

    System.Nullable<System.Boolean> private

    include private repositories this user has access to (defaults to true)

    System.Nullable<System.Boolean> is_private

    show only pubic, private or all repositories (defaults to all)

    System.Nullable<System.Boolean> template

    include template repositories this user has access to (defaults to true)

    System.Nullable<System.Boolean> archived

    show only archived, non-archived or all repositories (defaults to all)

    System.String mode

    type of repository to search for. Supported values are "fork", "source", "mirror" and "collaborative"

    System.Nullable<System.Boolean> exclusive

    if uid is given, search only for repos that the user owns

    System.String sort

    sort repos by attribute. Supported values are "alpha", "created", "updated", "size", and "id". Default is "alpha"

    System.String order

    sort order, either "asc" (ascending) or "desc" (descending). Default is "asc", ignored if "sort" is not specified.

    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<SearchResults>

    SearchResults

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoSearchAsync(String, Nullable<Boolean>, Nullable<Boolean>, Nullable<Int64>, Nullable<Int64>, Nullable<Int64>, Nullable<Int64>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, String, Nullable<Boolean>, String, String, Nullable<Int32>, Nullable<Int32>, CancellationToken)

    Search for repositories

    Declaration
    public virtual async Task<SearchResults> RepoSearchAsync(string q, bool? topic, bool? includeDesc, long? uid, long? priority_owner_id, long? team_id, long? starredBy, bool? private, bool? is_private, bool? template, bool? archived, string mode, bool? exclusive, string sort, string order, int? page, int? limit, CancellationToken cancellationToken)
    Parameters
    Type Name Description
    System.String q

    keyword

    System.Nullable<System.Boolean> topic

    Limit search to repositories with keyword as topic

    System.Nullable<System.Boolean> includeDesc

    include search of keyword within repository description

    System.Nullable<System.Int64> uid

    search only for repos that the user with the given id owns or contributes to

    System.Nullable<System.Int64> priority_owner_id

    repo owner to prioritize in the results

    System.Nullable<System.Int64> team_id

    search only for repos that belong to the given team id

    System.Nullable<System.Int64> starredBy

    search only for repos that the user with the given id has starred

    System.Nullable<System.Boolean> private

    include private repositories this user has access to (defaults to true)

    System.Nullable<System.Boolean> is_private

    show only pubic, private or all repositories (defaults to all)

    System.Nullable<System.Boolean> template

    include template repositories this user has access to (defaults to true)

    System.Nullable<System.Boolean> archived

    show only archived, non-archived or all repositories (defaults to all)

    System.String mode

    type of repository to search for. Supported values are "fork", "source", "mirror" and "collaborative"

    System.Nullable<System.Boolean> exclusive

    if uid is given, search only for repos that the user owns

    System.String sort

    sort repos by attribute. Supported values are "alpha", "created", "updated", "size", and "id". Default is "alpha"

    System.String order

    sort order, either "asc" (ascending) or "desc" (descending). Default is "asc", ignored if "sort" is not specified.

    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<SearchResults>

    SearchResults

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoSigningKeyAsync(String, String)

    Get signing-key.gpg for given repository

    Declaration
    public virtual Task<string> RepoSigningKeyAsync(string owner, string repo)
    Parameters
    Type Name Description
    System.String owner

    owner of the repo

    System.String repo

    name of the repo

    Returns
    Type Description
    System.Threading.Tasks.Task<System.String>

    GPG armored public key

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoSigningKeyAsync(String, String, CancellationToken)

    Get signing-key.gpg for given repository

    Declaration
    public virtual async Task<string> RepoSigningKeyAsync(string owner, string repo, CancellationToken cancellationToken)
    Parameters
    Type Name Description
    System.String owner

    owner of the repo

    System.String repo

    name of the repo

    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.String>

    GPG armored public key

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoSubmitPullReviewAsync(String, String, Int64, Int64, SubmitPullReviewOptions)

    Submit a pending review to an pull request

    Declaration
    public virtual Task<PullReview> RepoSubmitPullReviewAsync(string owner, string repo, long index, long id, SubmitPullReviewOptions 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 pull request

    System.Int64 id

    id of the review

    SubmitPullReviewOptions body
    Returns
    Type Description
    System.Threading.Tasks.Task<PullReview>

    PullReview

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoSubmitPullReviewAsync(String, String, Int64, Int64, SubmitPullReviewOptions, CancellationToken)

    Submit a pending review to an pull request

    Declaration
    public virtual async Task<PullReview> RepoSubmitPullReviewAsync(string owner, string repo, long index, long id, SubmitPullReviewOptions 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 pull request

    System.Int64 id

    id of the review

    SubmitPullReviewOptions 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<PullReview>

    PullReview

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoTestHookAsync(String, String, Int64, String)

    Test a push webhook

    Declaration
    public virtual Task RepoTestHookAsync(string owner, string repo, long id, string ref)
    Parameters
    Type Name Description
    System.String owner

    owner of the repo

    System.String repo

    name of the repo

    System.Int64 id

    id of the hook to test

    System.String ref

    The name of the commit/branch/tag, indicates which commit will be loaded to the webhook payload.

    Returns
    Type Description
    System.Threading.Tasks.Task

    APIEmpty is an empty response

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoTestHookAsync(String, String, Int64, String, CancellationToken)

    Test a push webhook

    Declaration
    public virtual async Task RepoTestHookAsync(string owner, string repo, long id, string ref, 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 hook to test

    System.String ref

    The name of the commit/branch/tag, indicates which commit will be loaded to the webhook payload.

    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.

    | Improve this Doc View Source

    RepoTrackedTimesAsync(String, String, String, Nullable<DateTimeOffset>, Nullable<DateTimeOffset>, Nullable<Int32>, Nullable<Int32>)

    List a repo's tracked times

    Declaration
    public virtual Task<ICollection<TrackedTime>> RepoTrackedTimesAsync(string owner, string repo, 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.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.

    | Improve this Doc View Source

    RepoTrackedTimesAsync(String, String, String, Nullable<DateTimeOffset>, Nullable<DateTimeOffset>, Nullable<Int32>, Nullable<Int32>, CancellationToken)

    List a repo's tracked times

    Declaration
    public virtual async Task<ICollection<TrackedTime>> RepoTrackedTimesAsync(string owner, string repo, 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.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.

    | Improve this Doc View Source

    RepoTransferAsync(String, String, TransferRepoOption)

    Transfer a repo ownership

    Declaration
    public virtual Task<Repository> RepoTransferAsync(string owner, string repo, TransferRepoOption body)
    Parameters
    Type Name Description
    System.String owner

    owner of the repo to transfer

    System.String repo

    name of the repo to transfer

    TransferRepoOption body

    Transfer Options

    Returns
    Type Description
    System.Threading.Tasks.Task<Repository>

    Repository

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoTransferAsync(String, String, TransferRepoOption, CancellationToken)

    Transfer a repo ownership

    Declaration
    public virtual async Task<Repository> RepoTransferAsync(string owner, string repo, TransferRepoOption body, CancellationToken cancellationToken)
    Parameters
    Type Name Description
    System.String owner

    owner of the repo to transfer

    System.String repo

    name of the repo to transfer

    TransferRepoOption body

    Transfer Options

    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<Repository>

    Repository

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoUnDismissPullReviewAsync(String, String, Int64, Int64)

    Cancel to dismiss a review for a pull request

    Declaration
    public virtual Task<PullReview> RepoUnDismissPullReviewAsync(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 pull request

    System.Int64 id

    id of the review

    Returns
    Type Description
    System.Threading.Tasks.Task<PullReview>

    PullReview

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoUnDismissPullReviewAsync(String, String, Int64, Int64, CancellationToken)

    Cancel to dismiss a review for a pull request

    Declaration
    public virtual async Task<PullReview> RepoUnDismissPullReviewAsync(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 pull request

    System.Int64 id

    id of the review

    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<PullReview>

    PullReview

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoUpdateFileAsync(String, String, String, UpdateFileOptions)

    Update a file in a repository

    Declaration
    public virtual Task<FileResponse> RepoUpdateFileAsync(string owner, string repo, string filepath, UpdateFileOptions body)
    Parameters
    Type Name Description
    System.String owner

    owner of the repo

    System.String repo

    name of the repo

    System.String filepath

    path of the file to update

    UpdateFileOptions body
    Returns
    Type Description
    System.Threading.Tasks.Task<FileResponse>

    FileResponse

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoUpdateFileAsync(String, String, String, UpdateFileOptions, CancellationToken)

    Update a file in a repository

    Declaration
    public virtual async Task<FileResponse> RepoUpdateFileAsync(string owner, string repo, string filepath, UpdateFileOptions body, CancellationToken cancellationToken)
    Parameters
    Type Name Description
    System.String owner

    owner of the repo

    System.String repo

    name of the repo

    System.String filepath

    path of the file to update

    UpdateFileOptions 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<FileResponse>

    FileResponse

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoUpdatePullRequestAsync(String, String, Int64, Nullable<Style>)

    Merge PR's baseBranch into headBranch

    Declaration
    public virtual Task RepoUpdatePullRequestAsync(string owner, string repo, long index, Style? style)
    Parameters
    Type Name Description
    System.String owner

    owner of the repo

    System.String repo

    name of the repo

    System.Int64 index

    index of the pull request to get

    System.Nullable<Style> style

    how to update pull request

    Returns
    Type Description
    System.Threading.Tasks.Task

    APIEmpty is an empty response

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoUpdatePullRequestAsync(String, String, Int64, Nullable<Style>, CancellationToken)

    Merge PR's baseBranch into headBranch

    Declaration
    public virtual async Task RepoUpdatePullRequestAsync(string owner, string repo, long index, Style? style, 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 pull request to get

    System.Nullable<Style> style

    how to update pull request

    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.

    | Improve this Doc View Source

    RepoUpdateTopicsAsync(String, String, RepoTopicOptions)

    Replace list of topics for a repository

    Declaration
    public virtual Task RepoUpdateTopicsAsync(string owner, string repo, RepoTopicOptions body)
    Parameters
    Type Name Description
    System.String owner

    owner of the repo

    System.String repo

    name of the repo

    RepoTopicOptions body
    Returns
    Type Description
    System.Threading.Tasks.Task

    APIEmpty is an empty response

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoUpdateTopicsAsync(String, String, RepoTopicOptions, CancellationToken)

    Replace list of topics for a repository

    Declaration
    public virtual async Task RepoUpdateTopicsAsync(string owner, string repo, RepoTopicOptions body, CancellationToken cancellationToken)
    Parameters
    Type Name Description
    System.String owner

    owner of the repo

    System.String repo

    name of the repo

    RepoTopicOptions 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

    APIEmpty is an empty response

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoValidateIssueConfigAsync(String, String)

    Returns the validation information for a issue config

    Declaration
    public virtual Task<IssueConfigValidation> RepoValidateIssueConfigAsync(string owner, string repo)
    Parameters
    Type Name Description
    System.String owner

    owner of the repo

    System.String repo

    name of the repo

    Returns
    Type Description
    System.Threading.Tasks.Task<IssueConfigValidation>

    RepoIssueConfigValidation

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    RepoValidateIssueConfigAsync(String, String, CancellationToken)

    Returns the validation information for a issue config

    Declaration
    public virtual async Task<IssueConfigValidation> RepoValidateIssueConfigAsync(string owner, string repo, CancellationToken cancellationToken)
    Parameters
    Type Name Description
    System.String owner

    owner of the repo

    System.String repo

    name of the repo

    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<IssueConfigValidation>

    RepoIssueConfigValidation

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    TopicSearchAsync(String, Nullable<Int32>, Nullable<Int32>)

    search topics via keyword

    Declaration
    public virtual Task<ICollection<TopicResponse>> TopicSearchAsync(string q, int? page, int? limit)
    Parameters
    Type Name Description
    System.String q

    keywords to search

    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<TopicResponse>>

    TopicListResponse

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    TopicSearchAsync(String, Nullable<Int32>, Nullable<Int32>, CancellationToken)

    search topics via keyword

    Declaration
    public virtual async Task<ICollection<TopicResponse>> TopicSearchAsync(string q, int? page, int? limit, CancellationToken cancellationToken)
    Parameters
    Type Name Description
    System.String q

    keywords to search

    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<TopicResponse>>

    TopicListResponse

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    UserCurrentCheckSubscriptionAsync(String, String)

    Check if the current user is watching a repo

    Declaration
    public virtual Task<WatchInfo> UserCurrentCheckSubscriptionAsync(string owner, string repo)
    Parameters
    Type Name Description
    System.String owner

    owner of the repo

    System.String repo

    name of the repo

    Returns
    Type Description
    System.Threading.Tasks.Task<WatchInfo>

    WatchInfo

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    UserCurrentCheckSubscriptionAsync(String, String, CancellationToken)

    Check if the current user is watching a repo

    Declaration
    public virtual async Task<WatchInfo> UserCurrentCheckSubscriptionAsync(string owner, string repo, CancellationToken cancellationToken)
    Parameters
    Type Name Description
    System.String owner

    owner of the repo

    System.String repo

    name of the repo

    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.

    | Improve this Doc View Source

    UserCurrentDeleteSubscriptionAsync(String, String)

    Unwatch a repo

    Declaration
    public virtual Task UserCurrentDeleteSubscriptionAsync(string owner, string repo)
    Parameters
    Type Name Description
    System.String owner

    owner of the repo

    System.String repo

    name of the repo

    Returns
    Type Description
    System.Threading.Tasks.Task

    APIEmpty is an empty response

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    UserCurrentDeleteSubscriptionAsync(String, String, CancellationToken)

    Unwatch a repo

    Declaration
    public virtual async Task UserCurrentDeleteSubscriptionAsync(string owner, string repo, CancellationToken cancellationToken)
    Parameters
    Type Name Description
    System.String owner

    owner of the repo

    System.String repo

    name of the repo

    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.

    | Improve this Doc View Source

    UserCurrentPutSubscriptionAsync(String, String)

    Watch a repo

    Declaration
    public virtual Task<WatchInfo> UserCurrentPutSubscriptionAsync(string owner, string repo)
    Parameters
    Type Name Description
    System.String owner

    owner of the repo

    System.String repo

    name of the repo

    Returns
    Type Description
    System.Threading.Tasks.Task<WatchInfo>

    WatchInfo

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    UserCurrentPutSubscriptionAsync(String, String, CancellationToken)

    Watch a repo

    Declaration
    public virtual async Task<WatchInfo> UserCurrentPutSubscriptionAsync(string owner, string repo, CancellationToken cancellationToken)
    Parameters
    Type Name Description
    System.String owner

    owner of the repo

    System.String repo

    name of the repo

    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.

    | Improve this Doc View Source

    UserTrackedTimesAsync(String, String, String)

    List a user's tracked times in a repo

    Declaration
    [Obsolete]
    public virtual Task<ICollection<TrackedTime>> UserTrackedTimesAsync(string owner, string repo, string user)
    Parameters
    Type Name Description
    System.String owner

    owner of the repo

    System.String repo

    name of the repo

    System.String user

    username of user

    Returns
    Type Description
    System.Threading.Tasks.Task<System.Collections.Generic.ICollection<TrackedTime>>

    TrackedTimeList

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    | Improve this Doc View Source

    UserTrackedTimesAsync(String, String, String, CancellationToken)

    List a user's tracked times in a repo

    Declaration
    [Obsolete]
    public virtual async Task<ICollection<TrackedTime>> UserTrackedTimesAsync(string owner, string repo, string user, CancellationToken cancellationToken)
    Parameters
    Type Name Description
    System.String owner

    owner of the repo

    System.String repo

    name of the repo

    System.String user

    username of user

    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.

    • Improve this Doc
    • View Source
    In This Article
    Back to top © Dangl IT GmbH