Class: SpotifyWebApi::CursorObject

Inherits:
BaseModel
  • Object
show all
Defined in:
lib/spotify_web_api/models/cursor_object.rb

Overview

CursorObject Model.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseModel

#to_hash, #to_json

Constructor Details

#initialize(after = SKIP, before = SKIP) ⇒ CursorObject

Returns a new instance of CursorObject.



41
42
43
44
 
# File 'lib/spotify_web_api/models/cursor_object.rb', line 41

def initialize(after = SKIP, before = SKIP)
  @after = after unless after == SKIP
  @before = before unless before == SKIP
end

Instance Attribute Details

#after ⇒ String

The cursor to use as key to find the next page of items.

Returns:

  • (String) 


14
15
16
 
# File 'lib/spotify_web_api/models/cursor_object.rb', line 14

def after
  @after
end

#before ⇒ String

The cursor to use as key to find the previous page of items.

Returns:

  • (String) 


18
19
20
 
# File 'lib/spotify_web_api/models/cursor_object.rb', line 18

def before
  @before
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



47
48
49
50
51
52
53
54
55
56
57
 
# File 'lib/spotify_web_api/models/cursor_object.rb', line 47

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  after = hash.key?('after') ? hash['after'] : SKIP
  before = hash.key?('before') ? hash['before'] : SKIP

  # Create object from extracted values.
  CursorObject.new(after,
                   before)
end

.names ⇒ Object

A mapping from model property names to API property names.



21
22
23
24
25
26
 
# File 'lib/spotify_web_api/models/cursor_object.rb', line 21

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['after'] = 'after'
  @_hash['before'] = 'before'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



37
38
39
 
# File 'lib/spotify_web_api/models/cursor_object.rb', line 37

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



29
30
31
32
33
34
 
# File 'lib/spotify_web_api/models/cursor_object.rb', line 29

def self.optionals
  %w[
    after
    before
  ]
end