Guide de référence ActionScript® 3.0 pour la plate-forme Adobe® Flash®
Accueil  |  Masquer la liste des packages et des classes |  Packages  |  Classes  |  Nouveautés  |  Index  |  Annexes  |  Pourquoi existe-t-il du contenu en anglais ?
Filtres : Récupération des données du serveur...
Récupération des données du serveur...
mx.rpc.soap 

Operation  - AS3 Flex

Packagemx.rpc.soap
Classepublic class Operation
HéritageOperation Inheritance AbstractOperation Inheritance AbstractInvoker Inheritance EventDispatcher Inheritance Object
Sous-classes Operation

Version du langage: ActionScript 3.0
Version du produit: Flex 3
Versions du moteur d’exécution: Flash Player 9, AIR 1.1

Opération utilisée spécialement par les classes WebService. Une opération est une méthode individuelle sur un service. Une opération peut être appelée en invoquant la fonction du même nom sur le service ou en accédant à l’opération en tant que propriété sur le service et en appelant la méthode send().



Propriétés publiques
 PropriétéDéfini par
 Inheritedarguments : Object
Arguments à transmettre à l’opération lorsqu’elle est invoquée.
AbstractOperation
 Inheritedconstructor : Object
Référence à l’objet de classe ou à la fonction constructeur d’une occurrence donnée d’un objet.
Object
  endpointURI : String
Emplacement de la classe WebService de cette opération.
Operation
  forcePartArrays : Boolean
Détermine si oui ou non une valeur de retour unique ou vide d’une partie de message de sortie définie comme tableau doit être renvoyée en tant que tableau contenant un (ou zéro, respectivement) élément.
Operation
  headerFormat : String
Détermine comment les en-têtes codés SOAP sont décodés.
Operation
  headers : Array
[lecture seule] Accesseur à un tableau d’en-têtes SOAPHeaders devant être envoyés à chaque invocation de l’opération.
Operation
  httpHeaders : Object
En-têtes HTTP personnalisés devant être envoyés à l’extrémité SOAP.
Operation
  ignoreWhitespace : Boolean
Détermine si l’espace blanc est ignoré lors du traitement de XML pour une demande ou réponse codée SOAP.
Operation
 InheritedlastResult : Object
[lecture seule] Résultat de la dernière invocation.
AbstractInvoker
  makeObjectsBindable : Boolean
[override] Lorsque cette valeur est true, les objets anonymes renvoyés sont forcés sur des objets liables.
Operation
  multiplePartsFormat : String
Détermine le type de l’objet de résultat par défaut pour les appels à des services Web qui définissent plusieurs parties dans le message de sortie.
Operation
 Inheritedname : String
Nom de cette opération.
AbstractOperation
 InheritedoperationManager : Function
Cette propriété est généralement définie par le code de structure qui désire modifier le comportement d’une invocation de service sans modifier la manière dont le service est appelé en externe.
AbstractInvoker
 Inheritedproperties : Object
Il s’agit d’un crochet permettant essentiellement aux développeurs de structures d’enregistrer d’autres propriétés spécifiées par l’utilisateur pour votre opération.
AbstractOperation
  request : Object
La demande de l’opération est une structure d’objet ou une structure XML.
Operation
 InheritedresultElementType : Class
Comme resultType, utilisé pour définir la classe ActionScript utilisée par une opération donnée, bien que cette propriété ne s’applique qu’aux opérations qui renvoient un résultat à plusieurs valeurs (par exemple,
AbstractInvoker
  resultFormat : String
Détermine comment le résultat de l’opération est décodé.
Operation
  resultHeaders : Array
[lecture seule] En-tête ayant été renvoyées dans le cadre de la dernière exécution de cette opération.
Operation
 InheritedresultType : Class
Spécifie un type de retour facultatif pour l’opération.
AbstractInvoker
 Inheritedservice : AbstractService
[lecture seule] Fournit un accès pratique au service sur lequel l’opération est invoquée.
AbstractOperation
  xmlSpecialCharsFilter : Function
Spécifie une fonction personnalisée à utiliser pour ignorer les caractères spéciaux XML avant de coder un contenu simple.
Operation
Méthodes publiques
 MéthodeDéfini par
  
Operation(webService:AbstractService = null, name:String = null)
Crée une nouvelle opération.
Operation
 Inherited
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Enregistre un objet écouteur d’événement auprès d’un objet EventDispatcher afin que l’écouteur soit averti d’un événement.
EventDispatcher
  
Ajoute un en-tête qui n’est appliqué qu’à cette opération.
Operation
  
addSimpleHeader(qnameLocal:String, qnameNamespace:String, headerName:String, headerValue:String):void
Ajoute un en-tête qui n’est appliqué qu’à cette opération.
Operation
  
[override] Annule la dernière invocation de service ou une invocation comportant l’ID spécifié.
Operation
  
Efface les en-têtes de cette opération individuelle.
Operation
 Inherited
clearResult(fireBindingEvent:Boolean = true):void
Définit la propriété result de l’invocateur sur null.
AbstractInvoker
 Inherited
Distribue un événement dans le flux d’événements.
EventDispatcher
  
getHeader(qname:QName, headerName:String = null):SOAPHeader
Renvoie un en-tête si une correspondance est trouvée en fonction du nom localName QName et de l’URI.
Operation
 Inherited
Vérifie si des écouteurs sont enregistrés auprès de l’objet EventDispatcher pour un type spécifique d’événement.
EventDispatcher
 Inherited
Indique si la propriété spécifiée d’un objet est définie.
Object
 Inherited
Indique si une occurrence de la classe Object figure dans la chaîne de prototype de l’objet spécifié en tant que paramètre.
Object
 Inherited
Indique si la propriété spécifiée existe et est énumérable.
Object
 Inherited
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
Supprime un écouteur de l’objet EventDispatcher.
EventDispatcher
  
removeHeader(qname:QName, headerName:String = null):void
Supprime de toutes les opérations l’en-tête portant le nom QName donné.
Operation
 Inherited
Exécute la méthode.
AbstractOperation
 Inherited
Définit la disponibilité d’une propriété dynamique pour les opérations en boucle.
Object
 Inherited
Ce crochet est exposé pour mettre à jour la propriété lastResult.
AbstractInvoker
 Inherited
Renvoie la représentation de chaîne de cet objet, formatée selon les paramètres régionaux en vigueur.
Object
 Inherited
Renvoie la représentation sous forme de chaîne de l’objet spécifié.
Object
 Inherited
Renvoie la valeur primitive de l’objet spécifié.
Object
 Inherited
Vérifie si un écouteur d’événement est enregistré auprès de cet objet EventDispatcher ou de ses ancêtres pour le type d’événement spécifié.
EventDispatcher
Evénements
 Evénement Synthèse Défini par
 Inherited[Evénement de diffusion] Distribué lorsque l’application Flash Player obtient le focus du système d’exploitation et devient active.EventDispatcher
 Inherited[Evénement de diffusion] Distribué lorsque l’application Flash Player ou AIR perd le focus du système d’exploitation et devient inactive.EventDispatcher
 InheritedDistribué lorsqu’une opération échoue.AbstractOperation
  Distribué lorsqu’une opération d’invocation est renvoyée avec des en-têtes SOAP dans la réponse.Operation
 InheritedDistribué lorsqu’une invocation d’opération réussit.AbstractOperation
Détails de la propriété

endpointURI

propriété
endpointURI:String

Version du langage: ActionScript 3.0
Version du produit: Flex 3
Versions du moteur d’exécution: Flash Player 9, AIR 1.1

Emplacement de la classe WebService de cette opération. Normalement, le document WSDL spécifie l’emplacement des services, mais vous pouvez définir cette propriété afin de remplacer cet emplacement pour l’opération individuelle.



Implémentation
    public function get endpointURI():String
    public function set endpointURI(value:String):void

forcePartArrays

propriété 
forcePartArrays:Boolean

Version du langage: ActionScript 3.0
Version du produit: Flex 3
Versions du moteur d’exécution: Flash Player 9, AIR 1.1

Détermine si oui ou non une valeur de retour unique ou vide d’une partie de message de sortie définie comme tableau doit être renvoyée en tant que tableau contenant un (ou zéro, respectivement) élément. Cela s’applique aux services Web « enveloppés » document/littéraux, où un ou plusieurs des éléments qui représentent des parties de message individuelles dans la séquence « enveloppante » peuvent comporter l’attribut maxOccurs défini sur une valeur supérieure à 1. Cela est une suggestion indiquant que la partie correspondante doit être traitée comme un tableau même si la réponse contient zéro ou une valeur pour cette partie. Définir forcePartArrays sur true créera toujours un tableau pour les parties définies de cette manière, quel que soit le nombre de valeurs renvoyées. Laisser forcePartArrays sur false ne créera des tableaux que si deux éléments ou plus sont renvoyés.



Implémentation
    public function get forcePartArrays():Boolean
    public function set forcePartArrays(value:Boolean):void

headerFormat

propriété 
headerFormat:String

Version du langage: ActionScript 3.0
Version du produit: Flex 3
Versions du moteur d’exécution: Flash Player 9, AIR 1.1

Détermine comment les en-têtes codés SOAP sont décodés. Une valeur object spécifie que chaque nœud XML d’en-tête sera décodé en un objet SOAPHeader et que sa propriété content sera une structure d’objet tel que spécifié dans le document WSDL. Une valeur xml spécifie que le XML sera laissé en tant que nœuds XMLNode. Une valeur e4x spécifie que le XML sera accessible via ECMAScript pour les expressions XML (E4X).



Implémentation
    public function get headerFormat():String
    public function set headerFormat(value:String):void

headers

propriété 
headers:Array  [lecture seule]

Version du langage: ActionScript 3.0
Version du produit: Flex 3
Versions du moteur d’exécution: Flash Player 9, AIR 1.1

Accesseur à un tableau d’en-têtes SOAPHeaders devant être envoyés à chaque invocation de l’opération.



Implémentation
    public function get headers():Array

httpHeaders

propriété 
httpHeaders:Object

Version du langage: ActionScript 3.0
Version du produit: Flex 3
Versions du moteur d’exécution: Flash Player 9, AIR 1.1

En-têtes HTTP personnalisés devant être envoyés à l’extrémité SOAP. Si plusieurs en-têtes doivent être envoyés avec le même nom, la valeur doit être spécifiée en tant que tableau.



Implémentation
    public function get httpHeaders():Object
    public function set httpHeaders(value:Object):void

ignoreWhitespace

propriété 
ignoreWhitespace:Boolean

Version du langage: ActionScript 3.0
Version du produit: Flex 3
Versions du moteur d’exécution: Flash Player 9, AIR 1.1

Détermine si l’espace blanc est ignoré lors du traitement de XML pour une demande ou réponse codée SOAP. La valeur par défaut est true, ce qui signifie que l’espace blanc n’est pas préservé. Si une définition de type schéma XML spécifie une restriction whiteSpace définie sur preserve, ignoreWhitespace doit d’abord être défini sur false. A l’inverse, si une restriction whiteSpace est définie sur replace ou collapse, ce paramètre est honoré même si ignoreWhitespace est défini sur false.



Implémentation
    public function get ignoreWhitespace():Boolean
    public function set ignoreWhitespace(value:Boolean):void

makeObjectsBindable

propriété 
makeObjectsBindable:Boolean[override]

Version du langage: ActionScript 3.0
Version du produit: Flex 3
Versions du moteur d’exécution: Flash Player 9, AIR 1.1

Lorsque cette valeur est true, les objets anonymes renvoyés sont forcés sur des objets liables.



Implémentation
    override public function get makeObjectsBindable():Boolean
    override public function set makeObjectsBindable(value:Boolean):void

multiplePartsFormat

propriété 
multiplePartsFormat:String

Version du langage: ActionScript 3.0
Version du produit: Flex 3
Versions du moteur d’exécution: Flash Player 9, AIR 1.1

Détermine le type de l’objet de résultat par défaut pour les appels à des services Web qui définissent plusieurs parties dans le message de sortie. Une valeur « object » spécifie que le dernier objet lastResult sera un objet avec des propriétés nommées correspondant aux parties de message individuelles. Une valeur « array » ferait de l’objet lastResult un tableau, dans lequel les valeurs de parties sont envoyées dans l’ordre dans lequel elles apparaissent dans le corps du message SOAP. La valeur par défaut des opérations document-littérales est « object ». La valeur par défaut des opérations rpc est « array ». La propriété multiplePartsFormat n’est applicable que si resultFormat est « object » et ignorée dans le cas contraire.



Implémentation
    public function get multiplePartsFormat():String
    public function set multiplePartsFormat(value:String):void

request

propriété 
request:Object

Version du langage: ActionScript 3.0
Version du produit: Flex 3
Versions du moteur d’exécution: Flash Player 9, AIR 1.1

La demande de l’opération est une structure d’objet ou une structure XML. Si vous spécifiez XML, le XML est envoyé tel quel. Si vous transmettez un objet, il est codé dans une structure WML SOAP.



Implémentation
    public function get request():Object
    public function set request(value:Object):void

resultFormat

propriété 
resultFormat:String

Version du langage: ActionScript 3.0
Version du produit: Flex 3
Versions du moteur d’exécution: Flash Player 9, AIR 1.1

Détermine comment le résultat de l’opération est décodé. Une valeur object spécifie que le XML sera décodé en une structure d’objet tel que spécifié dans le document WSDL. Une valeur xml spécifie que le XML sera laissé en tant que nœuds XMLNode. Une valeur e4x spécifie que le XML sera accessible via ECMAScript pour les expressions XML (E4X).



Implémentation
    public function get resultFormat():String
    public function set resultFormat(value:String):void

resultHeaders

propriété 
resultHeaders:Array  [lecture seule]

Version du langage: ActionScript 3.0
Version du produit: Flex 3
Versions du moteur d’exécution: Flash Player 9, AIR 1.1

En-tête ayant été renvoyées dans le cadre de la dernière exécution de cette opération. Ils correspondent à la propriété lastResult et sont les mêmes que en-têtes distribués individuellement en tant qu’événements HeaderEvents.

Cette propriété peut être utilisée comme source de la liaison de données. Lorsque cette propriété est modifiée, elle distribue l’événement resultForBinding .



Implémentation
    public function get resultHeaders():Array

xmlSpecialCharsFilter

propriété 
xmlSpecialCharsFilter:Function

Version du langage: ActionScript 3.0
Version du produit: Flex 3
Versions du moteur d’exécution: Flash Player 9, AIR 1.1

Spécifie une fonction personnalisée à utiliser pour ignorer les caractères spéciaux XML avant de coder un contenu simple. Valide pour toutes les opérations effectuées sur les services Web sauf si remplacé spécifiquement au niveau opérationnel. Si aucune fonction n’est fournie, valeurs par défaut définies par l’implémentation particulière d’IXMLEncoder.



Implémentation
    public function get xmlSpecialCharsFilter():Function
    public function set xmlSpecialCharsFilter(value:Function):void
Détails du constructeur

Operation

()Constructeur
public function Operation(webService:AbstractService = null, name:String = null)

Version du langage: ActionScript 3.0
Version du produit: Flex 3
Versions du moteur d’exécution: Flash Player 9, AIR 1.1

Crée une nouvelle opération. Cela est généralement effectué directement par le compilateur MXML ou automatiquement par la classe WebService lorsque l’utilisateur accède à une opération inconnue. Il n’est pas recommandé qu’un développeur utilise ce constructeur directement.

Paramètres
webService:AbstractService (default = null) — Service Web à l’issue duquel cette opération est invoquée.
 
name:String (default = null) — Nom de cette opération.
Détails de la méthode

addHeader

()méthode
public function addHeader(header:Object):void

Version du langage: ActionScript 3.0
Version du produit: Flex 3
Versions du moteur d’exécution: Flash Player 9, AIR 1.1

Ajoute un en-tête qui n’est appliqué qu’à cette opération. L’en-tête peut être fourni dans un format précodé en tant qu’instance XML ou en tant qu’instance SOAPHeader qui laisse le codeur SOAP interne se charger du codage.

Paramètres

header:Object — En-tête SOAP à ajouter à cette opération.

addSimpleHeader

()méthode 
public function addSimpleHeader(qnameLocal:String, qnameNamespace:String, headerName:String, headerValue:String):void

Version du langage: ActionScript 3.0
Version du produit: Flex 3
Versions du moteur d’exécution: Flash Player 9, AIR 1.1

Ajoute un en-tête qui n’est appliqué qu’à cette opération.

Paramètres

qnameLocal:String — Nom local du QName de l’en-tête.
 
qnameNamespace:String — Espace de noms du QName de l’en-tête.
 
headerName:String — Nom de l’en-tête.
 
headerValue:String — Valeur de l’en-tête.

cancel

()méthode 
override public function cancel(id:String = null):mx.rpc:AsyncToken

Version du langage: ActionScript 3.0
Version du produit: Flex 3
Versions du moteur d’exécution: Flash Player 9, AIR 1.1

Annule la dernière invocation de service ou une invocation comportant l’ID spécifié. Même s’il se peut que l’opération de réseau se poursuive, aucun événement de résultat ou d’erreur n’est distribué.

Paramètres

id:String (default = null) — ID messageId de l’invocation à annuler. Facultatif. Si omis, la dernière invocation de service est annulée.

Valeur renvoyée
mx.rpc:AsyncToken — Classe AsyncToken associée à l’appel qui est annulé ou null si aucun appel n’a été annulé.

clearHeaders

()méthode 
public function clearHeaders():void

Version du langage: ActionScript 3.0
Version du produit: Flex 3
Versions du moteur d’exécution: Flash Player 9, AIR 1.1

Efface les en-têtes de cette opération individuelle.

getHeader

()méthode 
public function getHeader(qname:QName, headerName:String = null):SOAPHeader

Version du langage: ActionScript 3.0
Version du produit: Flex 3
Versions du moteur d’exécution: Flash Player 9, AIR 1.1

Renvoie un en-tête si une correspondance est trouvée en fonction du nom localName QName et de l’URI.

Paramètres

qname:QName — Nom QName de l’en-tête SOAPHeader.
 
headerName:String (default = null) — Nom d’un en-tête dans le contenu SOAPHeader (facultatif).

Valeur renvoyée
SOAPHeader — Renvoie l’en-tête SOAPHeader.

removeHeader

()méthode 
public function removeHeader(qname:QName, headerName:String = null):void

Version du langage: ActionScript 3.0
Version du produit: Flex 3
Versions du moteur d’exécution: Flash Player 9, AIR 1.1

Supprime de toutes les opérations l’en-tête portant le nom QName donné.

Paramètres

qname:QName — Nom QName de l’en-tête SOAPHeader.
 
headerName:String (default = null) — Nom d’un en-tête dans le contenu SOAPHeader (facultatif).

Détails de l’événement

header

Evénement
Type d’objet d’événement: mx.rpc.events.HeaderEvent
propriété HeaderEvent.type = mx.rpc.events.HeaderEvent.HEADER

Version du langage: ActionScript 3.0
Version du produit: Flex 3
Versions du moteur d’exécution: Flash Player 9, AIR 1.1

Distribué lorsqu’une opération d’invocation est renvoyée avec des en-têtes SOAP dans la réponse. Un événement HeaderEvent est distribué pour chaque en-tête SOAP.

Type d’événement HEADER.

Les valeurs des propriétés de l’objet d’événement sont les suivantes :

PropriétéValeur
bubblesfalse
tokenJeton représentant l’appel à la méthode. Utilisé dans le modèle de jeton d’achèvement asynchrone.
cancelableLa valeur par défaut est true, mais la méthode preventDefault() est sans effet.
currentTargetObjet définissant l’écouteur d’événement qui traite l’événement. Par exemple, si vous utilisez myButton.addEventListener() pour enregistrer un écouteur d’événement, myButton est la valeur de currentTarget.
en-têteEn-tête que l’appel RPC renvoie dans la réponse.
messageMessage associé à cet événement.
targetObjet qui a distribué l’événement (il ne s’agit pas toujours de l’objet qui écoute l’événement). Pour accéder systématiquement à l’objet qui écoute l’événement, utilisez la propriété currentTarget.




[ X ]Pourquoi existe-t-il du contenu en anglais ?
Certaines parties du Guide de référence ActionScript 3.0 sont en anglais

Tout le contenu du Guide de référence ActionScript 3.0 n’a pas été traduit dans toutes les langues. Si un élément de langage n’est pas traduit, il s’affiche en anglais. Par exemple, la classe ga.controls.HelpBox n’est traduite dans aucune langue. Ainsi, dans la version française du guide de référence, la classe ga.controls.HelpBox apparaît en anglais.