org.gitlab4j.api

Class AwardEmojiApi

java.lang.Object

org.gitlab4j.api.AbstractApi

org.gitlab4j.api.AwardEmojiApi

All Implemented Interfaces:

Constants

public class AwardEmojiApi
extends AbstractApi

This class implements the client side API for the GitLab Award Emoji API calls.

Since:

v4.8.31

See Also:

GitLab Award Emoji API Documentaion

Nested Class Summary

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

Constants.ActionType, Constants.ApplicationScope, Constants.ArchiveFormat, Constants.CommitBuildState, Constants.Encoding, Constants.EpicOrderBy, Constants.GroupOrderBy, Constants.ImpersonationState, Constants.IssueOrderBy, Constants.IssueScope, Constants.IssueState, Constants.JobScope, Constants.LineType, Constants.MergeRequestOrderBy, Constants.MergeRequestScope, Constants.MergeRequestState, Constants.MilestoneState, Constants.PipelineOrderBy, Constants.PipelineScope, Constants.ProjectOrderBy, Constants.SortOrder, Constants.StateEvent, Constants.TagOrderBy, Constants.TargetType, Constants.TokenType

Field Summary

Fields inherited from class org.gitlab4j.api.AbstractApi

gitLabApi

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
AwardEmojiApi(GitLabApi gitLabApi)

Method Summary

Modifier and Type	Method and Description
AwardEmoji	addIssueAwardEmoji(Object projectIdOrPath, Integer issueIid, String name) Add an award emoji for the specified issue.
AwardEmoji	addMergeRequestAwardEmoji(Object projectIdOrPath, Integer mergeRequestIid, String name) Add an award emoji to the specified merge request.
AwardEmoji	addNoteAwardEmoji(Object projectIdOrPath, Integer issueIid, Integer noteId, String name) Add an award emoji for the specified note.
AwardEmoji	addSnippetAwardEmoji(Object projectIdOrPath, Integer snippetId, String name) Add an award emoji to the specified snippet.
void	deleteIssueAwardEmoji(Object projectIdOrPath, Integer issueIid, Integer awardId) Delete an award emoji from the specified issue.
void	deleteMergeRequestAwardEmoji(Object projectIdOrPath, Integer mergeRequestIid, Integer awardId) Delete an award emoji from the specified merge request.
void	deleteNoteAwardEmoji(Object projectIdOrPath, Integer issueIid, Integer noteId, Integer awardId) Delete an award emoji from the specified note.
void	deleteSnippetAwardEmoji(Object projectIdOrPath, Integer snippetId, Integer awardId) Delete an award emoji from the specified snippet.
AwardEmoji	getIssueAwardEmoji(Object projectIdOrPath, Integer issueIid, Integer awardId) Get the specified award emoji for the specified issue.
List<AwardEmoji>	getIssueAwardEmojis(Object projectIdOrPath, Integer issueIid) Get a list of award emoji for the specified issue.
AwardEmoji	getMergeRequestAwardEmoji(Object projectIdOrPath, Integer mergeRequestIid, Integer awardId) Get the specified award emoji for the specified merge request.
List<AwardEmoji>	getMergeRequestAwardEmojis(Object projectIdOrPath, Integer mergeRequestIid) Get a list of award emoji for the specified merge request.
AwardEmoji	getNoteAwardEmoji(Object projectIdOrPath, Integer issueIid, Integer noteId, Integer awardId) Get the specified award emoji for the specified note.
List<AwardEmoji>	getNoteAwardEmojis(Object projectIdOrPath, Integer issueIid, Integer noteId) Get a list of award emoji for the specified note.
AwardEmoji	getSnippetAwardEmoji(Object projectIdOrPath, Integer snippetId, Integer awardId) Get the specified award emoji for the specified snippet.
List<AwardEmoji>	getSnippetAwardEmojis(Object projectIdOrPath, Integer snippetId) Get a list of award emoji for the specified snippet.

Methods inherited from class org.gitlab4j.api.AbstractApi

addFormParam, addFormParam, delete, delete, get, get, getApiClient, getApiVersion, getDefaultPerPage, getDefaultPerPageParam, getDefaultPerPageParam, getGroupIdOrPath, getPageQueryParams, getPageQueryParams, getPerPageQueryParam, getProjectIdOrPath, getUserIdOrUsername, getWithAccepts, handle, head, isApiVersion, post, post, post, post, post, put, put, putUpload, putUpload, putWithFormData, upload, upload, upload, urlEncode, validate

Methods inherited from class java.lang.Object

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

Constructor Detail

AwardEmojiApi

public AwardEmojiApi(GitLabApi gitLabApi)

Method Detail

getIssueAwardEmojis

public List<AwardEmoji> getIssueAwardEmojis(Object projectIdOrPath,
                                            Integer issueIid)
                                     throws GitLabApiException

Get a list of award emoji for the specified issue.

GitLab Endpoint: GET /projects/:id/issues/:issue_iid/award_emoji

Parameters:

projectIdOrPath - id, path of the project, or a Project instance holding the project ID or path

issueIid - the issue IID to get the award emojis for

Returns:

a list of AwardEmoji for the specified issue

Throws:

GitLabApiException - if any exception occurs

getMergeRequestAwardEmojis

public List<AwardEmoji> getMergeRequestAwardEmojis(Object projectIdOrPath,
                                                   Integer mergeRequestIid)
                                            throws GitLabApiException

Get a list of award emoji for the specified merge request.

GitLab Endpoint: GET /projects/:id/merge_requests/:merge_request_iid/award_emoji

Parameters:

projectIdOrPath - id, path of the project, or a Project instance holding the project ID or path

mergeRequestIid - the merge request IID to get the award emojis for

Returns:

a list of AwardEmoji for the specified merge request

Throws:

GitLabApiException - if any exception occurs

getSnippetAwardEmojis

public List<AwardEmoji> getSnippetAwardEmojis(Object projectIdOrPath,
                                              Integer snippetId)
                                       throws GitLabApiException

Get a list of award emoji for the specified snippet.

GitLab Endpoint: GET /projects/:id/snippets/:snippet_id/award_emoji

Parameters:

projectIdOrPath - id, path of the project, or a Project instance holding the project ID or path

snippetId - the snippet ID to get the award emojis for

Returns:

a list of AwardEmoji for the specified snippet

Throws:

GitLabApiException - if any exception occurs

getNoteAwardEmojis

public List<AwardEmoji> getNoteAwardEmojis(Object projectIdOrPath,
                                           Integer issueIid,
                                           Integer noteId)
                                    throws GitLabApiException

Get a list of award emoji for the specified note.

GitLab Endpoint: GET /projects/:id/issues/:issue_iid/notes/:note_id/award_emoji

Parameters:

projectIdOrPath - id, path of the project, or a Project instance holding the project ID or path

issueIid - the issue IID of the issue that owns the note

noteId - the note ID to get the award emojis for

Returns:

a list of AwardEmoji for the specified note

Throws:

GitLabApiException - if any exception occurs

getIssueAwardEmoji

public AwardEmoji getIssueAwardEmoji(Object projectIdOrPath,
                                     Integer issueIid,
                                     Integer awardId)
                              throws GitLabApiException

Get the specified award emoji for the specified issue.

GitLab Endpoint: GET /projects/:id/issues/:issue_iid/award_emoji/:award_id

Parameters:

projectIdOrPath - id, path of the project, or a Project instance holding the project ID or path

issueIid - the issue IID to get the award emoji for

awardId - the ID of the award emoji to get

Returns:

an AwardEmoji instance for the specified award emoji

Throws:

GitLabApiException - if any exception occurs

getMergeRequestAwardEmoji

public AwardEmoji getMergeRequestAwardEmoji(Object projectIdOrPath,
                                            Integer mergeRequestIid,
                                            Integer awardId)
                                     throws GitLabApiException

Get the specified award emoji for the specified merge request.

GitLab Endpoint: GET /projects/:id/merge_requests/:merge_request_iid/award_emoji/:award_id

Parameters:

projectIdOrPath - id, path of the project, or a Project instance holding the project ID or path

mergeRequestIid - the merge request IID to get the award emoji for

awardId - the ID of the award emoji to get

Returns:

an AwardEmoji instance for the specified award emoji

Throws:

GitLabApiException - if any exception occurs

getSnippetAwardEmoji

public AwardEmoji getSnippetAwardEmoji(Object projectIdOrPath,
                                       Integer snippetId,
                                       Integer awardId)
                                throws GitLabApiException

Get the specified award emoji for the specified snippet.

GitLab Endpoint: GET /projects/:id/snippets/:snippet_id/award_emoji/:award_id

Parameters:

projectIdOrPath - id, path of the project, or a Project instance holding the project ID or path

snippetId - the snippet ID to get the award emoji for

awardId - the ID of the award emoji to get

Returns:

an AwardEmoji instance for the specified award emoji

Throws:

GitLabApiException - if any exception occurs

getNoteAwardEmoji

public AwardEmoji getNoteAwardEmoji(Object projectIdOrPath,
                                    Integer issueIid,
                                    Integer noteId,
                                    Integer awardId)
                             throws GitLabApiException

Get the specified award emoji for the specified note.

GitLab Endpoint: GET /projects/:id/issues/:issue_iid/notes/:note_id/award_emoji/:award_id

Parameters:

projectIdOrPath - id, path of the project, or a Project instance holding the project ID or path

issueIid - the issue IID of the issue that owns the note

noteId - the note ID to get the award emoji from

awardId - the ID of the award emoji to get

Returns:

an AwardEmoji instance for the specified award emoji

Throws:

GitLabApiException - if any exception occurs

addIssueAwardEmoji

public AwardEmoji addIssueAwardEmoji(Object projectIdOrPath,
                                     Integer issueIid,
                                     String name)
                              throws GitLabApiException

Add an award emoji for the specified issue.

GitLab Endpoint: POST /projects/:id/issues/:issue_iid/award_emoji

Parameters:

projectIdOrPath - id, path of the project, or a Project instance holding the project ID or path

issueIid - the issue IID to add the award emoji to

name - the name of the award emoji to add

Returns:

an AwardEmoji instance for the added award emoji

Throws:

GitLabApiException - if any exception occurs

addMergeRequestAwardEmoji

public AwardEmoji addMergeRequestAwardEmoji(Object projectIdOrPath,
                                            Integer mergeRequestIid,
                                            String name)
                                     throws GitLabApiException

Add an award emoji to the specified merge request.

GitLab Endpoint: POST /projects/:id/merge_requests/:merge_request_iid/award_emoji

Parameters:

projectIdOrPath - id, path of the project, or a Project instance holding the project ID or path

mergeRequestIid - the merge request IID to add the award emoji to

name - the name of the award emoji to add

Returns:

an AwardEmoji instance for the added award emoji

Throws:

GitLabApiException - if any exception occurs

addSnippetAwardEmoji

public AwardEmoji addSnippetAwardEmoji(Object projectIdOrPath,
                                       Integer snippetId,
                                       String name)
                                throws GitLabApiException

Add an award emoji to the specified snippet.

GitLab Endpoint: POST /projects/:id/snippets/:snippet_id/award_emoji

Parameters:

projectIdOrPath - id, path of the project, or a Project instance holding the project ID or path

snippetId - the snippet ID to add the award emoji to

name - the name of the award emoji to add

Returns:

an AwardEmoji instance for the added award emoji

Throws:

GitLabApiException - if any exception occurs

addNoteAwardEmoji

public AwardEmoji addNoteAwardEmoji(Object projectIdOrPath,
                                    Integer issueIid,
                                    Integer noteId,
                                    String name)
                             throws GitLabApiException

Add an award emoji for the specified note.

GitLab Endpoint: POST /projects/:id/issues/:issue_iid/notes/:noteId/award_emoji

Parameters:

projectIdOrPath - id, path of the project, or a Project instance holding the project ID or path

issueIid - the issue IID of the issue that owns the note

noteId - the note ID to add the award emoji to

name - the name of the award emoji to add

Returns:

an AwardEmoji instance for the added award emoji

Throws:

GitLabApiException - if any exception occurs

deleteIssueAwardEmoji

public void deleteIssueAwardEmoji(Object projectIdOrPath,
                                  Integer issueIid,
                                  Integer awardId)
                           throws GitLabApiException

Delete an award emoji from the specified issue.

GitLab Endpoint: DELETE /projects/:id/issues/:issue_iid/award_emoji/:award_id

Parameters:

projectIdOrPath - id, path of the project, or a Project instance holding the project ID or path

issueIid - the issue IID to delete the award emoji from

awardId - the ID of the award emoji to delete

Throws:

GitLabApiException - if any exception occurs

deleteMergeRequestAwardEmoji

public void deleteMergeRequestAwardEmoji(Object projectIdOrPath,
                                         Integer mergeRequestIid,
                                         Integer awardId)
                                  throws GitLabApiException

Delete an award emoji from the specified merge request.

GitLab Endpoint: DELETE /projects/:id/merge_requests/:merge_request_iid/award_emoji/:award_id

Parameters:

projectIdOrPath - id, path of the project, or a Project instance holding the project ID or path

mergeRequestIid - the merge request IID to delete the award emoji from

awardId - the ID of the award emoji to delete

Throws:

GitLabApiException - if any exception occurs

deleteSnippetAwardEmoji

public void deleteSnippetAwardEmoji(Object projectIdOrPath,
                                    Integer snippetId,
                                    Integer awardId)
                             throws GitLabApiException

Delete an award emoji from the specified snippet.

GitLab Endpoint: DELETE /projects/:id/snippets/:snippet_id/award_emoji/:award_id

Parameters:

projectIdOrPath - id, path of the project, or a Project instance holding the project ID or path

snippetId - the snippet ID to delete the award emoji from

awardId - the ID of the award emoji to delete

Throws:

GitLabApiException - if any exception occurs

deleteNoteAwardEmoji

public void deleteNoteAwardEmoji(Object projectIdOrPath,
                                 Integer issueIid,
                                 Integer noteId,
                                 Integer awardId)
                          throws GitLabApiException

Delete an award emoji from the specified note.

GitLab Endpoint: DELETE /projects/:id/issues/:issue_iid/notes/:note_id/award_emoji/:award_id

Parameters:

projectIdOrPath - id, path of the project, or a Project instance holding the project ID or path

issueIid - the issue IID that owns the note

noteId - the note ID of the note to delete the award emoji from

awardId - the ID of the award emoji to delete

Throws:

GitLabApiException - if any exception occurs