Class: MediaEndpoint

Defined in: endpoints/media.ts:6

Constructors

Constructor

new MediaEndpoint(client): MediaEndpoint;

Defined in: endpoints/media.ts:7

Parameters

Parameter	Type
client	RESTClient

Returns

MediaEndpoint

Methods

downloadAttachment()

downloadAttachment(url, signal?): Promise<Blob>;

Defined in: endpoints/media.ts:10

fetch private bytes with the current session, never put credentials in a url.

Parameters

Parameter	Type
url	string
signal?	AbortSignal

Returns

Promise<Blob>

---

uploadMedia()

uploadMedia(params): Promise<IUploadMediaResponse>;

Defined in: endpoints/media.ts:16

Parameters

Parameter	Type
params	{ fileBase64: string; filename: string; mediaType: IMediaType; }
params.fileBase64	string
params.filename	string
params.mediaType	IMediaType

Returns

Promise<IUploadMediaResponse>

---

uploadMediaFile()

uploadMediaFile(params): Promise<IUploadMediaResponse>;

Defined in: endpoints/media.ts:34

Upload bytes directly so large files never increase the JSON request limit.

crop keeps only that part of a profile picture, banner, background or badge picture; the server crops it, so animations survive.

Parameters

Parameter	Type	Description
params	{ channelId?: number; crop?: ICropRect; file: Blob; filename: string; mediaType: IMediaType; }	-
params.channelId?	number	Required for bot attachments; binds the upload to an allowed channel.
params.crop?	ICropRect	-
params.file	Blob	-
params.filename	string	-
params.mediaType	IMediaType	-

Returns

Promise<IUploadMediaResponse>