Class: TeamBattlesSdk::Generated::Models::ApiGameRank

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

Overview

API-safe game rank entry for the API key owner.

Defined Under Namespace

Classes: ApiGameRankSr, ApiGameRankTop250Rank

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_rank

Raises:

  • (StandardError)


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

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

Instance Method Details

#created_atObject

Gets the createdAt property value. When the rank was first recorded.

Returns:

  • a string



46
47
48
# File 'lib/teambattles_sdk/generated/models/api_game_rank.rb', line 46

def created_at
    return @created_at
end

#created_at=(value) ⇒ Object

Sets the createdAt property value. When the rank was first recorded.

Parameters:

  • value

    Value to set for the createdAt property.

Returns:

  • a void



54
55
56
# File 'lib/teambattles_sdk/generated/models/api_game_rank.rb', line 54

def created_at=(value)
    @created_at = value
end

#game_idObject

Gets the gameId property value. Game definition ID this rank belongs to.

Returns:

  • a string



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

def game_id
    return @game_id
end

#game_id=(value) ⇒ Object

Sets the gameId property value. Game definition ID this rank belongs to.

Parameters:

  • value

    Value to set for the gameId property.

Returns:

  • a void



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

def game_id=(value)
    @game_id = value
end

#get_field_deserializersObject

The deserialization information for the current model

Returns:

  • a i_dictionary



85
86
87
88
89
90
91
92
93
94
95
96
97
98
# File 'lib/teambattles_sdk/generated/models/api_game_rank.rb', line 85

def get_field_deserializers()
    return {
        "createdAt" => lambda {|n| @created_at = n.get_string_value() },
        "gameId" => lambda {|n| @game_id = n.get_string_value() },
        "id" => lambda {|n| @id = n.get_string_value() },
        "isTop250" => lambda {|n| @is_top250 = n.get_boolean_value() },
        "mode" => lambda {|n| @mode = n.get_string_value() },
        "source" => lambda {|n| @source = n.get_enum_value(TeamBattlesSdk::Generated::Models::ApiGameRankSource) },
        "sr" => lambda {|n| @sr = n.get_object_value(lambda {|pn| ApiGameRank::ApiGameRankSr.create_from_discriminator_value(pn) }) },
        "top250Rank" => lambda {|n| @top250_rank = n.get_object_value(lambda {|pn| ApiGameRank::ApiGameRankTop250Rank.create_from_discriminator_value(pn) }) },
        "updatedAt" => lambda {|n| @updated_at = n.get_string_value() },
        "winstreak" => lambda {|n| @winstreak = n.get_number_value() },
    }
end

#idObject

Gets the id property value. Game rank row ID.

Returns:

  • a string



103
104
105
# File 'lib/teambattles_sdk/generated/models/api_game_rank.rb', line 103

def id
    return @id
end

#id=(value) ⇒ Object

Sets the id property value. Game rank row ID.

Parameters:

  • value

    Value to set for the id property.

Returns:

  • a void



111
112
113
# File 'lib/teambattles_sdk/generated/models/api_game_rank.rb', line 111

def id=(value)
    @id = value
end

#is_top250Object

Gets the isTop250 property value. Whether the player is in the Top 250 ladder.

Returns:

  • a boolean



118
119
120
# File 'lib/teambattles_sdk/generated/models/api_game_rank.rb', line 118

def is_top250
    return @is_top250
end

#is_top250=(value) ⇒ Object

Sets the isTop250 property value. Whether the player is in the Top 250 ladder.

Parameters:

  • value

    Value to set for the isTop250 property.

Returns:

  • a void



126
127
128
# File 'lib/teambattles_sdk/generated/models/api_game_rank.rb', line 126

def is_top250=(value)
    @is_top250 = value
end

#modeObject

Gets the mode property value. Game mode / playlist the rank is tracked for.

Returns:

  • a string



133
134
135
# File 'lib/teambattles_sdk/generated/models/api_game_rank.rb', line 133

def mode
    return @mode
end

#mode=(value) ⇒ Object

Sets the mode property value. Game mode / playlist the rank is tracked for.

Parameters:

  • value

    Value to set for the mode property.

Returns:

  • a void



141
142
143
# File 'lib/teambattles_sdk/generated/models/api_game_rank.rb', line 141

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


149
150
151
152
153
154
155
156
157
158
159
160
161
# File 'lib/teambattles_sdk/generated/models/api_game_rank.rb', line 149

def serialize(writer)
    raise StandardError, 'writer cannot be null' if writer.nil?
    writer.write_string_value("createdAt", @created_at)
    writer.write_string_value("gameId", @game_id)
    writer.write_string_value("id", @id)
    writer.write_boolean_value("isTop250", @is_top250)
    writer.write_string_value("mode", @mode)
    writer.write_enum_value("source", @source)
    writer.write_object_value("sr", @sr)
    writer.write_object_value("top250Rank", @top250_rank)
    writer.write_string_value("updatedAt", @updated_at)
    writer.write_number_value("winstreak", @winstreak)
end

#sourceObject

Gets the source property value. Origin of the rank: manual entry or an API push.

Returns:

  • a api_game_rank_source



166
167
168
# File 'lib/teambattles_sdk/generated/models/api_game_rank.rb', line 166

def source
    return @source
end

#source=(value) ⇒ Object

Sets the source property value. Origin of the rank: manual entry or an API push.

Parameters:

  • value

    Value to set for the source property.

Returns:

  • a void



174
175
176
# File 'lib/teambattles_sdk/generated/models/api_game_rank.rb', line 174

def source=(value)
    @source = value
end

#srObject

Gets the sr property value. Skill rating, when set.

Returns:

  • a api_game_rank_sr



181
182
183
# File 'lib/teambattles_sdk/generated/models/api_game_rank.rb', line 181

def sr
    return @sr
end

#sr=(value) ⇒ Object

Sets the sr property value. Skill rating, when set.

Parameters:

  • value

    Value to set for the sr property.

Returns:

  • a void



189
190
191
# File 'lib/teambattles_sdk/generated/models/api_game_rank.rb', line 189

def sr=(value)
    @sr = value
end

#top250_rankObject

Gets the top250Rank property value. Top 250 ladder position (1-250), when applicable.

Returns:

  • a api_game_rank_top250_rank



196
197
198
# File 'lib/teambattles_sdk/generated/models/api_game_rank.rb', line 196

def top250_rank
    return @top250_rank
end

#top250_rank=(value) ⇒ Object

Sets the top250Rank property value. Top 250 ladder position (1-250), when applicable.

Parameters:

  • value

    Value to set for the top250Rank property.

Returns:

  • a void



204
205
206
# File 'lib/teambattles_sdk/generated/models/api_game_rank.rb', line 204

def top250_rank=(value)
    @top250_rank = value
end

#updated_atObject

Gets the updatedAt property value. When the rank was last updated.

Returns:

  • a string



211
212
213
# File 'lib/teambattles_sdk/generated/models/api_game_rank.rb', line 211

def updated_at
    return @updated_at
end

#updated_at=(value) ⇒ Object

Sets the updatedAt property value. When the rank was last updated.

Parameters:

  • value

    Value to set for the updatedAt property.

Returns:

  • a void



219
220
221
# File 'lib/teambattles_sdk/generated/models/api_game_rank.rb', line 219

def updated_at=(value)
    @updated_at = value
end

#winstreakObject

Gets the winstreak property value. Current win streak count.

Returns:

  • a integer



226
227
228
# File 'lib/teambattles_sdk/generated/models/api_game_rank.rb', line 226

def winstreak
    return @winstreak
end

#winstreak=(value) ⇒ Object

Sets the winstreak property value. Current win streak count.

Parameters:

  • value

    Value to set for the winstreak property.

Returns:

  • a void



234
235
236
# File 'lib/teambattles_sdk/generated/models/api_game_rank.rb', line 234

def winstreak=(value)
    @winstreak = value
end