Class: TeamBattlesSdk::Generated::Models::ApiGameCatalogEntry

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

Overview

Static public game catalog entry.

Defined Under Namespace

Classes: ApiGameCatalogEntryBannerImage, ApiGameCatalogEntryConvexId, ApiGameCatalogEntryCoverImage, ApiGameCatalogEntryDescriptionKey, ApiGameCatalogEntryRulesLink, ApiGameCatalogEntryShortNameKey

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 api_game_catalog_entry

Raises:

  • (StandardError) 


128
129
130
131
 
# File 'lib/teambattles_sdk/generated/models/api_game_catalog_entry.rb', line 128

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

Instance Method Details

Gets the bannerImage property value. The bannerImage property

Returns:

  • a api_game_catalog_entry_banner_image



67
68
69
 
# File 'lib/teambattles_sdk/generated/models/api_game_catalog_entry.rb', line 67

def banner_image
    return @banner_image
end

Sets the bannerImage property value. The bannerImage property

Parameters:

  • value —

    Value to set for the bannerImage property.

Returns:

  • a void



75
76
77
 
# File 'lib/teambattles_sdk/generated/models/api_game_catalog_entry.rb', line 75

def banner_image=(value)
    @banner_image = value
end

#category ⇒ Object

Gets the category property value. The category property

Returns:

  • a string



82
83
84
 
# File 'lib/teambattles_sdk/generated/models/api_game_catalog_entry.rb', line 82

def category
    return @category
end

#category=(value) ⇒ Object

Sets the category property value. The category property

Parameters:

  • value —

    Value to set for the category property.

Returns:

  • a void



90
91
92
 
# File 'lib/teambattles_sdk/generated/models/api_game_catalog_entry.rb', line 90

def category=(value)
    @category = value
end

#convex_id ⇒ Object

Gets the convexId property value. Active Convex games-table ID, when available for match APIs.

Returns:

  • a api_game_catalog_entry_convex_id



97
98
99
 
# File 'lib/teambattles_sdk/generated/models/api_game_catalog_entry.rb', line 97

def convex_id
    return @convex_id
end

#convex_id=(value) ⇒ Object

Sets the convexId property value. Active Convex games-table ID, when available for match APIs.

Parameters:

  • value —

    Value to set for the convexId property.

Returns:

  • a void



105
106
107
 
# File 'lib/teambattles_sdk/generated/models/api_game_catalog_entry.rb', line 105

def convex_id=(value)
    @convex_id = value
end

#cover_image ⇒ Object

Gets the coverImage property value. The coverImage property

Returns:

  • a api_game_catalog_entry_cover_image



112
113
114
 
# File 'lib/teambattles_sdk/generated/models/api_game_catalog_entry.rb', line 112

def cover_image
    return @cover_image
end

#cover_image=(value) ⇒ Object

Sets the coverImage property value. The coverImage property

Parameters:

  • value —

    Value to set for the coverImage property.

Returns:

  • a void



120
121
122
 
# File 'lib/teambattles_sdk/generated/models/api_game_catalog_entry.rb', line 120

def cover_image=(value)
    @cover_image = value
end

#default_team_size ⇒ Object

Gets the defaultTeamSize property value. The defaultTeamSize property

Returns:

  • a integer



136
137
138
 
# File 'lib/teambattles_sdk/generated/models/api_game_catalog_entry.rb', line 136

def default_team_size
    return @default_team_size
end

#default_team_size=(value) ⇒ Object

Sets the defaultTeamSize property value. The defaultTeamSize property

Parameters:

  • value —

    Value to set for the defaultTeamSize property.

Returns:

  • a void



144
145
146
 
# File 'lib/teambattles_sdk/generated/models/api_game_catalog_entry.rb', line 144

def default_team_size=(value)
    @default_team_size = value
end

#description_key ⇒ Object

Gets the descriptionKey property value. The descriptionKey property

Returns:

  • a api_game_catalog_entry_description_key



151
152
153
 
# File 'lib/teambattles_sdk/generated/models/api_game_catalog_entry.rb', line 151

def description_key
    return @description_key
end

#description_key=(value) ⇒ Object

Sets the descriptionKey property value. The descriptionKey property

Parameters:

  • value —

    Value to set for the descriptionKey property.

Returns:

  • a void



159
160
161
 
# File 'lib/teambattles_sdk/generated/models/api_game_catalog_entry.rb', line 159

def description_key=(value)
    @description_key = value
end

#get_field_deserializers ⇒ Object

The deserialization information for the current model

Returns:

  • a i_dictionary



166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
 
# File 'lib/teambattles_sdk/generated/models/api_game_catalog_entry.rb', line 166

def get_field_deserializers()
    return {
        "bannerImage" => lambda {|n| @banner_image = n.get_object_value(lambda {|pn| ApiGameCatalogEntry::ApiGameCatalogEntryBannerImage.create_from_discriminator_value(pn) }) },
        "category" => lambda {|n| @category = n.get_string_value() },
        "convexId" => lambda {|n| @convex_id = n.get_object_value(lambda {|pn| ApiGameCatalogEntry::ApiGameCatalogEntryConvexId.create_from_discriminator_value(pn) }) },
        "coverImage" => lambda {|n| @cover_image = n.get_object_value(lambda {|pn| ApiGameCatalogEntry::ApiGameCatalogEntryCoverImage.create_from_discriminator_value(pn) }) },
        "defaultTeamSize" => lambda {|n| @default_team_size = n.get_number_value() },
        "descriptionKey" => lambda {|n| @description_key = n.get_object_value(lambda {|pn| ApiGameCatalogEntry::ApiGameCatalogEntryDescriptionKey.create_from_discriminator_value(pn) }) },
        "hasCompetitiveMode" => lambda {|n| @has_competitive_mode = n.get_boolean_value() },
        "id" => lambda {|n| @id = n.get_string_value() },
        "isAvailableForMatchApi" => lambda {|n| @is_available_for_match_api = n.get_boolean_value() },
        "isComingSoon" => lambda {|n| @is_coming_soon = n.get_boolean_value() },
        "maps" => lambda {|n| @maps = n.get_collection_of_object_values(lambda {|pn| TeamBattlesSdk::Generated::Models::ApiGameMap.create_from_discriminator_value(pn) }) },
        "modeMapPools" => lambda {|n| @mode_map_pools = n.get_collection_of_object_values(lambda {|pn| TeamBattlesSdk::Generated::Models::ApiGameModeMapPool.create_from_discriminator_value(pn) }) },
        "modes" => lambda {|n| @modes = n.get_collection_of_object_values(lambda {|pn| TeamBattlesSdk::Generated::Models::ApiGameMode.create_from_discriminator_value(pn) }) },
        "nameKey" => lambda {|n| @name_key = n.get_string_value() },
        "playlists" => lambda {|n| @playlists = n.get_collection_of_object_values(lambda {|pn| TeamBattlesSdk::Generated::Models::ApiGamePlaylist.create_from_discriminator_value(pn) }) },
        "rulesLink" => lambda {|n| @rules_link = n.get_object_value(lambda {|pn| ApiGameCatalogEntry::ApiGameCatalogEntryRulesLink.create_from_discriminator_value(pn) }) },
        "shortNameKey" => lambda {|n| @short_name_key = n.get_object_value(lambda {|pn| ApiGameCatalogEntry::ApiGameCatalogEntryShortNameKey.create_from_discriminator_value(pn) }) },
    }
end

#has_competitive_mode ⇒ Object

Gets the hasCompetitiveMode property value. The hasCompetitiveMode property

Returns:

  • a boolean



191
192
193
 
# File 'lib/teambattles_sdk/generated/models/api_game_catalog_entry.rb', line 191

def has_competitive_mode
    return @has_competitive_mode
end

#has_competitive_mode=(value) ⇒ Object

Sets the hasCompetitiveMode property value. The hasCompetitiveMode property

Parameters:

  • value —

    Value to set for the hasCompetitiveMode property.

Returns:

  • a void



199
200
201
 
# File 'lib/teambattles_sdk/generated/models/api_game_catalog_entry.rb', line 199

def has_competitive_mode=(value)
    @has_competitive_mode = value
end

#id ⇒ Object

Gets the id property value. Static public game ID/slug.

Returns:

  • a string



206
207
208
 
# File 'lib/teambattles_sdk/generated/models/api_game_catalog_entry.rb', line 206

def id
    return @id
end

#id=(value) ⇒ Object

Sets the id property value. Static public game ID/slug.

Parameters:

  • value —

    Value to set for the id property.

Returns:

  • a void



214
215
216
 
# File 'lib/teambattles_sdk/generated/models/api_game_catalog_entry.rb', line 214

def id=(value)
    @id = value
end

#is_available_for_match_api ⇒ Object

Gets the isAvailableForMatchApi property value. The isAvailableForMatchApi property

Returns:

  • a boolean



221
222
223
 
# File 'lib/teambattles_sdk/generated/models/api_game_catalog_entry.rb', line 221

def is_available_for_match_api
    return @is_available_for_match_api
end

#is_available_for_match_api=(value) ⇒ Object

Sets the isAvailableForMatchApi property value. The isAvailableForMatchApi property

Parameters:

  • value —

    Value to set for the isAvailableForMatchApi property.

Returns:

  • a void



229
230
231
 
# File 'lib/teambattles_sdk/generated/models/api_game_catalog_entry.rb', line 229

def is_available_for_match_api=(value)
    @is_available_for_match_api = value
end

#is_coming_soon ⇒ Object

Gets the isComingSoon property value. The isComingSoon property

Returns:

  • a boolean



236
237
238
 
# File 'lib/teambattles_sdk/generated/models/api_game_catalog_entry.rb', line 236

def is_coming_soon
    return @is_coming_soon
end

#is_coming_soon=(value) ⇒ Object

Sets the isComingSoon property value. The isComingSoon property

Parameters:

  • value —

    Value to set for the isComingSoon property.

Returns:

  • a void



244
245
246
 
# File 'lib/teambattles_sdk/generated/models/api_game_catalog_entry.rb', line 244

def is_coming_soon=(value)
    @is_coming_soon = value
end

#maps ⇒ Object

Gets the maps property value. The maps property

Returns:

  • a api_game_map



251
252
253
 
# File 'lib/teambattles_sdk/generated/models/api_game_catalog_entry.rb', line 251

def maps
    return @maps
end

#maps=(value) ⇒ Object

Sets the maps property value. The maps property

Parameters:

  • value —

    Value to set for the maps property.

Returns:

  • a void



259
260
261
 
# File 'lib/teambattles_sdk/generated/models/api_game_catalog_entry.rb', line 259

def maps=(value)
    @maps = value
end

#mode_map_pools ⇒ Object

Gets the modeMapPools property value. The modeMapPools property

Returns:

  • a api_game_mode_map_pool



266
267
268
 
# File 'lib/teambattles_sdk/generated/models/api_game_catalog_entry.rb', line 266

def mode_map_pools
    return @mode_map_pools
end

#mode_map_pools=(value) ⇒ Object

Sets the modeMapPools property value. The modeMapPools property

Parameters:

  • value —

    Value to set for the modeMapPools property.

Returns:

  • a void



274
275
276
 
# File 'lib/teambattles_sdk/generated/models/api_game_catalog_entry.rb', line 274

def mode_map_pools=(value)
    @mode_map_pools = value
end

#modes ⇒ Object

Gets the modes property value. The modes property

Returns:

  • a api_game_mode



281
282
283
 
# File 'lib/teambattles_sdk/generated/models/api_game_catalog_entry.rb', line 281

def modes
    return @modes
end

#modes=(value) ⇒ Object

Sets the modes property value. The modes property

Parameters:

  • value —

    Value to set for the modes property.

Returns:

  • a void



289
290
291
 
# File 'lib/teambattles_sdk/generated/models/api_game_catalog_entry.rb', line 289

def modes=(value)
    @modes = value
end

#name_key ⇒ Object

Gets the nameKey property value. The nameKey property

Returns:

  • a string



296
297
298
 
# File 'lib/teambattles_sdk/generated/models/api_game_catalog_entry.rb', line 296

def name_key
    return @name_key
end

#name_key=(value) ⇒ Object

Sets the nameKey property value. The nameKey property

Parameters:

  • value —

    Value to set for the nameKey property.

Returns:

  • a void



304
305
306
 
# File 'lib/teambattles_sdk/generated/models/api_game_catalog_entry.rb', line 304

def name_key=(value)
    @name_key = value
end

#playlists ⇒ Object

Gets the playlists property value. The playlists property

Returns:

  • a api_game_playlist



311
312
313
 
# File 'lib/teambattles_sdk/generated/models/api_game_catalog_entry.rb', line 311

def playlists
    return @playlists
end

#playlists=(value) ⇒ Object

Sets the playlists property value. The playlists property

Parameters:

  • value —

    Value to set for the playlists property.

Returns:

  • a void



319
320
321
 
# File 'lib/teambattles_sdk/generated/models/api_game_catalog_entry.rb', line 319

def playlists=(value)
    @playlists = value
end

#rules_link ⇒ Object

Gets the rulesLink property value. The rulesLink property

Returns:

  • a api_game_catalog_entry_rules_link



326
327
328
 
# File 'lib/teambattles_sdk/generated/models/api_game_catalog_entry.rb', line 326

def rules_link
    return @rules_link
end

#rules_link=(value) ⇒ Object

Sets the rulesLink property value. The rulesLink property

Parameters:

  • value —

    Value to set for the rulesLink property.

Returns:

  • a void



334
335
336
 
# File 'lib/teambattles_sdk/generated/models/api_game_catalog_entry.rb', line 334

def rules_link=(value)
    @rules_link = 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) 


342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
 
# File 'lib/teambattles_sdk/generated/models/api_game_catalog_entry.rb', line 342

def serialize(writer)
    raise StandardError, 'writer cannot be null' if writer.nil?
    writer.write_object_value("bannerImage", @banner_image)
    writer.write_string_value("category", @category)
    writer.write_object_value("convexId", @convex_id)
    writer.write_object_value("coverImage", @cover_image)
    writer.write_number_value("defaultTeamSize", @default_team_size)
    writer.write_object_value("descriptionKey", @description_key)
    writer.write_boolean_value("hasCompetitiveMode", @has_competitive_mode)
    writer.write_string_value("id", @id)
    writer.write_boolean_value("isAvailableForMatchApi", @is_available_for_match_api)
    writer.write_boolean_value("isComingSoon", @is_coming_soon)
    writer.write_collection_of_object_values("maps", @maps)
    writer.write_collection_of_object_values("modeMapPools", @mode_map_pools)
    writer.write_collection_of_object_values("modes", @modes)
    writer.write_string_value("nameKey", @name_key)
    writer.write_collection_of_object_values("playlists", @playlists)
    writer.write_object_value("rulesLink", @rules_link)
    writer.write_object_value("shortNameKey", @short_name_key)
end

#short_name_key ⇒ Object

Gets the shortNameKey property value. The shortNameKey property

Returns:

  • a api_game_catalog_entry_short_name_key



366
367
368
 
# File 'lib/teambattles_sdk/generated/models/api_game_catalog_entry.rb', line 366

def short_name_key
    return @short_name_key
end

#short_name_key=(value) ⇒ Object

Sets the shortNameKey property value. The shortNameKey property

Parameters:

  • value —

    Value to set for the shortNameKey property.

Returns:

  • a void



374
375
376
 
# File 'lib/teambattles_sdk/generated/models/api_game_catalog_entry.rb', line 374

def short_name_key=(value)
    @short_name_key = value
end