Class Media

Represents a media information for a message in a conversation.

Index

Constructors

Accessors

category contentType filename sid size

Methods

_state getContentTemporaryUrl

Constructors

constructor

new Media(data: MediaState | Media, services: MediaServices): Media
Internal
Parameters
- data: MediaState | Media
- services: MediaServices
Returns Media

Accessors

category

get category(): MediaCategory
Media category, can be one of the MediaCategory values.

Returns MediaCategory

contentType

get contentType(): string
Content type of the media.

Returns string

filename

get filename(): null | string
File name. Null if absent.

Returns null | string

sid

get sid(): string
Server-assigned unique identifier for the media.

Returns string

size

get size(): number
Size of the media in bytes.

Returns number

Methods

_state

_state(): MediaState
Internal
Returns MediaState

getContentTemporaryUrl

getContentTemporaryUrl(): CancellablePromise<null | string>
Returns the direct content URL for the media.

This URL is impermanent, it will expire in several minutes and cannot be cached. If the URL becomes expired, you need to request a new one. Each call to this function produces a new temporary URL.

Returns CancellablePromise<null | string>