Class: OsuAPI::V2Client

Inherits:

BaseClient

• Object
• BaseClient
• OsuAPI::V2Client

Includes:

RequestV2::Beatmap, RequestV2::User

Defined in:

(osu-api 0.1.0) osu-api/client.rb

Constant Summary

Constants inherited from BaseClient

BaseClient::METHOD_PROCESS_MAP

Class Method Summary

• .base_url ⇒ String

  get class' base url.

Instance Method Summary

• #auto_refresh=(value)
• #auto_refresh? ⇒ Boolean

  Auto refresh token upon expiry.

• #auto_refresh_callback=(fun)
• #initialize(**data) ⇒ V2Client constructor

  A new instance of V2Client.

• #refresh_token

  manually refreshes OAuth token.

• #update(data)

  update OAuthClient internals.

• #version ⇒ Integer

  API version (v2).

Methods included from RequestV2::User

#get_user, #get_user_activity, #get_user_beatmaps, #get_user_kudosu, #get_user_scores, #get_user_self

Methods included from RequestV2::Beatmap

#get_beatmap, #get_beatmap_scores, #get_beatmap_user_score, #lookup_beatmap

Methods inherited from BaseClient

#base_url, create, inherit, #inspect

Constructor Details

#initialize(**data) ⇒ V2Client

Returns a new instance of V2Client.

Class Method Details

.base_url ⇒ String

get class' base url

Returns:

• (String)

Instance Method Details

#auto_refresh=(value)

This method returns an undefined value.

Parameters:

• value (Object) —

  set auto refresh flag from truth value of an object

#auto_refresh? ⇒ Boolean

Returns auto refresh token upon expiry.

Returns:

• (Boolean) —

  auto refresh token upon expiry

#auto_refresh_callback=(fun)

This method returns an undefined value.

Parameters:

• fun (#call) —

  call potential that receives token object.

#refresh_token

This method returns an undefined value.

manually refreshes OAuth token.

#update(data)

This method returns an undefined value.

update OAuthClient internals.

#version ⇒ Integer

Returns API version (v2).

Returns:

• (Integer) —

  API version (v2)