Class: Spotted::Models::Users::PlaylistCreateParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/spotted/models/users/playlist_create_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(name: , collaborative: nil, description: nil, public: nil, request_options: {}) ⇒ Object

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

to

Parameters:

  • name (String) (defaults to: ) —

    The name for the new playlist, for example ‘“Your Coolest Playlist”`. This name

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

    Defaults to ‘false`. If `true` the playlist will be collaborative. _Note:

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

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

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

    Defaults to ‘true`. The playlist’s public/private status (if it should be added

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



# File 'lib/spotted/models/users/playlist_create_params.rb', line 48

Instance Attribute Details

#collaborative ⇒ Boolean?

Defaults to ‘false`. If `true` the playlist will be collaborative. _Note: to create a collaborative playlist you must also set `public` to `false`. To create collaborative playlists you must have granted `playlist-modify-private` and `playlist-modify-public` [scopes](/documentation/web-api/concepts/scopes/#list-of-scopes)._

Returns:

  • (Boolean, nil) 


27
 
# File 'lib/spotted/models/users/playlist_create_params.rb', line 27

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) 


34
 
# File 'lib/spotted/models/users/playlist_create_params.rb', line 34

optional :description, String

#name ⇒ String

The name for the new playlist, for example ‘“Your Coolest Playlist”`. This name does not need to be unique; a user may have several playlists with the same name.

Returns:

  • (String) 


17
 
# File 'lib/spotted/models/users/playlist_create_params.rb', line 17

required :name, String

#public ⇒ Boolean?

Defaults to ‘true`. 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. To be able to create private playlists, the user must have granted the `playlist-modify-private` [scope](/documentation/web-api/concepts/scopes/#list-of-scopes). For more about public/private status, see [Working with Playlists](/documentation/web-api/concepts/playlists)

Returns:

  • (Boolean, nil) 


46
 
# File 'lib/spotted/models/users/playlist_create_params.rb', line 46

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