Class: Vk::API::Apps::Methods::GetLeaderboard

Inherits:

Schema::Method

• Object
• Dry::Struct
• Schema::Method
• Vk::API::Apps::Methods::GetLeaderboard

Defined in:

lib/vk/api/apps/methods/get_leaderboard.rb

Overview

Returns players rating in the game.

Arguments

• #global ⇒ Boolean

  Rating type.

• #type ⇒ String

  Leaderboard type.

Instance Method Summary

• #initialize(arguments) ⇒ Apps::Methods::GetLeaderboard constructor

Methods inherited from Schema::Method

#call, #method, #to_hash

Constructor Details

#initialize(arguments) ⇒ Apps::Methods::GetLeaderboard

Parameters:

• arguments (Hash)

Options Hash (arguments):

• :type (String) —

  Leaderboard type. Possible values:; *'level' — by level;; *'points' — by mission points;; *'score' — by score ().

• :global (Boolean) —

  Rating type. Possible values:; *'1' — global rating among all players;; *'0' — rating among user friends.

# File 'lib/vk/api/apps/methods/get_leaderboard.rb', line 15

Instance Method Details

#global ⇒ Boolean

Returns Rating type. Possible values:; *'1' — global rating among all players;; *'0' — rating among user friends.

Returns:

• (Boolean) —

  Rating type. Possible values:; *'1' — global rating among all players;; *'0' — rating among user friends.

# File 'lib/vk/api/apps/methods/get_leaderboard.rb', line 26

attribute :global, API::Types::Form::Bool.optional.default(true)

#type ⇒ String

Returns Leaderboard type. Possible values:; *'level' — by level;; *'points' — by mission points;; *'score' — by score ().

Returns:

• (String) —

  Leaderboard type. Possible values:; *'level' — by level;; *'points' — by mission points;; *'score' — by score ().

# File 'lib/vk/api/apps/methods/get_leaderboard.rb', line 24

attribute :type, API::Types::Coercible::String