Class Profile

Classe permettant des opérations sur le profil public d'un compte JVC. Utilise l'API v4 et nécessite un Client connecté.

Index

Constructors

constructor

Methods

editFavoriteForums editFavoriteGames editFavoriteTopics getFavorites getForumPosts getInfos getPage setAvatar setDescription

Constructors

constructor

new Profile(client: Client): Profile
Crée une instance de Profile.
Parameters
- client: Client
  un client connecté
Returns Profile
- Defined in lib/classes/Profile.ts:28

Methods

editFavoriteForums

editFavoriteForums(
forums: number[] | Forum[],
options?: { mode?: "add" | "remove" | "update" },
): Promise<void>
Modifie les forums favoris du compte.
Parameters
- forums: number[] | Forum[]
  tableau contenant les forums cibles des modifications
- Optionaloptions: { mode?: "add" | "remove" | "update" } = {}
  - Optionalmode?: "add" | "remove" | "update"
    "add" pour ajouter les entrées aux favoris, "update" pour remplacer les favoris existants par les entrées (comportement par défaut), "delete" pour retirer les entrées de la liste des favoris
Returns Promise<void>
Throws
NotConnected si le client n'est pas connecté
- Defined in lib/classes/Profile.ts:115

editFavoriteGames

editFavoriteGames(
games: { id: number; machine: number }[],
options?: { mode?: "add" | "remove" | "update" },
): Promise<void>
Modifie les jeux favoris du compte.
Parameters
- games: { id: number; machine: number }[]
  tableau contenant les jeux (ID et machine) cibles des modifications
- Optionaloptions: { mode?: "add" | "remove" | "update" } = {}
  - Optionalmode?: "add" | "remove" | "update"
    "add" pour ajouter les entrées aux favoris, "update" pour remplacer les favoris existants par les entrées (comportement par défaut), "delete" pour retirer les entrées de la liste des favoris
Returns Promise<void>
Throws
NotConnected si le client n'est pas connecté
- Defined in lib/classes/Profile.ts:146

editFavoriteTopics

editFavoriteTopics(
topics: number[] | Topic[],
options?: { mode?: "add" | "remove" | "update" },
): Promise<void>
Modifie les topics favoris du compte.
Parameters
- topics: number[] | Topic[]
  tableau contenant les topics cibles des modifications
- Optionaloptions: { mode?: "add" | "remove" | "update" } = {}
  - Optionalmode?: "add" | "remove" | "update"
    "add" pour ajouter les entrées aux favoris, "update" pour remplacer les favoris existants par les entrées (comportement par défaut), "delete" pour retirer les entrées de la liste des favoris
Returns Promise<void>
Throws
NotConnected si le client n'est pas connecté
- Defined in lib/classes/Profile.ts:176

getFavorites

getFavorites(
    options?: { raw?: boolean },
): Promise<
    V4Types.Account.Favorites.Default
    | V4Types.Account.Favorites.Raw,
>
Renvoie les forums, topics et jeux vidéo favoris du compte.
Parameters
- Optionaloptions: { raw?: boolean }
  - Optionalraw?: boolean
    true pour renvoyer un objet JSON brut (V4Types.Account.Favorites.Raw), par défaut false pour utiliser les classes fournies par la librairie (V4Types.Account.Favorites.Default)
Returns Promise<V4Types.Account.Favorites.Default | V4Types.Account.Favorites.Raw>
Throws
NotConnected si le client n'est pas connecté
- Defined in lib/classes/Profile.ts:91

getForumPosts

getForumPosts(): AsyncGenerator<Post, void, unknown>
Renvoie la liste des messages du compte sous forme de générateur asynchrone. Cette méthode est lente car JVC renvoie des erreurs 403 si trop de requêtes sont envoyées sur un profil.

Returns AsyncGenerator<Post, void, unknown>
Throws
NotConnected si le client n'est pas connecté
- Defined in lib/classes/Profile.ts:246

getInfos

getInfos(): Promise<V4Types.Account.Infos>
Renvoie la page de profil du compte.

Returns Promise<V4Types.Account.Infos>
Throws
NotConnected si le client n'est pas connecté
- Defined in lib/classes/Profile.ts:51

getPage

getPage(): Promise<V4Types.Account.Page.Raw>
Renvoie la page (contenus et reviews) du compte.

Returns Promise<V4Types.Account.Page.Raw>
Throws
NotConnected si le client n'est pas connecté
- Defined in lib/classes/Profile.ts:66

setAvatar

setAvatar(filePath: string): Promise<void>
Remplace l'avatar de profil par le fichier dont le chemin est donné en entrée.
Parameters
- filePath: string
  chemin du fichier
Returns Promise<void>
Throws
NotConnected si le client n'est pas connecté

Throws
JvcErrorMessage si le fichier fourni est invalide (pas une image ou trop volumineux)
- Defined in lib/classes/Profile.ts:206

setDescription

setDescription(description: string): Promise<void>
Modifie la description du profil.
Parameters
- description: string
  nouvelle description
Returns Promise<void>
Throws
NotConnected si le client n'est pas connecté
- Defined in lib/classes/Profile.ts:232

Class Profile

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns Profile

Methods

editFavoriteForums

Parameters

Optionalmode?: "add" | "remove" | "update"

Returns Promise<void>

Throws

editFavoriteGames

Parameters

Optionalmode?: "add" | "remove" | "update"

Returns Promise<void>

Throws

editFavoriteTopics

Parameters

Optionalmode?: "add" | "remove" | "update"

Returns Promise<void>

Throws

getFavorites

Parameters

Optionalraw?: boolean

Returns Promise<V4Types.Account.Favorites.Default | V4Types.Account.Favorites.Raw>

Throws

getForumPosts

Returns AsyncGenerator<Post, void, unknown>

Throws

getInfos

Returns Promise<V4Types.Account.Infos>

Throws

getPage

Returns Promise<V4Types.Account.Page.Raw>

Throws

setAvatar

Parameters

Returns Promise<void>

Throws

Throws

setDescription

Parameters

Returns Promise<void>

Throws

Settings

On This Page

`Optional`mode?: "add" | "remove" | "update"

`Optional`mode?: "add" | "remove" | "update"

`Optional`mode?: "add" | "remove" | "update"

`Optional`raw?: boolean