module Tilia::Dav::ICollection
The ICollection
Interface
This interface should be implemented by each class that represents a collection
Public Instance Methods
Returns a specific child node, referenced by its name
This method must throw SabreDAVExceptionNotFound if the node does not exist.
@param string name @return DAVINode
# File lib/tilia/dav/i_collection.rb, line 48 def child(name) end
Checks if a child-node with the specified name exists
@param string name @return bool
# File lib/tilia/dav/i_collection.rb, line 61 def child_exists(name) end
Returns an array with all the child nodes
@return DAVINode[]
# File lib/tilia/dav/i_collection.rb, line 54 def children end
Creates a new subdirectory
@param string name @return void
# File lib/tilia/dav/i_collection.rb, line 38 def create_directory(name) end
Creates a new file in the directory
Data will either be supplied as a stream resource, or in certain cases as a string. Keep in mind that you may have to support either.
After successful creation of the file, you may choose to return the ETag of the new file here.
The returned ETag must be surrounded by double-quotes (The quotes should be part of the actual string).
If you cannot accurately determine the ETag, you should not return it. If you don't store the file exactly as-is (you're transforming it somehow) you should also not return an ETag.
This means that if a subsequent GET to this new file does not exactly return the same contents of what was submitted here, you are strongly recommended to omit the ETag.
@param string name Name of the file @param resource|string data Initial payload @return nil|string
# File lib/tilia/dav/i_collection.rb, line 31 def create_file(name, data = nil) end