smf/smfservermodule/smfserver/smfplugins/smfpluginbase.h
changeset 25 a180113055cb
parent 18 013a02bf2bb0
equal deleted inserted replaced
24:1cee9f1b95e0 25:a180113055cb
    49 	 */
    49 	 */
    50 	virtual SmfProviderBase* getProviderInfo( ) = 0;
    50 	virtual SmfProviderBase* getProviderInfo( ) = 0;
    51 	
    51 	
    52 	/**
    52 	/**
    53 	 * Method to get the result for a network request.
    53 	 * Method to get the result for a network request.
    54 	 * @param aOperation The type of operation to be requested
    54 	 * @param aOperation [in] The type of operation to be requested
    55 	 * @param aTransportResult The result of transport operation
    55 	 * @param aTransportResult [in] The result of transport operation
    56 	 * @param aReply The QByteArray instance containing the network response.
    56 	 * @param aReply [in] The QByteArray instance containing the network response.
    57 	 * The plugins should delete this instance once they have read the 
    57 	 * The plugins should delete this instance once they have read the 
    58 	 * data from it.
    58 	 * data from it.
    59 	 * @param aResult [out] An output parameter to the plugin manager.If the 
    59 	 * @param aResult [out] An output parameter to the plugin manager.If the 
    60 	 * return value is SmfSendRequestAgain, QVariant will be of type 
    60 	 * return value is SmfSendRequestAgain, QVariant will be of type 
    61 	 * SmfPluginRequestData.
    61 	 * SmfPluginRequestData.
    62 	 * 
    62 	 * 
       
    63 	 * For SmfActivityFetcherPlugin: If the last operation was selfActivities(), 
       
    64 	 * friendsActivities() or filtered(), aResult will be of type QList<SmfActivityEntry>
       
    65 	 * 
    63 	 * For SmfContactFetcherPlugin: If last operation was friends() or followers() 
    66 	 * For SmfContactFetcherPlugin: If last operation was friends() or followers() 
    64 	 * or search() or searchInGroup() or searchNear(), aResult will be of type 
    67 	 * or search() or searchInGroup() or searchNear(), aResult will be of type 
    65 	 * QList<SmfContact>. If last operation was groups(), aResult will be of 
    68 	 * QList<SmfContact>. If last operation was groups(), aResult will be of 
    66 	 * type QList<SmfGroup>
    69 	 * type QList<SmfGroup>
       
    70 	 * 
       
    71 	 * For SmfEventsFetcherPlugin: If the last operation was events(), aResult will 
       
    72 	 * be of type QList<SmfEvent>. If the last operation was venues(), aResult 
       
    73 	 * will be of type QList<SmfLocation>. If the last operation was attendees(), 
       
    74 	 * aResult will be of type QList<SmfContact>. If the last operation was 
       
    75 	 * postEvents(), aResult will be of type bool.
       
    76 	 * 
       
    77 	 * For SmfGalleryPlugin: If last operation was albums, aResult will be of 
       
    78 	 * type QList<SmfPictureAlbum>. If the last operation was pictures(), aResult 
       
    79 	 * will be of type QList<SmfPicture>. If last operation was description(), 
       
    80 	 * aResult will be of type QString. If last operation was upload() or 
       
    81 	 * postComment(), aResult will be of type bool.
       
    82 	 * 
       
    83 	 * For SmfLyricsServicePlugin: If last operation was lyrics(), aResult will 
       
    84 	 * be of type QList<SmfLyrics>. If last operation was subtitles(), aResult will 
       
    85 	 * be of type QList<SmfSubtitle>.
       
    86 	 * 
       
    87 	 * For SmfMusicSearchPlugin: If last operation was recommendations() or 
       
    88 	 * tracksSimilar() or tracksOfAlbum() or tracksOfArtist() or trackInfo(), 
       
    89 	 * aResult will be of type QList<SmfTrackInfo>. If last operation was 
       
    90 	 * stores(), aResult will be of type QList<SmfProvider>.
       
    91 	 * 
       
    92 	 * For SmfMusicServicePlugin: If last operation was userMusicInfo(), aResult 
       
    93 	 * will be of type SmfMusicProfile. If last operation was searchArtist(), 
       
    94 	 * aResult will be of type QList<SmfArtists>. If last operation was searchAlbum(), 
       
    95 	 * aResult will be of type QList<SmfAlbum>. If last operation was searchEvents(), 
       
    96 	 * aResult will be of type QList<SmfEvent>. If last operation was searchVenue(), 
       
    97 	 * aResult will be of type QList<Smfocation>. If last operation was searchUser(), 
       
    98 	 * aResult will be of type QList<SmfMusicProfile>. If last operation was 
       
    99 	 * postCurrentPlaying() or postRating() or postComments(), aResult will be of 
       
   100 	 * type bool.
       
   101 	 * 
       
   102 	 * For SmfPlaylistServicePlugin: If last operation was playlists() or 
       
   103 	 * playlistsOf(), aResult will be of type QList<SmfPlaylist>. If last 
       
   104 	 * operation was addToPlaylist() or postCurrentPlayingPlaylist(), 
       
   105 	 * aResult will be of type bool.
       
   106 	 * 
    67 	 * For SmfPostProviderPlugin: If last operation was retrieve(), aResult will be 
   107 	 * For SmfPostProviderPlugin: If last operation was retrieve(), aResult will be 
    68 	 * of type QList<SmfPost>. If last operation was post() or updatePost() or 
   108 	 * of type QList<SmfPost>. If last operation was post() or updatePost() or 
    69 	 * postDirected() or commentOnAPost() or postAppearence() or sharePost(), 
   109 	 * postDirected() or commentOnAPost() or postAppearence() or sharePost(), 
    70 	 * aResult will be of type bool
   110 	 * aResult will be of type bool
    71 	 * For SmfLyricsServicePlugin: If last operation was lyrics(), aResult will 
       
    72 	 * be of type QList<SmfLyrics>. If last operation was subtitles(), aResult will 
       
    73 	 * be of type QList<SmfSubtitle>.
       
    74 	 * For SmfMusicEventsPlugin: If last operation was events(), aResult will 
       
    75 	 * be of type QList<SmfEvent>. If last operation was venues(), aResult 
       
    76 	 * will be of type QList<SmfLocation>. If last operation was postEvents(), 
       
    77 	 * aResult will be of type bool
       
    78 	 * For SmfMusicSearchPlugin: If last operation was recommendations() or 
       
    79 	 * tracks() or trackInfo(), aResult will be of type QList<SmfTrackInfo>. 
       
    80 	 * If last operation was stores(), aResult will be of type 
       
    81 	 * QList<SmfProvider>. If last operation was postCurrentPlaying(), 
       
    82 	 * aResult will be of type bool.
       
    83 	 * For SmfMusicServicePlugin: If last operation was userInfo(), aResult 
       
    84 	 * will be of type SmfMusicProfile. If last operation was searchUser(), 
       
    85 	 * aResult will be of type QList<SmfMusicProfile>.
       
    86 	 * For SmfPlaylistServicePlugin: If last operation was playlists() or 
       
    87 	 * playlistsOf(), aResult will be of type QList<SmfPlaylist>. If last 
       
    88 	 * operation was addToPlaylist() or postCurrentPlayingPlaylist(), 
       
    89 	 * aResult will be of type bool.
       
    90 	 * For SmfGalleryPlugin: If last operation was pictures(), aResult will 
       
    91 	 * be of type QList<SmfPicture>. If last operation was description(), 
       
    92 	 * aResult will be of type QString. If last operation was upload() or 
       
    93 	 * postComment(), aResult will be of type bool.
       
    94 	 * 
   111 	 * 
    95 	 * @param aRetType [out] SmfPluginRetType
   112 	 * @param aRetType [out] Appropriate value of the enum SmfPluginRetType
    96 	 * @param aPageResult [out] The SmfResultPage structure variable
   113 	 * @param aPageResult [out] The SmfResultPage structure variable
       
   114 	 * @return Appropriate value of the enum SmfPluginError.
       
   115 	 * Plugin error if any, else SmfPluginErrNone for success
    97 	 */
   116 	 */
    98 	virtual SmfPluginError responseAvailable( 
   117 	virtual SmfPluginError responseAvailable( 
    99 			const SmfRequestTypeID aOperation,
   118 			const SmfRequestTypeID aOperation,
   100 			const SmfTransportResult &aTransportResult, 
   119 			const SmfTransportResult &aTransportResult, 
   101 			QByteArray *aReply, 
   120 			QByteArray *aReply,