BoardService class abstract

Play on Lichess with physical boards and third-party clients. Works with normal Lichess accounts. Engine play or assistance is forbidden.

Features

• Stream incoming chess moves.
• Play chess moves.
• Read and write in the player and spectator chats.
• Receive, create and accept (or decline) challenges.
• Abort and resign games.
• Compatible with normal Lichess accounts.

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

Mixed in types

• CloseableMixin

Implementers

• BoardServiceDio

Constructors

BoardService()

Interface for this client.

const

Properties

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

abortGame(String gameId) → Future<void>

Abort a game being played with the Board API.

claimVictory(String gameId) → Future<void>

Claim victory when the opponent has left the game for a while.

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

Close any resources associated with this object.

inherited

createCorrespondenceSeek({required DaysPerTurn days, bool rated = false, LichessVariantKey variant = LichessVariantKey.standard, LichessChallengeColor color = LichessChallengeColor.random, double? time, int? increment, int? maxRating, int? minRating}) → Future<Future<void> Function()>

Create a seek

createRealTimeSeek({required double time, required int increment, DaysPerTurn? days, bool rated = false, LichessVariantKey variant = LichessVariantKey.standard, LichessChallengeColor color = LichessChallengeColor.random, int? maxRating, int? minRating}) → Future<Future<void> Function()>

Create a seek

fetchGameChat(String gameId) → Stream<LichessGameChatMessage>

Get the messages posted in the game chat.

makeBoardMove({required String gameId, required String move, bool? offeringDraw}) → Future<void>

Make a move in a game being played with the Board API.

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

resignGame(String gameId) → Future<void>

Resign a game being played with the Board API.

streamBoardGameState({required String gameId}) → Stream<LichessBoardGameEvent>

Stream the state of a game being played with the Board API, as ndjson.

streamIncomingEvents() → Stream<LichessBoardGameIncomingEvent>

Stream the events reaching a lichess user in real time as ndjson.

toString() → String

A string representation of this object.

inherited

writeInTheChat({required String gameId, required LichessChatLineRoom room, required String text}) → Future<void>

Post a message to the player or spectator chat, in a game being played with the Board API.

Operators

operator ==(Object other) → bool

The equality operator.

inherited