Class: TeamBattlesSdk::Generated::Models::LeagueSummary

Inherits:
Object
  • Object
show all
Includes:
MicrosoftKiotaAbstractions::Parsable
Defined in:
lib/teambattles_sdk/generated/models/league_summary.rb

Overview

Summary view of a league for discovery results.

Defined Under Namespace

Classes: LeagueSummaryAvatarUrl, LeagueSummaryBannerUrl

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.create_from_discriminator_value(parse_node) ⇒ Object

Creates a new instance of the appropriate class based on discriminator value

Parameters:

  • parse_node

    The parse node to use to read the discriminator value and create the object

Returns:

  • a league_summary

Raises:

  • (StandardError)


101
102
103
104
# File 'lib/teambattles_sdk/generated/models/league_summary.rb', line 101

def self.create_from_discriminator_value(parse_node)
    raise StandardError, 'parse_node cannot be null' if parse_node.nil?
    return LeagueSummary.new
end

Instance Method Details

#avatar_urlObject

Gets the avatarUrl property value. League avatar image URL.

Returns:

  • a league_summary_avatar_url



55
56
57
# File 'lib/teambattles_sdk/generated/models/league_summary.rb', line 55

def avatar_url
    return @avatar_url
end

#avatar_url=(value) ⇒ Object

Sets the avatarUrl property value. League avatar image URL.

Parameters:

  • value

    Value to set for the avatarUrl property.

Returns:

  • a void



63
64
65
# File 'lib/teambattles_sdk/generated/models/league_summary.rb', line 63

def avatar_url=(value)
    @avatar_url = value
end

Gets the bannerUrl property value. League banner image URL.

Returns:

  • a league_summary_banner_url



70
71
72
# File 'lib/teambattles_sdk/generated/models/league_summary.rb', line 70

def banner_url
    return @banner_url
end

Sets the bannerUrl property value. League banner image URL.

Parameters:

  • value

    Value to set for the bannerUrl property.

Returns:

  • a void



78
79
80
# File 'lib/teambattles_sdk/generated/models/league_summary.rb', line 78

def banner_url=(value)
    @banner_url = value
end

#created_atObject

Gets the createdAt property value. Creation timestamp (epoch milliseconds).

Returns:

  • a double



85
86
87
# File 'lib/teambattles_sdk/generated/models/league_summary.rb', line 85

def created_at
    return @created_at
end

#created_at=(value) ⇒ Object

Sets the createdAt property value. Creation timestamp (epoch milliseconds).

Parameters:

  • value

    Value to set for the createdAt property.

Returns:

  • a void



93
94
95
# File 'lib/teambattles_sdk/generated/models/league_summary.rb', line 93

def created_at=(value)
    @created_at = value
end

#descriptionObject

Gets the description property value. League description.

Returns:

  • a string



109
110
111
# File 'lib/teambattles_sdk/generated/models/league_summary.rb', line 109

def description
    return @description
end

#description=(value) ⇒ Object

Sets the description property value. League description.

Parameters:

  • value

    Value to set for the description property.

Returns:

  • a void



117
118
119
# File 'lib/teambattles_sdk/generated/models/league_summary.rb', line 117

def description=(value)
    @description = value
end

#gamesObject

Gets the games property value. Games associated with the league.

Returns:

  • a league_summary_games



124
125
126
# File 'lib/teambattles_sdk/generated/models/league_summary.rb', line 124

def games
    return @games
end

#games=(value) ⇒ Object

Sets the games property value. Games associated with the league.

Parameters:

  • value

    Value to set for the games property.

Returns:

  • a void



132
133
134
# File 'lib/teambattles_sdk/generated/models/league_summary.rb', line 132

def games=(value)
    @games = value
end

#get_field_deserializersObject

The deserialization information for the current model

Returns:

  • a i_dictionary



139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
# File 'lib/teambattles_sdk/generated/models/league_summary.rb', line 139

def get_field_deserializers()
    return {
        "avatarUrl" => lambda {|n| @avatar_url = n.get_object_value(lambda {|pn| LeagueSummary::LeagueSummaryAvatarUrl.create_from_discriminator_value(pn) }) },
        "bannerUrl" => lambda {|n| @banner_url = n.get_object_value(lambda {|pn| LeagueSummary::LeagueSummaryBannerUrl.create_from_discriminator_value(pn) }) },
        "createdAt" => lambda {|n| @created_at = n.get_object_value(lambda {|pn| Double.create_from_discriminator_value(pn) }) },
        "description" => lambda {|n| @description = n.get_string_value() },
        "games" => lambda {|n| @games = n.get_collection_of_object_values(lambda {|pn| TeamBattlesSdk::Generated::Models::LeagueSummaryGames.create_from_discriminator_value(pn) }) },
        "id" => lambda {|n| @id = n.get_string_value() },
        "isFeatured" => lambda {|n| @is_featured = n.get_boolean_value() },
        "isVerified" => lambda {|n| @is_verified = n.get_boolean_value() },
        "name" => lambda {|n| @name = n.get_string_value() },
        "seasonStatus" => lambda {|n| @season_status = n.get_enum_value(TeamBattlesSdk::Generated::Models::LeagueSummarySeasonStatus) },
        "slug" => lambda {|n| @slug = n.get_string_value() },
        "status" => lambda {|n| @status = n.get_string_value() },
        "teamCount" => lambda {|n| @team_count = n.get_number_value() },
    }
end

#idObject

Gets the id property value. League ID.

Returns:

  • a string



160
161
162
# File 'lib/teambattles_sdk/generated/models/league_summary.rb', line 160

def id
    return @id
end

#id=(value) ⇒ Object

Sets the id property value. League ID.

Parameters:

  • value

    Value to set for the id property.

Returns:

  • a void



168
169
170
# File 'lib/teambattles_sdk/generated/models/league_summary.rb', line 168

def id=(value)
    @id = value
end

Gets the isFeatured property value. Whether the league is featured.

Returns:

  • a boolean



175
176
177
# File 'lib/teambattles_sdk/generated/models/league_summary.rb', line 175

def is_featured
    return @is_featured
end

#is_featured=(value) ⇒ Object

Sets the isFeatured property value. Whether the league is featured.

Parameters:

  • value

    Value to set for the isFeatured property.

Returns:

  • a void



183
184
185
# File 'lib/teambattles_sdk/generated/models/league_summary.rb', line 183

def is_featured=(value)
    @is_featured = value
end

#is_verifiedObject

Gets the isVerified property value. Whether the league is verified.

Returns:

  • a boolean



190
191
192
# File 'lib/teambattles_sdk/generated/models/league_summary.rb', line 190

def is_verified
    return @is_verified
end

#is_verified=(value) ⇒ Object

Sets the isVerified property value. Whether the league is verified.

Parameters:

  • value

    Value to set for the isVerified property.

Returns:

  • a void



198
199
200
# File 'lib/teambattles_sdk/generated/models/league_summary.rb', line 198

def is_verified=(value)
    @is_verified = value
end

#nameObject

Gets the name property value. League display name.

Returns:

  • a string



205
206
207
# File 'lib/teambattles_sdk/generated/models/league_summary.rb', line 205

def name
    return @name
end

#name=(value) ⇒ Object

Sets the name property value. League display name.

Parameters:

  • value

    Value to set for the name property.

Returns:

  • a void



213
214
215
# File 'lib/teambattles_sdk/generated/models/league_summary.rb', line 213

def name=(value)
    @name = value
end

#season_statusObject

Gets the seasonStatus property value. Aggregate season state across the league’s games.

Returns:

  • a league_summary_season_status



220
221
222
# File 'lib/teambattles_sdk/generated/models/league_summary.rb', line 220

def season_status
    return @season_status
end

#season_status=(value) ⇒ Object

Sets the seasonStatus property value. Aggregate season state across the league’s games.

Parameters:

  • value

    Value to set for the seasonStatus property.

Returns:

  • a void



228
229
230
# File 'lib/teambattles_sdk/generated/models/league_summary.rb', line 228

def season_status=(value)
    @season_status = value
end

#serialize(writer) ⇒ Object

Serializes information the current object

Parameters:

  • writer

    Serialization writer to use to serialize this model

Returns:

  • a void

Raises:

  • (StandardError)


236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
# File 'lib/teambattles_sdk/generated/models/league_summary.rb', line 236

def serialize(writer)
    raise StandardError, 'writer cannot be null' if writer.nil?
    writer.write_object_value("avatarUrl", @avatar_url)
    writer.write_object_value("bannerUrl", @banner_url)
    writer.write_object_value("createdAt", @created_at)
    writer.write_string_value("description", @description)
    writer.write_collection_of_object_values("games", @games)
    writer.write_string_value("id", @id)
    writer.write_boolean_value("isFeatured", @is_featured)
    writer.write_boolean_value("isVerified", @is_verified)
    writer.write_string_value("name", @name)
    writer.write_enum_value("seasonStatus", @season_status)
    writer.write_string_value("slug", @slug)
    writer.write_string_value("status", @status)
    writer.write_number_value("teamCount", @team_count)
end

#slugObject

Gets the slug property value. URL-friendly league identifier.

Returns:

  • a string



256
257
258
# File 'lib/teambattles_sdk/generated/models/league_summary.rb', line 256

def slug
    return @slug
end

#slug=(value) ⇒ Object

Sets the slug property value. URL-friendly league identifier.

Parameters:

  • value

    Value to set for the slug property.

Returns:

  • a void



264
265
266
# File 'lib/teambattles_sdk/generated/models/league_summary.rb', line 264

def slug=(value)
    @slug = value
end

#statusObject

Gets the status property value. League status.

Returns:

  • a string



271
272
273
# File 'lib/teambattles_sdk/generated/models/league_summary.rb', line 271

def status
    return @status
end

#status=(value) ⇒ Object

Sets the status property value. League status.

Parameters:

  • value

    Value to set for the status property.

Returns:

  • a void



279
280
281
# File 'lib/teambattles_sdk/generated/models/league_summary.rb', line 279

def status=(value)
    @status = value
end

#team_countObject

Gets the teamCount property value. Number of teams in the league.

Returns:

  • a integer



286
287
288
# File 'lib/teambattles_sdk/generated/models/league_summary.rb', line 286

def team_count
    return @team_count
end

#team_count=(value) ⇒ Object

Sets the teamCount property value. Number of teams in the league.

Parameters:

  • value

    Value to set for the teamCount property.

Returns:

  • a void



294
295
296
# File 'lib/teambattles_sdk/generated/models/league_summary.rb', line 294

def team_count=(value)
    @team_count = value
end