Logo DataHubClient

IssuesApi Type

Client for GitLab issue operations. See the .

Constructors

Constructor Description

IssuesApi(baseUrl, auth, http)

Full Usage: IssuesApi(baseUrl, auth, http)

Parameters:
Returns: IssuesApi
baseUrl : string
auth : Authentication
http : IHttpClient
Returns: IssuesApi

Instance members

Instance member Description

this.CloseAsync

Full Usage: this.CloseAsync

Parameters:
    projectId : int - The project identifier.
    iid : int - The project-local issue number.

Returns: Async<Issue>

Closes an issue.

projectId : int

The project identifier.

iid : int

The project-local issue number.

Returns: Async<Issue>

this.CreateAsync

Full Usage: this.CreateAsync

Parameters:
    projectId : int - The project identifier.
    title : string - The issue title.
    ?description : string - Optional issue description.

Returns: Async<Issue>

Creates a new issue.

projectId : int

The project identifier.

title : string

The issue title.

?description : string

Optional issue description.

Returns: Async<Issue>

this.CreateNoteAsync

Full Usage: this.CreateNoteAsync

Parameters:
    projectId : int - The project identifier.
    iid : int - The project-local issue number.
    body : string - The note text.

Returns: Async<Note>

Creates a note on an issue.

projectId : int

The project identifier.

iid : int

The project-local issue number.

body : string

The note text.

Returns: Async<Note>

this.GetAsync

Full Usage: this.GetAsync

Parameters:
    projectId : int - The project identifier.
    iid : int - The project-local issue number.

Returns: Async<Issue>

Gets a single issue by project-local issue number.

projectId : int

The project identifier.

iid : int

The project-local issue number.

Returns: Async<Issue>

this.ListAsync

Full Usage: this.ListAsync

Parameters:
    projectId : int - The project identifier.
    ?state : string - Optional state filter, such as opened or closed.

Returns: Async<ResizeArray<Issue>>

Lists issues for a project.

projectId : int

The project identifier.

?state : string

Optional state filter, such as opened or closed.

Returns: Async<ResizeArray<Issue>>

this.NotesAsync

Full Usage: this.NotesAsync

Parameters:
    projectId : int - The project identifier.
    iid : int - The project-local issue number.

Returns: Async<ResizeArray<Note>>

Lists notes on an issue.

projectId : int

The project identifier.

iid : int

The project-local issue number.

Returns: Async<ResizeArray<Note>>

this.UpdateAsync

Full Usage: this.UpdateAsync

Parameters:
    projectId : int - The project identifier.
    iid : int - The project-local issue number.
    ?title : string - Optional replacement title.
    ?description : string - Optional replacement description.
    ?stateEvent : string - Optional state transition, such as close or reopen.

Returns: Async<Issue>

Updates an issue.

projectId : int

The project identifier.

iid : int

The project-local issue number.

?title : string

Optional replacement title.

?description : string

Optional replacement description.

?stateEvent : string

Optional state transition, such as close or reopen.

Returns: Async<Issue>

Type something to start searching.