Class: TeamBattlesSdk::Generated::Models::ApiStrategy

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

Overview

API-safe shareable strategy.

Defined Under Namespace

Classes: ApiStrategyCreatedAt, ApiStrategyDescription, ApiStrategyPreviewUrl, ApiStrategyUpdatedAt

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_strategy

Raises:

  • (StandardError) 


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

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

Instance Method Details

#created_at ⇒ Object

Gets the createdAt property value. The createdAt property

Returns:

  • a api_strategy_created_at



61
62
63
 
# File 'lib/teambattles_sdk/generated/models/api_strategy.rb', line 61

def created_at
    return @created_at
end

#created_at=(value) ⇒ Object

Sets the createdAt property value. The createdAt property

Parameters:

  • value —

    Value to set for the createdAt property.

Returns:

  • a void



69
70
71
 
# File 'lib/teambattles_sdk/generated/models/api_strategy.rb', line 69

def created_at=(value)
    @created_at = value
end

#description ⇒ Object

Gets the description property value. Author description, when set.

Returns:

  • a api_strategy_description



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

def description
    return @description
end

#description=(value) ⇒ Object

Sets the description property value. Author description, when set.

Parameters:

  • value —

    Value to set for the description property.

Returns:

  • a void



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

def description=(value)
    @description = value
end

#game ⇒ Object

Gets the game property value. Game slug the strategy targets.

Returns:

  • a string



100
101
102
 
# File 'lib/teambattles_sdk/generated/models/api_strategy.rb', line 100

def game
    return @game
end

#game=(value) ⇒ Object

Sets the game property value. Game slug the strategy targets.

Parameters:

  • value —

    Value to set for the game property.

Returns:

  • a void



108
109
110
 
# File 'lib/teambattles_sdk/generated/models/api_strategy.rb', line 108

def game=(value)
    @game = value
end

#get_field_deserializers ⇒ Object

The deserialization information for the current model

Returns:

  • a i_dictionary



115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
 
# File 'lib/teambattles_sdk/generated/models/api_strategy.rb', line 115

def get_field_deserializers()
    return {
        "createdAt" => lambda {|n| @created_at = n.get_object_value(lambda {|pn| ApiStrategy::ApiStrategyCreatedAt.create_from_discriminator_value(pn) }) },
        "description" => lambda {|n| @description = n.get_object_value(lambda {|pn| ApiStrategy::ApiStrategyDescription.create_from_discriminator_value(pn) }) },
        "game" => lambda {|n| @game = n.get_string_value() },
        "id" => lambda {|n| @id = n.get_string_value() },
        "mapId" => lambda {|n| @map_id = n.get_string_value() },
        "mapRotation" => lambda {|n| @map_rotation = n.get_object_value(lambda {|pn| Double.create_from_discriminator_value(pn) }) },
        "name" => lambda {|n| @name = n.get_string_value() },
        "ownerId" => lambda {|n| @owner_id = n.get_string_value() },
        "playbackLoop" => lambda {|n| @playback_loop = n.get_boolean_value() },
        "previewUrl" => lambda {|n| @preview_url = n.get_object_value(lambda {|pn| ApiStrategy::ApiStrategyPreviewUrl.create_from_discriminator_value(pn) }) },
        "shareSlug" => lambda {|n| @share_slug = n.get_string_value() },
        "stageCount" => lambda {|n| @stage_count = n.get_number_value() },
        "stages" => lambda {|n| @stages = n.get_collection_of_object_values(lambda {|pn| TeamBattlesSdk::Generated::Models::ApiStrategyStage.create_from_discriminator_value(pn) }) },
        "updatedAt" => lambda {|n| @updated_at = n.get_object_value(lambda {|pn| ApiStrategy::ApiStrategyUpdatedAt.create_from_discriminator_value(pn) }) },
        "visibility" => lambda {|n| @visibility = n.get_enum_value(TeamBattlesSdk::Generated::Models::StrategyVisibility) },
    }
end

#id ⇒ Object

Gets the id property value. Strategy ID.

Returns:

  • a string



138
139
140
 
# File 'lib/teambattles_sdk/generated/models/api_strategy.rb', line 138

def id
    return @id
end

#id=(value) ⇒ Object

Sets the id property value. Strategy ID.

Parameters:

  • value —

    Value to set for the id property.

Returns:

  • a void



146
147
148
 
# File 'lib/teambattles_sdk/generated/models/api_strategy.rb', line 146

def id=(value)
    @id = value
end

#map_id ⇒ Object

Gets the mapId property value. Built-in map slug, or the sentinel “__custom” for a custom map.

Returns:

  • a string



153
154
155
 
# File 'lib/teambattles_sdk/generated/models/api_strategy.rb', line 153

def map_id
    return @map_id
end

#map_id=(value) ⇒ Object

Sets the mapId property value. Built-in map slug, or the sentinel “__custom” for a custom map.

Parameters:

  • value —

    Value to set for the mapId property.

Returns:

  • a void



161
162
163
 
# File 'lib/teambattles_sdk/generated/models/api_strategy.rb', line 161

def map_id=(value)
    @map_id = value
end

#map_rotation ⇒ Object

Gets the mapRotation property value. Map render orientation in degrees (0, 90, 180, or 270).

Returns:

  • a double



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

def map_rotation
    return @map_rotation
end

#map_rotation=(value) ⇒ Object

Sets the mapRotation property value. Map render orientation in degrees (0, 90, 180, or 270).

Parameters:

  • value —

    Value to set for the mapRotation property.

Returns:

  • a void



176
177
178
 
# File 'lib/teambattles_sdk/generated/models/api_strategy.rb', line 176

def map_rotation=(value)
    @map_rotation = value
end

#name ⇒ Object

Gets the name property value. Strategy name.

Returns:

  • a string



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

def name
    return @name
end

#name=(value) ⇒ Object

Sets the name property value. Strategy name.

Parameters:

  • value —

    Value to set for the name property.

Returns:

  • a void



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

def name=(value)
    @name = value
end

#owner_id ⇒ Object

Gets the ownerId property value. Owning user ID.

Returns:

  • a string



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

def owner_id
    return @owner_id
end

#owner_id=(value) ⇒ Object

Sets the ownerId property value. Owning user ID.

Parameters:

  • value —

    Value to set for the ownerId property.

Returns:

  • a void



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

def owner_id=(value)
    @owner_id = value
end

#playback_loop ⇒ Object

Gets the playbackLoop property value. Whether frame playback wraps from the last stage to the first.

Returns:

  • a boolean



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

def playback_loop
    return @playback_loop
end

#playback_loop=(value) ⇒ Object

Sets the playbackLoop property value. Whether frame playback wraps from the last stage to the first.

Parameters:

  • value —

    Value to set for the playbackLoop property.

Returns:

  • a void



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

def playback_loop=(value)
    @playback_loop = value
end

#preview_url ⇒ Object

Gets the previewUrl property value. Freshly signed preview image URL, when a preview has been rendered.

Returns:

  • a api_strategy_preview_url



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

def preview_url
    return @preview_url
end

#preview_url=(value) ⇒ Object

Sets the previewUrl property value. Freshly signed preview image URL, when a preview has been rendered.

Parameters:

  • value —

    Value to set for the previewUrl property.

Returns:

  • a void



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

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


244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
 
# File 'lib/teambattles_sdk/generated/models/api_strategy.rb', line 244

def serialize(writer)
    raise StandardError, 'writer cannot be null' if writer.nil?
    writer.write_object_value("createdAt", @created_at)
    writer.write_object_value("description", @description)
    writer.write_string_value("game", @game)
    writer.write_string_value("id", @id)
    writer.write_string_value("mapId", @map_id)
    writer.write_object_value("mapRotation", @map_rotation)
    writer.write_string_value("name", @name)
    writer.write_string_value("ownerId", @owner_id)
    writer.write_boolean_value("playbackLoop", @playback_loop)
    writer.write_object_value("previewUrl", @preview_url)
    writer.write_string_value("shareSlug", @share_slug)
    writer.write_number_value("stageCount", @stage_count)
    writer.write_collection_of_object_values("stages", @stages)
    writer.write_object_value("updatedAt", @updated_at)
    writer.write_enum_value("visibility", @visibility)
end

#share_slug ⇒ Object

Gets the shareSlug property value. Public share slug.

Returns:

  • a string



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

def share_slug
    return @share_slug
end

#share_slug=(value) ⇒ Object

Sets the shareSlug property value. Public share slug.

Parameters:

  • value —

    Value to set for the shareSlug property.

Returns:

  • a void



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

def share_slug=(value)
    @share_slug = value
end

#stage_count ⇒ Object

Gets the stageCount property value. The stageCount property

Returns:

  • a integer



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

def stage_count
    return @stage_count
end

#stage_count=(value) ⇒ Object

Sets the stageCount property value. The stageCount property

Parameters:

  • value —

    Value to set for the stageCount property.

Returns:

  • a void



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

def stage_count=(value)
    @stage_count = value
end

#stages ⇒ Object

Gets the stages property value. The stages property

Returns:

  • a api_strategy_stage



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

def stages
    return @stages
end

#stages=(value) ⇒ Object

Sets the stages property value. The stages property

Parameters:

  • value —

    Value to set for the stages property.

Returns:

  • a void



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

def stages=(value)
    @stages = value
end

#updated_at ⇒ Object

Gets the updatedAt property value. The updatedAt property

Returns:

  • a api_strategy_updated_at



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

def updated_at
    return @updated_at
end

#updated_at=(value) ⇒ Object

Sets the updatedAt property value. The updatedAt property

Parameters:

  • value —

    Value to set for the updatedAt property.

Returns:

  • a void



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

def updated_at=(value)
    @updated_at = value
end

#visibility ⇒ Object

Gets the visibility property value. Strategy share visibility setting.

Returns:

  • a strategy_visibility



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

def visibility
    return @visibility
end

#visibility=(value) ⇒ Object

Sets the visibility property value. Strategy share visibility setting.

Parameters:

  • value —

    Value to set for the visibility property.

Returns:

  • a void



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

def visibility=(value)
    @visibility = value
end