Package org.gitlab4j.api

Class AwardEmojiApi

  • All Implemented Interfaces:
    org.gitlab4j.models.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.models.Constants

        org.gitlab4j.models.Constants.ActionType, org.gitlab4j.models.Constants.ApplicationScope, org.gitlab4j.models.Constants.ArchiveFormat, org.gitlab4j.models.Constants.AutoDevopsDeployStrategy, org.gitlab4j.models.Constants.BuildGitStrategy, org.gitlab4j.models.Constants.CommitBuildState, org.gitlab4j.models.Constants.ContributorOrderBy, org.gitlab4j.models.Constants.DefaultBranchProtectionLevel, org.gitlab4j.models.Constants.DeploymentOrderBy, org.gitlab4j.models.Constants.DeploymentStatus, org.gitlab4j.models.Constants.DeployTokenScope, org.gitlab4j.models.Constants.Encoding, org.gitlab4j.models.Constants.EpicOrderBy, org.gitlab4j.models.Constants.EventScope, org.gitlab4j.models.Constants.GroupOrderBy, org.gitlab4j.models.Constants.GroupSearchScope<T extends java.lang.Object>, org.gitlab4j.models.Constants.ImpersonationState, org.gitlab4j.models.Constants.IssueOrderBy, org.gitlab4j.models.Constants.IssueScope, org.gitlab4j.models.Constants.IssueState, org.gitlab4j.models.Constants.JobScope, org.gitlab4j.models.Constants.LineType, org.gitlab4j.models.Constants.MergeRequestOrderBy, org.gitlab4j.models.Constants.MergeRequestScope, org.gitlab4j.models.Constants.MergeRequestSearchIn, org.gitlab4j.models.Constants.MergeRequestState, org.gitlab4j.models.Constants.MilestoneState, org.gitlab4j.models.Constants.PackageOrderBy, org.gitlab4j.models.Constants.PackageStatus, org.gitlab4j.models.Constants.PipelineOrderBy, org.gitlab4j.models.Constants.PipelineScope, org.gitlab4j.models.Constants.PipelineSource, org.gitlab4j.models.Constants.ProjectAccessTokenScope, org.gitlab4j.models.Constants.ProjectCreationLevel, org.gitlab4j.models.Constants.ProjectOrderBy, org.gitlab4j.models.Constants.ProjectSearchScope<T extends java.lang.Object>, org.gitlab4j.models.Constants.SearchScope<T extends java.lang.Object>, org.gitlab4j.models.Constants.SortOrder, org.gitlab4j.models.Constants.SquashOption, org.gitlab4j.models.Constants.StateEvent, org.gitlab4j.models.Constants.SubgroupCreationLevel, org.gitlab4j.models.Constants.TagOrderBy, org.gitlab4j.models.Constants.TargetType, org.gitlab4j.models.Constants.TodoAction, org.gitlab4j.models.Constants.TodoState, org.gitlab4j.models.Constants.TodoType, org.gitlab4j.models.Constants.TokenType

    • Field Summary

      • Fields inherited from interface org.gitlab4j.models.Constants

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

    • Constructor Detail

      • AwardEmojiApi

        public AwardEmojiApi​(GitLabApi gitLabApi)

    • Method Detail

      • getIssueAwardEmojis

        public java.util.List<org.gitlab4j.api.models.AwardEmoji> getIssueAwardEmojis​(java.lang.Object projectIdOrPath,
                                                                              java.lang.Long 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 java.util.List<org.gitlab4j.api.models.AwardEmoji> getMergeRequestAwardEmojis​(java.lang.Object projectIdOrPath,
                                                                                     java.lang.Long 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 java.util.List<org.gitlab4j.api.models.AwardEmoji> getSnippetAwardEmojis​(java.lang.Object projectIdOrPath,
                                                                                java.lang.Long 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

      • getIssueNoteAwardEmojis

        public java.util.List<org.gitlab4j.api.models.AwardEmoji> getIssueNoteAwardEmojis​(java.lang.Object projectIdOrPath,
                                                                                  java.lang.Long issueIid,
                                                                                  java.lang.Long noteId)
                                                                           throws GitLabApiException
        Get a list of award emoji for the specified issue 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

      • getNoteAwardEmojis

        public java.util.List<org.gitlab4j.api.models.AwardEmoji> getNoteAwardEmojis​(java.lang.Object projectIdOrPath,
                                                                             java.lang.Long issueIid,
                                                                             java.lang.Long noteId)
                                                                      throws GitLabApiException
        Get a list of award emoji for the specified issue 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

      • getMergeRequestNoteAwardEmojis

        public java.util.List<org.gitlab4j.api.models.AwardEmoji> getMergeRequestNoteAwardEmojis​(java.lang.Object projectIdOrPath,
                                                                                         java.lang.Long mergeRequestIid,
                                                                                         java.lang.Long noteId)
                                                                                  throws GitLabApiException
        Get a list of award emoji for the specified merge request note. 
        GitLab Endpoint: GET /projects/:id/merge_requests/:merge_request_iid/notes/:note_id/award_emoji
        Parameters:
        projectIdOrPath - id, path of the project, or a Project instance holding the project ID or path
        mergeRequestIid - the merge request IID of the merge request 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 org.gitlab4j.api.models.AwardEmoji getIssueAwardEmoji​(java.lang.Object projectIdOrPath,
                                                             java.lang.Long issueIid,
                                                             java.lang.Long 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 org.gitlab4j.api.models.AwardEmoji getMergeRequestAwardEmoji​(java.lang.Object projectIdOrPath,
                                                                    java.lang.Long mergeRequestIid,
                                                                    java.lang.Long 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 org.gitlab4j.api.models.AwardEmoji getSnippetAwardEmoji​(java.lang.Object projectIdOrPath,
                                                               java.lang.Long snippetId,
                                                               java.lang.Long 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

      • getIssueNoteAwardEmoji

        public org.gitlab4j.api.models.AwardEmoji getIssueNoteAwardEmoji​(java.lang.Object projectIdOrPath,
                                                                 java.lang.Long issueIid,
                                                                 java.lang.Long noteId,
                                                                 java.lang.Long awardId)
                                                          throws GitLabApiException
        Get the specified award emoji for the specified issue 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

      • getNoteAwardEmoji

        @Deprecated
public org.gitlab4j.api.models.AwardEmoji getNoteAwardEmoji​(java.lang.Object projectIdOrPath,
                                                            java.lang.Long issueIid,
                                                            java.lang.Long noteId,
                                                            java.lang.Long awardId)
                                                     throws GitLabApiException
        Deprecated.
        use getIssueNoteAwardEmoji(Object, Long, Long, Long) instead
        Get the specified award emoji for the specified issue 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

      • getMergeRequestNoteAwardEmoji

        public org.gitlab4j.api.models.AwardEmoji getMergeRequestNoteAwardEmoji​(java.lang.Object projectIdOrPath,
                                                                        java.lang.Long mergeRequestIid,
                                                                        java.lang.Long noteId,
                                                                        java.lang.Long awardId)
                                                                 throws GitLabApiException
        Get the specified award emoji for the specified merge request note. 
        GitLab Endpoint: GET /projects/:id/merge_requests/:merge_request_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
        mergeRequestIid - the merge request IID of the merge request 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 org.gitlab4j.api.models.AwardEmoji addIssueAwardEmoji​(java.lang.Object projectIdOrPath,
                                                             java.lang.Long issueIid,
                                                             java.lang.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 org.gitlab4j.api.models.AwardEmoji addMergeRequestAwardEmoji​(java.lang.Object projectIdOrPath,
                                                                    java.lang.Long mergeRequestIid,
                                                                    java.lang.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 org.gitlab4j.api.models.AwardEmoji addSnippetAwardEmoji​(java.lang.Object projectIdOrPath,
                                                               java.lang.Long snippetId,
                                                               java.lang.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

      • addIssueNoteAwardEmoji

        public org.gitlab4j.api.models.AwardEmoji addIssueNoteAwardEmoji​(java.lang.Object projectIdOrPath,
                                                                 java.lang.Long issueIid,
                                                                 java.lang.Long noteId,
                                                                 java.lang.String name)
                                                          throws GitLabApiException
        Add an award emoji for the specified issue 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

      • addNoteAwardEmoji

        @Deprecated
public org.gitlab4j.api.models.AwardEmoji addNoteAwardEmoji​(java.lang.Object projectIdOrPath,
                                                            java.lang.Long issueIid,
                                                            java.lang.Long noteId,
                                                            java.lang.String name)
                                                     throws GitLabApiException
        Deprecated.
        use addIssueNoteAwardEmoji(Object, Long, Long, String)
        Add an award emoji for the specified issue 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

      • addMergeRequestAwardEmoji

        public org.gitlab4j.api.models.AwardEmoji addMergeRequestAwardEmoji​(java.lang.Object projectIdOrPath,
                                                                    java.lang.Integer mergeRequestIid,
                                                                    java.lang.Integer noteId,
                                                                    java.lang.String name)
                                                             throws GitLabApiException
        Add an award emoji for the specified merge request note. 
        GitLab Endpoint: POST /projects/:id/merge_requests/:merge_request_iid/notes/:noteId/award_emoji
        Parameters:
        projectIdOrPath - id, path of the project, or a Project instance holding the project ID or path
        mergeRequestIid - the merge request IID of the merge request 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​(java.lang.Object projectIdOrPath,
                                  java.lang.Long issueIid,
                                  java.lang.Long 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​(java.lang.Object projectIdOrPath,
                                         java.lang.Long mergeRequestIid,
                                         java.lang.Long 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​(java.lang.Object projectIdOrPath,
                                    java.lang.Long snippetId,
                                    java.lang.Long 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

      • deleteIssueNoteAwardEmoji

        public void deleteIssueNoteAwardEmoji​(java.lang.Object projectIdOrPath,
                                      java.lang.Long issueIid,
                                      java.lang.Long noteId,
                                      java.lang.Long awardId)
                               throws GitLabApiException
        Delete an award emoji from the specified issue 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

      • deleteNoteAwardEmoji

        @Deprecated
public void deleteNoteAwardEmoji​(java.lang.Object projectIdOrPath,
                                 java.lang.Long issueIid,
                                 java.lang.Long noteId,
                                 java.lang.Long awardId)
                          throws GitLabApiException
        Deprecated.
        use deleteIssueNoteAwardEmoji(Object, Long, Long, Long) instead
        Delete an award emoji from the specified issue 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

      • deleteMergeRequestNoteAwardEmoji

        public void deleteMergeRequestNoteAwardEmoji​(java.lang.Object projectIdOrPath,
                                             java.lang.Long mergeRequestIid,
                                             java.lang.Long noteId,
                                             java.lang.Long awardId)
                                      throws GitLabApiException
        Delete an award emoji from the specified merge request note. 
        GitLab Endpoint: DELETE /projects/:id/merge_requests/:merge_request_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
        mergeRequestIid - the merge request IID of the merge request 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