Class: Spotted::Resources::Me

Inherits:
Object
  • Object
show all
Defined in:
lib/spotted/resources/me.rb,
lib/spotted/resources/me/top.rb,
lib/spotted/resources/me/shows.rb,
lib/spotted/resources/me/albums.rb,
lib/spotted/resources/me/player.rb,
lib/spotted/resources/me/tracks.rb,
lib/spotted/resources/me/episodes.rb,
lib/spotted/resources/me/following.rb,
lib/spotted/resources/me/playlists.rb,
lib/spotted/resources/me/audiobooks.rb,
lib/spotted/resources/me/player/queue.rb

Defined Under Namespace

Classes: Albums, Audiobooks, Episodes, Following, Player, Playlists, Shows, Top, Tracks

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ Me

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of Me.

Parameters:



55
56
57
58
59
60
61
62
63
64
65
66
 
# File 'lib/spotted/resources/me.rb', line 55

def initialize(client:)
  @client = client
  @audiobooks = Spotted::Resources::Me::Audiobooks.new(client: client)
  @playlists = Spotted::Resources::Me::Playlists.new(client: client)
  @top = Spotted::Resources::Me::Top.new(client: client)
  @albums = Spotted::Resources::Me::Albums.new(client: client)
  @tracks = Spotted::Resources::Me::Tracks.new(client: client)
  @episodes = Spotted::Resources::Me::Episodes.new(client: client)
  @shows = Spotted::Resources::Me::Shows.new(client: client)
  @following = Spotted::Resources::Me::Following.new(client: client)
  @player = Spotted::Resources::Me::Player.new(client: client)
end

Instance Attribute Details

#albums ⇒ Spotted::Resources::Me::Albums (readonly)

Returns:



16
17
18
 
# File 'lib/spotted/resources/me.rb', line 16

def albums
  @albums
end

#audiobooks ⇒ Spotted::Resources::Me::Audiobooks (readonly)

Returns:



7
8
9
 
# File 'lib/spotted/resources/me.rb', line 7

def audiobooks
  @audiobooks
end

#episodes ⇒ Spotted::Resources::Me::Episodes (readonly)

Returns:



22
23
24
 
# File 'lib/spotted/resources/me.rb', line 22

def episodes
  @episodes
end

#following ⇒ Spotted::Resources::Me::Following (readonly)

Returns:



28
29
30
 
# File 'lib/spotted/resources/me.rb', line 28

def following
  @following
end

#player ⇒ Spotted::Resources::Me::Player (readonly)

Returns:



31
32
33
 
# File 'lib/spotted/resources/me.rb', line 31

def player
  @player
end

#playlists ⇒ Spotted::Resources::Me::Playlists (readonly)

Returns:



10
11
12
 
# File 'lib/spotted/resources/me.rb', line 10

def playlists
  @playlists
end

#shows ⇒ Spotted::Resources::Me::Shows (readonly)

Returns:



25
26
27
 
# File 'lib/spotted/resources/me.rb', line 25

def shows
  @shows
end

#top ⇒ Spotted::Resources::Me::Top (readonly)

Returns:



13
14
15
 
# File 'lib/spotted/resources/me.rb', line 13

def top
  @top
end

#tracks ⇒ Spotted::Resources::Me::Tracks (readonly)

Returns:



19
20
21
 
# File 'lib/spotted/resources/me.rb', line 19

def tracks
  @tracks
end

Instance Method Details

#retrieve(request_options: {}) ⇒ Spotted::Models::MeRetrieveResponse

Get detailed profile information about the current user (including the current user’s username).

Parameters:

Returns:

See Also:



43
44
45
46
47
48
49
50
 
# File 'lib/spotted/resources/me.rb', line 43

def retrieve(params = {})
  @client.request(
    method: :get,
    path: "me",
    model: Spotted::Models::MeRetrieveResponse,
    options: params[:request_options]
  )
end