io.github.pidoveproject.showdown.protocol.server.query

Members list

Type members

Classlikes

case class BattleRoomInfo(p1: String, p2: String, minElo: Int)

Informations on a battle room sent by the server.

Informations on a battle room sent by the server.

Value parameters

minElo

the min elo of the match

p1

the first battle participant

p2

the second battle participant

Attributes

Source
BattleRoomInfo.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class BattleRooms(rooms: Map[String, BattleRoomInfo])

The list of battle rooms.

The list of battle rooms.

Value parameters

rooms

a Map assciating a room name to its info

Attributes

Companion
object
Source
BattleRooms.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object BattleRooms

Attributes

Companion
class
Source
BattleRooms.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
case class ChatRoomInfo(title: String, description: String, userCount: Count, section: Option[String], subRooms: Option[List[String]], privacy: Option[String])

Informations on a chat room.

Informations on a chat room.

Value parameters

description

the description of the room

privacy

the privacy settings of the room if any

section

the section where the room belongs to

subRooms

the children of the room if any

title

the title of the room

userCount

the number of users in the room

Attributes

Source
ChatRoomInfo.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class ChatRooms(rooms: List[ChatRoomInfo], sectionTitles: List[String], userCount: Count, battleCount: Count)

Informations about the available chat rooms.

Informations about the available chat rooms.

Value parameters

battleCount

the number of currently-running battles

rooms

the list of available chat rooms

sectionTitles

the room sections

userCount

the number of connected users in a room

Attributes

Companion
object
Source
ChatRooms.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object ChatRooms

Attributes

Companion
class
Source
ChatRooms.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
ChatRooms.type

The content of a query response.

The content of a query response.

Attributes

Source
ResponseContent.scala
Supertypes
trait Enum
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class UserInfo(id: String, userId: String, name: String, avatar: AvatarName, group: String, autoConfirmed: Boolean, rooms: Map[String, Map[String, String]])

Details about a user.

Details about a user.

Value parameters

autoConfirmed

true if this user has been authenticated automatically

avatar

the user's avatar

group

the user's group/role

id

the user's id

name

the user's name

rooms

the list of sub-rooms

userId

the user's user id (usually the id, lower-cased and without spaces and special chars)

Attributes

Companion
object
Source
UserInfo.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object UserInfo

Attributes

Companion
class
Source
UserInfo.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
UserInfo.type