Révision 196228 sur nsIFeedProgressListener

  • Raccourci de la révision : nsIFeedProgressListener
  • Titre de la révision : nsIFeedProgressListener
  • ID de la révision : 196228
  • Créé :
  • Créateur : Planche
  • Version actuelle ? Oui
  • Commentaire Relecture de l'article

Contenu de la révision

L'interface nsIFeedProgressListener définit les fonctions de rappel utilisées pendant l'analyse d'un flux RSS ou Atom. Les programmes utilisant l'API d'accés au contenu de flux ne sont pas obligés d'implémenter ces fonctions ; elles sont optionnelles, mais vous permettent de fournir des informations en retour pendant le processus d'analyse.


{{ InterfaceStatus("nsiFeedProgressListener", "toolkit/components/feeds/public/nsiFeedListener.idl", "unfrozen", "Mozilla 1.8.1", "yes") }}

Hérité de : nsIFeedResultListener

Synoptique

void handleEntry(in nsIFeedEntry entry, in nsIFeedResult result);
void handleFeedAtFirstEntry(in nsIFeedResult result);
void handleStartFeed(in nsIFeedResult result);
void reportError(in AString errorText, in long lineNumber, in boolean bozo);

Méthodes

handleEntry()

Appelée après l'analyse de chaque entrée ou élément. Si le document est une entrée ou un élément unique, la méthode handleFeedAtFirstEntry() n'aura pas encore été appelée, et la nsIFeedEntry reçue aura la valeur null parent.

 void handleEntry(
   in nsIFeedEntry entry,
   in nsIFeedResult result
 );
Paramètres
<tt>entry</tt>
Pointeur vers une nsIFeedEntry contenant des informations sur l'entrée qui vient d'être analysée.
<tt>result</tt>
Pointeur vers une nsIFeedResult contenant des informations sur l'entrée en cours d'analyse.

handleFeedAtFirstEntry()

Appelée lorsque la première entrée ou le premier élément du flux est rencontré. Dans les flux Atom, toutes les données du flux doivent précéder les entrées ; dans les flux RSS ce n'est pas une obligation, mais c'est généralement respecté. En d'autres termes, lorsque cette méthode est appelée, il est très probable que toutes ou la plupart des métadonnées du flux ont été analysées et sont disponibles dans l'objet nsIFeedResult reçu.

 void handleFeedAtFirstEntry(
   in nsIFeedResult result
 );
Paramètres
<tt>result</tt>
Une nsIFeedResult décrivant le flux lorsque la première entrée est trouvée, mais avant son traitement.
Note : Si le type de flux est une entrée ou un élément unique, cet événement n'est jamais appelé.

handleStartFeed()

Appelée dès qu'un début acceptable d'un flux est détecté ; ceci informe votre code que le flux semble bien être un flux de news et non un autre type document.

 void handleStartFeed(
   in nsIFeedResult result
 );
Paramètres
<tt>result</tt>
Un nsIFeedResult décrivant l'état du flux au début de son analyse.

reportError()

Appelée par le processeur de flux lorsque se produit une erreur d'analyse XML fatale, ou si le document n'est pas un flux.

 void reportError(
   in AString errorText,
   in long lineNumber,
   in boolean bozo
 );

Chaque méthode reçoit comme entrée au moins un nsIFeedResult qui décrit l'état actuel du traitement.

Voir également

nsIFeedResultListener


Liens Interwiki

{{ languages( { "en": "en/NsIFeedProgressListener" } ) }}

Source de la révision

<p>
L'interface <code>nsIFeedProgressListener</code> définit les fonctions de rappel utilisées pendant l'analyse d'un flux RSS ou Atom. Les programmes utilisant l'API d'accés au contenu de flux ne sont pas obligés d'implémenter ces fonctions ; elles sont optionnelles, mais vous permettent de fournir des informations en retour pendant le processus d'analyse.
</p><p><br>
{{ InterfaceStatus("nsiFeedProgressListener", "toolkit/components/feeds/public/nsiFeedListener.idl", "unfrozen", "Mozilla 1.8.1", "yes") }}
</p><p>Hérité de : <code><a href="fr/NsIFeedResultListener">nsIFeedResultListener</a></code>
</p>
<h2 id="Synoptique" name="Synoptique">Synoptique</h2>
<table class="standard-table"> <tbody><tr>
<td> <code>void <a href="fr/NsIFeedProgressListener#handleEntry.28.29">handleEntry</a>(in nsIFeedEntry entry, in nsIFeedResult result);</code>
</td></tr>
<tr>
<td> <code>void <a href="fr/NsIFeedProgressListener#handleFeedAtFirstEntry.28.29">handleFeedAtFirstEntry</a>(in nsIFeedResult result);</code>
</td></tr>
<tr>
<td> <code>void <a href="fr/NsIFeedProgressListener#handleStartFeed.28.29">handleStartFeed</a>(in nsIFeedResult result);</code>
</td></tr>
<tr>
<td> <code>void <a href="fr/NsIFeedProgressListener#reportError.28.29">reportError</a>(in AString errorText, in long lineNumber, in boolean bozo);</code>
</td></tr>
</tbody></table>
<h2 id="M.C3.A9thodes" name="M.C3.A9thodes">Méthodes</h2>
<h3 id="handleEntry.28.29" name="handleEntry.28.29">handleEntry()</h3>
<p>Appelée après l'analyse de chaque entrée ou élément. Si le document est une entrée ou un élément unique, la méthode <code><a href="fr/NsIFeedProgressListener#handleFeedAtFirstEntry.28.29">handleFeedAtFirstEntry()</a></code> n'aura pas encore été appelée, et la <code><a href="fr/NsIFeedEntry">nsIFeedEntry</a></code> reçue aura la valeur <code>null</code> <code>parent</code>.
</p>
<pre class="eval"> void handleEntry(
   in nsIFeedEntry entry,
   in nsIFeedResult result
 );
</pre>
<h6 id="Param.C3.A8tres" name="Param.C3.A8tres">Paramètres</h6>
<dl><dt><tt>entry</tt>
</dt><dd> Pointeur vers une <code><a href="fr/NsIFeedEntry">nsIFeedEntry</a></code> contenant des informations sur l'entrée qui vient d'être analysée.
</dd><dt><tt>result</tt>
</dt><dd> Pointeur vers une <code><a href="fr/NsIFeedResult">nsIFeedResult</a></code> contenant des informations sur l'entrée en cours d'analyse.
</dd></dl>
<h3 id="handleFeedAtFirstEntry.28.29" name="handleFeedAtFirstEntry.28.29">handleFeedAtFirstEntry()</h3>
<p>Appelée lorsque la première entrée ou le premier élément du flux est rencontré. Dans les flux Atom, toutes les données du flux doivent précéder les entrées ; dans les flux RSS ce n'est pas une obligation, mais c'est généralement respecté. En d'autres termes, lorsque cette méthode est appelée, il est très probable que toutes ou la plupart des métadonnées du flux ont été analysées et sont disponibles dans l'objet <code><a href="fr/NsIFeedResult">nsIFeedResult</a></code> reçu.
</p>
<pre class="eval"> void handleFeedAtFirstEntry(
   in nsIFeedResult result
 );
</pre>
<h6 id="Param.C3.A8tres_2" name="Param.C3.A8tres_2">Paramètres</h6>
<dl><dt><tt>result</tt>
</dt><dd>Une <code><a href="fr/NsIFeedResult">nsIFeedResult</a></code> décrivant le flux lorsque la première entrée est trouvée, mais avant son traitement.
</dd></dl>
<div class="note"><b>Note :</b> Si le type de flux est une entrée ou un élément unique, cet événement n'est jamais appelé.</div>
<h3 id="handleStartFeed.28.29" name="handleStartFeed.28.29">handleStartFeed()</h3>
<p>Appelée dès qu'un début acceptable d'un flux est détecté ; ceci informe votre code que le flux semble bien être un flux de news et non un autre type document.
</p>
<pre class="eval"> void handleStartFeed(
   in nsIFeedResult result
 );
</pre>
<h6 id="Param.C3.A8tres_3" name="Param.C3.A8tres_3">Paramètres</h6>
<dl><dt><tt>result</tt>
</dt><dd> Un <code><a href="fr/NsIFeedResult">nsIFeedResult</a></code> décrivant l'état du flux au début de son analyse.
</dd></dl>
<h3 id="reportError.28.29" name="reportError.28.29">reportError()</h3>
<p>Appelée par le processeur de flux lorsque se produit une erreur d'analyse XML fatale, ou si le document n'est pas un flux.
</p>
<pre class="eval"> void reportError(
   in AString errorText,
   in long lineNumber,
   in boolean bozo
 );
</pre>
<p>Chaque méthode reçoit comme entrée au moins un <code><a href="fr/NsIFeedResult">nsIFeedResult</a></code> qui décrit l'état actuel du traitement.
</p>
<h2 id="Voir_.C3.A9galement" name="Voir_.C3.A9galement">Voir également</h2>
<p><a href="fr/NsIFeedResultListener">nsIFeedResultListener</a>
</p><p><br>
<span class="comment">Liens Interwiki</span>
</p>{{ languages( { "en": "en/NsIFeedProgressListener" } ) }}
Revenir à cette révision