Class: Spotted::Models::PagingPlaylistObject

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/spotted/models/paging_playlist_object.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

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(href:, limit:, next_:, offset:, previous:, total:, items: nil, published: nil) ⇒ Object

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

Parameters:

  • href (String) —

    A link to the Web API endpoint returning the full result of the request

  • limit (Integer) —

    The maximum number of items in the response (as set in the query or by default).

  • next_ (String, nil) —

    URL to the next page of items. ( ‘null` if none)

  • offset (Integer) —

    The offset of the items returned (as set in the query or by default)

  • previous (String, nil) —

    URL to the previous page of items. ( ‘null` if none)

  • total (Integer) —

    The total number of items available to return.

  • items (Array<Spotted::Models::SimplifiedPlaylistObject>) (defaults to: nil)
  • published (Boolean) (defaults to: nil) —

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




# File 'lib/spotted/models/paging_playlist_object.rb', line 57

Instance Attribute Details

#href ⇒ String

A link to the Web API endpoint returning the full result of the request

Returns:

  • (String) 


10
 
# File 'lib/spotted/models/paging_playlist_object.rb', line 10

required :href, String

#items ⇒ Array<Spotted::Models::SimplifiedPlaylistObject>?

Returns:



45
 
# File 'lib/spotted/models/paging_playlist_object.rb', line 45

optional :items, -> { Spotted::Internal::Type::ArrayOf[Spotted::SimplifiedPlaylistObject] }

#limit ⇒ Integer

The maximum number of items in the response (as set in the query or by default).

Returns:

  • (Integer) 


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

required :limit, Integer

#next_ ⇒ String?

URL to the next page of items. ( ‘null` if none)

Returns:

  • (String, nil) 


22
 
# File 'lib/spotted/models/paging_playlist_object.rb', line 22

required :next_, String, api_name: :next, nil?: true

#offset ⇒ Integer

The offset of the items returned (as set in the query or by default)

Returns:

  • (Integer) 


28
 
# File 'lib/spotted/models/paging_playlist_object.rb', line 28

required :offset, Integer

#previous ⇒ String?

URL to the previous page of items. ( ‘null` if none)

Returns:

  • (String, nil) 


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

required :previous, String, nil?: true

#published ⇒ 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) 


55
 
# File 'lib/spotted/models/paging_playlist_object.rb', line 55

optional :published, Spotted::Internal::Type::Boolean

#total ⇒ Integer

The total number of items available to return.

Returns:

  • (Integer) 


40
 
# File 'lib/spotted/models/paging_playlist_object.rb', line 40

required :total, Integer