Class Alias

Classe prenant en entrée un pseudo et envoyant des requêtes au site JVC à la différence de Account qui utilise l'API v4.

Index

Constructors

Accessors

Methods

doesAliasExist getID getInfos isBanned

Constructors

constructor

new Alias(alias: string): Alias
Crée une instance de la classe Alias.
Parameters
- alias: string
  pseudo du compte
Returns Alias
- Defined in lib/classes/Alias.ts:147

Accessors

alias

get alias(): string
Renvoie le pseudo du compte.

Returns string
- Defined in lib/classes/Alias.ts:166

url

get url(): string
Renvoie l'URL de la page de profil JVC associée au compte.

Returns string
- Defined in lib/classes/Alias.ts:157

Methods

doesAliasExist

doesAliasExist(): Promise<boolean>
Renvoie un booléen à true si le compte existe, false sinon.

Returns Promise<boolean>
- Defined in lib/classes/Alias.ts:188

getID

getID(client: Client): Promise<undefined | number>
Renvoie l'ID du compte. Nécessite un client connecté.
Parameters
- client: Client
  instance connectée de Client
Returns Promise<undefined | number>
Throws
NonexistentContent si le compte n'existe pas

Throws
NotConnected si le client fourni n'est pas connecté
- Defined in lib/classes/Alias.ts:216

getInfos

getInfos(): Promise<JVCTypes.CDV.Infos>
Renvoie les informations du compte obtenues depuis sa page de profil.

Returns Promise<JVCTypes.CDV.Infos>
Throws
NonexistentContent si le compte n'existe pas
- Defined in lib/classes/Alias.ts:257

isBanned

isBanned(): Promise<boolean>
Renvoie un booléen à true si le compte est banni, false sinon.

Returns Promise<boolean>
Throws
NonexistentContent si le compte n'existe pas
- Defined in lib/classes/Alias.ts:199