Back to index

lightning-sunbird  0.9+nobinonly
Public Member Functions | Public Attributes
nsIWebServiceCallContext Interface Reference

A representation of a method invocation on a web service. More...

import "nsIWebServiceProxy.idl";

Inheritance diagram for nsIWebServiceCallContext:
Inheritance graph
[legend]
Collaboration diagram for nsIWebServiceCallContext:
Collaboration graph
[legend]

List of all members.

Public Member Functions

void abort (in nsIException error)
 Called to abort a pending call.

Public Attributes

const PRUint32 PENDING = 0
 Possible values of the status attribute.
const PRUint32 SUCCEEDED = 1
const PRUint32 FAILED = 2
const PRUint32 ABORTED = 3
readonly attribute
nsIWebServiceProxy 
proxy
 The proxy object on which the call was made.
readonly attribute AString methodName
 The name of the method that was invoked.
readonly attribute PRUint32 status
 The status of the call, whether pending, completed successfully or completed with a fault.
readonly attribute nsIException pendingException
 The exception generated by the call if the status is FAILURE.
readonly attribute nsIWSDLOperation operation
 The WSDL operation that correpsonds to the method being invoked.

Detailed Description

A representation of a method invocation on a web service.

An instance of this interface is returned as a result of making an asynchronous call and can be queried for status of the call.

Definition at line 219 of file nsIWebServiceProxy.idl.


Member Function Documentation

Called to abort a pending call.

If the call is still pending, its callback instance's onError will be invoked, passing in the specified exception.

Parameters:
errorThe exception passed to the callback instance's onError method.

Member Data Documentation

Definition at line 229 of file nsIWebServiceProxy.idl.

Definition at line 228 of file nsIWebServiceProxy.idl.

The name of the method that was invoked.

Definition at line 241 of file nsIWebServiceProxy.idl.

The WSDL operation that correpsonds to the method being invoked.

See also:
nsIWSDLOperation

Definition at line 263 of file nsIWebServiceProxy.idl.

Possible values of the status attribute.

A pending call has a status of PENDING. A completed call has a status of SUCCEEDED or FAILED depending on the result of the call.

Definition at line 226 of file nsIWebServiceProxy.idl.

The exception generated by the call if the status is FAILURE.

The exception object can be introspected for more information. The data member can be QIed to a nsISOAPFault instance for calls that use a SOAP binding.

Definition at line 256 of file nsIWebServiceProxy.idl.

The proxy object on which the call was made.

See also:
nsIWebServiceProxy

Definition at line 236 of file nsIWebServiceProxy.idl.

The status of the call, whether pending, completed successfully or completed with a fault.

Definition at line 247 of file nsIWebServiceProxy.idl.

Definition at line 227 of file nsIWebServiceProxy.idl.


The documentation for this interface was generated from the following file: