smf/smfservermodule/smfserver/smfplugins/smfgalleryplugin.h
changeset 25 a180113055cb
parent 18 013a02bf2bb0
equal deleted inserted replaced
24:1cee9f1b95e0 25:a180113055cb
    63 	virtual ~SmfGalleryPlugin( ) {}
    63 	virtual ~SmfGalleryPlugin( ) {}
    64 
    64 
    65 	/**
    65 	/**
    66 	 * Method to get a list of albums
    66 	 * Method to get a list of albums
    67 	 * @param aRequest [out] The request data to be sent to network
    67 	 * @param aRequest [out] The request data to be sent to network
    68 	 * @param aNames The subject or any keywords to be used to filter albums with that name
    68 	 * @param aNames [in] The subject or any keywords to be used to filter 
    69 	 * @param aUser The user whose albums are requested
    69 	 * albums with that name
    70 	 * @param aPageNum The page to be extracted
    70 	 * @param aUser [in] The user whose albums are requested
    71 	 * @param aItemsPerPage Number of items per page
    71 	 * @param aPageNum [in] The page to be extracted
    72 	 * @return SmfPluginError Plugin error if any, else SmfPluginErrNone
    72 	 * @param aItemsPerPage [in] Number of items per page
       
    73 	 * @return Appropriate value of the enum SmfPluginError.
       
    74 	 * Plugin error if any, else SmfPluginErrNone for success
    73 	 */
    75 	 */
    74 	virtual SmfPluginError albums( SmfPluginRequestData &aRequest, 
    76 	virtual SmfPluginError albums( SmfPluginRequestData &aRequest, 
    75 			const QStringList &aNames, 
    77 			const QStringList &aNames, 
    76 			const SmfContact *aUser, 
    78 			const SmfContact *aUser, 
    77 			const int aPageNum = SMF_FIRST_PAGE,
    79 			const int aPageNum = SMF_FIRST_PAGE,
    78 			const int aItemsPerPage = SMF_ITEMS_PER_PAGE ) = 0;
    80 			const int aItemsPerPage = SMF_ITEMS_PER_PAGE ) = 0;
    79 	
    81 	
    80 	/**
    82 	/**
    81 	 * Method to get a list of pictures
    83 	 * Method to get a list of pictures
    82 	 * @param aRequest [out] The request data to be sent to network
    84 	 * @param aRequest [out] The request data to be sent to network
    83 	 * @param aAlbums The album(s) whose pictures are being requested
    85 	 * @param aAlbums [in] The album(s) whose pictures are being requested
    84 	 * @param aPageNum The page to be extracted
    86 	 * @param aPageNum [in] The page to be extracted
    85 	 * @param aItemsPerPage Number of items per page
    87 	 * @param aItemsPerPage [in] Number of items per page
    86 	 * @return SmfPluginError Plugin error if any, else SmfPluginErrNone
    88 	 * @return Appropriate value of the enum SmfPluginError.
       
    89 	 * Plugin error if any, else SmfPluginErrNone for success
    87 	 */
    90 	 */
    88 	virtual SmfPluginError pictures( SmfPluginRequestData &aRequest, 
    91 	virtual SmfPluginError pictures( SmfPluginRequestData &aRequest, 
    89 			const SmfPictureAlbumList &aAlbums, 
    92 			const SmfPictureAlbumList &aAlbums, 
    90 			const int aPageNum = SMF_FIRST_PAGE, 
    93 			const int aPageNum = SMF_FIRST_PAGE, 
    91 			const int aItemsPerPage = SMF_ITEMS_PER_PAGE ) = 0;
    94 			const int aItemsPerPage = SMF_ITEMS_PER_PAGE ) = 0;
    92 	
    95 	
    93 	/**
    96 	/**
    94 	 * Method to get a description
    97 	 * Method to get a description
    95 	 * @param aRequest [out] The request data to be sent to network
    98 	 * @param aRequest [out] The request data to be sent to network
    96 	 * @param aImage The image abot which the description is required
    99 	 * @param aImage [in] The image about which the description is required
    97 	 * @return SmfPluginError Plugin error if any, else SmfPluginErrNone
   100 	 * @return Appropriate value of the enum SmfPluginError.
       
   101 	 * Plugin error if any, else SmfPluginErrNone for success
    98 	 */
   102 	 */
    99 	virtual SmfPluginError description( SmfPluginRequestData &aRequest,
   103 	virtual SmfPluginError description( SmfPluginRequestData &aRequest,
   100 			const SmfPicture &aImage ) = 0;
   104 			const SmfPicture &aImage ) = 0;
   101 	
   105 	
   102 	/**
   106 	/**
   103 	 * Method to upload a picture
   107 	 * Method to upload a picture
   104 	 * @param aRequest [out] The request data to be sent to network
   108 	 * @param aRequest [out] The request data to be sent to network
   105 	 * @param aImage The image to be uploaded
   109 	 * @param aImage [in] The image to be uploaded
   106 	 * @param aAlbum the optional destination album name
   110 	 * @param aAlbum [in] the optional destination album name
   107 	 * @return SmfPluginError Plugin error if any, else SmfPluginErrNone
   111 	 * @return Appropriate value of the enum SmfPluginError.
       
   112 	 * Plugin error if any, else SmfPluginErrNone for success
   108 	 */
   113 	 */
   109 	virtual SmfPluginError upload( SmfPluginRequestData &aRequest,
   114 	virtual SmfPluginError upload( SmfPluginRequestData &aRequest,
   110 			const SmfPicture &aImage,
   115 			const SmfPicture &aImage,
   111 			const SmfPictureAlbum* aAlbum = NULL ) = 0;
   116 			const SmfPictureAlbum* aAlbum = NULL ) = 0;
   112 	
   117 	
   113 	/**
   118 	/**
   114 	 * Method to upload a list of pictures
   119 	 * Method to upload a list of pictures
   115 	 * @param aRequest [out] The request data to be sent to network
   120 	 * @param aRequest [out] The request data to be sent to network
   116 	 * @param aImages The list of images to be uploaded
   121 	 * @param aImages [in] The list of images to be uploaded
   117 	 * @param aAlbum the optional destination album name
   122 	 * @param aAlbum [in] the optional destination album name
   118 	 * @return SmfPluginError Plugin error if any, else SmfPluginErrNone
   123 	 * @return Appropriate value of the enum SmfPluginError.
       
   124 	 * Plugin error if any, else SmfPluginErrNone for success
   119 	 */
   125 	 */
   120 	virtual SmfPluginError upload( SmfPluginRequestData &aRequest,
   126 	virtual SmfPluginError upload( SmfPluginRequestData &aRequest,
   121 			const QList<SmfPicture> &aImages, 
   127 			const QList<SmfPicture> &aImages, 
   122 			const SmfPictureAlbum* aAlbum = NULL ) = 0;
   128 			const SmfPictureAlbum* aAlbum = NULL ) = 0;
   123 	
   129 	
   124 	/**
   130 	/**
   125 	 * Method to post comment on a picture is available
   131 	 * Method to post comment on a picture is available
   126 	 * @param aRequest [out] The request data to be sent to network
   132 	 * @param aRequest [out] The request data to be sent to network
   127 	 * @param aImage The image on which comment is to be posted
   133 	 * @param aImage [in] The image on which comment is to be 
   128 	 * @param aComment The comment to be posted
   134 	 * posted (its id should be present)
   129 	 * @return SmfPluginError Plugin error if any, else SmfPluginErrNone
   135 	 * @param aComment [in] The comment to be posted
       
   136 	 * @return Appropriate value of the enum SmfPluginError.
       
   137 	 * Plugin error if any, else SmfPluginErrNone for success
   130 	 */
   138 	 */
   131 	virtual SmfPluginError postComment( SmfPluginRequestData &aRequest,
   139 	virtual SmfPluginError postComment( SmfPluginRequestData &aRequest,
   132 			const SmfPicture &aImage, 
   140 			const SmfPicture &aImage, 
   133 			const SmfComment &aComment ) = 0;
   141 			const SmfComment &aComment ) = 0;
   134 		
   142 		
   135 	/**
   143 	/**
   136 	 * Customised method for SmfGalleryPlugin interface
   144 	 * Customised method for SmfGalleryPlugin interface
   137 	 * @param aRequest [out] The request data to be sent to network
   145 	 * @param aRequest [out] The request data to be sent to network
   138 	 * @param aOperation The operation type (should be known between 
   146 	 * @param aOperation [in] The operation type (should be known between 
   139 	 * the client interface and the plugin)
   147 	 * the client interface and the plugin)
   140 	 * @param aData The data required to form the request (The type 
   148 	 * @param aData [in] The data required to form the request (The type 
   141 	 * of data should be known between client and the plugin)
   149 	 * of data should be known between client and the plugin)
   142 	 * @return SmfPluginError Plugin error if any, else SmfPluginErrNone
   150 	 * @return Appropriate value of the enum SmfPluginError.
       
   151 	 * Plugin error if any, else SmfPluginErrNone for success
   143 	 */
   152 	 */
   144 	virtual SmfPluginError customRequest( SmfPluginRequestData &aRequest, 
   153 	virtual SmfPluginError customRequest( SmfPluginRequestData &aRequest, 
   145 			const int &aOperation, QByteArray *aData ) = 0;
   154 			const int &aOperation, QByteArray *aData ) = 0;
   146 		
   155 		
   147 	};
   156 	};