podcast

Module podcast

Mots-clés : gout, gout-module, gout-module-podcast.

Ce module affiche une liste des dernières émissions audio d'un podcast.

Options

Les options sont dans un objet YAML avec les propriétés suivantes :

Nom	Type	Description
color	string	La couleur de fond du cadre. Par défaut la couleur grise ("#757575") est utilisée. Exemples : "#673ab7", "chocolate"
cron	string string[]	La ou les expressions cron indiquant la fréquence de mise à jour. Sans cette propriété, les données ne sont jamais mises à jour. Exemple : "*/5 * * * *"
empty	object	Les données affichées quand les scrapers n'ont retourné aucune donnée. Ce doit être un objet avec les mêmes propriétés qu'un élément retourné par les scrapers. Si cette propriété n'est pas renseignée, le module est laissé vide. Exemple : title: "(aucun élément)"
icon	string	L'URL de l'icône qui sera affichée en fond. Pour avoir une harmonie avec les autres widgets, il est conseillé d'utiliser une image carrée avec un dessin occupant toute l'image. Si le dessin n'est pas carré, il faut le centrer. Seule la couleur noire doit être utilisée et elle doit avoir une opacité de 0.2. Par défaut, aucune icône n'est affichée. Exemple : "https://example.com/foo/bar.svg"
max	number	Le nombre maximum d'éléments affichés dans le module. Sans maximum, tous les éléments retournés par les scrapers sont affichés. Exemple : 5

Scrapers

Note

Ce chapitre est utile principalement pour le développement de scrapers compatibles avec ce module.

Les scrapers associés à ce module doivent définir une méthode extract() qui prend en paramètre un entier indiquant le nombre maximum d'éléments à retourner. La méthode doit retourner une promesse contenant un tableau dont chaque élément est un objet ayant les propriétés suivantes :

Nom	Type	Description
audio	number	L'URL d'un fichier audio. Exemple : "https://example.com/foo/bar.mp3"
date	number	Le nombre de millisecondes depuis le 1er janvier 1970 à 00:00:00 UTC (cf. Date.prototype.getTime()). Cette valeur est utilisée pour trier les éléments du plus récent au plus ancien. Par défaut, le nombre 0 est utilisé. Exemple : 900277200000
desc	string	La description de l'élément affichée dans l'infobulle. Par défaut, aucune infobulle n'est affichée. Exemple : "Ce top10 des choses incroyables est incroyable"
guid	string	Un identifiant de l'élément (globally unique identifier) qui sera utilisé pour savoir s'il faut mettre à jour un élément ou en insérer un nouveau. Par défaut, il est calculé à partir des autres propriétés. Exemple : "example.com:12345"
icon	string	L'URL de l'icône qui préfixera le titre. Pour avoir une harmonie avec les autres widgets, il est conseillé d'utiliser une image carrée avec un dessin occupant toute l'image. Si le dessin n'est pas carré, il faut le centrer. Seule la couleur blanche doit être utilisée. Par défaut, une icône de lecture est affichée. Exemple : "https://example.com/foo/bar.svg"
link	string	Le lien de l'élément. Par défaut, il n'y a pas de lien (mais le titre de l'élément est affiché). Exemple : "https://example.com/foo/bar.html"
target	string	L'emplacement où sera ouvert le lien (cf. l'attribut target des liens HTML). Par défaut, les liens s'ouvrent dans un nouvel onglet. Exemple : "_top"
title	string	Le texte affiché dans la ligne. Exemple : "La 7e va vous étonner"

Exemple

Ce widget affiche les deux derniers épisodes des Cast Codeurs Podcast.

<script type="application/yaml">
  module:
    url: "https://cdn.jsdelivr.net/gh/regseb/gout@0/src/module/podcast/podcast.js"
    options:
      cron: "@daily"
      max: 2
      color: "black"
    scrapers:
      - url: "https://cdn.jsdelivr.net/gh/regseb/gout@0/src/scraper/list/rss/rss.js"
        options:
          url: "https://lescastcodeurs.com/podcast-rss"
</script>