SpotifyApiSpotify LogoJS

Episode src/structures/Episode.ts#L122

Spotify api's episode object.


Properties:

audioPreviewURL description duration explicit externalURL htmlDescription id images isExternallyHosted isPlayable languages name releaseDate releaseDatePrecision restrictions resumePoint show type uri

Methods:

makeCodeImage

constructor(data, client) src/structures/Episode.ts#L122

No documentation found.

NameTypeDescription
dataEpisode | SimplifiedEpisode
clientClientThe spotify client.

.audioPreviewURL src/structures/Episode.ts#L24
OPTIONAL

Type:

string

A URL to a 30 second preview (MP3 format) of the episode. null if not available.

.description src/structures/Episode.ts#L29

Type:

string

A description of the episode. HTML tags are stripped away from this field, use html_description field in case HTML tags are needed.

.duration src/structures/Episode.ts#L34

Type:

number

The episode length in milliseconds.

.explicit src/structures/Episode.ts#L39

Type:

boolean

Whether or not the episode has explicit content (true = yes it does; false = no it does not OR unknown).

.externalURL src/structures/Episode.ts#L44

Type:

ExternalUrl

External URLs for this episode

.htmlDescription src/structures/Episode.ts#L49

Type:

string

A description of the episode. This field may contain HTML tags.

.id src/structures/Episode.ts#L54

Type:

string

The Spotify ID for the episode.

.images src/structures/Episode.ts#L59

Type:

Image[]

The cover art for the episode in various sizes, widest first.

.isExternallyHosted src/structures/Episode.ts#L64

Type:

boolean

True if the episode is hosted outside of Spotify’s CDN.

.isPlayable src/structures/Episode.ts#L69

Type:

boolean

True if the episode is playable in the given market. Otherwise false.

.languages src/structures/Episode.ts#L74

Type:

string[]

A list of the languages used in the episode, identified by their ISO 639 code.

.name src/structures/Episode.ts#L79

Type:

string

The name of the episode.

.releaseDate src/structures/Episode.ts#L84

Type:

string

The date the episode was first released, for example "1981-12-15". Depending on the precision, it might be shown as "1981" or "1981-12".

.releaseDatePrecision src/structures/Episode.ts#L89

Type:

string

The precision with which release_date value is known: "year", "month", or "day".

.restrictions src/structures/Episode.ts#L94

Type:

Restriction[]

Included in the response when a content restriction is applied.

.resumePoint src/structures/Episode.ts#L99
OPTIONAL

Type:

CamelCaseObjectKeys<ResumePoint>

The user’s most recent position in the episode. Set if the supplied access token is a user token and has the scope ‘user-read-playback-position’.

.show src/structures/Episode.ts#L114
OPTIONAL

Type:

Show

The show which the episode belongs to.

.type src/structures/Episode.ts#L104

Type:

SpotifyType

The object type: “episode”.

.uri src/structures/Episode.ts#L109

Type:

string

The Spotify URI for the episode

.makeCodeImage(color) src/structures/Episode.ts#L155

Returns a code image url from the spotify uri.

Returns:

string

Parameters:

NameTypeDescription
colorstringThe color code in hex.