Class: Spotted::Models::PlaylistUpdateParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/spotted/models/playlist_update_params.rb

Overview

See Also:

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary collapse

Methods included from Internal::Type::RequestParameters::Converter

dump_request

Methods included from Internal::Type::RequestParameters

included

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, #inspect, inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(collaborative: nil, description: nil, name: nil, public: nil, request_options: {}) ⇒ Object

Some parameter documentations has been truncated, see Spotted::Models::PlaylistUpdateParams for more details.

Parameters:

  • collaborative (Boolean) (defaults to: nil) —

    If ‘true`, the playlist will become collaborative and other users will be able t

  • description (String) (defaults to: nil) —

    Value for playlist description as displayed in Spotify Clients and in the Web AP

  • name (String) (defaults to: nil) —

    The new name for the playlist, for example ‘“My New Playlist Title”`

  • public (Boolean) (defaults to: nil) —

    The playlist’s public/private status (if it should be added to the user’s profil

  • request_options (Spotted::RequestOptions, Hash{Symbol=>Object}) (defaults to: {}) 



# File 'lib/spotted/models/playlist_update_params.rb', line 41

Instance Attribute Details

#collaborative ⇒ Boolean?

If ‘true`, the playlist will become collaborative and other users will be able to modify the playlist in their Spotify client. <br/> _Note: You can only set `collaborative` to `true` on non-public playlists._

Returns:

  • (Boolean, nil) 


16
 
# File 'lib/spotted/models/playlist_update_params.rb', line 16

optional :collaborative, Spotted::Internal::Type::Boolean

#description ⇒ String?

Value for playlist description as displayed in Spotify Clients and in the Web API.

Returns:

  • (String, nil) 


23
 
# File 'lib/spotted/models/playlist_update_params.rb', line 23

optional :description, String

#name ⇒ String?

The new name for the playlist, for example ‘“My New Playlist Title”`

Returns:

  • (String, nil) 


29
 
# File 'lib/spotted/models/playlist_update_params.rb', line 29

optional :name, String

#public ⇒ Boolean?

The playlist’s public/private status (if it should be added to the user’s profile or not): ‘true` the playlist will be public, `false` the playlist will be private, `null` the playlist status is not relevant. For more about public/private status, see [Working with Playlists](/documentation/web-api/concepts/playlists)

Returns:

  • (Boolean, nil) 


39
 
# File 'lib/spotted/models/playlist_update_params.rb', line 39

optional :public, Spotted::Internal::Type::Boolean