UsersServiceDio class abstract

Access registered users on Lichess. https://lichess.org/player

• Each user blog exposes an atom (RSS) feed, like https://lichess.org/@/thibault/blog.atom.
• User blogs mashup feed: https://lichess.org/blog/community.atom.
• User blogs mashup feed for a language: https://lichess.org/blog/community/fr.atom.

https://lichess.org/api#tag/Users

Inheritance

• Object
• UsersService
• UsersServiceDio

Annotations

• @RestApi()

Constructors

UsersServiceDio(Dio dio)

factory

UsersServiceDio.create({String? accessToken, String baseUrl = 'https://lichess.org'})

factory

Properties

dio → Dio

Dio client linked with this service instance.

final

hashCode → int

The hash code for this object.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

close({bool force = false}) → Future<void>

Close the dio instance associated with this service instance.

override

getChessVariantLeaderboard({required PerfType variant, int limit = 100}) → Future<List<User>>

Method with semantic names for getPerfTypeLeaderboard.

override

getLiveStreamers() → Future<List<User>>

Get basic info about currently streaming users.

override

getManyById({required List<String> ids}) → Future<List<User>>

Get up to 300 users by their IDs. Users are returned in the same order as the IDs.

override

getPerfTypeLeaderboard({required PerfType perfType, int nb = 100}) → Future<List<User>>

Get the leaderboard for a single speed or variant (a.k.a. perfType). There is no leaderboard for correspondence or puzzles.

override

getPublicData({required String username, bool trophies = false}) → Future<User>

Read public data of a user.

override

getRatingHistory({required String username}) → Future<List<RatingHistory>>

Read rating history of a user, for all perf types.

override

getRealTimeStatus({required List<String> ids, bool withGameIds = false}) → Future<List<RealTimeUserStatus>>

Read the online, playing and streaming flags of several users.

override

getTop10() → Future<Map<String, List<User>>>

Get the top 10 players for each speed and variant.

override

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

searchByTerm({required String term, bool friend = false, bool object = true}) → Future<List<User>>

Provides autocompletion options for an incomplete username.

override

searchNamesByTerm({required String term, bool friend = false}) → Future<List<String>>

Provides autocompletion options for an incomplete username.

override

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited