29
edits
Changes
Jump to navigation
Jump to search
Line 1:
Line 1: + + Line 10:
Line 12: − + − + − + + − PubSubNodeName - s + − + + − + + − + Line 34:
Line 39: − + + Line 45:
Line 51: − + − + Line 54:
Line 60: − PubSubNodeName - s + − SubSectionPubSubNodeName - s + Line 75:
Line 81: − + Line 87:
Line 93: − + − − This method is called when one wants to suscribe to a FileList. This method returns whether the subscription was successful ('true') or not ('false'). + + + − PubSubNodeToSubscribe - s + − + − SubscriptionType - s + − SubscriptionDepth - s + Line 105:
Line 112: − + Line 115:
Line 122: − + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + − + + + − + − PubSubNodeToAddFile - s + − + Line 145:
Line 185: − + Line 154:
Line 194: − + Line 164:
Line 204: − + − + − PubSubNode - s + − + − FileItemId - q + Line 188:
Line 228: − + Line 199:
Line 239: − + − + − PubSubNodeHostingFile - s + − + Line 232:
Line 272: − + Line 243:
Line 283: − + − + − PubSubNode - s + − + − Jid - s + − Jid of the user whose permission/affilation are being changed. + − + Line 270:
Line 310: − + Line 279:
Line 319: − GetRepo( s: PubSubNode) -> as + − + − PubSubNode - s + − + − + + Line 299:
Line 340: − + + + Line 309:
Line 352: − RequestFile() -> nothing + + + − 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. + + + + + + + + + + + + + + + + + + + + + + + + + − Signals :+ + + + − NotificationChange( s: PubSubNodeModified, s: CollectionModified, s: Title, as: Metadata, s: Mirror)+ − + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + − PubSubNodeModified - s + − + − + − CollectionModified - s + − + + + + − Title - s + − + Line 357:
Line 462: − (undocumented) +
no edit summary
better formated version at: http://pastebin.com/f3222e122
'''org.freedesktop.Telepathy.Connection.Interface.FileSharing.DRAFT'''
'''org.freedesktop.Telepathy.Connection.Interface.FileSharing.DRAFT'''
Methods:
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
Parameters
Title - s
Title - s
This will be the title of the pubsub node.
This will be the title of the File_Listing.
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
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
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.
org.freedesktop.Telepathy.Error.Disconnected
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.
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
Parameters
This will be the title of the subsection.
This will be the title of the subsection.
File_Listing_Parent - s
This is how the repository of the user will be referenced.
This is how the repository of the user will be referenced.
File_Listing_Derived - s
This is how the SubSection will be referenced.
This is how the SubSection will be referenced.
org.freedesktop.Telepathy.Error.InvalidHandle
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
org.freedesktop.Telepathy.Error.PermissionDenied
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 File_List. This method returns whether the subscription was successful ('true') or not ('false').
note: "no-ops" for AIM
Parameters
Parameters
File_List - s
This is the PubSub node user want to subscibe.
This is the File_List user wants to subscibe.
Subscription_Type - s
This gives the subscription type.
This gives the subscription type.
Subscription_Depth - s
Since a pubsub FileListing might have many SubSections,therefore this parameter gives the depth a user want to subscribe to.
Since a pubsub FileListing might have many SubSections,therefore this parameter gives the depth a user want to subscribe to.
Returns
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.
org.freedesktop.Telepathy.Error.InvalidHandle
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
Parameters
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
Filename - s
Return
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.
org.freedesktop.Telepathy.Error.InvalidHandle
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
org.freedesktop.Telepathy.Error.PermissionDenied
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
Parameters
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
File_Item_Id - q
This is the ItemId of the FileName that has to be deleted
This is the ItemId of the FileName that has to be deleted
org.freedesktop.Telepathy.Error.InvalidHandle
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
org.freedesktop.Telepathy.Error.PermissionDenied
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
Parameters
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
Filename - s
org.freedesktop.Telepathy.Error.InvalidHandle
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
org.freedesktop.Telepathy.Error.PermissionDenied
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
Parameter
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.
UserHandle - u
UserHandle of the user whose permission/affilation are being changed.
Affilation - s
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
org.freedesktop.Telepathy.Error.InvalidHandle
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
org.freedesktop.Telepathy.Error.PermissionDenied
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
Parameter
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
Return
Returns an array of strings
Returns an array of strings where each string represents a File_List hosted by the User.
org.freedesktop.Telepathy.Error.InvalidHandle
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)
GetFileList( s: File_List, u: User_Handle ) -> as
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)
RequestFile(s: File_List, u: User_Handle, s: Filename) -> nothing
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
Parameter
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
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
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
Metadata - as
Modified - s
Modified - s
The last modified time of the revision
CheckSum - s
CheckSum - s