SHARE
TWEET

kartik rustagi

a guest Apr 7th, 2009 69 Never
Not a member of Pastebin yet? Sign Up, it unlocks many cool features!
  1. org.freedesktop.Telepathy.Connection.Interface.FileSharing.DRAFT
  2.  
  3. Implementations of this interface must also implement:
  4.    * org.freedesktop.Telepathy.Connection
  5.    
  6.  
  7. An interface on connections to support protocols which allow users to designate a set of files as available for retrieval by other users of their choosing. Other features specified by this interface include file metadata, revisions, and download mirrors.
  8.    
  9.    
  10. Methods:
  11.  
  12.         CreateFileListing ( s: Title, s: PubSubNodeName, s: Description)-> b
  13.        
  14.         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').
  15.        
  16.         Parameters
  17.        
  18.         Title - s
  19.                 This will be the title of the pubsub node.
  20.        
  21.         PubSubNodeName - s
  22.                 This is how the repository of the user will be referenced.
  23.        
  24.         Discription - s
  25.                 This is optional and can be use to give the discription of the FileListing that is being created.
  26.                
  27.                
  28.         Returns
  29.        
  30.                 Returns 'true' if the FileListing was created and 'false' if it was not.       
  31.  
  32.        
  33.         Possible Error 
  34.                
  35.         org.freedesktop.Telepathy.Error.Disconnected
  36.                 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.
  37.                
  38.                
  39.                  
  40.        
  41.        
  42.        
  43.        
  44.        
  45.        
  46.        
  47.         AddSubSection ( s: Title, s: PubSubNodeName, s: SubSectionPubSubNodeName, s: Description) -> b
  48.        
  49.         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').  
  50.        
  51.         Parameters
  52.        
  53.         Title - s
  54.                 This will be the title of the subsection.
  55.        
  56.         PubSubNodeName - s
  57.                 This is how the repository of the user will be referenced.
  58.        
  59.         SubSectionPubSubNodeName - s
  60.                 This is how the SubSection will be referenced.
  61.        
  62.         Discription - s
  63.                 This is optional and can be use to give the discription of the SubSection that is being created.
  64.  
  65.        
  66.         Returns
  67.        
  68.                 Returns 'true' if the SubSection was created and 'false' if it was not.
  69.  
  70.        
  71.         Possible Error 
  72.                
  73.         org.freedesktop.Telepathy.Error.Disconnected
  74.                 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.
  75.  
  76.         org.freedesktop.Telepathy.Error.InvalidHandle
  77.                 The PubSubNodeName specified is unknown on this channel or connection. (generic description)
  78.        
  79.         org.freedesktop.Telepathy.Error.PermissionDenied
  80.                 The user is not permitted to perform the requested operation. (generic description)
  81.  
  82.  
  83.        
  84.        
  85.        
  86.        
  87.        
  88.        
  89.         SuscribeList ( s: PubSubNodeToSubscribe, s: SubscriptionType, s: SubscriptionDepth) -> b
  90.        
  91.         This method is called when one wants to suscribe to a FileList.  This method returns whether the subscription was successful ('true') or not            ('false').  
  92.        
  93.         Parameters
  94.        
  95.         PubSubNodeToSubscribe - s
  96.                 This is the PubSub node user want to subscibe.
  97.        
  98.         SubscriptionType - s
  99.                 This gives the subscription type.
  100.                
  101.         SubscriptionDepth - s
  102.                 Since a pubsub FileListing might have many SubSections,therefore this parameter gives the depth a user want to subscribe to.
  103.                        
  104.        
  105.         Returns
  106.        
  107.                 Returns 'true' if the SubSection was created and 'false' if it was not.
  108.  
  109.        
  110.        
  111.         Possible Error 
  112.                
  113.         org.freedesktop.Telepathy.Error.Disconnected
  114.                 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.
  115.  
  116.         org.freedesktop.Telepathy.Error.InvalidHandle
  117.                 The PubSubNodeToSubscribe specified is unknown on this channel or connection. (generic description)
  118.        
  119.        
  120.        
  121.        
  122.        
  123.        
  124.         PublishFile ( s: PubSubNodeToAddFile, s: Filename, q: ItemId, as: Metadata, s: Mirrors) -> b
  125.        
  126.         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').  
  127.        
  128.         Parameters
  129.        
  130.         PubSubNodeToAddFile - s
  131.                 This is the PubSub node user want to publish file to.
  132.        
  133.         Filename - s
  134.                 This is the FileName user want to publish.
  135.        
  136.         ItemId - q
  137.                 This Id is used to create more than one version of the same file.
  138.        
  139.         Metadata - as
  140.                 This list all the metadata about the file which includes Size,Modified,CheckSum,Ckecksumtype and Mime.
  141.                
  142.         Mirrors - s
  143.                 This list the mirrors from where the file can be fetched.
  144.                
  145.        
  146.         Return
  147.                 Returns 'true' if the FileName was published and 'false' if it was not.
  148.                  
  149.        
  150.         Possible Error 
  151.                
  152.         org.freedesktop.Telepathy.Error.Disconnected
  153.                 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.
  154.  
  155.         org.freedesktop.Telepathy.Error.InvalidHandle
  156.                 The PubSubNodeToAddFile specified is unknown on this channel or connection. (generic description)
  157.  
  158.         org.freedesktop.Telepathy.Error.PermissionDenied
  159.                 The user is not permitted to perform the requested operation. (generic description)
  160.  
  161.  
  162.  
  163.  
  164.  
  165.        
  166.         DeleteRevision ( s: PubSubNode, q: FileItemId) -> b
  167.        
  168.         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').
  169.        
  170.          
  171.         Parameters
  172.        
  173.         PubSubNode - s
  174.                 This is the pubsub node which is holding the file with the ItemId equal to FileItemId
  175.                
  176.         FileItemId - q
  177.                 This is the ItemId of the FileName that has to be deleted
  178.                
  179.        
  180.         Return
  181.                 Returns 'true' if the FileItemId was deleted and 'false' if it was not.
  182.                
  183.        
  184.         Possible Error 
  185.        
  186.         org.freedesktop.Telepathy.Error.Disconnected
  187.                 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.
  188.  
  189.         org.freedesktop.Telepathy.Error.InvalidHandle
  190.                 The PubSubNode specified is unknown on this channel or connection. (generic description)
  191.  
  192.         org.freedesktop.Telepathy.Error.PermissionDenied
  193.                 The user is not permitted to perform the requested operation. (generic description)
  194.  
  195.  
  196.  
  197.  
  198.  
  199.  
  200.  
  201.         MakeRevision ( s: PubSubNodeHostingFile, s: Filename, q: ItemId, as: Metadata, s: Mirrors) -> b
  202.        
  203.         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').
  204.  
  205.  
  206.         Parameters
  207.        
  208.         PubSubNodeHostingFile - s
  209.                 This is the PubSub node user want to publish file to.
  210.        
  211.         Filename - s
  212.                 This is the FileName user want to publish.
  213.        
  214.         ItemId - q
  215.                 This Id is used to create more than one version of the same file.
  216.        
  217.         Metadata - as
  218.                 This list all the metadata about the file which includes Size,Modified,CheckSum,Ckecksumtype and Mime.
  219.                
  220.         Mirrors - s
  221.                 This list the mirrors from where the file can be fetched.
  222.                
  223.        
  224.         Return
  225.                 Returns 'true' if the FileName was published and 'false' if it was not.
  226.                  
  227.        
  228.         Possible Error 
  229.                
  230.         org.freedesktop.Telepathy.Error.Disconnected
  231.                 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.
  232.  
  233.         org.freedesktop.Telepathy.Error.InvalidHandle
  234.                 The PubSubNodeHostingFile specified is unknown on this channel or connection. (generic description)
  235.  
  236.         org.freedesktop.Telepathy.Error.PermissionDenied
  237.                 The user is not permitted to perform the requested operation. (generic description)
  238.  
  239.  
  240.  
  241.  
  242.  
  243.  
  244.  
  245.         SetPermissions ( s: PubSubNode, s: Jid, s: Affilation) -> Nothing
  246.  
  247.         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').
  248.  
  249.  
  250.         Parameter
  251.                
  252.         PubSubNode - s 
  253.                 This is the PubSub node user want to change permission of.
  254.                
  255.         Jid - s
  256.                 Jid of the user whose permission/affilation are being changed.
  257.        
  258.         Affilation - s
  259.                 This is the permission that will be set gor the Jid
  260.                
  261.        
  262.         Return
  263.                 Nothing
  264.                
  265.                
  266.         Possible Error
  267.        
  268.         org.freedesktop.Telepathy.Error.Disconnected
  269.                 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.
  270.  
  271.         org.freedesktop.Telepathy.Error.InvalidHandle
  272.                 The PubSubNode specified is unknown on this channel or connection. (generic description)
  273.  
  274.         org.freedesktop.Telepathy.Error.PermissionDenied
  275.                 The user is not permitted to perform the requested operation. (generic description)
  276.  
  277.  
  278.  
  279.  
  280.        
  281.         GetRepo( s: PubSubNode) -> as
  282.        
  283.         This method is called to request the Repo hosted on the PubSubNode .
  284.        
  285.         Parameter
  286.        
  287.         PubSubNode - s
  288.                 The PubSub node on which the file repository is hosted.
  289.                
  290.        
  291.         Return
  292.                 Returns an array of strings
  293.                
  294.        
  295.         Possible Error
  296.                        
  297.         org.freedesktop.Telepathy.Error.Disconnected
  298.                 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.
  299.  
  300.         org.freedesktop.Telepathy.Error.InvalidHandle
  301.                 The PubSubNode specified is unknown on this channel or connection. (generic description)
  302.                
  303.  
  304.  
  305.  
  306.        
  307.        
  308.        
  309.        
  310.        
  311.         RequestFile() -> nothing
  312.        
  313.         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.
  314.        
  315.        
  316.  
  317.  
  318.  
  319.  
  320. Signals :
  321.        
  322.         NotificationChange( s: PubSubNodeModified, s: CollectionModified, s: Title, as: Metadata, s: Mirror)
  323.        
  324.         This signal is sent to every user which is subscribed to the PubSubNode in which the change has been made.
  325.        
  326.         Parameter
  327.        
  328.         PubSubNodeModified - s
  329.                 This is the PubSub node on which the change has been done
  330.                
  331.         CollectionModified - s
  332.                 This is collection on PubSub node which has been change
  333.  
  334.         Title - s
  335.                 This is the Title of the collection which has been modified
  336.                
  337.         Metadata - as
  338.                 This is the Metadata of the file which has been added/deleted
  339.                
  340.         Mirror - s
  341.                 Mirror of the modified file.
  342.        
  343.        
  344.  
  345.  
  346.  
  347. Structure types
  348.  
  349.         Metadata ( u: Size, s: Modified, s: CheckSum, s: Checksumtype, s: Mime )
  350.  
  351.         This represents all the information needed about the file.
  352.        
  353.         Members
  354.        
  355.         Size - s
  356.                 Size of the file in KB
  357.        
  358.         Modified - s
  359.                 (undocumented)
  360.                
  361.         CheckSum - s
  362.                 Checksum of the file
  363.  
  364.         Checksumtype - s
  365.                 The type of CheckSum used
  366.        
  367.         Mime - s
  368.                 Mime Type of the file
RAW Paste Data
We use cookies for various purposes including analytics. By continuing to use Pastebin, you agree to our use of cookies as described in the Cookies Policy. OK, I Understand
 
Top