smf/smfservermodule/smfserver/smfplugins/smfcontactfetcherplugin.h
changeset 25 a180113055cb
parent 14 a469c0e6e7fb
equal deleted inserted replaced
24:1cee9f1b95e0 25:a180113055cb
    44 	virtual ~SmfContactFetcherPlugin( ) {}
    44 	virtual ~SmfContactFetcherPlugin( ) {}
    45 	
    45 	
    46 	/**
    46 	/**
    47 	 * Method to get the list of friends
    47 	 * Method to get the list of friends
    48 	 * @param aRequest [out] The request data to be sent to network
    48 	 * @param aRequest [out] The request data to be sent to network
    49 	 * @param aPageNum The page to be extracted
    49 	 * @param aPageNum [in] The page to be extracted
    50 	 * @param aItemsPerPage Number of items per page
    50 	 * @param aItemsPerPage [in] Number of items per page
    51 	 * @return SmfPluginError Plugin error if any, else SmfPluginErrNone
    51 	 * @return Appropriate value of the enum SmfPluginError.
       
    52 	 * Plugin error if any, else SmfPluginErrNone for success
    52 	 */
    53 	 */
    53 	virtual SmfPluginError friends( SmfPluginRequestData &aRequest,
    54 	virtual SmfPluginError friends( SmfPluginRequestData &aRequest,
    54 			const int aPageNum = SMF_FIRST_PAGE, 
    55 			const int aPageNum = SMF_FIRST_PAGE, 
    55 			const int aItemsPerPage = SMF_ITEMS_PER_PAGE ) = 0;
    56 			const int aItemsPerPage = SMF_ITEMS_PER_PAGE ) = 0;
    56 	
    57 	
    57 	/**
    58 	/**
    58 	 * Method to get the list of followers
    59 	 * Method to get the list of followers
    59 	 * @param aRequest [out] The request data to be sent to network
    60 	 * @param aRequest [out] The request data to be sent to network
    60 	 * @param aPageNum The page to be extracted
    61 	 * @param aPageNum [in] The page to be extracted
    61 	 * @param aItemsPerPage Number of items per page
    62 	 * @param aItemsPerPage [in] Number of items per page
    62 	 * @return SmfPluginError Plugin error if any, else SmfPluginErrNone
    63 	 * @return Appropriate value of the enum SmfPluginError.
       
    64 	 * Plugin error if any, else SmfPluginErrNone for success
    63 	 */
    65 	 */
    64 	virtual SmfPluginError followers( SmfPluginRequestData &aRequest,
    66 	virtual SmfPluginError followers( SmfPluginRequestData &aRequest,
    65 			const int aPageNum = SMF_FIRST_PAGE, 
    67 			const int aPageNum = SMF_FIRST_PAGE, 
    66 			const int aItemsPerPage = SMF_ITEMS_PER_PAGE ) = 0;
    68 			const int aItemsPerPage = SMF_ITEMS_PER_PAGE ) = 0;
    67 	
    69 	
    68 	/**
    70 	/**
    69 	 * Method to search for a contact
    71 	 * Method to search for a contact (name or service ID should be provided)
    70 	 * @param aRequest [out] The request data to be sent to network
    72 	 * @param aRequest [out] The request data to be sent to network
    71 	 * @param aContact contact to be searched
    73 	 * @param aContact [in] contact to be searched
    72 	 * @param aPageNum The page to be extracted
    74 	 * @param aPageNum [in] The page to be extracted
    73 	 * @param aItemsPerPage Number of items per page
    75 	 * @param aItemsPerPage [in] Number of items per page
    74 	 * @return SmfPluginError Plugin error if any, else SmfPluginErrNone
    76 	 * @return Appropriate value of the enum SmfPluginError.
       
    77 	 * Plugin error if any, else SmfPluginErrNone for success
    75 	 */
    78 	 */
    76 	virtual SmfPluginError search( SmfPluginRequestData &aRequest,
    79 	virtual SmfPluginError search( SmfPluginRequestData &aRequest,
    77 			const SmfContact &aContact,
    80 			const SmfContact &aContact,
    78 			const int aPageNum = SMF_FIRST_PAGE, 
    81 			const int aPageNum = SMF_FIRST_PAGE, 
    79 			const int aItemsPerPage = SMF_ITEMS_PER_PAGE ) = 0;
    82 			const int aItemsPerPage = SMF_ITEMS_PER_PAGE ) = 0;
    80 	
    83 	
    81 	/**
    84 	/**
    82 	 * Method to search for contacts (friends) who are near the user.
    85 	 * Method to search for contacts (friends) who are near the user.
    83 	 * Proximity defines accuracy level
    86 	 * Proximity defines accuracy level
    84 	 * @param aRequest [out] The request data to be sent to network
    87 	 * @param aRequest [out] The request data to be sent to network
    85 	 * @param aLocation The location search criteria
    88 	 * @param aLocation [in] The location search criteria
    86 	 * @param aProximity location search boundary
    89 	 * @param aProximity [in] location search boundary
    87 	 * @param aPageNum The page to be extracted
    90 	 * @param aPageNum [in] The page to be extracted
    88 	 * @param aItemsPerPage Number of items per page
    91 	 * @param aItemsPerPage [in] Number of items per page
    89 	 * @return SmfPluginError Plugin error if any, else SmfPluginErrNone
    92 	 * @return Appropriate value of the enum SmfPluginError.
       
    93 	 * Plugin error if any, else SmfPluginErrNone for success
    90 	 */
    94 	 */
    91 	virtual SmfPluginError searchNear( SmfPluginRequestData &aRequest,
    95 	virtual SmfPluginError searchNear( SmfPluginRequestData &aRequest,
    92 			const SmfLocation &aLocation,
    96 			const SmfLocation &aLocation,
    93 			const SmfLocationSearchBoundary &aProximity,
    97 			const SmfLocationSearchBoundary &aProximity,
    94 			const int aPageNum = SMF_FIRST_PAGE, 
    98 			const int aPageNum = SMF_FIRST_PAGE, 
    97 	/**
   101 	/**
    98 	 * Method to get the list of groups
   102 	 * Method to get the list of groups
    99 	 * @param aRequest [out] The request data to be sent to network
   103 	 * @param aRequest [out] The request data to be sent to network
   100 	 * @param aPageNum The page to be extracted
   104 	 * @param aPageNum The page to be extracted
   101 	 * @param aItemsPerPage Number of items per page
   105 	 * @param aItemsPerPage Number of items per page
   102 	 * @return SmfPluginError Plugin error if any, else SmfPluginErrNone
   106 	 * @return Appropriate value of the enum SmfPluginError.
       
   107 	 * Plugin error if any, else SmfPluginErrNone for success
   103 	 */
   108 	 */
   104 	virtual SmfPluginError groups( SmfPluginRequestData &aRequest,
   109 	virtual SmfPluginError groups( SmfPluginRequestData &aRequest,
   105 			const int aPageNum = SMF_FIRST_PAGE, 
   110 			const int aPageNum = SMF_FIRST_PAGE, 
   106 			const int aItemsPerPage = SMF_ITEMS_PER_PAGE ) = 0;
   111 			const int aItemsPerPage = SMF_ITEMS_PER_PAGE ) = 0;
   107 	
   112 	
   108 	/**
   113 	/**
   109 	 * Method to search for a contact in a group
   114 	 * Method to search for a contact in a group
   110 	 * @param aRequest [out] The request data to be sent to network
   115 	 * @param aRequest [out] The request data to be sent to network
   111 	 * @param aGroup the group in which to search
   116 	 * @param aGroup [in] the group in which to search
   112 	 * @param aPageNum The page to be extracted
   117 	 * @param aContact [in] The contact to be searched, 
   113 	 * @param aItemsPerPage Number of items per page
   118 	 * default (NULL) is the self contact.
   114 	 * @return SmfPluginError Plugin error if any, else SmfPluginErrNone
   119 	 * @param aPageNum [in] The page to be extracted
       
   120 	 * @param aItemsPerPage [in] Number of items per page
       
   121 	 * @return Appropriate value of the enum SmfPluginError.
       
   122 	 * Plugin error if any, else SmfPluginErrNone for success
   115 	 */
   123 	 */
   116 	virtual SmfPluginError searchInGroup( SmfPluginRequestData &aRequest,
   124 	virtual SmfPluginError searchInGroup( SmfPluginRequestData &aRequest,
   117 			const SmfGroup &aGroup,
   125 			const SmfGroup &aGroup,
       
   126 			SmfContact *aContact = NULL,
   118 			const int aPageNum = SMF_FIRST_PAGE, 
   127 			const int aPageNum = SMF_FIRST_PAGE, 
   119 			const int aItemsPerPage = SMF_ITEMS_PER_PAGE ) = 0;
   128 			const int aItemsPerPage = SMF_ITEMS_PER_PAGE ) = 0;
   120 	
   129 	
   121 	/**
   130 	/**
   122 	 * Customised method for SmfContactFetcherPlugin interface
   131 	 * Customised method for SmfContactFetcherPlugin interface
   123 	 * @param aRequest [out] The request data to be sent to network
   132 	 * @param aRequest [out] The request data to be sent to network
   124 	 * @param aOperation The operation type (should be known between 
   133 	 * @param aOperation [in] The operation type (should be known between 
   125 	 * the client interface and the plugin)
   134 	 * the client interface and the plugin)
   126 	 * @param aData The data required to form the request (The type 
   135 	 * @param aData [in] The data required to form the request (The type 
   127 	 * of data should be known between client and the plugin)
   136 	 * of data should be known between client and the plugin)
   128 	 * @return SmfPluginError Plugin error if any, else SmfPluginErrNone
   137 	 * @return Appropriate value of the enum SmfPluginError.
       
   138 	 * Plugin error if any, else SmfPluginErrNone for success
   129 	 */
   139 	 */
   130 	virtual SmfPluginError customRequest( SmfPluginRequestData &aRequest, 
   140 	virtual SmfPluginError customRequest( SmfPluginRequestData &aRequest, 
   131 			const int &aOperation, QByteArray *aData ) = 0;
   141 			const int &aOperation, QByteArray *aData ) = 0;
   132 	};
   142 	};
   133 
   143