API docs for “twisted.web2.dav.idav.IDAVResource”

Line #	Kind	Name	Docs
37	Method	isCollection	Checks whether this resource is a collection resource.
44	Method	findChildren	Returns an iterable of child resources for the given depth.
54	Method	hasProperty	Checks whether the given property is defined on this resource.
64	Method	readProperty	Reads the given property on this resource.
77	Method	writeProperty	Writes the given property on this resource.
87	Method	removeProperty	Removes the given property from this resource.
98	Method	listProperties
105	Method	principalCollections	Provides the URIs of collection resources which contain principal
114	Method	accessControlList
120	Method	supportedPrivileges

Inherited from IResource:

Line #	Kind	Name	Docs
20	Method	locateChild	Locate another object which can be adapted to IResource.
37	Method	renderHTTP	Return an IResponse or a deferred which will fire an

Line #	Kind	Name	Docs
114	Method	accessControlList
44	Method	findChildren	Returns an iterable of child resources for the given depth.
54	Method	hasProperty	Checks whether the given property is defined on this resource.
37	Method	isCollection	Checks whether this resource is a collection resource.
98	Method	listProperties
20	Method	locateChild	Locate another object which can be adapted to IResource.
105	Method	principalCollections	Provides the URIs of collection resources which contain principal
64	Method	readProperty	Reads the given property on this resource.
87	Method	removeProperty	Removes the given property from this resource.
37	Method	renderHTTP	Return an IResponse or a deferred which will fire an
120	Method	supportedPrivileges
77	Method	writeProperty	Writes the given property on this resource.

def isCollection(): (source)

Checks whether this resource is a collection resource.

Returns True if this resource is a collection resource, False otherwise.

def findChildren(depth): (source)

Returns an iterable of child resources for the given depth. Because resources do not know their request URIs, chidren are returned as tuples (resource, uri), where resource is the child resource and uri is a URL path relative to this resource.

Parameters	depth	the search depth (one of `"0"`, `"1"`, or `"infinity"`)
Returns	an iterable of tuples `(resource, uri)`.

def hasProperty(property, request): (source)

Checks whether the given property is defined on this resource.

Parameters	property	an empty `davxml.WebDAVElement` instance or a qname tuple.
	request	the request being processed.
Returns	a deferred value of `True` if the given property is set on this resource, or `False` otherwise.

def readProperty(property, request): (source)

Reads the given property on this resource.

Parameters	property	an empty `davxml.WebDAVElement` class or instance, or a qname tuple.
	request	the request being processed.
Returns	a deferred `davxml.WebDAVElement` instance containing the value of the given property.
Raises	HTTPError	(containing a response with a status code of `responsecode.CONFLICT`) if `property` is not set on this resource.

def writeProperty(property, request): (source)

Writes the given property on this resource.

Parameters	property	a `davxml.WebDAVElement` instance.
	request	the request being processed.
Returns	an empty deferred which fires when the operation is completed.
Raises	HTTPError	(containing a response with a status code of `responsecode.CONFLICT`) if `property` is a read-only property.

def removeProperty(property, request): (source)

Removes the given property from this resource.

Parameters	property	a `davxml.WebDAVElement` instance or a qname tuple.
	request	the request being processed.
Returns	an empty deferred which fires when the operation is completed.
Raises	HTTPError	(containing a response with a status code of `responsecode.CONFLICT`) if `property` is a read-only property or if the property does not exist.

def listProperties(request): (source)

Parameters	request	the request being processed.
Returns	a deferred iterable of qnames for all properties defined for this resource.

def principalCollections(): (source)

Provides the URIs of collection resources which contain principal resources which may be used in access control entries on this resource. (RFC 3744, section 5.8)

Returns a sequence of URIs referring to collection resources which implement the DAV:principal-property-search REPORT.

def accessControlList(): (source)

Returns the davxml.ACL element containing the access control list for this resource.

Interface t.w.d.i.IDAVResource(IResource):