Requêteur de reflet
Acteur requêteur de reflet. Permet de paramétrer les requêtes et d’exposer les reflets pour des liaisons ou accessible par script. Il doit être complété par des fournisseurs de reflet pour effectuer une requête groupée.
🔧 propriété · ℹ️ information · ⚙️ méthode · ⚡ évènement · 🔒 lecture seule
Propriétés
Auto rafraîchissement
this.properties.autoRefresh · boolean · défaut true
Auto rafraîchissement activé?
Chemin
this.properties.path · string · défaut ''
Chemin de la variable WOS depuis :easy.RESS.
Délai rafraîchissement
this.properties.autoRefreshDelay · number · défaut 30
Délai en seconde de rafraîchissement.
Écriture au changement
this.properties.writeOnChange · boolean · défaut false
Écriture dès changement de la donnée activée?
Mode
this.properties.mode · 'manual' | 'relative' · défaut 'relative'
Mode de requête de la donnée.
manual: Les requêtes doivent être commandées par script avec la méthode {{#crossLink “Actor.DataSource/request:method”}}{{/crossLink}} ou {{#crossLink “Actor.DataSource/requestDebounce:method”}}{{/crossLink}},relative: Le comportement est automatique dès que des fournisseurs de reflet sont attachées à cet acteur.
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 · any
Obtient ou définit la donnée exposée.
error
this.error · 🔒 lecture seule · String ou null
Erreur de requête.
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
Indique si la requête est en cours.
isValorized
this.isValorized · 🔒 lecture seule · boolean
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.
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()
this.write()
Envoie les commandes de tous les fournisseurs de reflet commandables, puis rafraîchit la donnée.
Événements
Les évènements communs à tous les acteurs sont décrits avec l’acteur de base.
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
context : contexte d’évènement, avec en plus :
Membre de context | Type | Description |
|---|---|---|
error | ||
data |
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 :
- ReflectRequesterBase : Acteur requêteur de reflet de base. Permet de paramétrer les requêtes et d’exposer les reflets pour des liaisons ou accessible par script. Il doit être complété par des fournisseurs de reflet et des détails de reflet pour effectuer une requête groupée.
- 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.
