Class V4Client

Classe permettant des interactions avec les contenus du site. Utilise l'API v4 et nécessite un Client connecté.

Index

Constructors

constructor

Methods

addAnswer addComment addCommentVote addReview deleteComment deleteCommentVote deleteReview updateComment

Constructors

constructor

new V4Client(client: Client): V4Client
Crée une instance de V4Client.
Parameters
- client: Client
Returns V4Client
- Defined in lib/classes/V4Client.ts:26

Methods

addAnswer

addAnswer(
comment: ContentComment,
text: string,
): Promise<V4Types.Content.Comment.Infos>
Ajoute une réponse sous un commentaire et renvoie un objet la représentant.
Parameters
- comment: ContentComment
  instance représentant le commentaire
- text: string
  corps de la réponse
Returns Promise<V4Types.Content.Comment.Infos>
Throws
NotConnected si le client n'est pas connecté

Throws
NonexistentContent si le commentaire n'existe pas

Throws
JvcErrorMessage si le compte est banni ou si le message est invalide
- Defined in lib/classes/V4Client.ts:96

addComment

addComment(
content: Content,
text: string,
): Promise<V4Types.Content.Comment.Infos>
Ajoute un commentaire sur le contenu passé en entrée et renvoie un objet le représentant.
Parameters
- content: Content
  instance représentant le contenu
- text: string
  corps du commentaire
Returns Promise<V4Types.Content.Comment.Infos>
Throws
NotConnected si le client n'est pas connecté

Throws
NonexistentContent si le contenu n'existe pas

Throws
JvcErrorMessage si le compte est banni ou si le message est invalide
- Defined in lib/classes/V4Client.ts:53

addCommentVote

addCommentVote(comment: ContentComment, vote: -1 | 1): Promise<void>
Ajoute un vote positif ou négatif sur un commentaire.
Parameters
- comment: ContentComment
  instance représentant le commentaire
- vote: -1 | 1
  1 : positif, -1 : négatif
Returns Promise<void>
Throws
NotConnected si le client n'est pas connecté

Throws
NonexistentContent si le commentaire n'existe pas
- Defined in lib/classes/V4Client.ts:76

addReview

addReview(
    game: Game,
    machineId: number,
    mark: number,
    text: string,
    options?: { onProfile?: boolean },
): Promise<V4Types.Game.Review.Infos>
Ajoute un avis sur un jeu vidéo passé en entrée et renvoie un objet le représentant
Parameters
- game: Game
  instance représentant le jeu
- machineId: number
  ID de la machine sur laquelle l'avis est posté
- mark: number
  note comprise entre 0 et 20
- text: string
  corps de l'avis
- Optionaloptions: { onProfile?: boolean } = {}
  - OptionalonProfile?: boolean
    true pour faire apparaître l'avis sur la page de profil (par défaut)
Returns Promise<V4Types.Game.Review.Infos>
Throws
NotConnected si le client n'est pas connecté

Throws
NonexistentContent si le jeu n'existe pas ou si le jeu n'existe pas sur la machine renseignée

Throws
JvcErrorMessage si le compte est banni, si le message ou la note est invalide
- Defined in lib/classes/V4Client.ts:209

deleteComment

deleteComment(comment: ContentComment): Promise<void>
Retire le commentaire.
Parameters
- comment: ContentComment
  instance représentant le commentaire
Returns Promise<void>
Throws
NotConnected si le client n'est pas connecté

Throws
NonexistentContent si le contenu n'existe pas

Throws
JvcErrorMessage si le commentaire n'appartient pas au compte
- Defined in lib/classes/V4Client.ts:125

deleteCommentVote

deleteCommentVote(comment: ContentComment): Promise<void>
Supprime le vote donné à un commentaire.
Parameters
- comment: ContentComment
  instance représentant le commentaire
Returns Promise<void>
- Defined in lib/classes/V4Client.ts:143

deleteReview

deleteReview(review: Review): Promise<void>
Supprime l'avis.
Parameters
- review: Review
  instance représentant l'avis
Returns Promise<void>
Throws
NotConnected si le client n'est pas connecté

Throws
NonexistentContent si l'avis n'existe pas
- Defined in lib/classes/V4Client.ts:229

updateComment

updateComment(
comment: ContentComment,
text: string,
): Promise<V4Types.Content.Comment.Infos>
Modifie le texte du commentaire et renvoie un objet représentant le commentaire mis à jour.
Parameters
- comment: ContentComment
  instance représentant le commentaire
- text: string
  nouveau texte
Returns Promise<V4Types.Content.Comment.Infos>
Throws
NotConnected si le client n'est pas connecté

Throws
NonexistentContent si le commentaire n'existe pas

Throws
JvcErrorMessage si le commentaire n'appartient pas au compte, si le compte est banni ou si le message est invalide
- Defined in lib/classes/V4Client.ts:163

Class V4Client

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns V4Client

Methods

addAnswer

Parameters

Returns Promise<V4Types.Content.Comment.Infos>

Throws

Throws

Throws

addComment

Parameters

Returns Promise<V4Types.Content.Comment.Infos>

Throws

Throws

Throws

addCommentVote

Parameters

Returns Promise<void>

Throws

Throws

addReview

Parameters

OptionalonProfile?: boolean

Returns Promise<V4Types.Game.Review.Infos>

Throws

Throws

Throws

deleteComment

Parameters

Returns Promise<void>

Throws

Throws

Throws

deleteCommentVote

Parameters

Returns Promise<void>

deleteReview

Parameters

Returns Promise<void>

Throws

Throws

updateComment

Parameters

Returns Promise<V4Types.Content.Comment.Infos>

Throws

Throws

Throws

Settings

On This Page

`Optional`onProfile?: boolean