pidgin3: comparison src/protocols/novell/nmuser.h

-:3eb7902c2b4b
+:7ec649752daa
 * USED, PRACTICED, PERFORMED, COPIED, DISTRIBUTED, REVISED, MODIFIED,
 * TRANSLATED, ABRIDGED, CONDENSED, EXPANDED, COLLECTED, COMPILED, LINKED,
 * RECAST, TRANSFORMED OR ADAPTED WITHOUT THE PRIOR WRITTEN CONSENT OF NOVELL,
 * INC. ANY USE OR EXPLOITATION OF THIS WORK WITHOUT AUTHORIZATION COULD SUBJECT
 * THE PERPETRATOR TO CRIMINAL AND CIVIL LIABILITY.
 *
 * AS BETWEEN [GAIM] AND NOVELL, NOVELL GRANTS [GAIM] THE RIGHT TO REPUBLISH
 * THIS WORK UNDER THE GPL (GNU GENERAL PUBLIC LICENSE) WITH ALL RIGHTS AND
 * LICENSES THEREUNDER.  IF YOU HAVE RECEIVED THIS WORK DIRECTLY OR INDIRECTLY
 * FROM [GAIM] AS PART OF SUCH A REPUBLICATION, YOU HAVE ALL RIGHTS AND LICENSES
 * GRANTED BY [GAIM] UNDER THE GPL.  IN CONNECTION WITH SUCH A REPUBLICATION, IF
 #define NMERR_CONFERENCE_NOT_FOUND 			(NMERR_BASE + 0x0006)
 #define NMERR_CONFERENCE_NOT_INSTANTIATED 	(NMERR_BASE + 0x0007)
 #define NMERR_FOLDER_EXISTS					(NMERR_BASE + 0x0008)
 /**
 *	Initialize the user that we are going to login to the system as.
 *
 *	@param	name			The userid of the user
 *	@param	server			IP Address of server
 *	@param	port			Port to connect to on the server
 */
 NMUser *nm_initialize_user(const char *name, const char *server, int port,
 						   gpointer data, nm_event_cb event_callback);
 /**
 *	Free up resources associated with the user object.
 *
 *  @param	user	The user to deinitialize
 */
 void nm_deinitialize_user(NMUser * user);
 /**
 *	Send a login request to the server.
 *
 *	The response data sent to the callback will be NULL.
 *
 *  @param	user		The User to login -- must be initialized
 *	@param	pwd			The password of the user
 *  @param  my_addr		The address of the client machine
 *  @param	user_agent	String describing the client (eg. "Gaim/0.76 (Linux; 2.4.20)")
 *	@param	callback	Function to call when we get the response from the server
 *  @param 	data		User defined data to be passed to the callback function
 *
 *
 *	@return	NM_OK if login is sent successfully, error otherwise.
 */
 NMERR_T nm_send_login(NMUser * user, const char *pwd, const char *my_addr,
 					  const char *user_agent, nm_response_cb callback,
 					  gpointer data);
 /**
 *	Send a set status request to the server.
 *
 *	The response data sent to the callback will be NULL.
 *
 *  @param	user		The logged in User
 */
 NMERR_T nm_send_set_status(NMUser * user, int status, const char *text,
 						   const char *auto_resp, nm_response_cb callback,
 						   gpointer data);
 /**
 *	Send a create conference to the server.
 *
 *	The response data sent to the callback will be NULL.
 *
 *  @param	user		The logged in User
 *	@return	NM_OK if successfully sent, error otherwise
 */
 NMERR_T nm_send_create_conference(NMUser * user, NMConference * conference,
 								  nm_response_cb callback, gpointer data);
 /**
 *	Tell server we have left the conference.
 *
 *	The response data sent to the callback will be NULL.
 *
 *  @param	user		The logged in User
 *	@param	conference	Conference the user is leaving
 *	@param	callback	Function to call when we get the response from the server
 *	@return	NM_OK if successfully sent, error otherwise
 */
 NMERR_T nm_send_leave_conference(NMUser * user, NMConference * conference,
 								 nm_response_cb callback, gpointer data);
 /**
 *	Send a join conference request to the server.
 *
 *	The response data sent to the callback will be NULL.
 *
 *  @param	user		The logged in User
 *	@return	NM_OK if successfully sent, error otherwise
 */
 NMERR_T nm_send_join_conference(NMUser * user, NMConference * conference,
 								nm_response_cb callback, gpointer data);
 /**
 *	Send a conference reject request to the server.
 *
 *	The response data sent to the callback will be NULL.
 *
 *  @param	user		The logged in User
 *	@param	conference	Conference the user is rejecting
 *	@param	callback	Function to call when we get the response from the server
 *	@param	data		User defined data to be passed to the callback function
 *	@return	NM_OK if successfully sent, error otherwise
 */
 NMERR_T nm_send_reject_conference(NMUser * user, NMConference * conference,
 								  nm_response_cb callback, gpointer data);
 /**
 *	Get details for a user from the server.
 *
 *	The response data sent to the callback will be an NMUserRecord which should be
 *  freed with nm_release_user_record
 *
 *  @param	user		The logged in User
 *	@param	name		Userid or DN of the user to look up
 *	@return	NM_OK if successfully sent, error otherwise
 */
 NMERR_T nm_send_get_details(NMUser * user, const char *name,
 							nm_response_cb callback, gpointer data);
 /**
 *	Get details for multiple users from the server.
 *
 *	The response data to the callback will be a list of NMUserRecord, which should be
 *	freed (each user record should be released with nm_release_user_record and the
 *  list should be freed)
 *
 *  @param	user		The logged in User
 *	@param	name		Userid or DN of the user to look up
 *	@param	callback	Function to call when we get the response from the server
 *	@return	NM_OK if successfully sent, error otherwise
 */
 NMERR_T nm_send_multiple_get_details(NMUser *user, GSList *names,
 									 nm_response_cb callback, gpointer data);
 /**
 *	Send a message.
 *
 *  The response data sent to the callback will be NULL.
 *
 *  @param	user		The logged in User
 *	@return	NM_OK if successfully sent, error otherwise
 */
 NMERR_T nm_send_message(NMUser * user, NMMessage * message,
 						nm_response_cb callback);
 /**
 *	Sends a typing event to the server.
 *
 *  The response data sent to the callback will be NULL.
 *
 *  @param	user		The logged in User
 *	@return	NM_OK if successfully sent, error otherwise
 */
 NMERR_T nm_send_typing(NMUser * user, NMConference * conf,
 					   gboolean typing, nm_response_cb callback);
 /**
 *	Send a create contact request to the server.
 *
 *  The given folder should already exist on the server. If not,
 *  the call will fail.
 *
 */
 NMERR_T nm_send_create_contact(NMUser * user, NMFolder * folder,
 							   NMContact * contact, nm_response_cb callback,
 							   gpointer data);
 /**
 *	Send a remove contact request to the server.
 *
 *  The response data sent to the callback will be NULL.
 *
 *  @param	user		The logged in User
 */
 NMERR_T nm_send_remove_contact(NMUser * user, NMFolder * folder,
 							   NMContact * contact, nm_response_cb callback,
 							   gpointer data);
 /**
 *	Send a create folder request to the server.
 *
 *  The response data sent to the callback will be a NMFolder which should be
 *  released with nm_release_folder
 *
 *	@return	NM_OK if successfully sent, error otherwise
 */
 NMERR_T nm_send_create_folder(NMUser * user, const char *name,
 							  nm_response_cb callback, gpointer data);
 /**
 *	Send a delete folder request to the server.
 *
 *  The response data sent to the callback will be NULL.
 *
 *  @param	user		The logged in User
 *	@return	NM_OK if successfully sent, error otherwise
 */
 NMERR_T nm_send_remove_folder(NMUser * user, NMFolder * folder,
 							  nm_response_cb callback, gpointer data);
 /**
 *	Send a rename contact request to the server.
 *
 *	The response data sent to the callback will be NULL.
 *
 *  @param	user		The logged in User
 */
 NMERR_T nm_send_rename_contact(NMUser * user, NMContact * contact,
 							   const char *new_name, nm_response_cb callback,
 							   gpointer data);
 /**
 *	Send a rename folder request to the server.
 *
 *	The response data sent to the callback will be NULL.
 *
 *  @param	user		The logged in User
 */
 NMERR_T nm_send_rename_folder(NMUser * user, NMFolder * folder,
 							  const char *new_name, nm_response_cb callback,
 							  gpointer data);
 /**
 *	Send a move contact request to the server.
 *
 *	The response data sent to the callback will be NULL.
 *
 *  @param	user		The logged in User
 */
 NMERR_T nm_send_move_contact(NMUser * user, NMContact * contact,
 							 NMFolder * folder, nm_response_cb callback,
 							 gpointer data);
 /**
 *	Send a get status request to the server.
 *
 * 	The response data sent to the callback will be a NMUserRecord.
 *
 *  @param	user		The logged in User
 *	@return	NM_OK if successfully sent, error otherwise
 */
 NMERR_T nm_send_get_status(NMUser * user, NMUserRecord * user_record,
 						   nm_response_cb callback, gpointer data);
 /**
 *	Reads a response/event from the server and processes it.
 *
 *  @param	user	The logged in User
 */
 NMERR_T nm_process_new_data(NMUser * user);
 /**
 *	Return the root folder of the contact list
 *
 *  @param	user	The logged in User
 *
 *	@return	Root folder
 */
 NMFolder *nm_get_root_folder(NMUser * user);
 /**
 *	Create the contact list based on the login fields
 *
 *  @param	user	The logged in User
 *
 */
 NMConn *nm_user_get_conn(NMUser * user);
 /** Some utility functions **/
 /**
 * Check to see if the conference GUIDs are equivalent.
 *
 * @param guid1	First guid to compare
 * @param guid2 Second guid to compare
 *
 * @return 		TRUE if conference GUIDs are equivalent, FALSE otherwise.

Mercurial > pidgin3 / file comparison

comparison: src/protocols/novell/nmuser.h

src/protocols/novell/nmuser.h