net.bis5.mattermost.client4.api

Interface EmojiApi

All Known Implementing Classes:

MattermostClient

public interface EmojiApi

Emoji API.

Author:

Takayuki Maruyama

Method Summary

Modifier and Type	Method and Description
ApiResponse<EmojiList>	autocompleteEmoji(String name) get a list of custom emoji that name starts with or matching provided name.
ApiResponse<Emoji>	createEmoji(Emoji emoji, Path imageFile) will save an emoji to the server if the current user has permission to do so.
ApiResponse<Boolean>	deleteEmoji(String emojiId) delete an custom emoji on the provided emoji id string.
ApiResponse<Emoji>	getEmoji(String emojiId) returns a custom emoji in the system on the provided emoji id string.
ApiResponse<Emoji>	getEmojiByName(String emojiName) get a custom emoji by name.
ApiResponse<Path>	getEmojiImage(String emojiId) returns the emoji image.
default ApiResponse<EmojiList>	getEmojiList() returns a list of custom emoji in the system.
ApiResponse<EmojiList>	getEmojiList(Pager pager) returns a list of custom emoji in the system.
ApiResponse<EmojiList>	searchEmoji(SearchEmojiRequest searchRequest) search custom emoji based on request.

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.

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.

getEmojiImage

ApiResponse<Path> getEmojiImage(String emojiId)
                         throws IOException

returns the emoji image.

Throws:

IOException

getEmojiByName

ApiResponse<Emoji> getEmojiByName(String emojiName)

get a custom emoji by name.

searchEmoji

ApiResponse<EmojiList> searchEmoji(SearchEmojiRequest searchRequest)

search custom emoji based on request.

autocompleteEmoji

ApiResponse<EmojiList> autocompleteEmoji(String name)

get a list of custom emoji that name starts with or matching provided name.