include/alp/postal_imps_search.h File Reference


Detailed Description

Postal IMPS search APIs.

#include <alp/postal_types.h>
#include <alp/postal_imps_types.h>
#include <alp/postal_property.h>
#include <alp/postal_imps_service.h>

Go to the source code of this file.

Defines

#define ALP_POSTAL_IMPS_SEARCH_ELEMENT_GROUP_ID   (alp_postal_imps_search_element_t)8
#define ALP_POSTAL_IMPS_SEARCH_ELEMENT_GROUP_NAME   (alp_postal_imps_search_element_t)9
#define ALP_POSTAL_IMPS_SEARCH_ELEMENT_GROUP_TOPIC   (alp_postal_imps_search_element_t)10
#define ALP_POSTAL_IMPS_SEARCH_ELEMENT_GROUP_USER_ID_JOINED   (alp_postal_imps_search_element_t)11
#define ALP_POSTAL_IMPS_SEARCH_ELEMENT_GROUP_USER_ID_OWNER   (alp_postal_imps_search_element_t)12
#define ALP_POSTAL_IMPS_SEARCH_ELEMENT_PROFILE_AGE_MAX   (alp_postal_imps_search_element_t)16
#define ALP_POSTAL_IMPS_SEARCH_ELEMENT_PROFILE_AGE_MIN   (alp_postal_imps_search_element_t)15
#define ALP_POSTAL_IMPS_SEARCH_ELEMENT_PROFILE_COUNTRY   (alp_postal_imps_search_element_t)14
#define ALP_POSTAL_IMPS_SEARCH_ELEMENT_PROFILE_FRIENDLY_NAME   (alp_postal_imps_search_element_t)13
#define ALP_POSTAL_IMPS_SEARCH_ELEMENT_USER_ALIAS   (alp_postal_imps_search_element_t)5
#define ALP_POSTAL_IMPS_SEARCH_ELEMENT_USER_EMAIL_ADDRESS   (alp_postal_imps_search_element_t)4
#define ALP_POSTAL_IMPS_SEARCH_ELEMENT_USER_FIRST_NAME   (alp_postal_imps_search_element_t)2
#define ALP_POSTAL_IMPS_SEARCH_ELEMENT_USER_ID   (alp_postal_imps_search_element_t)1
#define ALP_POSTAL_IMPS_SEARCH_ELEMENT_USER_LAST_NAME   (alp_postal_imps_search_element_t)3
#define ALP_POSTAL_IMPS_SEARCH_ELEMENT_USER_MOBILE_NUMBER   (alp_postal_imps_search_element_t)7
#define ALP_POSTAL_IMPS_SEARCH_ELEMENT_USER_ONLINE_STATUS   (alp_postal_imps_search_element_t)6
#define IMPS_SEARCH_MAX_SEARCH_LIMIT   10
#define IMPS_SEARCH_STRING_MAXSIZE   100

Typedefs

typedef char alp_postal_imps_search_string_char_t [IMPS_SEARCH_STRING_MAXSIZE]
typedef void(* AlpPostalImpsSearchAsyncReplyCallback )(alp_postal_session_id_t iSessionId, AlpPostalEnumerator *iBuddyEnumeratorP, uint32_t iSearchId, uint32_t iSearchFinding, bool iCompleted, alp_status_t iRequestResult)
 Postal Imps Async Search Response Callback.
typedef _AlpPostalPropertyContainerList AlpPostalImpsSearchElementList
typedef void(* AlpPostalImpsStopAsyncReplyCallback )(alp_postal_session_id_t iSessionId, alp_status_t iRequestResult)

Functions

alp_status_t alp_postal_imps_search_cancel_continue (alp_postal_session_id_t iSessionId)
 Cancel the async search_continue call.
alp_status_t alp_postal_imps_search_cancel_start (alp_postal_session_id_t iSessionId)
 Cancel the async search_start call.
alp_status_t alp_postal_imps_search_cancel_stop (alp_postal_session_id_t iSessionId)
 Cancel the async search_stop call.
alp_status_t alp_postal_imps_search_continue (alp_postal_session_id_t iSessionId, uint32_t iSearchId, AlpPostalImpsSearchAsyncReplyCallback iCallbackFuncP)
 Continue the search.
alp_status_t alp_postal_imps_search_get_next_buddy (AlpPostalEnumerator *iBuddyEnumeratorP, AlpPostalImpsBuddy *oBuddyP)
 Return the buddy structure for the current position and increment it.
alp_status_t alp_postal_imps_search_list_init (AlpPostalImpsSearchElementList *iImpsSeachElementListP)
 Initialize a Search Element List. MUST be called before used.
alp_status_t alp_postal_imps_search_release_enumerator (AlpPostalEnumerator *iBuddyEnumeratorP)
 free datas into the enumerator and release it, must be called when data access is over.
alp_status_t alp_postal_imps_search_set_criteria (AlpPostalImpsSearchElementList *iImpsSeachElementListP, alp_postal_imps_search_element_t iSearchElement, alp_postal_imps_search_string_char_t iSearchString)
 Set a criteria on a Search Element List. If iSearchElement already exist, it will be overwritten.
alp_status_t alp_postal_imps_search_start (alp_postal_session_id_t iSessionId, AlpPostalImpsSearchElementList *iImpsSeachElementListP, uint8_t iSearchLimit, AlpPostalImpsSearchAsyncReplyCallback iCallbackFuncP)
 Send the search request to the IMPS Server.
alp_status_t alp_postal_imps_search_stop (alp_postal_session_id_t iSessionId, uint32_t iSearchId, AlpPostalImpsStopAsyncReplyCallback iCallbackFuncP)
 Stop the search. Indicate to the server that results are no further required from a previously issued search request.


Generated on Wed Jul 30 07:06:40 2008 by Doxygen 1.4.6 for ALP SDK + Hiker Documentation

Copyright © 1999-2008 ACCESS CO., LTD. All rights reserved.