Class: EmojiEndpoint ​
Defined in: endpoints/emoji.ts:41
Constructors ​
Constructor ​
ts
new EmojiEndpoint(client): EmojiEndpoint;Defined in: endpoints/emoji.ts:42
Parameters ​
| Parameter | Type |
|---|---|
client | RESTClient |
Returns ​
EmojiEndpoint
Methods ​
createEmoji() ​
ts
createEmoji(payload): Promise<ICustomEmojiResponse>;Defined in: endpoints/emoji.ts:53
Register an already-uploaded image as a custom emoji. Upload it through the media endpoint first with mediaType custom_emoji.
Parameters ​
| Parameter | Type |
|---|---|
payload | { mediaId: number; name: string; } |
payload.mediaId | number |
payload.name | string |
Returns ​
Promise<ICustomEmojiResponse>
deleteEmoji() ​
ts
deleteEmoji(emojiId): Promise<IDeleteCustomEmojiResponse>;Defined in: endpoints/emoji.ts:150
Parameters ​
| Parameter | Type |
|---|---|
emojiId | number |
Returns ​
Promise<IDeleteCustomEmojiResponse>
deletePack() ​
ts
deletePack(packId): Promise<IDeleteEmojiPackResponse>;Defined in: endpoints/emoji.ts:137
Deleting a pack deletes its emoji and any reactions that used them.
Parameters ​
| Parameter | Type |
|---|---|
packId | number |
Returns ​
Promise<IDeleteEmojiPackResponse>
exportPack() ​
ts
exportPack(packId): Promise<Blob>;Defined in: endpoints/emoji.ts:142
A pack's images as a zip archive, which imports straight back to the same emoji names.
Parameters ​
| Parameter | Type |
|---|---|
packId | number |
Returns ​
Promise<Blob>
importArchive() ​
ts
importArchive(archiveBase64, options?): Promise<IEmojiImportResponse>;Defined in: endpoints/emoji.ts:61
Bulk add emoji from a zip archive. The archive is processed in memory and never stored.
Parameters ​
| Parameter | Type |
|---|---|
archiveBase64 | string |
options? | EmojiImportTarget |
Returns ​
Promise<IEmojiImportResponse>
importArchiveFile() ​
ts
importArchiveFile(file, options?): Promise<IEmojiImportResponse>;Defined in: endpoints/emoji.ts:84
Upload the archive bytes directly, independently of the JSON request limit.
Parameters ​
| Parameter | Type |
|---|---|
file | Blob |
options? | EmojiImportTarget |
Returns ​
Promise<IEmojiImportResponse>
importFiles() ​
ts
importFiles(files, options?): Promise<IEmojiImportResponse>;Defined in: endpoints/emoji.ts:72
Bulk add emoji from a set of images, named from each file.
Parameters ​
| Parameter | Type |
|---|---|
files | object[] |
options? | Omit<EmojiImportTarget, "filename"> |
Returns ​
Promise<IEmojiImportResponse>
importImageFiles() ​
ts
importImageFiles(files, options?): Promise<IEmojiImportResponse>;Defined in: endpoints/emoji.ts:94
Send images sequentially, keeping every successful file in the same pack.
Parameters ​
| Parameter | Type |
|---|---|
files | object[] |
options? | Omit<EmojiImportTarget, "filename"> |
Returns ​
Promise<IEmojiImportResponse>
listEmojis() ​
ts
listEmojis(): Promise<IListCustomEmojiResponse>;Defined in: endpoints/emoji.ts:45
every custom emoji the caller may use
Returns ​
Promise<IListCustomEmojiResponse>
renameEmoji() ​
ts
renameEmoji(emojiId, name): Promise<ICustomEmojiResponse>;Defined in: endpoints/emoji.ts:146
Parameters ​
| Parameter | Type |
|---|---|
emojiId | number |
name | string |
Returns ​
Promise<ICustomEmojiResponse>
renamePack() ​
ts
renamePack(packId, name): Promise<IEmojiPackResponse>;Defined in: endpoints/emoji.ts:132
Parameters ​
| Parameter | Type |
|---|---|
packId | number |
name | string |
Returns ​
Promise<IEmojiPackResponse>