nsIFeedProgressListener

Un article de MDC.

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.

nsiFeedProgressListener est définie dans toolkit/components/feeds/public/nsiFeedListener.idl, et elle est non figée (n'a pas été modifiée depuis Mozilla 1.8.1). Cette interface est scriptable.

Hérité de : nsIFeedResultListener

[modifier] Synoptique

[modifier] Méthodes

[modifier] 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
 );

[modifier] Paramètres

entry

Pointeur vers une nsIFeedEntry contenant des informations sur l'entrée qui vient d'être analysée.

result

Pointeur vers une nsIFeedResult contenant des informations sur l'entrée en cours d'analyse.

[modifier] 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
 );

[modifier] Paramètres

result

Une nsIFeedResult décrivant le flux lorsque la première entrée est trouvée, mais avant son traitement.

[modifier] 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
 );

[modifier] Paramètres

result

Un nsIFeedResult décrivant l'état du flux au début de son analyse.

[modifier] 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.

[modifier] Voir également

nsIFeedResultListener