smf/smfservermodule/smfserver/smfplugins/smfmusicserviceplugin.h
changeset 18 013a02bf2bb0
parent 14 a469c0e6e7fb
child 25 a180113055cb
equal deleted inserted replaced
17:106a4bfcb866 18:013a02bf2bb0
    22 #define SMFMUSICSERVICEPLUGIN_H_
    22 #define SMFMUSICSERVICEPLUGIN_H_
    23 
    23 
    24 #include <smfpluginbase.h>
    24 #include <smfpluginbase.h>
    25 #include <smfmusicprofile.h>
    25 #include <smfmusicprofile.h>
    26 #include <smflocation.h>
    26 #include <smflocation.h>
       
    27 #include <smftrackinfo.h>
       
    28 #include <smfmusicrating.h>
       
    29 #include <smfcomment.h>
    27 
    30 
    28 /**
    31 /**
    29  * @ingroup smf_plugin_group
    32  * @ingroup smf_plugin_group
    30  * Interface specification for music services. This class provides basic 
    33  * Interface specification for music services. This class provides basic 
    31  * functionality to allow application to search for a user or check for
    34  * functionality to allow application to search for a user or check for
    63 			const SmfLocation &aPlace,
    66 			const SmfLocation &aPlace,
    64 			const int aPageNum = SMF_FIRST_PAGE, 
    67 			const int aPageNum = SMF_FIRST_PAGE, 
    65 			const int aItemsPerPage = SMF_ITEMS_PER_PAGE ) = 0;
    68 			const int aItemsPerPage = SMF_ITEMS_PER_PAGE ) = 0;
    66 	
    69 	
    67 	/**
    70 	/**
       
    71 	 * Method to post the currently playing track
       
    72 	 * @param aRequest [out] The request data to be sent to network
       
    73 	 * @param aTrack The current playing track, that should be posted
       
    74 	 * @return SmfPluginError Plugin error if any, else SmfPluginErrNone
       
    75 	 */
       
    76 	virtual SmfPluginError postCurrentPlaying( 
       
    77 			SmfPluginRequestData &aRequest,
       
    78 			const SmfTrackInfo &aTrack ) = 0;
       
    79 	
       
    80 	/**
       
    81 	 * Method to post the rating on a track
       
    82 	 * @param aRequest [out] The request data to be sent to network
       
    83 	 * @param aTrack The track on which rating should be posted
       
    84 	 * @param aRating The rating values
       
    85 	 * @return SmfPluginError Plugin error if any, else SmfPluginErrNone
       
    86 	 */
       
    87 	virtual SmfPluginError postRating( 
       
    88 			SmfPluginRequestData &aRequest, 
       
    89 			const SmfTrackInfo &aTrack, 
       
    90 			const SmfMusicRating &aRating ) = 0;
       
    91 	
       
    92 	/**
       
    93 	 * Method to post comment on a track
       
    94 	 * @param aRequest [out] The request data to be sent to network
       
    95 	 * @param aTrack The track on which comment should be posted
       
    96 	 * @param aComment The comment content
       
    97 	 * @return SmfPluginError Plugin error if any, else SmfPluginErrNone
       
    98 	 */
       
    99 	virtual SmfPluginError postComments( 
       
   100 			SmfPluginRequestData &aRequest, 
       
   101 			const SmfTrackInfo &aTrack, 
       
   102 			const SmfComment &aComment ) = 0;
       
   103 	
       
   104 	/**
    68 	 * Customised method for SmfMusicServicePlugin interface
   105 	 * Customised method for SmfMusicServicePlugin interface
    69 	 * @param aRequest [out] The request data to be sent to network
   106 	 * @param aRequest [out] The request data to be sent to network
    70 	 * @param aOperation The operation type (should be known between 
   107 	 * @param aOperation The operation type (should be known between 
    71 	 * the client interface and the plugin)
   108 	 * the client interface and the plugin)
    72 	 * @param aData The data required to form the request (The type 
   109 	 * @param aData The data required to form the request (The type