Interface EmojiApi

  • All Known Implementing Classes:
    MattermostClient

    public interface EmojiApi
    Emoji API.
    Author:
    Takayuki Maruyama
    • Method Detail

      • createEmoji

        ApiResponse<Emoji> createEmoji​(Emoji emoji,
                                       Path imageFile)
        will save an emoji to the server if the current user has permission to do so. If successful, the provided emoji will be returned with its Id field filled in. Otherwise, an error will be returned.
      • getEmojiList

        default ApiResponse<EmojiList> getEmojiList()
        returns a list of custom emoji in the system.
      • getEmojiList

        ApiResponse<EmojiList> getEmojiList​(Pager pager)
        returns a list of custom emoji in the system.
        Parameters:
        pager - add in Mattermost Server 4.1, in older version, ignore.
      • getEmojiListSorted

        default ApiResponse<EmojiList> getEmojiListSorted()
        returns a list of custom emoji in the system sorted by name.
      • getEmojiListSorted

        ApiResponse<EmojiList> getEmojiListSorted​(Pager pager)
        returns a list of custom emoji in the system sorted by name.
        Parameters:
        pager -
        Since:
        Mattermost Server 4.7
      • deleteEmoji

        ApiResponse<Boolean> deleteEmoji​(String emojiId)
        delete an custom emoji on the provided emoji id string.
      • getEmoji

        ApiResponse<Emoji> getEmoji​(String emojiId)
        returns a custom emoji in the system on the provided emoji id string.
      • autocompleteEmoji

        ApiResponse<EmojiList> autocompleteEmoji​(String name)
        get a list of custom emoji that name starts with or matching provided name.