Class Content

Classe représentant un contenu JVC (news, review, preview, etc.). Utilise l'API v4.

Hierarchy (View Summary)

Content
- Video

Index

Constructors

constructor

Properties

_id

Accessors

Methods

doesContentExist getComments getInfos getRelatedNews getRelatedVideos getRelatedWikis

Constructors

constructor

new Content(id: number): Content
Crée une instance de la classe Content.
Parameters
- id: number
  ID du contenu
Returns Content
- Defined in lib/classes/Content.ts:24

Properties

`Protected`_id

_id: number

Accessors

id

get id(): number
Renvoie l'ID du contenu.

Returns number
- Defined in lib/classes/Content.ts:34

Methods

doesContentExist

doesContentExist(): Promise<boolean>
Renvoie true si le contenu existe, false sinon.

Returns Promise<boolean>
- Defined in lib/classes/Content.ts:104

getComments

getComments(
    options?: {
        paging?: V4Types.Request.Paging;
        perPage?: number;
        raw?: boolean;
    },
): AsyncGenerator<
    ContentComment[]
    | V4Types.Content.Comments.Raw,
    void,
    unknown,
>
Renvoie un générateur asynchrone des commentaires du contenu situés aux pages décrites par le paramètre paging.
Parameters
- Optionaloptions: { paging?: V4Types.Request.Paging; perPage?: number; raw?: boolean }
  - Optionalpaging?: V4Types.Request.Paging
    objet décrivant les pages à traiter (par défaut vide : toutes les pages le sont)
  - OptionalperPage?: number
    nombre d'entités par page, par défaut 20
  - Optionalraw?: boolean
    true pour renvoyer un objet JSON brut (V4Types.Content.Comments.Raw), par défaut false pour utiliser les classes fournies par la librairie (ContentComment)
Returns AsyncGenerator<ContentComment[] | V4Types.Content.Comments.Raw, void, unknown>
Example
```
const content = new Content(1);
for await (const page of content.getComments()) {
     console.log(page);
}
```
Throws
InexistentContent si le contenu n'existe pas
- Defined in lib/classes/Content.ts:174
getComments(
    options: { page: number; perPage?: number; raw?: boolean },
): AsyncGenerator<
    ContentComment[]
    | V4Types.Content.Comments.Raw,
    void,
    unknown,
>
Renvoie les commentaires du contenu situés à une page particulière.
Parameters
- options: { page: number; perPage?: number; raw?: boolean }
  - page: number
    numéro de la page à traiter
  - OptionalperPage?: number
    nombre d'entités par page, par défaut 20
  - Optionalraw?: boolean
    true pour renvoyer un objet JSON brut (V4Types.Content.Comments.Raw), par défaut false pour utiliser les classes fournies par la librairie (ContentComment)
Returns AsyncGenerator<ContentComment[] | V4Types.Content.Comments.Raw, void, unknown>
Example
```
const content = new Content(1);
console.log(await content.getComments({ page: 2 }));
```
Throws
InexistentContent si le contenu n'existe pas
- Defined in lib/classes/Content.ts:190

getInfos

getInfos(): Promise<V4Types.Content.Infos>
Renvoie les informations du contenu.

Returns Promise<V4Types.Content.Infos>
Throws
InexistentContent si le contenu n'existe pas
- Defined in lib/classes/Content.ts:130

getRelatedNews

getRelatedNews(
    options?: {
        paging?: V4Types.Request.Paging;
        perPage?: number;
        raw?: boolean;
    },
): AsyncGenerator<V4Types.Contents.Raw | Content[], void, unknown>
Renvoie un générateur asynchrone des actualités associées au contenu situées aux pages décrites par le paramètre paging.
Parameters
- Optionaloptions: { paging?: V4Types.Request.Paging; perPage?: number; raw?: boolean }
  - Optionalpaging?: V4Types.Request.Paging
    objet décrivant les pages à traiter (par défaut vide : toutes les pages le sont)
  - OptionalperPage?: number
    nombre d'entités par page, par défaut 20
  - Optionalraw?: boolean
    true pour renvoyer un objet JSON brut (V4Types.Contents.Raw), par défaut false pour utiliser les classes fournies par la librairie (Content)
Returns AsyncGenerator<V4Types.Contents.Raw | Content[], void, unknown>
Example
```
const content = new Content(1);
for await (const page of content.getRelatedNews()) {
     console.log(page);
}
```
Throws
InexistentContent si le contenu n'existe pas
- Defined in lib/classes/Content.ts:248
getRelatedNews(
options: { page: number; perPage?: number; raw?: boolean },
): Promise<V4Types.Contents.Raw | Content[]>
Renvoie les actualités associées au contenu situées à une page particulière.
Parameters
- options: { page: number; perPage?: number; raw?: boolean }
  - page: number
    numéro de la page à traiter
  - OptionalperPage?: number
    nombre d'entités par page, par défaut 20
  - Optionalraw?: boolean
    true pour renvoyer un objet JSON brut (V4Types.Contents.Raw), par défaut false pour utiliser les classes fournies par la librairie (Content)
Returns Promise<V4Types.Contents.Raw | Content[]>
Example
```
const content = new Content(1);
console.log(await content.getRelatedNews({ page: 2 }));
```
Throws
InexistentContent si le contenu n'existe pas
- Defined in lib/classes/Content.ts:264

getRelatedVideos

getRelatedVideos(
    options?: {
        paging?: V4Types.Request.Paging;
        perPage?: number;
        raw?: boolean;
    },
): AsyncGenerator<V4Types.Videos.Raw | Video[], void, unknown>
Renvoie un générateur asynchrone des vidéos associées au contenu situées aux pages décrites par le paramètre paging.
Parameters
- Optionaloptions: { paging?: V4Types.Request.Paging; perPage?: number; raw?: boolean }
  - Optionalpaging?: V4Types.Request.Paging
    objet décrivant les pages à traiter (par défaut vide : toutes les pages le sont)
  - OptionalperPage?: number
    nombre d'entités par page, par défaut 20
  - Optionalraw?: boolean
    true pour renvoyer un objet JSON brut (V4Types.Videos.Raw), par défaut false pour utiliser les classes fournies par la librairie (Video)
Returns AsyncGenerator<V4Types.Videos.Raw | Video[], void, unknown>
Example
```
const content = new Content(1);
for await (const page of content.getRelatedVideos()) {
     console.log(page);
}
```
Throws
InexistentContent si le contenu n'existe pas
- Defined in lib/classes/Content.ts:308
getRelatedVideos(
options: { page: number; perPage?: number; raw?: boolean },
): Promise<V4Types.Videos.Raw | Video[]>
Renvoie les vidéos associées au contenu situées à une page particulière.
Parameters
- options: { page: number; perPage?: number; raw?: boolean }
  - page: number
    numéro de la page à traiter
  - OptionalperPage?: number
    nombre d'entités par page, par défaut 20
  - Optionalraw?: boolean
    true pour renvoyer un objet JSON brut (V4Types.Videos.Raw), par défaut false pour utiliser les classes fournies par la librairie (Video)
Returns Promise<V4Types.Videos.Raw | Video[]>
Example
```
const content = new Content(1);
console.log(await content.getRelatedVideos({ page: 2 }));
```
Throws
InexistentContent si le contenu n'existe pas
- Defined in lib/classes/Content.ts:324

getRelatedWikis

getRelatedWikis(
    options?: {
        paging?: V4Types.Request.Paging;
        perPage?: number;
        raw?: boolean;
    },
): AsyncGenerator<V4Types.Contents.Raw | Content[], void, unknown>
Renvoie un générateur asynchrone des wikis associés au contenu situés aux pages décrites par le paramètre paging.
Parameters
- Optionaloptions: { paging?: V4Types.Request.Paging; perPage?: number; raw?: boolean }
  - Optionalpaging?: V4Types.Request.Paging
    objet décrivant les pages à traiter (par défaut vide : toutes les pages le sont)
  - OptionalperPage?: number
    nombre d'entités par page, par défaut 20
  - Optionalraw?: boolean
    true pour renvoyer un objet JSON brut (V4Types.Contents.Raw), par défaut false pour utiliser les classes fournies par la librairie (Content)
Returns AsyncGenerator<V4Types.Contents.Raw | Content[], void, unknown>
Example
```
const content = new Content(1);
for await (const page of content.getRelatedWikis()) {
     console.log(page);
}
```
Throws
InexistentContent si le contenu n'existe pas
- Defined in lib/classes/Content.ts:368
getRelatedWikis(
options: { page: number; perPage?: number; raw?: boolean },
): Promise<V4Types.Contents.Raw | Content[]>
Renvoie les wikis associés au contenu situés à une page particulière.
Parameters
- options: { page: number; perPage?: number; raw?: boolean }
  - page: number
    numéro de la page à traiter
  - OptionalperPage?: number
    nombre d'entités par page, par défaut 20
  - Optionalraw?: boolean
    true pour renvoyer un objet JSON brut (V4Types.Contents.Raw), par défaut false pour utiliser les classes fournies par la librairie (Content)
Returns Promise<V4Types.Contents.Raw | Content[]>
Example
```
const content = new Content(1);
console.log(await content.getRelatedWikis({ page: 2 }));
```
Throws
InexistentContent si le contenu n'existe pas
- Defined in lib/classes/Content.ts:384

Class Content

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns Content

Properties

Protected_id

Accessors

id

Returns number

Methods

doesContentExist

Returns Promise<boolean>

getComments

Parameters

Optionalpaging?: V4Types.Request.Paging

OptionalperPage?: number

Optionalraw?: boolean

Returns AsyncGenerator<ContentComment[] | V4Types.Content.Comments.Raw, void, unknown>

Example

Throws

Parameters

page: number

OptionalperPage?: number

Optionalraw?: boolean

Returns AsyncGenerator<ContentComment[] | V4Types.Content.Comments.Raw, void, unknown>

Example

Throws

getInfos

Returns Promise<V4Types.Content.Infos>

Throws

getRelatedNews

Parameters

Optionalpaging?: V4Types.Request.Paging

OptionalperPage?: number

Optionalraw?: boolean

Returns AsyncGenerator<V4Types.Contents.Raw | Content[], void, unknown>

Example

Throws

Parameters

page: number

OptionalperPage?: number

Optionalraw?: boolean

Returns Promise<V4Types.Contents.Raw | Content[]>

Example

Throws

getRelatedVideos

Parameters

Optionalpaging?: V4Types.Request.Paging

OptionalperPage?: number

Optionalraw?: boolean

Returns AsyncGenerator<V4Types.Videos.Raw | Video[], void, unknown>

Example

Throws

Parameters

page: number

OptionalperPage?: number

Optionalraw?: boolean

Returns Promise<V4Types.Videos.Raw | Video[]>

Example

Throws

getRelatedWikis

Parameters

Optionalpaging?: V4Types.Request.Paging

OptionalperPage?: number

Optionalraw?: boolean

Returns AsyncGenerator<V4Types.Contents.Raw | Content[], void, unknown>

Example

Throws

Parameters

page: number

OptionalperPage?: number

Optionalraw?: boolean

Returns Promise<V4Types.Contents.Raw | Content[]>

`Protected`_id

`Optional`paging?: V4Types.Request.Paging

`Optional`perPage?: number

`Optional`raw?: boolean

`Optional`perPage?: number

`Optional`raw?: boolean

`Optional`paging?: V4Types.Request.Paging

`Optional`perPage?: number

`Optional`raw?: boolean

`Optional`perPage?: number

`Optional`raw?: boolean

`Optional`paging?: V4Types.Request.Paging

`Optional`perPage?: number

`Optional`raw?: boolean

`Optional`perPage?: number

`Optional`raw?: boolean

`Optional`paging?: V4Types.Request.Paging

`Optional`perPage?: number

`Optional`raw?: boolean

`Optional`perPage?: number

`Optional`raw?: boolean