Class: Yt::Models::UserInfo

Inherits:

Base

• Object
• Base
• Yt::Models::UserInfo

Defined in:

lib/yt/models/user_info.rb

Overview

Provides methods to retrieve an account’s user profile.

See Also:

• https://developers.google.com/+/api/latest/people/getOpenIdConnect

Instance Method Summary

• #avatar_url ⇒ String

  The URL of the user’s profile picture.

• #email ⇒ String

  The user’s email address.

• #family_name ⇒ String

  The user’s family (last) name.

• #gender ⇒ String

  The person’s gender.

• #given_name ⇒ String

  The user’s given (first) name.

• #has_verified_email? ⇒ Boolean

  Whether the email address is verified.

• #hd ⇒ String

  The hosted domain name for the user’s Google Apps account.

• #id ⇒ String

  The user’s ID.

• #initialize(options = {}) ⇒ UserInfo constructor

  A new instance of UserInfo.

• #locale ⇒ String

  The user’s preferred locale.

• #name ⇒ String

  The user’s full name.

• #profile_url ⇒ String

  The URL of the user’s profile page.

Methods included from Associations::HasReports

#has_report

Methods included from Associations::HasViewerPercentages

#has_viewer_percentages

Methods included from Associations::HasOne

#has_one

Methods included from Associations::HasMany

#has_many

Methods included from Associations::HasAuthentication

#has_authentication

Constructor Details

#initialize(options = {}) ⇒ UserInfo

Returns a new instance of UserInfo.

# File 'lib/yt/models/user_info.rb', line 8

def initialize(options = {})
  @data = options[:data]
end

Instance Method Details

#avatar_url ⇒ String

Returns the URL of the user’s profile picture.

Returns:

• (String) —

  the URL of the user’s profile picture.

# File 'lib/yt/models/user_info.rb', line 34

has_attribute :avatar_url, from: :picture, default: ''

#email ⇒ String

Returns the user’s email address.

Returns:

• (String) —

  the user’s email address.

# File 'lib/yt/models/user_info.rb', line 16

has_attribute :email, default: ''

#family_name ⇒ String

Returns the user’s family (last) name.

Returns:

• (String) —

  the user’s family (last) name.

# File 'lib/yt/models/user_info.rb', line 28

has_attribute :family_name, default: '', camelize: false

#gender ⇒ String

Returns the person’s gender. Possible values include, but are not limited to, “male”, “female”, “other”.

Returns:

• (String) —

  the person’s gender. Possible values include, but are not limited to, “male”, “female”, “other”.

# File 'lib/yt/models/user_info.rb', line 38

has_attribute :gender, default: ''

#given_name ⇒ String

Returns the user’s given (first) name.

Returns:

• (String) —

  the user’s given (first) name.

# File 'lib/yt/models/user_info.rb', line 25

has_attribute :given_name, default: '', camelize: false

#has_verified_email? ⇒ Boolean

Returns whether the email address is verified.

Returns:

• (Boolean) —

  whether the email address is verified.

# File 'lib/yt/models/user_info.rb', line 19

has_attribute :has_verified_email?, from: :verified_email, default: false, camelize: false

#hd ⇒ String

Returns the hosted domain name for the user’s Google Apps account. For instance, example.com.

Returns:

• (String) —

  the hosted domain name for the user’s Google Apps account. For instance, example.com.

# File 'lib/yt/models/user_info.rb', line 45

has_attribute :hd, default: ''

#id ⇒ String

Returns the user’s ID.

Returns:

• (String) —

  the user’s ID.

# File 'lib/yt/models/user_info.rb', line 13

has_attribute :id, default: ''

#locale ⇒ String

Returns the user’s preferred locale.

Returns:

• (String) —

  the user’s preferred locale.

# File 'lib/yt/models/user_info.rb', line 41

has_attribute :locale, default: ''

#name ⇒ String

Returns the user’s full name.

Returns:

• (String) —

  the user’s full name.

# File 'lib/yt/models/user_info.rb', line 22

has_attribute :name, default: ''

#profile_url ⇒ String

Returns the URL of the user’s profile page.

Returns:

• (String) —

  the URL of the user’s profile page.

# File 'lib/yt/models/user_info.rb', line 31

has_attribute :profile_url, from: :link, default: ''