Class: YFantasy::Group

Inherits:

BaseResource

• Object
• BaseResource
• YFantasy::Group

Defined in:

lib/y_fantasy/resources/group.rb,
lib/y_fantasy/resources/group/settings.rb,
lib/y_fantasy/resources/group/standings.rb

Overview

Represents a Yahoo Fantasy NFL Survival Group

Defined Under Namespace

Classes: Settings, Standings

Instance Attribute Summary

• #commissioner_nickname ⇒ String^? readonly

  The nickname of the commissioner.

• #current_login_is_member ⇒ Boolean readonly

  Whether the current user is a member of this group.

• #current_week ⇒ Integer readonly

  The current week number of the group.

• #current_week_lock_time ⇒ Integer readonly

  The timestamp when the current week locks.

• #group_id ⇒ String readonly

  The ID for this group.

• #group_key ⇒ String readonly

  The unique key for this group.

• #has_group_started ⇒ Boolean readonly

  Whether the group has started.

• #is_commissioner ⇒ Boolean^? readonly

  Whether the current user is the commissioner.

• #name ⇒ String readonly

  The name of the group.

• #num_teams ⇒ Integer readonly

  The number of teams in the group.

• #settings ⇒ Settings^? readonly

  The settings for this group.

• #standings ⇒ Standings^? readonly

  The standings for this group.

• #teams ⇒ Array<PickemTeam>^? readonly

  The teams in this group.

• #type ⇒ String readonly

  The type of group (e.g. “private”).

• #url ⇒ String readonly

  The URL to the group’s Yahoo Fantasy page.

Method Summary

Methods inherited from BaseResource

collection_name, dependent?, find, find_all, #key, resource_name

Methods included from Subresourceable

included

Instance Attribute Details

#commissioner_nickname ⇒ String^? (readonly)

Returns the nickname of the commissioner.

Returns:

• (String, nil) —

  the nickname of the commissioner

# File 'lib/y_fantasy/resources/group.rb', line 52

option :commissioner_nickname, optional: true

#current_login_is_member ⇒ Boolean (readonly)

Returns whether the current user is a member of this group.

Returns:

• (Boolean) —

  whether the current user is a member of this group

# File 'lib/y_fantasy/resources/group.rb', line 34

option :current_login_is_member, type: Types::Params::Bool

#current_week ⇒ Integer (readonly)

Returns the current week number of the group.

Returns:

• (Integer) —

  the current week number of the group

# File 'lib/y_fantasy/resources/group.rb', line 38

option :current_week, type: Types::Coercible::Integer

#current_week_lock_time ⇒ Integer (readonly)

Returns the timestamp when the current week locks.

Returns:

• (Integer) —

  the timestamp when the current week locks

# File 'lib/y_fantasy/resources/group.rb', line 46

option :current_week_lock_time, type: Types::Coercible::Integer

#group_id ⇒ String (readonly)

Returns the ID for this group.

Returns:

• (String) —

  the ID for this group

# File 'lib/y_fantasy/resources/group.rb', line 14

option :group_id

#group_key ⇒ String (readonly)

Returns the unique key for this group.

Returns:

• (String) —

  the unique key for this group

# File 'lib/y_fantasy/resources/group.rb', line 10

option :group_key

#has_group_started ⇒ Boolean (readonly)

Returns whether the group has started.

Returns:

• (Boolean) —

  whether the group has started

# File 'lib/y_fantasy/resources/group.rb', line 42

option :has_group_started, type: Types::Params::Bool

#is_commissioner ⇒ Boolean^? (readonly)

Returns whether the current user is the commissioner.

Returns:

• (Boolean, nil) —

  whether the current user is the commissioner

# File 'lib/y_fantasy/resources/group.rb', line 56

option :is_commissioner, optional: true, type: Types::Params::Bool

#name ⇒ String (readonly)

Returns the name of the group.

Returns:

• (String) —

  the name of the group

# File 'lib/y_fantasy/resources/group.rb', line 18

option :name

#num_teams ⇒ Integer (readonly)

Returns the number of teams in the group.

Returns:

• (Integer) —

  the number of teams in the group

# File 'lib/y_fantasy/resources/group.rb', line 30

option :num_teams, type: Types::Coercible::Integer

#settings ⇒ Settings^? (readonly)

Returns the settings for this group.

Returns:

• (Settings, nil) —

  the settings for this group

# File 'lib/y_fantasy/resources/group.rb', line 62

option :settings, optional: true, type: instance_of(Settings)

#standings ⇒ Standings^? (readonly)

Returns the standings for this group.

Returns:

• (Standings, nil) —

  the standings for this group

# File 'lib/y_fantasy/resources/group.rb', line 66

option :standings, optional: true, type: instance_of(Standings)

#teams ⇒ Array<PickemTeam>^? (readonly)

Returns the teams in this group.

Returns:

• (Array<PickemTeam>, nil) —

  the teams in this group

# File 'lib/y_fantasy/resources/group.rb', line 70

option :teams, optional: true, type: array_of(PickemTeam)

#type ⇒ String (readonly)

Returns the type of group (e.g. “private”).

Returns:

• (String) —

  the type of group (e.g. “private”)

# File 'lib/y_fantasy/resources/group.rb', line 26

option :type

#url ⇒ String (readonly)

Returns the URL to the group’s Yahoo Fantasy page.

Returns:

• (String) —

  the URL to the group’s Yahoo Fantasy page

# File 'lib/y_fantasy/resources/group.rb', line 22

option :url