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.ImpersonationState, Constants.IssueScope, Constants.IssueState, Constants.JobScope, Constants.LineType, 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 and Description
NotesApi(GitLabApi gitLabApi)

Method Summary

Modifier and Type	Method and Description
Note	createIssueNote(Integer projectId, Integer issueIid, String body)
Note	createIssueNote(Integer projectId, Integer issueIid, String body, Date createdAt)
void	deleteIssueNote(Integer projectId, Integer issueIid, Integer noteId)
Note	getIssueNote(Integer projectId, Integer issueIid, Integer noteId)
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.
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, String body)

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

Throws:

GitLabApiException

createIssueNote

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

Throws:

GitLabApiException

createIssueNote

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

Throws:

GitLabApiException

updateIssueNote

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

Throws:

GitLabApiException

deleteIssueNote

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

Throws:

GitLabApiException