Back to index

lightning-sunbird  0.9+nobinonly
Public Member Functions
nsIWebDAVService Interface Reference

import "nsIWebDAVService.idl";

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

List of all members.

Public Member Functions

void lockResources (in PRUint32 count,[array, size_is(count)] in nsIWebDAVResource resources, in nsIWebDAVOperationListener listener, in nsIInterfaceRequestor notificationCallbacks, in nsISupports closure)
void unlockResources (in PRUint32 count,[array, size_is(count)] in nsIWebDAVResource resources, in nsIWebDAVOperationListener listener, in nsIInterfaceRequestor notificationCallbacks, in nsISupports closure)
void getResourcePropertyNames (in nsIWebDAVResource resource, in boolean withDepth, in nsIWebDAVOperationListener listener, in nsIInterfaceRequestor notificationCallbacks, in nsISupports closure)
void getResourceProperties (in nsIWebDAVResource resource, in PRUint32 propCount,[array, size_is(propCount)] in string properties, in boolean withDepth, in nsIWebDAVOperationListener listener, in nsIInterfaceRequestor notificationCallbacks, in nsISupports closure)
void getResourceOptions (in nsIWebDAVResource resource, in nsIWebDAVOperationListener listener, in nsIInterfaceRequestor notificationCallbacks, in nsISupports closure)
void get (in nsIWebDAVResource resource, in nsIStreamListener listener, in nsIInterfaceRequestor notificationCallbacks)
void getToOutputStream (in nsIWebDAVResource resource, in nsIOutputStream stream, in nsIWebDAVOperationListener listener, in nsIInterfaceRequestor notificationCallbacks, in nsISupports closure)
 GET the resource and stick it in the provided OutputStream.
void getToString (in nsIWebDAVResource resource, in nsIWebDAVOperationListener listener, in nsIInterfaceRequestor notificationCallbacks, in nsISupports closure)
 GET the resource and return it to the listener as a string.
void put (in nsIWebDAVResource resource, in ACString contentType, in nsIInputStream data, in nsIWebDAVOperationListener listener, in nsIInterfaceRequestor notificationCallbacks, in nsISupports closure)
void putFromString (in nsIWebDAVResource resource, in ACString contentType, in AUTF8String data, in nsIWebDAVOperationListener listener, in nsIInterfaceRequestor notificationCallbacks, in nsISupports closure)
void remove (in nsIWebDAVResource resource, in nsIWebDAVOperationListener listener, in nsIInterfaceRequestor notificationCallbacks, in nsISupports closure)
void moveTo (in nsIWebDAVResource resource, in ACString destination, in boolean overwrite, in nsIWebDAVOperationListener listener, in nsIInterfaceRequestor notificationCallbacks, in nsISupports closure)
void copyTo (in nsIWebDAVResource resource, in ACString destination, in boolean recursive, in boolean overwrite, in nsIWebDAVOperationListener listener, in nsIInterfaceRequestor notificationCallbacks, in nsISupports closure)
void makeCollection (in nsIWebDAVResource resource, in nsIWebDAVOperationListener listener, in nsIInterfaceRequestor notificationCallbacks, in nsISupports closure)
void report (in nsIWebDAVResource resource, in nsIDOMDocument query, in boolean withDepth, in nsIWebDAVOperationListener listener, in nsIInterfaceRequestor notificationCallbacks, in nsISupports closure)
 Requests the specified report on the given resource with a Depth: header set to zero.

Detailed Description

Definition at line 53 of file nsIWebDAVService.idl.


Member Function Documentation

void nsIWebDAVService::copyTo ( in nsIWebDAVResource  resource,
in ACString  destination,
in boolean  recursive,
in boolean  overwrite,
in nsIWebDAVOperationListener  listener,
in nsIInterfaceRequestor  notificationCallbacks,
in nsISupports  closure 
)
Parameters:
notificationCallbacksThe notification callbacks to be passed to the channel that will be used to perform this opperation. This is set by clients, who wish to provide a means to receive progress, status and protocol-specific notifications.

Interfaces commonly requested include: nsIProgressEventSink, nsIPrompt, and nsIAuthPrompt.

Parameters:
closurecaller-private data returned via listener
void nsIWebDAVService::get ( in nsIWebDAVResource  resource,
in nsIStreamListener  listener,
in nsIInterfaceRequestor  notificationCallbacks 
)
Parameters:
notificationCallbacksThe notification callbacks to be passed to the channel that will be used to perform this opperation. This is set by clients, who wish to provide a means to receive progress, status and protocol-specific notifications.

Interfaces commonly requested include: nsIProgressEventSink, nsIPrompt, and nsIAuthPrompt. XXX need to add a closure param

void nsIWebDAVService::getResourceOptions ( in nsIWebDAVResource  resource,
in nsIWebDAVOperationListener  listener,
in nsIInterfaceRequestor  notificationCallbacks,
in nsISupports  closure 
)
Parameters:
notificationCallbacksThe notification callbacks to be passed to the channel that will be used to perform this opperation. This is set by clients, who wish to provide a means to receive progress, status and protocol-specific notifications.

Interfaces commonly requested include: nsIProgressEventSink, nsIPrompt, and nsIAuthPrompt.

Parameters:
closurecaller-private data returned via listener
void nsIWebDAVService::getResourceProperties ( in nsIWebDAVResource  resource,
in PRUint32  propCount,
[array, size_is(propCount)] in string  properties,
in boolean  withDepth,
in nsIWebDAVOperationListener  listener,
in nsIInterfaceRequestor  notificationCallbacks,
in nsISupports  closure 
)
Parameters:
propertiesan array of propertynames, where the namespace and the name of the properties are seperated by a space
notificationCallbacksThe notification callbacks to be passed to the channel that will be used to perform this opperation. This is set by clients, who wish to provide a means to receive progress, status and protocol-specific notifications.

Interfaces commonly requested include: nsIProgressEventSink, nsIPrompt, and nsIAuthPrompt.

Parameters:
closurecaller-private data returned via listener
void nsIWebDAVService::getResourcePropertyNames ( in nsIWebDAVResource  resource,
in boolean  withDepth,
in nsIWebDAVOperationListener  listener,
in nsIInterfaceRequestor  notificationCallbacks,
in nsISupports  closure 
)
Parameters:
notificationCallbacksThe notification callbacks to be passed to the channel that will be used to perform this opperation. This is set by clients, who wish to provide a means to receive progress, status and protocol-specific notifications.

Interfaces commonly requested include: nsIProgressEventSink, nsIPrompt, and nsIAuthPrompt.

Parameters:
closurecaller-private data returned via listener
void nsIWebDAVService::getToOutputStream ( in nsIWebDAVResource  resource,
in nsIOutputStream  stream,
in nsIWebDAVOperationListener  listener,
in nsIInterfaceRequestor  notificationCallbacks,
in nsISupports  closure 
)

GET the resource and stick it in the provided OutputStream.

Your output stream must be buffered, or we will fail miserably. I would check that for you and provide a buffered wrapper automatically, but there is no way to check if one is needed!

Parameters:
notificationCallbacksThe notification callbacks to be passed to the channel that will be used to perform this opperation. This is set by clients, who wish to provide a means to receive progress, status and protocol-specific notifications.

Interfaces commonly requested include: nsIProgressEventSink, nsIPrompt, and nsIAuthPrompt.

Parameters:
closurecaller-private data returned via listener
void nsIWebDAVService::getToString ( in nsIWebDAVResource  resource,
in nsIWebDAVOperationListener  listener,
in nsIInterfaceRequestor  notificationCallbacks,
in nsISupports  closure 
)

GET the resource and return it to the listener as a string.

Parameters:
notificationCallbacksThe notification callbacks to be passed to the channel that will be used to perform this opperation. This is set by clients, who wish to provide a means to receive progress, status and protocol-specific notifications.

Interfaces commonly requested include: nsIProgressEventSink, nsIPrompt, and nsIAuthPrompt.

Parameters:
closurecaller-private data returned via listener
void nsIWebDAVService::lockResources ( in PRUint32  count,
[array, size_is(count)] in nsIWebDAVResource  resources,
in nsIWebDAVOperationListener  listener,
in nsIInterfaceRequestor  notificationCallbacks,
in nsISupports  closure 
)
Parameters:
notificationCallbacksThe notification callbacks to be passed to the channel that will be used to perform this opperation. This is set by clients, who wish to provide a means to receive progress, status and protocol-specific notifications.

Interfaces commonly requested include: nsIProgressEventSink, nsIPrompt, and nsIAuthPrompt.

Parameters:
closurecaller-private data returned via listener
void nsIWebDAVService::makeCollection ( in nsIWebDAVResource  resource,
in nsIWebDAVOperationListener  listener,
in nsIInterfaceRequestor  notificationCallbacks,
in nsISupports  closure 
)
Parameters:
notificationCallbacksThe notification callbacks to be passed to the channel that will be used to perform this opperation. This is set by clients, who wish to provide a means to receive progress, status and protocol-specific notifications.

Interfaces commonly requested include: nsIProgressEventSink, nsIPrompt, and nsIAuthPrompt.

Parameters:
closurecaller-private data returned via listener
void nsIWebDAVService::moveTo ( in nsIWebDAVResource  resource,
in ACString  destination,
in boolean  overwrite,
in nsIWebDAVOperationListener  listener,
in nsIInterfaceRequestor  notificationCallbacks,
in nsISupports  closure 
)
Parameters:
notificationCallbacksThe notification callbacks to be passed to the channel that will be used to perform this opperation. This is set by clients, who wish to provide a means to receive progress, status and protocol-specific notifications.

Interfaces commonly requested include: nsIProgressEventSink, nsIPrompt, and nsIAuthPrompt.

Parameters:
closurecaller-private data returned via listener
void nsIWebDAVService::put ( in nsIWebDAVResource  resource,
in ACString  contentType,
in nsIInputStream  data,
in nsIWebDAVOperationListener  listener,
in nsIInterfaceRequestor  notificationCallbacks,
in nsISupports  closure 
)
Parameters:
notificationCallbacksThe notification callbacks to be passed to the channel that will be used to perform this opperation. This is set by clients, who wish to provide a means to receive progress, status and protocol-specific notifications.

Interfaces commonly requested include: nsIProgressEventSink, nsIPrompt, and nsIAuthPrompt.

Parameters:
closurecaller-private data returned via listener
void nsIWebDAVService::putFromString ( in nsIWebDAVResource  resource,
in ACString  contentType,
in AUTF8String  data,
in nsIWebDAVOperationListener  listener,
in nsIInterfaceRequestor  notificationCallbacks,
in nsISupports  closure 
)
Parameters:
notificationCallbacksThe notification callbacks to be passed to the channel that will be used to perform this opperation. This is set by clients, who wish to provide a means to receive progress, status and protocol-specific notifications.

Interfaces commonly requested include: nsIProgressEventSink, nsIPrompt, and nsIAuthPrompt.

Parameters:
closurecaller-private data returned via listener
void nsIWebDAVService::remove ( in nsIWebDAVResource  resource,
in nsIWebDAVOperationListener  listener,
in nsIInterfaceRequestor  notificationCallbacks,
in nsISupports  closure 
)
Parameters:
notificationCallbacksThe notification callbacks to be passed to the channel that will be used to perform this opperation. This is set by clients, who wish to provide a means to receive progress, status and protocol-specific notifications.

Interfaces commonly requested include: nsIProgressEventSink, nsIPrompt, and nsIAuthPrompt.

Parameters:
closurecaller-private data returned via listener
void nsIWebDAVService::report ( in nsIWebDAVResource  resource,
in nsIDOMDocument  query,
in boolean  withDepth,
in nsIWebDAVOperationListener  listener,
in nsIInterfaceRequestor  notificationCallbacks,
in nsISupports  closure 
)

Requests the specified report on the given resource with a Depth: header set to zero.

Parameters:
resourcethe resource to perform this query on?
queryan XML document of the query
withDepthif true, set the Depth header to 1 instead of 0
listenerresults will be called back through this interface
notificationCallbacksThe notification callbacks to be passed to the channel that will be used to perform this opperation. This is set by clients, who wish to provide a means to receive progress, status and protocol-specific notifications.

Interfaces commonly requested include: nsIProgressEventSink, nsIPrompt, and nsIAuthPrompt.

Parameters:
closurecaller-private data returned via listener
void nsIWebDAVService::unlockResources ( in PRUint32  count,
[array, size_is(count)] in nsIWebDAVResource  resources,
in nsIWebDAVOperationListener  listener,
in nsIInterfaceRequestor  notificationCallbacks,
in nsISupports  closure 
)
Parameters:
notificationCallbacksThe notification callbacks to be passed to the channel that will be used to perform this opperation. This is set by clients, who wish to provide a means to receive progress, status and protocol-specific notifications.

Interfaces commonly requested include: nsIProgressEventSink, nsIPrompt, and nsIAuthPrompt.

Parameters:
closurecaller-private data returned via listener

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