Changes

3,341 bytes added , 05:43, 10 April 2009

no edit summary

Line 1: Line 1: +

better formated version at: http://pastebin.com/f3222e122

+

'''org.freedesktop.Telepathy.Connection.Interface.FileSharing.DRAFT'''

Line 10: Line 12:

Methods:

−

CreateFileListing ( s: Title, s: ~~PubSubNodeName~~, s: Description)-> b

+

CreateFileListing ( s: Title, s: File_Listing, s: Description)-> b

−

In order to be able to publish a file ~~on a PubSub server~~ one should have a ~~PubSub~~ node. Here the Discription parameter is optional. Returns whether the ~~FileListing~~ was created ('true') or not ('false').

+

In order to be able to publish a file one should have a File_Listing node. Here the Discription parameter is optional. Returns whether the File_Listing was created ('true') or not ('false').

Parameters

Title - s

−

This will be the title of the ~~pubsub node~~.

+

This will be the title of the File_Listing.

−

~~PubSubNodeName~~ - s

+

File_Listing - s

−

This is how the ~~repository~~ of the user will be referenced.

+

This is how the File_Listing of the user will be referenced.

Discription - s

−

This is optional and can be use to give the discription of the ~~FileListing~~ that is being created.

+

This is optional and can be use to give the discription of the File_Listing that is being created.

Returns

−

Returns 'true' if the ~~FileListing~~ was created and 'false' if it was not.

+

Returns 'true' if the File_Listing was created and 'false' if it was not.

Line 34: Line 39:

org.freedesktop.Telepathy.Error.Disconnected

−

The connection is not currently connected and cannot be used. This error may also be raised when operations are performed on a Connection for which StatusChanged has ~~signalled~~ status Disconnected for reason None.

+

The connection is not currently connected and cannot be used. This error may also be raised when operations are performed on a Connection for which StatusChanged has signaled status Disconnected for reason None.

Line 45: Line 51:

−

AddSubSection ( s: Title, s: ~~PubSubNodeName~~, s: ~~SubSectionPubSubNodeName~~, s: Description) -> b

+

AddSubSection ( s: Title, s: File_Listing_Parent, s: File_Listing_Derived, s: Description) -> b

−

This method is called in order to add a SubSection to an already existing ~~PubSubNode~~. This method returns whether the creation of the SubSection was successful ('true') or not ('false').

+

This method is called in order to add a SubSection (File_Listing_Derived) to an already existing File_Listing (File_Listing_Parent). This method returns whether the creation of the SubSection was successful ('true') or not ('false').

Parameters

Line 54: Line 60:

This will be the title of the subsection.

−

~~PubSubNodeName~~ - s

+

File_Listing_Parent - s

This is how the repository of the user will be referenced.

−

~~SubSectionPubSubNodeName~~ - s

+

File_Listing_Derived - s

This is how the SubSection will be referenced.

Line 75: Line 81:

org.freedesktop.Telepathy.Error.InvalidHandle

−

The ~~PubSubNodeName~~ specified is unknown on this channel or connection. (generic description)

+

The File_Listing_Parent specified is unknown on this channel or connection. (generic description)

org.freedesktop.Telepathy.Error.PermissionDenied

Line 87: Line 93:

−

SuscribeList ( s: ~~PubSubNodeToSubscribe~~, s: ~~SubscriptionType~~, s: ~~SubscriptionDepth~~) -> b

+

SuscribeList ( s: File_List, s: Subscription_Type, s: Subscription_Depth) -> b

−

~~This method is called when one wants to suscribe to a FileList. This method returns whether the subscription was successful ('true') or not ('false').~~

+

This method is called when one wants to suscribe to a File_List. This method returns whether the subscription was successful ('true') or not ('false').

+

note: "no-ops" for AIM

+

Parameters

−

~~PubSubNodeToSubscribe~~ - s

+

File_List - s

−

This is the ~~PubSub node~~ user ~~want~~ to subscibe.

+

This is the File_List user wants to subscibe.

−

~~SubscriptionType~~ - s

+

Subscription_Type - s

This gives the subscription type.

−

~~SubscriptionDepth~~ - s

+

Subscription_Depth - s

Since a pubsub FileListing might have many SubSections,therefore this parameter gives the depth a user want to subscribe to.

Line 105: Line 112:

Returns

−

Returns 'true' if the ~~SubSection~~ was ~~created~~ and 'false' if it was not.

+

Returns 'true' if the subscription was done and 'false' if it was not.

Line 115: Line 122:

org.freedesktop.Telepathy.Error.InvalidHandle

−

The ~~PubSubNodeToSubscribe~~ specified is unknown on this channel or connection. (generic description)

+

The File_List specified is unknown on this channel or connection. (generic description)

+

UnSuscribeList ( s: File_List) -> b

+

This method is called when one wants to unsuscribe to a File_List. This method returns whether the subscription was successful ('true') or not ('false').

+

note: "no-ops" for AIM

+

Parameters

+

File_List - s

+

This is the File_List user wants to unsubscibe from

+

Returns

+

Returns 'true' if the unsubscription was done and 'false' if it was not.

+

Possible Error

+

org.freedesktop.Telepathy.Error.Disconnected

+

The connection is not currently connected and cannot be used. This error may also be raised when operations are performed on a Connection for which StatusChanged has signalled status Disconnected for reason None.

+

org.freedesktop.Telepathy.Error.InvalidHandle

+

The File_List specified is unknown on this channel or connection. (generic description)

+

−

PublishFile ( s: ~~PubSubNodeToAddFile~~, s: Filename, q: ItemId, as: Metadata, s: Mirrors) -> b

+

PublishFile ( s: File_List, s: Filename, q: ItemId, as: Metadata, s: Mirrors) -> b

−

This method is called in order to to add a file to the ~~list~~ of published files. This method returns whether the file was published successfully ('true') or not ('false').

+

This method is called in order to to add a file to the File_List of published files. This method returns whether the file was published successfully ('true') or not ('false').

Parameters

−

~~PubSubNodeToAddFile~~ - s

+

File_List - s

−

This is the ~~PubSub node~~ user ~~want~~ to publish file to.

+

This is the File_List user wants to publish file to.

Filename - s

Line 145: Line 185:

Return

−

Returns 'true' if the ~~FileName~~ was published and 'false' if it was not.

+

Returns 'true' if the Filename was published and 'false' if it was not.

Line 154: Line 194:

org.freedesktop.Telepathy.Error.InvalidHandle

−

The ~~PubSubNodeToAddFile~~ specified is unknown on this channel or connection. (generic description)

+

The File_List specified is unknown on this channel or connection. (generic description)

org.freedesktop.Telepathy.Error.PermissionDenied

Line 164: Line 204:

−

DeleteRevision ( s: ~~PubSubNode~~, q: ~~FileItemId~~) -> b

+

DeleteRevision ( s: File_List, q: File_Item_Id) -> b

−

This method is called in order to delete a revision from the list of published files on a ~~PubSubNode~~. This method returns whether the file was deleted successfully ('true') or not ('false').

+

This method is called in order to delete a revision from the list of published files on a File_List. This method returns whether the file was deleted successfully ('true') or not ('false').

Parameters

−

~~PubSubNode~~ - s

+

File_List - s

−

This is the ~~pubsub node~~ which is holding the file with the ~~ItemId~~ equal to ~~FileItemId~~

+

This is the File_List which is holding the file with the Item_Id equal to File_Item_Id

−

~~FileItemId~~ - q

+

File_Item_Id - q

This is the ItemId of the FileName that has to be deleted

Line 188: Line 228:

org.freedesktop.Telepathy.Error.InvalidHandle

−

The ~~PubSubNode~~ specified is unknown on this channel or connection. (generic description)

+

The File_List specified is unknown on this channel or connection. (generic description)

org.freedesktop.Telepathy.Error.PermissionDenied

Line 199: Line 239: −

MakeRevision ( s: ~~PubSubNodeHostingFile~~, s: Filename, q: ItemId, as: Metadata, s: Mirrors) -> b

+

MakeRevision ( s: File_List, s: Filename, q: ItemId, as: Metadata, s: Mirrors) -> b

−

This method is called in order to make a revision to an existing file on ~~a PubSubNode~~. Use a different ItemId than the original file. This method returns whether the file was revised successfully ('true') or not ('false').

+

This method is called in order to make a revision to an existing file on File_List. Use a different ItemId than the original file. This method returns whether the file was revised successfully ('true') or not ('false').

Parameters

−

~~PubSubNodeHostingFile~~ - s

+

File_List - s

−

This is the ~~PubSub node~~ user want to ~~publish file~~ to.

+

This is the File_List on which the file user want to make revision to is listed.

Filename - s

Line 232: Line 272:

org.freedesktop.Telepathy.Error.InvalidHandle

−

The ~~PubSubNodeHostingFile~~ specified is unknown on this channel or connection. (generic description)

+

The File_List specified is unknown on this channel or connection. (generic description)

org.freedesktop.Telepathy.Error.PermissionDenied

Line 243: Line 283: −

SetPermissions ( s: ~~PubSubNode~~, s: ~~Jid~~, s: Affilation) -> Nothing

+

SetPermissions ( s: File_List, u: User_Handle, s: Affilation) -> Nothing

−

This method is called in order to set permissions for users regarding a ~~PubSubNode~~. This method returns whether ~~the file was revised~~ successfully ('true') or not ('false').

+

This method is called in order to set permissions for users regarding a File_List owned by an owner. This method returns whether permissions were set successfully ('true') or not ('false').

Parameter

−

~~PubSubNode~~ - s

+

File_List - s

−

This is the ~~PubSub node user~~ want to change permission of.

+

This is the File_List owner want to change permission of.

−

~~Jid~~ - s

+

UserHandle - u

−

~~Jid~~ of the user whose permission/affilation are being changed.

+

UserHandle of the user whose permission/affilation are being changed.

Affilation - s

−

This is the permission that will be set ~~gor~~ the ~~Jid~~

+

This is the permission that will be set for the User_Handle

Line 270: Line 310:

org.freedesktop.Telepathy.Error.InvalidHandle

−

The ~~PubSubNode~~ specified is unknown on this channel or connection. (generic description)

+

The File_List specified is unknown on this channel or connection. (generic description)

org.freedesktop.Telepathy.Error.PermissionDenied

Line 279: Line 319:

−

~~GetRepo~~( s: ~~PubSubNode~~) -> as

+

GetRepoList( u: User_Handle ) -> as

−

This method is called to request the ~~Repo~~ hosted ~~on the PubSubNode~~ .

+

This method is called to request the File_list which are hosted by User_Handle.

Parameter

−

~~PubSubNode~~ - s

+

User_Handle - u

−

The ~~PubSub node on which~~ the ~~file repository~~ is ~~hosted~~.

+

The Contact_Handle of the user whose list of hosted File_List is being requested.

Return

−

Returns an array of strings

+

Returns an array of strings where each string represents a File_List hosted by the User.

+

Line 299: Line 340:

org.freedesktop.Telepathy.Error.InvalidHandle

−

The ~~PubSubNode~~ specified is unknown on this channel or connection. (generic description)

+

The User_handle specified is unknown on this channel or connection. (generic description)

+

org.freedesktop.Telepathy.Error.PermissionDenied

+

The user is not permitted to perform the requested operation. (generic description)

Line 309: Line 352:

−

~~RequestFile~~() -> ~~nothing~~

+

GetFileList( s: File_List, u: User_Handle ) -> as

−

~~In order~~ to request ~~for a file to be sent one must request~~ a ~~FileSharing channel for~~ the ~~mirror hosting~~ the file ~~including the following mandatory properties (Protocol, FileId). After this RequestFile~~ is ~~called to to configure the socket that will be used to complete this operation.~~

+

This method is called to request the list of files in a File_List hosted by the user with Contact_Handle as User_Handle.

+

Parameter

+

File_List - s

+

This is the File_List whose list of included file is being requested

+

User_Handle - u

+

The Contact_Handle of the user whose list of hosted File_List is being requested.

+

Return

+

Returns an array of strings where each string represents a Filename hosted by the User. If their is a Subsection at the same hierarchy level, it is aso retturned in this array.

+

Possible Error

+

org.freedesktop.Telepathy.Error.Disconnected

+

The connection is not currently connected and cannot be used. This error may also be raised when operations are performed on a Connection for which StatusChanged has signalled status Disconnected for reason None.

+

org.freedesktop.Telepathy.Error.InvalidHandle

+

The File_List/User_handle specified is unknown on this channel or connection. (generic description)

+

org.freedesktop.Telepathy.Error.PermissionDenied

+

The user is not permitted to perform the requested operation. (generic description)

+

−

~~Signals~~ :

+

RequestFile(s: File_List, u: User_Handle, s: Filename) -> nothing

−

~~NotificationChange~~( ~~s: PubSubNodeModified~~, ~~s: CollectionModified, s: Title, as: Metadata, s: Mirror~~)

+

In order to request for a file to be sent one must request a FileSharing channel for the mirror hosting the file including the following mandatory properties (Protocol, FileId). After this RequestFile is called to to configure the socket that will be used to complete this operation.

−

This signal is sent to every user which is subscribed to the ~~PubSubNode~~ in which the change has been made.

+

Parameter

+

File_List - s

+

This is the File_List whose list of included file is being requested

+

User_Handle - u

+

The Contact_Handle of the user whose list of hosted File_List is being requested.

+

Filename - s

+

File which is being requested to be sent

+

Possible Error

+

org.freedesktop.Telepathy.Error.Disconnected

+

The connection is not currently connected and cannot be used. This error may also be raised when operations are performed on a Connection for which StatusChanged has signalled status Disconnected for reason None.

+

org.freedesktop.Telepathy.Error.InvalidHandle

+

The File_List/User_handle specified is unknown on this channel or connection. (generic description)

+

org.freedesktop.Telepathy.Error.PermissionDenied

+

The user is not permitted to perform the requested operation. (generic description)

+

Signals

+

NotificationChange( s: File_List, s: File_List_Title, s: Filename_Modified, s: Description, as: Metadata, s: Mirror)

+

This signal is sent to every user which is subscribed to the File_List in which the change has been made.

Parameter

−

~~PubSubNodeModified~~ - s

+

File_List - s

−

This is the ~~PubSub node~~ on which the change has been done

+

This is the File_List on which the change has been done

−

+

−

~~CollectionModified~~ - s

+

File_List_Title - s

−

This is ~~collection~~ on ~~PubSub node~~ which has been ~~change~~

+

This is the title of the File_List which has been modified

+

Filename_Modified - s

+

This is Filename on File_List which has been changed

−

~~Title~~ - s

+

Discription - s

−

This is the ~~Title~~ of the ~~collection~~ which has been modified

+

This is the Discripton of the File_List which has been modified

Metadata - as

Line 357: Line 462:

Modified - s

−

~~(undocumented)~~

+

The last modified time of the revision

CheckSum - s

Kashes911

29

edits

Changes

0-th (view source)

Revision as of 05:43, 10 April 2009