Pokemon Showdown API
0.0.0-64-5fb1ac-SNAPSHOT
DocsAPI
Generated with
Pokemon Showdown API/io.github.pidoveproject.showdown/io.github.pidoveproject.showdown.user

io.github.pidoveproject.showdown.user

package io.github.pidoveproject.showdown.user

Members list

Type members

Classlikes

object AvatarName extends RefinedTypeOps[String, Not[Blank], AvatarName]

Attributes

Source
package.scala
Supertypes
trait RefinedTypeOps[String, Not[Blank], AvatarName]
class Object
trait Matchable
class Any
Self type
AvatarName.type
case class LoggedUser(name: Username, avatar: AvatarName, isGuest: Boolean, settings: UserSettings, privateMessages: Map[User, RoomChat], challenges: Map[User, FormatName])

Represent a logged-in user. Typically the current user when connecting to Showdown.

Represent a logged-in user. Typically the current user when connecting to Showdown.

Value parameters

avatar

the avatar representing this user

isGuest

whether this user is a guest or has a registered account

name

the name of the user

settings

this user's settings

Attributes

Source
LoggedUser.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class User(name: Username, rank: Option[Char])

Represents a public user as seen from others.

Represents a public user as seen from others.

Value parameters

name

this user's name

rank

this user's rank if exists

Attributes

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

Attributes

Companion
class
Source
User.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
User.type
object UserList extends RefinedTypeOps[List[User], Pure, UserList]

Attributes

Source
package.scala
Supertypes
trait RefinedTypeOps[List[User], Pure, UserList]
class Object
trait Matchable
class Any
Self type
UserList.type
case class UserSettings(blockChallenges: Boolean, blockPMs: Boolean, ignoreTickets: Boolean, hideBattlesFromTrainerCard: Boolean, blockInvites: Boolean, doNotDisturb: Boolean, blockFriendRequests: Boolean, allowFriendNotifications: Boolean, displayBattlesToFriends: Boolean, hideLogins: Boolean, hiddenNextBattle: Boolean, inviteOnlyNextBattle: Boolean, language: Option[String])

Represents various settings of a user.

Represents various settings of a user.

Value parameters

allowFriendNotifications

whether this user allows notifications from friends or not

blockChallenges

whether this user blocks challenges from others or not

blockFriendRequests

whether this user blocks friend requests from others or not

blockInvites

whether this user blocks invites from others or not

blockPMs

whether this user blocks private messages from others or not

displayBattlesToFriends

whether this user's friends can see their battle or not

doNotDisturb

whether this user receives notifications or not

hiddenNextBattle

???

hideBattlesFromTrainerCard

whether this user hides its trainer card from battles or not

hideLogins

???

ignoreTickets

whether this user ignore tickets or not

inviteOnlyNextBattle

???

language

the language of this user's UI

Attributes

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

Attributes

Companion
class
Source
UserSettings.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
object Username extends RefinedTypeOps[String, Not[Blank], Username]

Attributes

Source
package.scala
Supertypes
trait RefinedTypeOps[String, Not[Blank], Username]
class Object
trait Matchable
class Any
Self type
Username.type

Types

opaque type AvatarName

Attributes

Source
package.scala
opaque type UserList

Attributes

Source
package.scala
opaque type Username

Attributes

Source
package.scala

Givens

Givens

given userListDecoder(using userDecoder: MessageDecoder[User]): MessageDecoder[UserList]

Attributes

Source
decoder.scala
Generated with