Class: Twitch::V2::Users

Inherits:
Object
  • Object
show all
Defined in:
lib/kappa/user.rb

Overview

Query class for finding users.

See Also:

Instance Method Summary collapse

Instance Method Details

#get(user_name) ⇒ User

Get a user by name.

Examples:

Twitch.users.get('totalbiscuit')

Parameters:

  • user_name (String) —

    The name of the user to get. This is the same as the channel or stream name.

Returns:

  • (User) —

    A valid User object if the user exists, nil otherwise.

See Also:



151
152
153
154
155
156
157
 
# File 'lib/kappa/user.rb', line 151

def get(user_name)
  name = CGI.escape(user_name)
  Twitch::Status.map(404 => nil) do
    json = @query.connection.get("users/#{name}")
    User.new(json, @query)
  end
end