Sommaire

Fournisseur de reflet

Acteur fournisseur de reflet. Permet d’indiquer à un requêteur de reflet d’aller chercher un reflet supplémentaire dans sa requête.

🔧 propriété · ℹ️ information · ⚙️ méthode · ⚡ évènement · 🔒 lecture seule

Propriétés

Chemin relatif

this.properties.relativePath · string · défaut ''

Chemin relatif vers le reflet Le chemin sera complété par le requêteur défini dans la propriété requesterKey ou récupéré dans le contexte.

Clé du requêteur

this.properties.requesterKey · string · défaut null

Clé de l’acteur requêteur de reflet.

Mode de lecture

this.properties.dataReadMode · 'always' | 'onetime' · défaut 'onetime'

Mode de lecture des valeurs du reflet.

  • always : Récupération des valeurs à chaque fois que le requêteur effectue une requête,
  • onetime: Récupération des valeurs qu’une fois par le requêteur. Ce sera fait dès que possible.

Informations

Accessibles par script, via this dans un script de l’acteur ou context.getActor('clé') depuis un autre acteur.

autoRefreshing

this.autoRefreshing · 🔒 lecture seule · Boolean

Indique si le rafraîchissement automatique est actif.

data

this.data · 🔒 lecture seule · Reflect

Obtient ou définit la donnée exposée.

error

this.error · 🔒 lecture seule · String ou null

Erreur de requête.

fullPath

this.fullPath · 🔒 lecture seule · string

Obtient le chemin complet vers le reflet.

hasError

this.hasError · 🔒 lecture seule · Boolean

Indique s’il y a eu une erreur de requête.

isCommanding

this.isCommanding

Indique si la requête de commande est en cours.

isFirstRequestDone

this.isFirstRequestDone · 🔒 lecture seule · boolean

Indique si la première requête a été faite.

isRequesting

this.isRequesting · 🔒 lecture seule · Boolean

Requête en cours ?

isValorized

this.isValorized · 🔒 lecture seule

Indique si la donnée a été valorisée.

lastRequestDate

this.lastRequestDate · 🔒 lecture seule · String ou null

Date de la dernière requête (ISO 8601), null avant la première.

requesterSource

this.requesterSource · 🔒 lecture seule · Actor.ReflectRequesterBase ou null

Obtient le requêteur de reflet source.

Méthodes

refresh()

this.refresh()

Effectue un rafraîchissement de la donnée.

request()

this.request() · renvoie Promise<Any>

Effectue une requête.

requestDebounce()

this.requestDebounce() · renvoie Promise<any>

Effectue une requête retardée. Si une requête est déjà en cours, elle part à sa fin.

write(params?)

this.write(params?) · renvoie Promise<Object null>

Envoie la commande du reflet si elle est autorisée (data.allowCommand), puis rafraîchit la donnée par défaut (withRefreshAfter).

  • params : Options de l’envoi ; sans elles, la donnée est rafraîchie.
  • params.withRefreshAfter : Recharge la valeur du reflet après la commande. Si params est donné, elle n’est rechargée que si cette option vaut true.

Événements

Les évènements communs à tous les acteurs sont décrits avec l’acteur de base.

onDidDataRefresh

Se produit lorsque les valeurs du reflet sont rafraichies.

context : contexte d’évènement, avec en plus :

Membre de context Type Description
data Reflect Le reflet rafraichi.

onDidDataStore

Se produit lorsque le reflet est stocké dans data.

context : contexte d’évènement, avec en plus :

Membre de context Type Description
data Reflect Le reflet stocké.

onRequestDone

Se produit lorsque la requête s’est terminée.

context : contexte d’évènement, avec en plus :

Membre de context Type Description
error String ou Object ou null Une erreur éventuelle
data any La donnée

onWriteDone

Se produit lorsque la requête d’écriture s’est terminée.

context : contexte d’évènement, avec en plus :

Membre de context Type Description
error String ou Object ou null Une erreur éventuelle
data any La donnée

Hérite de

Outre ce qui est décrit ici, l’acteur a tout ce que décrit l’acteur de base : propriétés communes (taille, disposition, aspect, texte, bordures, effets…), évènements communs (cycle de vie, souris, clavier…) et membres accessibles par script.

Il hérite aussi de :

  • DataSource : Classe de base pour fournisseur de donnée. Permet de paramétrer les requêtes et d’exposer une donnée pour des liaisons ou accessible par script.
  • Requesterable (comportement) : Attribut la possibilité à un acteur de réaliser des requêtes.