Package org.gitlab4j.api

Class NotesApi

java.lang.Object

org.gitlab4j.api.AbstractApi

org.gitlab4j.api.NotesApi

All Implemented Interfaces:

Constants

public class NotesApi
extends AbstractApi

Nested Class Summary

Nested classes/interfaces inherited from interface org.gitlab4j.api.Constants

Constants.ActionType, Constants.GroupOrderBy, Constants.ImpersonationState, Constants.IssueScope, Constants.IssueState, Constants.JobScope, Constants.LineType, Constants.MergeRequestState, Constants.MilestoneState, Constants.PipelineOrderBy, Constants.PipelineScope, Constants.ProjectOrderBy, Constants.SortOrder, Constants.StateEvent, Constants.TargetType, Constants.TokenType

Field Summary

Fields inherited from interface org.gitlab4j.api.Constants

NEXT_PAGE_HEADER, PAGE_HEADER, PAGE_PARAM, PER_PAGE, PER_PAGE_PARAM, PREV_PAGE_HEADER, TOTAL_HEADER, TOTAL_PAGES_HEADER

Constructor Summary

Constructors

Constructor	Description
NotesApi(GitLabApi gitLabApi)

Method Summary

Modifier and Type	Method	Description
Note	createIssueNote(Integer projectId, Integer issueIid, String body)	Create a issues's note.
Note	createIssueNote(Integer projectId, Integer issueIid, String body, Date createdAt)	Create a issues's note.
Note	createMergeRequestNote(Integer projectId, Integer mergeRequestIid, String body)	Create a merge request's note.
void	deleteIssueNote(Integer projectId, Integer issueIid, Integer noteId)	Delete the specified issues's note.
void	deleteMergeRequestNote(Integer projectId, Integer mergeRequestIid, Integer noteId)	Delete the specified merge request's note.
Note	getIssueNote(Integer projectId, Integer issueIid, Integer noteId)	Get the specified issues's note.
List<Note>	getIssueNotes(Integer projectId, Integer issueIid)	Get a list of the issues's notes.
Pager<Note>	getIssueNotes(Integer projectId, Integer issueIid, int itemsPerPage)	Get a Pager of issues's notes.
List<Note>	getIssueNotes(Integer projectId, Integer issueIid, int page, int perPage)	Get a list of the issue's notes using the specified page and per page settings.
Note	getMergeRequestNote(Integer projectId, Integer mergeRequestIid, Integer noteId)	Get the specified merge request's note.
List<Note>	getMergeRequestNotes(Integer projectId, Integer mergeRequestIid)	Gets a list of all notes for a single merge request.
Pager<Note>	getMergeRequestNotes(Integer projectId, Integer mergeRequestIid, int itemsPerPage)	Get a Pager of all notes for a single merge request GET /projects/:id/merge_requests/:merge_request_iid/notes
List<Note>	getMergeRequestNotes(Integer projectId, Integer mergeRequestIid, int page, int perPage)	Gets a list of all notes for a single merge request using the specified page and per page settings.
List<Note>	getMergeRequestNotes(Integer projectId, Integer mergeRequestIid, Constants.SortOrder sortOrder, Note.OrderBy orderBy)	Gets a list of all notes for a single merge request.
Pager<Note>	getMergeRequestNotes(Integer projectId, Integer mergeRequestIid, Constants.SortOrder sortOrder, Note.OrderBy orderBy, int itemsPerPage)	Get a Pager of all notes for a single merge request GET /projects/:id/merge_requests/:merge_request_iid/notes
List<Note>	getMergeRequestNotes(Integer projectId, Integer mergeRequestIid, Constants.SortOrder sortOrder, Note.OrderBy orderBy, int page, int perPage)	Gets a list of all notes for a single merge request using the specified page and per page settings.
List<Note>	getNotes(Integer projectId, Integer issueIid)	Deprecated. As of release 4.7.0, replaced by getIssueNotes(Integer, Integer)
Pager<Note>	getNotes(Integer projectId, Integer issueIid, int itemsPerPage)	Deprecated. As of release 4.7.0, replaced by getIssueNotes(Integer, Integer, int)
List<Note>	getNotes(Integer projectId, Integer issueIid, int page, int perPage)	Deprecated. As of release 4.7.0, replaced by getIssueNotes(Integer, Integer, int, int)
Note	updateIssueNote(Integer projectId, Integer issueIid, Integer noteId, String body)	Update the specified issues's note.
Note	updateMergeRequestNote(Integer projectId, Integer mergeRequestIid, Integer noteId, String body)	Update the specified merge request's note.

Methods inherited from class org.gitlab4j.api.AbstractApi

addFormParam, addFormParam, delete, delete, get, get, getApiClient, getApiVersion, getDefaultPerPage, getDefaultPerPageParam, getPageQueryParams, getWithAccepts, handle, isApiVersion, post, post, post, post, put, put, putWithFormData, urlEncode, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

NotesApi

public NotesApi(GitLabApi gitLabApi)

Method Detail

getNotes

public List<Note> getNotes(Integer projectId,
                           Integer issueIid)
                    throws GitLabApiException

Deprecated. As of release 4.7.0, replaced by getIssueNotes(Integer, Integer)

Get a list of the issues's notes. Only returns the first page GET /projects/:id/issues/:issue_iid/notes

Parameters:

projectId - the project ID to get the issues for

issueIid - the issue ID to get the notes for

Returns:

a list of the issues's notes

Throws:

GitLabApiException - if any exception occurs

getNotes

public List<Note> getNotes(Integer projectId,
                           Integer issueIid,
                           int page,
                           int perPage)
                    throws GitLabApiException

Deprecated. As of release 4.7.0, replaced by getIssueNotes(Integer, Integer, int, int)

Get a list of the issue's notes using the specified page and per page settings. GET /projects/:id/issues/:issue_iid/notes

Parameters:

projectId - the project ID to get the issues for

issueIid - the issue IID to get the notes for

page - the page to get

perPage - the number of notes per page

Returns:

the list of notes in the specified range

Throws:

GitLabApiException - if any exception occurs

getNotes

public Pager<Note> getNotes(Integer projectId,
                            Integer issueIid,
                            int itemsPerPage)
                     throws GitLabApiException

Deprecated. As of release 4.7.0, replaced by getIssueNotes(Integer, Integer, int)

Get a Pager of issues's notes. GET /projects/:id/issues/:issue_iid/notes

Parameters:

projectId - the project ID to get the issues for

issueIid - the issue IID to get the notes for

itemsPerPage - the number of notes per page

Returns:

the list of notes in the specified range

Throws:

GitLabApiException - if any exception occurs

getIssueNotes

public List<Note> getIssueNotes(Integer projectId,
                                Integer issueIid)
                         throws GitLabApiException

Get a list of the issues's notes. Only returns the first page GET /projects/:id/issues/:issue_iid/notes

Parameters:

projectId - the project ID to get the issues for

issueIid - the issue ID to get the notes for

Returns:

a list of the issues's notes

Throws:

GitLabApiException - if any exception occurs

getIssueNotes

public List<Note> getIssueNotes(Integer projectId,
                                Integer issueIid,
                                int page,
                                int perPage)
                         throws GitLabApiException

Get a list of the issue's notes using the specified page and per page settings. GET /projects/:id/issues/:issue_iid/notes

Parameters:

projectId - the project ID to get the issues for

issueIid - the issue IID to get the notes for

page - the page to get

perPage - the number of notes per page

Returns:

the list of notes in the specified range

Throws:

GitLabApiException - if any exception occurs

getIssueNotes

public Pager<Note> getIssueNotes(Integer projectId,
                                 Integer issueIid,
                                 int itemsPerPage)
                          throws GitLabApiException

Get a Pager of issues's notes. GET /projects/:id/issues/:issue_iid/notes

Parameters:

projectId - the project ID to get the issues for

issueIid - the issue IID to get the notes for

itemsPerPage - the number of notes per page

Returns:

the list of notes in the specified range

Throws:

GitLabApiException - if any exception occurs

getIssueNote

public Note getIssueNote(Integer projectId,
                         Integer issueIid,
                         Integer noteId)
                  throws GitLabApiException

Get the specified issues's note.

Parameters:

projectId - the project ID to get the issues for

issueIid - the issue IID to get the notes for

noteId - the ID of the Note to get

Returns:

a Note instance for the specified IDs

Throws:

GitLabApiException - if any exception occurs

createIssueNote

public Note createIssueNote(Integer projectId,
                            Integer issueIid,
                            String body)
                     throws GitLabApiException

Create a issues's note.

Parameters:

projectId - the project ID to create the issues for

issueIid - the issue IID to create the notes for

body - the content of note

Returns:

the created Note instance

Throws:

GitLabApiException - if any exception occurs

createIssueNote

public Note createIssueNote(Integer projectId,
                            Integer issueIid,
                            String body,
                            Date createdAt)
                     throws GitLabApiException

Create a issues's note.

Parameters:

projectId - the project ID to create the issues for

issueIid - the issue IID to create the notes for

body - the content of note

createdAt - the created time of note

Returns:

the created Note instance

Throws:

GitLabApiException - if any exception occurs

updateIssueNote

public Note updateIssueNote(Integer projectId,
                            Integer issueIid,
                            Integer noteId,
                            String body)
                     throws GitLabApiException

Update the specified issues's note.

Parameters:

projectId - the project ID to update the issues for

issueIid - the issue IID to update the notes for

noteId - the ID of the node to update

body - the update content for the Note

Returns:

the modified Note instance

Throws:

GitLabApiException - if any exception occurs

deleteIssueNote

public void deleteIssueNote(Integer projectId,
                            Integer issueIid,
                            Integer noteId)
                     throws GitLabApiException

Delete the specified issues's note.

Parameters:

projectId - the project ID to delete the issues for

issueIid - the issue IID to delete the notes for

noteId - the ID of the node to delete

Throws:

GitLabApiException - if any exception occurs

getMergeRequestNotes

public List<Note> getMergeRequestNotes(Integer projectId,
                                       Integer mergeRequestIid)
                                throws GitLabApiException

Gets a list of all notes for a single merge request. Only returns the first page GET /projects/:id/merge_requests/:merge_request_iid/notes

Parameters:

projectId - the project ID to get the issues for

mergeRequestIid - the issue ID to get the notes for

Returns:

a list of the merge request's notes

Throws:

GitLabApiException - if any exception occurs

getMergeRequestNotes

public List<Note> getMergeRequestNotes(Integer projectId,
                                       Integer mergeRequestIid,
                                       Constants.SortOrder sortOrder,
                                       Note.OrderBy orderBy)
                                throws GitLabApiException

Gets a list of all notes for a single merge request. Only returns the first page GET /projects/:id/merge_requests/:merge_request_iid/notes

Parameters:

projectId - the project ID to get the issues for

mergeRequestIid - the issue ID to get the notes for

sortOrder - return merge request notes sorted in the specified sort order, default is DESC

orderBy - return merge request notes ordered by CREATED_AT or UPDATED_AT, default is CREATED_AT

Returns:

a list of the merge request's notes

Throws:

GitLabApiException - if any exception occurs

getMergeRequestNotes

public List<Note> getMergeRequestNotes(Integer projectId,
                                       Integer mergeRequestIid,
                                       int page,
                                       int perPage)
                                throws GitLabApiException

Gets a list of all notes for a single merge request using the specified page and per page settings. GET /projects/:id/merge_requests/:merge_request_iid/notes

Parameters:

projectId - the project ID to get the issues for

mergeRequestIid - the merge request IID to get the notes for

page - the page to get

perPage - the number of notes per page

Returns:

the list of notes in the specified range

Throws:

GitLabApiException - if any exception occurs

getMergeRequestNotes

public List<Note> getMergeRequestNotes(Integer projectId,
                                       Integer mergeRequestIid,
                                       Constants.SortOrder sortOrder,
                                       Note.OrderBy orderBy,
                                       int page,
                                       int perPage)
                                throws GitLabApiException

Gets a list of all notes for a single merge request using the specified page and per page settings. GET /projects/:id/merge_requests/:merge_request_iid/notes

Parameters:

projectId - the project ID to get the issues for

mergeRequestIid - the merge request IID to get the notes for

sortOrder - return merge request notes sorted in the specified sort order, default is DESC

orderBy - return merge request notes ordered by CREATED_AT or UPDATED_AT, default is CREATED_AT

page - the page to get

perPage - the number of notes per page

Returns:

the list of notes in the specified range

Throws:

GitLabApiException - if any exception occurs

getMergeRequestNotes

public Pager<Note> getMergeRequestNotes(Integer projectId,
                                        Integer mergeRequestIid,
                                        int itemsPerPage)
                                 throws GitLabApiException

Get a Pager of all notes for a single merge request GET /projects/:id/merge_requests/:merge_request_iid/notes

Parameters:

projectId - the project ID to get the issues for

mergeRequestIid - the merge request IID to get the notes for

itemsPerPage - the number of notes per page

Returns:

the list of notes in the specified range

Throws:

GitLabApiException - if any exception occurs

getMergeRequestNotes

public Pager<Note> getMergeRequestNotes(Integer projectId,
                                        Integer mergeRequestIid,
                                        Constants.SortOrder sortOrder,
                                        Note.OrderBy orderBy,
                                        int itemsPerPage)
                                 throws GitLabApiException

Get a Pager of all notes for a single merge request GET /projects/:id/merge_requests/:merge_request_iid/notes

Parameters:

projectId - the project ID to get the issues for

mergeRequestIid - the merge request IID to get the notes for

sortOrder - return merge request notes sorted in the specified sort order, default is DESC

orderBy - return merge request notes ordered by CREATED_AT or UPDATED_AT, default is CREATED_AT

itemsPerPage - the number of notes per page

Returns:

the list of notes in the specified range

Throws:

GitLabApiException - if any exception occurs

getMergeRequestNote

public Note getMergeRequestNote(Integer projectId,
                                Integer mergeRequestIid,
                                Integer noteId)
                         throws GitLabApiException

Get the specified merge request's note.

Parameters:

projectId - the project ID to get the issues for

mergeRequestIid - the merge request IID to get the notes for

noteId - the ID of the Note to get

Returns:

a Note instance for the specified IDs

Throws:

GitLabApiException - if any exception occurs

createMergeRequestNote

public Note createMergeRequestNote(Integer projectId,
                                   Integer mergeRequestIid,
                                   String body)
                            throws GitLabApiException

Create a merge request's note.

Parameters:

projectId - the project ID to create the issues for

mergeRequestIid - the merge request IID to create the notes for

body - the content of note

Returns:

the created Note instance

Throws:

GitLabApiException - if any exception occurs

updateMergeRequestNote

public Note updateMergeRequestNote(Integer projectId,
                                   Integer mergeRequestIid,
                                   Integer noteId,
                                   String body)
                            throws GitLabApiException

Update the specified merge request's note.

Parameters:

projectId - the project ID to update the issues for

mergeRequestIid - the merge request IID to update the notes for

noteId - the ID of the node to update

body - the update content for the Note

Returns:

the modified Note instance

Throws:

GitLabApiException - if any exception occurs

deleteMergeRequestNote

public void deleteMergeRequestNote(Integer projectId,
                                   Integer mergeRequestIid,
                                   Integer noteId)
                            throws GitLabApiException

Delete the specified merge request's note.

Parameters:

projectId - the project ID to delete the issues for

mergeRequestIid - the merge request IID to delete the notes for

noteId - the ID of the node to delete

Throws:

GitLabApiException - if any exception occurs