Options
All
  • Public
  • Public/Protected
  • All
Menu

Module "types/SpotifyOptions"

Index

Type aliases

AddItemsToPlaylistOptions

AddItemsToPlaylistOptions: { position?: undefined | number }

Type declaration

  • Optional position?: undefined | number

CreatePlaylistOptions

CreatePlaylistOptions: { collaborative?: undefined | false | true; description?: undefined | string; public?: undefined | false | true }

Type declaration

  • Optional collaborative?: undefined | false | true
  • Optional description?: undefined | string
  • Optional public?: undefined | false | true

DeviceIdOptions

DeviceIdOptions: { device_id?: undefined | string }

Type declaration

  • Optional device_id?: undefined | string

FollowPlaylistOptions

FollowPlaylistOptions: { public?: undefined | false | true }

Type declaration

  • Optional public?: undefined | false | true

GetAlbumTracksOptions

GetAlbumTracksOptions: { limit?: undefined | number; market?: undefined | string; offset?: undefined | number }

Type declaration

  • Optional limit?: undefined | number
  • Optional market?: undefined | string
  • Optional offset?: undefined | number

GetArtistAlbumsOptions

GetArtistAlbumsOptions: { country?: undefined | string; include_groups?: Array<"album" | "single" | "appears_on" | "compilation">; limit?: undefined | number; offset?: undefined | number }

Type declaration

  • Optional country?: undefined | string
  • Optional include_groups?: Array<"album" | "single" | "appears_on" | "compilation">
  • Optional limit?: undefined | number
  • Optional offset?: undefined | number

GetCategoriesOptions

GetCategoriesOptions: { country?: undefined | string; limit?: undefined | number; locale?: undefined | string; offset?: undefined | number }

Type declaration

  • Optional country?: undefined | string
  • Optional limit?: undefined | number
  • Optional locale?: undefined | string
  • Optional offset?: undefined | number

GetCategoryOptions

GetCategoryOptions: { country?: undefined | string; locale?: undefined | string }

Type declaration

  • Optional country?: undefined | string
  • Optional locale?: undefined | string

GetCategoryPlaylistsOptions

GetCategoryPlaylistsOptions: { country?: undefined | string; limit?: undefined | number; offset?: undefined | number }

Type declaration

  • Optional country?: undefined | string
  • Optional limit?: undefined | number
  • Optional offset?: undefined | number

GetCurrentlyPlayingTrackOptions

GetCurrentlyPlayingTrackOptions: { additional_types?: Array<"episode">; market?: undefined | string }

Type declaration

  • Optional additional_types?: Array<"episode">
  • Optional market?: undefined | string

GetFeaturedPlaylistsOptions

GetFeaturedPlaylistsOptions: { country?: undefined | string; limit?: undefined | number; locale?: undefined | string; offset?: undefined | number; timestamp?: undefined | string }

Type declaration

  • Optional country?: undefined | string
  • Optional limit?: undefined | number
  • Optional locale?: undefined | string
  • Optional offset?: undefined | number
  • Optional timestamp?: undefined | string

GetFollowedArtistsOptions

GetFollowedArtistsOptions: { after?: undefined | string; limit?: undefined | number }

Type declaration

  • Optional after?: undefined | string
  • Optional limit?: undefined | number

GetMyPlaylistsOptions

GetMyPlaylistsOptions: { limit?: undefined | number; offset?: undefined | number }

Type declaration

  • Optional limit?: undefined | number
  • Optional offset?: undefined | number

GetNewReleasesOptions

GetNewReleasesOptions: { country?: undefined | string; limit?: undefined | number; offset?: undefined | number }

Type declaration

  • Optional country?: undefined | string
  • Optional limit?: undefined | number
  • Optional offset?: undefined | number

GetPlaybackInfoOptions

GetPlaybackInfoOptions: { additional_types?: Array<"episode">; market?: undefined | string }

Type declaration

  • Optional additional_types?: Array<"episode">
  • Optional market?: undefined | string

GetPlaylistItemsOptions

GetPlaylistItemsOptions: { additional_types?: Array<"episode">; fields?: undefined | string; limit?: undefined | number; market?: undefined | string; offset?: undefined | number }

Type declaration

  • Optional additional_types?: Array<"episode">
  • Optional fields?: undefined | string
  • Optional limit?: undefined | number
  • Optional market?: undefined | string
  • Optional offset?: undefined | number

GetPlaylistOptions

GetPlaylistOptions: { additional_types?: Array<"episode">; fields?: undefined | string; market?: undefined | string }

Type declaration

  • Optional additional_types?: Array<"episode">
  • Optional fields?: undefined | string
  • Optional market?: undefined | string

GetRecentlyPlayedTracksOptions

GetRecentlyPlayedTracksOptions: { after?: undefined | number; before?: undefined | number; limit?: undefined | number }

Type declaration

  • Optional after?: undefined | number
  • Optional before?: undefined | number
  • Optional limit?: undefined | number

GetRecommendationsOptions

GetRecommendationsOptions: { limit?: undefined | number; market?: undefined | string; max_acousticness?: undefined | number; max_danceability?: undefined | number; max_duration_ms?: undefined | number; max_energy?: undefined | number; max_instrumentalness?: undefined | number; max_key?: undefined | number; max_liveness?: undefined | number; max_loudness?: undefined | number; max_mode?: undefined | number; max_popularity?: undefined | number; max_speechiness?: undefined | number; max_tempo?: undefined | number; max_time_signature?: undefined | number; max_valence?: undefined | number; min_acousticness?: undefined | number; min_danceability?: undefined | number; min_duration_ms?: undefined | number; min_energy?: undefined | number; min_instrumentalness?: undefined | number; min_key?: undefined | number; min_liveness?: undefined | number; min_loudness?: undefined | number; min_mode?: undefined | number; min_popularity?: undefined | number; min_speechiness?: undefined | number; min_tempo?: undefined | number; min_time_signature?: undefined | number; min_valence?: undefined | number; target_acousticness?: undefined | number; target_danceability?: undefined | number; target_duration_ms?: undefined | number; target_energy?: undefined | number; target_instrumentalness?: undefined | number; target_key?: undefined | number; target_liveness?: undefined | number; target_loudness?: undefined | number; target_mode?: undefined | number; target_popularity?: undefined | number; target_speechiness?: undefined | number; target_tempo?: undefined | number; target_time_signature?: undefined | number; target_valence?: undefined | number }

Type declaration

  • Optional limit?: undefined | number
  • Optional market?: undefined | string
  • Optional max_acousticness?: undefined | number
  • Optional max_danceability?: undefined | number
  • Optional max_duration_ms?: undefined | number
  • Optional max_energy?: undefined | number
  • Optional max_instrumentalness?: undefined | number
  • Optional max_key?: undefined | number
  • Optional max_liveness?: undefined | number
  • Optional max_loudness?: undefined | number
  • Optional max_mode?: undefined | number
  • Optional max_popularity?: undefined | number
  • Optional max_speechiness?: undefined | number
  • Optional max_tempo?: undefined | number
  • Optional max_time_signature?: undefined | number
  • Optional max_valence?: undefined | number
  • Optional min_acousticness?: undefined | number
  • Optional min_danceability?: undefined | number
  • Optional min_duration_ms?: undefined | number
  • Optional min_energy?: undefined | number
  • Optional min_instrumentalness?: undefined | number
  • Optional min_key?: undefined | number
  • Optional min_liveness?: undefined | number
  • Optional min_loudness?: undefined | number
  • Optional min_mode?: undefined | number
  • Optional min_popularity?: undefined | number
  • Optional min_speechiness?: undefined | number
  • Optional min_tempo?: undefined | number
  • Optional min_time_signature?: undefined | number
  • Optional min_valence?: undefined | number
  • Optional target_acousticness?: undefined | number
  • Optional target_danceability?: undefined | number
  • Optional target_duration_ms?: undefined | number
  • Optional target_energy?: undefined | number
  • Optional target_instrumentalness?: undefined | number
  • Optional target_key?: undefined | number
  • Optional target_liveness?: undefined | number
  • Optional target_loudness?: undefined | number
  • Optional target_mode?: undefined | number
  • Optional target_popularity?: undefined | number
  • Optional target_speechiness?: undefined | number
  • Optional target_tempo?: undefined | number
  • Optional target_time_signature?: undefined | number
  • Optional target_valence?: undefined | number

GetSavedAlbumsOptions

GetSavedAlbumsOptions: { limit?: undefined | number; market?: undefined | string; offset?: undefined | number }

Type declaration

  • Optional limit?: undefined | number
  • Optional market?: undefined | string
  • Optional offset?: undefined | number

GetSavedShowsOptions

GetSavedShowsOptions: { limit?: undefined | number; offset?: undefined | number }

Type declaration

  • Optional limit?: undefined | number
  • Optional offset?: undefined | number

GetSavedTracksOptions

GetSavedTracksOptions: { limit?: undefined | number; market?: undefined | string; offset?: undefined | number }

Type declaration

  • Optional limit?: undefined | number
  • Optional market?: undefined | string
  • Optional offset?: undefined | number

GetShowEpisodesOptions

GetShowEpisodesOptions: { limit?: undefined | number; market?: undefined | string; offset?: undefined | number }

Type declaration

  • Optional limit?: undefined | number
  • Optional market?: undefined | string
  • Optional offset?: undefined | number

GetUserPlaylistsOptions

GetUserPlaylistsOptions: { limit?: undefined | number; offset?: undefined | number }

Type declaration

  • Optional limit?: undefined | number
  • Optional offset?: undefined | number

MarketOptions

MarketOptions: { market?: undefined | string }

Type declaration

  • Optional market?: undefined | string

PersonalizationOptions

PersonalizationOptions: { limit?: undefined | number; offset?: undefined | number; time_range?: "long_term" | "medium_term" | "short_term" }

Type declaration

  • Optional limit?: undefined | number
  • Optional offset?: undefined | number
  • Optional time_range?: "long_term" | "medium_term" | "short_term"

PlayOptions

PlayOptions: { context_uri?: undefined | string; device_id?: undefined | string; offset?: { position: number } | { uri: string }; uris?: string[] }

Type declaration

  • Optional context_uri?: undefined | string
  • Optional device_id?: undefined | string
  • Optional offset?: { position: number } | { uri: string }
  • Optional uris?: string[]

RemovePlaylistItemsByPositionOptions

RemovePlaylistItemsByPositionOptions: { snapshot_id?: undefined | string }

Type declaration

  • Optional snapshot_id?: undefined | string

RemoveSavedShowsOptions

RemoveSavedShowsOptions: { market?: undefined | string }

Type declaration

  • Optional market?: undefined | string

ReorderPlaylistItemsOptions

ReorderPlaylistItemsOptions: { range_length?: undefined | number; snapshot_id?: undefined | string }

Type declaration

  • Optional range_length?: undefined | number
  • Optional snapshot_id?: undefined | string

SearchOptions

SearchOptions: { include_external?: undefined | "audio"; limit?: undefined | number; market?: undefined | string; offset?: undefined | number }

Type declaration

  • Optional include_external?: undefined | "audio"
  • Optional limit?: undefined | number
  • Optional market?: undefined | string
  • Optional offset?: undefined | number

TransferPlaybackOptions

TransferPlaybackOptions: { play?: undefined | false | true }

Type declaration

  • Optional play?: undefined | false | true

Generated using TypeDoc