Session
[IMPS]

---

Detailed Description

Postal IMPS session management APIs.

Defines
#define	ALP_POSTAL_IMPS_ENTITY_GROUPID   ((alp_postal_imps_entity_t)3)
#define	ALP_POSTAL_IMPS_ENTITY_SCREEN_NAME   ((alp_postal_imps_entity_t)2)
#define	ALP_POSTAL_IMPS_ENTITY_USERID   ((alp_postal_imps_entity_t)1)
	Values for entity type.
#define	ALP_POSTAL_IMPS_NOTIFICATION_SESSION_INFO   ALP_POSTAL_NOTIFICATION(ALP_POSTAL_SERVICE_ID_IMPS, ALP_POSTAL_IMPS_SERVICE_CLASS_ID_SESSION, 1)
	Notification ID for a session info.
#define	ALP_POSTAL_IMPS_PROPERTY_SESSION_ENTITY_TYPE   ALP_POSTAL_PROPERTY(ALP_POSTAL_SERVICE_ID_IMPS, ALP_POSTAL_IMPS_SERVICE_CLASS_ID_SESSION, ALP_POSTAL_PROPERTY_TYPE_INT, 1)
	The type of the entity.
Typedefs
typedef uint8_t	alp_postal_imps_entity_t
	Entity type.
typedef void(*	AlpPostalImpsSessionConnectAsyncReplyCallback )(alp_postal_session_id_t iSessiontId, alp_status_t iRequestResult, char *iResultDescription)
	Postal Imps Session Connection request async response Callback.
typedef void(*	AlpPostalImpsSessionDisconnectAsyncReplyCallback )(alp_postal_session_id_t iSessiontId, alp_status_t iRequestResult, char *iResultDescription)
	Postal Imps Session Disconnection request async response Callback.
typedef void(*	AlpPostalImpsSessionInfoNotificationCallbackPtr )(alp_postal_session_id_t iSessionId, alp_status_t iStatus)
	Postal Imps Session Info Callback.
typedef void(*	AlpPostalSessionBlockEntityReplyCallbackPtr )(alp_postal_session_id_t iSessionId, alp_status_t iStatus)
	Postal Imps Session Block Entity list Callback.
typedef void(*	AlpPostalSessionGetPresenceReplyCallbackPtr )(alp_postal_session_id_t iSessionId, alp_status_t iStatus, AlpPostalImpsBuddy *iBuddy)
	Postal Imps Session Get Presence Callback.
typedef void(*	AlpPostalSessionGetWatcherListReplyCallbackPtr )(alp_postal_session_id_t iSessionId, alp_status_t iStatus, int iHistoryPeriod, AlpPostalEnumerator *iWatcherEnumeratorP)
	Postal Imps Session Get Watcher List Callback.
typedef void(*	AlpPostalSessionInviteToGroupReplyCallbackPtr )(alp_postal_session_id_t iSessionId, alp_status_t iStatus)
	Postal Imps Session Invite to group Callback.
typedef void(*	AlpPostalSessionProactiveAuthResponseReplyCallbackPtr )(alp_postal_session_id_t iSessionId, alp_status_t iStatus)
	Postal Imps Session Send Proactive Authorization Response Callback.
typedef void(*	AlpPostalSessionPublicProfileGetReplyCallbackPtr )(alp_postal_session_id_t iSessionId, alp_status_t iStatus, AlpPostalImpsPublicProfile *iPublicProfile)
	Postal Imps Session Get Public Profile Callback.
typedef void(*	AlpPostalSessionPublicProfileUpdateReplyCallbackPtr )(alp_postal_session_id_t iSessionId, alp_status_t iStatus)
	Postal Imps Session Update Public Profile Callback.
typedef void(*	AlpPostalSessionSystemMessageResponseyReplyCallbackPtr )(alp_postal_session_id_t iSessionId, alp_status_t iStatus)
	Postal Imps Session Send Message Response Callback.
typedef void(*	AlpPostalSessionUnsubscribeResponseReplyCallbackPtr )(alp_postal_session_id_t iSessionId, alp_status_t iStatus)
	Postal Imps Session Unsubscribe Response Callback.
Functions
alp_status_t	alp_postal_imps_session_block_entity_list (alp_postal_session_id_t iSessionId, AlpPostalImpsEntityList *iAddBlockList, AlpPostalImpsEntityList *iRemoveBlockList, AlpPostalImpsEntityList *iAddGrantList, AlpPostalImpsEntityList *iRemoveGrantList, bool iBlockListInUse, bool iGrantListInUse, AlpPostalSessionBlockEntityReplyCallbackPtr iCallbackP)
	Block, Grant a list of entity. Also indicate if list has to be activated.
alp_status_t	alp_postal_imps_session_buddy_exist (alp_postal_session_id_t iSessionId, char *iUserId, char *iContactListId, bool *oExistP)
	check if a userId belong to the account related to the given session.
alp_status_t	alp_postal_imps_session_buddy_init_enumerator (AlpPostalEnumerator *iEnumeratorP)
	Initialize a contact enumerator. MUST be called before alp_postal_imps_session_get_contact_enumerator API.
alp_status_t	alp_postal_imps_session_buddy_release_enumerator (AlpPostalEnumerator *iEnumeratorP)
	free datas into the enumerator and release it, must be called when data access is over.
alp_status_t	alp_postal_imps_session_connect (alp_postal_session_id_t iSessionId, char *iLoginPasswd, AlpPostalImpsSessionConnectAsyncReplyCallback iCallbackFuncP)
	Connect the given session - async request.
alp_status_t	alp_postal_imps_session_contact_list_init_enumerator (AlpPostalEnumerator *iEnumeratorP)
	Initialize a contact list enumerator. MUST be called before alp_postal_imps_session_get_contact_list_enumerator API.
alp_status_t	alp_postal_imps_session_contact_list_release_enumerator (AlpPostalEnumerator *iEnumeratorP)
	free datas into the enumerator and release it, must be called when data access is over.
alp_status_t	alp_postal_imps_session_disconnect (alp_postal_session_id_t iSessionId, AlpPostalImpsSessionDisconnectAsyncReplyCallback iCallbackFuncP)
	Disconnect the given session - async request.
alp_status_t	alp_postal_imps_session_get_block_enumerator (alp_postal_session_id_t iSessionId, AlpPostalEnumerator *oBlockEnumeratorP)
	Get an enumerator of blocked entity in a specific session.
alp_status_t	alp_postal_imps_session_get_buddy_enumerator (alp_postal_session_id_t iSessionId, AlpPostalSearchNode *iFilterP, AlpPostalSortCriteria *iSortInfoP, AlpPostalEnumerator *oBuddyEnumeratorP)
	Get an enumerator of contact in a specific session.
alp_status_t	alp_postal_imps_session_get_contact_list_enumerator (alp_postal_session_id_t iSessionId, AlpPostalEnumerator *oEnumeratorP)
	Get an enumerator of contactList in a specific session.
alp_status_t	alp_postal_imps_session_get_grant_enumerator (alp_postal_session_id_t iSessionId, AlpPostalEnumerator *oGrantEnumeratorP)
	Get an enumerator of granted entity in a specific session.
alp_status_t	alp_postal_imps_session_get_next_buddy (AlpPostalEnumerator *iEnumeratorP, AlpPostalImpsBuddy *oImpsBuddy)
	Return the contact structure for the current position and increment it.
alp_status_t	alp_postal_imps_session_get_next_contact_list (AlpPostalEnumerator *iEnumeratorP, AlpPostalImpsContactList *ioImpsContactListP)
	Return the contactList structure for the current position and increment it.
alp_status_t	alp_postal_imps_session_get_next_entity (AlpPostalEnumerator *iEnumeratorP, AlpPostalImpsEntity *oImpsEntity)
	Return the entity structure for the current position and increment it.
alp_status_t	alp_postal_imps_session_get_presence (alp_postal_session_id_t iSessionId, const char *iUserId, AlpPostalSessionGetPresenceReplyCallbackPtr iCallbackFuncP)
	free datas into the enumerator and release it, must be called when data access is over.
alp_status_t	alp_postal_imps_session_get_system_message_enumerator (alp_postal_session_id_t iSessionId, AlpPostalEnumerator *oSystemMessageEnumeratorP)
	Get an enumerator of system message in a specific session.
alp_status_t	alp_postal_imps_session_get_watcher_list (alp_postal_session_id_t iSessionId, int iHistoryPeriod, AlpPostalSessionGetWatcherListReplyCallbackPtr iCallbackFuncP)
	Get Watcher List.
alp_status_t	alp_postal_imps_session_invite_to_group (alp_postal_session_id_t iSessionId, AlpPostalImpsNickList *iNickListP, char *iGroupId, char *iInviteNote, AlpPostalSessionInviteToGroupReplyCallbackPtr iCallbackP)
	invite a contact to join a group chat.
alp_status_t	alp_postal_imps_session_proactive_auth (alp_postal_session_id_t iSessionId, const char *iUserId, AlpPostalSessionProactiveAuthResponseReplyCallbackPtr iCallbackFuncP)
	Send a proactive authorization for default presence attibutes.
alp_status_t	alp_postal_imps_session_public_profile_get (alp_postal_session_id_t iSessionId, const char *iUserId, AlpPostalSessionPublicProfileGetReplyCallbackPtr iCallbackFuncP)
	Get Public Profile of iUserId.
alp_status_t	alp_postal_imps_session_public_profile_update (alp_postal_session_id_t iSessionId, AlpPostalImpsPublicProfile *iPublicProfile, AlpPostalSessionPublicProfileUpdateReplyCallbackPtr iCallbackFuncP)
	Update My Public Profile.
alp_status_t	alp_postal_imps_session_refresh (alp_postal_session_id_t iSessionId)
	poll the imps server.
alp_status_t	alp_postal_imps_session_restriction_in_use (alp_postal_session_id_t iSessionId, bool *oBlockListInUse, bool *oGrantListInUse)
	Return a bool value indicating if block/grant list are in use.
alp_status_t	alp_postal_imps_session_restriction_init_enumerator (AlpPostalEnumerator *iEnumeratorP)
	Initialize an entity enumerator. MUST be called before alp_postal_imps_session_get_block_enumerator or alp_postal_imps_session_get_grant_enumerator API.
alp_status_t	alp_postal_imps_session_restriction_release_enumerator (AlpPostalEnumerator *iEnumeratorP)
	free datas into the enumerator and release it, must be called when data access is over.
alp_status_t	alp_postal_imps_session_system_message_get_next (AlpPostalEnumerator *iSystemMessageEnumeratorP, AlpPostalImpsSystemMessage *oImpsSystemMessage)
	Return the system message structure for the current position and increment enumerator cursor.
alp_status_t	alp_postal_imps_session_system_message_init_enumerator (AlpPostalEnumerator *iSystemMessageEnumeratorP)
	Initialize a system message enumerator. MUST be called before alp_postal_imps_session_get_system_message_enumerator API.
alp_status_t	alp_postal_imps_session_system_message_release_enumerator (AlpPostalEnumerator *iSystemMessageEnumeratorP)
	free datas into the enumerator and release it, must be called when data access is over.
alp_status_t	alp_postal_imps_session_system_message_send_response (alp_postal_session_id_t iSessionId, AlpPostalImpsSystemMessageResponseList *iImpsResponseList, AlpPostalSessionSystemMessageResponseyReplyCallbackPtr iCallbackFuncP)
	Send a list of System Message Response.
alp_status_t	alp_postal_imps_session_unsubscribe (alp_postal_session_id_t iSessionId, const char *iUserId, AlpPostalSessionUnsubscribeResponseReplyCallbackPtr iCallbackFuncP)
	Unsubscribe presence.
alp_status_t	alp_postal_imps_session_watcher_get_next (AlpPostalEnumerator *iWatcherEnumeratorP, AlpPostalImpsWatcher *oImpsWatcher)
	Return the watcher structure for the current position and increment enumerator cursor.
alp_status_t	alp_postal_imps_session_watcher_release_enumerator (AlpPostalEnumerator **iWatcherEnumeratorP)
	free datas into the enumerator and release it, must be called when data access is over.

---

Define Documentation

#define ALP_POSTAL_IMPS_ENTITY_GROUPID   ((alp_postal_imps_entity_t)3)

#define ALP_POSTAL_IMPS_ENTITY_SCREEN_NAME   ((alp_postal_imps_entity_t)2)

#define ALP_POSTAL_IMPS_ENTITY_USERID   ((alp_postal_imps_entity_t)1)

Values for entity type.

#define ALP_POSTAL_IMPS_NOTIFICATION_SESSION_INFO   ALP_POSTAL_NOTIFICATION(ALP_POSTAL_SERVICE_ID_IMPS, ALP_POSTAL_IMPS_SERVICE_CLASS_ID_SESSION, 1)

Notification ID for a session info.

#define ALP_POSTAL_IMPS_PROPERTY_SESSION_ENTITY_TYPE   ALP_POSTAL_PROPERTY(ALP_POSTAL_SERVICE_ID_IMPS, ALP_POSTAL_IMPS_SERVICE_CLASS_ID_SESSION, ALP_POSTAL_PROPERTY_TYPE_INT, 1)

The type of the entity.

---

Typedef Documentation

typedef uint8_t alp_postal_imps_entity_t

Entity type.

typedef void(* AlpPostalImpsSessionConnectAsyncReplyCallback)(alp_postal_session_id_t iSessiontId, alp_status_t iRequestResult, char *iResultDescription)

Postal Imps Session Connection request async response Callback.

typedef void(* AlpPostalImpsSessionDisconnectAsyncReplyCallback)(alp_postal_session_id_t iSessiontId, alp_status_t iRequestResult, char *iResultDescription)

Postal Imps Session Disconnection request async response Callback.

typedef void(* AlpPostalImpsSessionInfoNotificationCallbackPtr)(alp_postal_session_id_t iSessionId, alp_status_t iStatus)

Postal Imps Session Info Callback.

typedef void(* AlpPostalSessionBlockEntityReplyCallbackPtr)(alp_postal_session_id_t iSessionId, alp_status_t iStatus)

Postal Imps Session Block Entity list Callback.

typedef void(* AlpPostalSessionGetPresenceReplyCallbackPtr)(alp_postal_session_id_t iSessionId, alp_status_t iStatus, AlpPostalImpsBuddy *iBuddy)

Postal Imps Session Get Presence Callback.

typedef void(* AlpPostalSessionGetWatcherListReplyCallbackPtr)(alp_postal_session_id_t iSessionId, alp_status_t iStatus, int iHistoryPeriod, AlpPostalEnumerator *iWatcherEnumeratorP)

Postal Imps Session Get Watcher List Callback.

typedef void(* AlpPostalSessionInviteToGroupReplyCallbackPtr)(alp_postal_session_id_t iSessionId, alp_status_t iStatus)

Postal Imps Session Invite to group Callback.

typedef void(* AlpPostalSessionProactiveAuthResponseReplyCallbackPtr)(alp_postal_session_id_t iSessionId, alp_status_t iStatus)

Postal Imps Session Send Proactive Authorization Response Callback.

typedef void(* AlpPostalSessionPublicProfileGetReplyCallbackPtr)(alp_postal_session_id_t iSessionId, alp_status_t iStatus, AlpPostalImpsPublicProfile *iPublicProfile)

Postal Imps Session Get Public Profile Callback.

typedef void(* AlpPostalSessionPublicProfileUpdateReplyCallbackPtr)(alp_postal_session_id_t iSessionId, alp_status_t iStatus)

Postal Imps Session Update Public Profile Callback.

typedef void(* AlpPostalSessionSystemMessageResponseyReplyCallbackPtr)(alp_postal_session_id_t iSessionId, alp_status_t iStatus)

Postal Imps Session Send Message Response Callback.

typedef void(* AlpPostalSessionUnsubscribeResponseReplyCallbackPtr)(alp_postal_session_id_t iSessionId, alp_status_t iStatus)

Postal Imps Session Unsubscribe Response Callback.

---

Function Documentation

alp_status_t alp_postal_imps_session_block_entity_list (  alp_postal_session_id_t  iSessionId, AlpPostalImpsEntityList *  iAddBlockList, AlpPostalImpsEntityList *  iRemoveBlockList, AlpPostalImpsEntityList *  iAddGrantList, AlpPostalImpsEntityList *  iRemoveGrantList, bool  iBlockListInUse, bool  iGrantListInUse, AlpPostalSessionBlockEntityReplyCallbackPtr  iCallbackP )

Block, Grant a list of entity. Also indicate if list has to be activated. Parameters: [in]  iSessionId  The session Id to work on. [in]  iAddBlockList  a list of entity to add to the blocked list, NULL if none. [in]  iRemoveBlockList  a list of entity to remove from the blocked list, NULL if none. [in]  iAddGrantList  a list of entity to add to the granted list, NULL if none. [in]  iRemoveGrantList  a list of entity to remove from the granted list, NULL if none. [in]  iBlockListInUse  activate or desactivate the use of the block list. [in]  iGrantListInUse  activate or desactivate the use of the grant list. [in]  iCallbackP  The callback that will be called when async call terminate. Returns: Returns an error code.

alp_status_t alp_postal_imps_session_buddy_exist (  alp_postal_session_id_t  iSessionId, char *  iUserId, char *  iContactListId, bool *  oExistP )

check if a userId belong to the account related to the given session. Parameters: [in]  iSessionId  The session Id to work on. [in]  iUserId  the userId, prefixed by the scheme or not. [in]  iContactListId  the contactlistId to search into, all if iContactListId is null or empty. [out]  oExistP  result: true if the user exists. Returns: Returns an error code.

alp_status_t alp_postal_imps_session_buddy_init_enumerator (  AlpPostalEnumerator *  iEnumeratorP  )

Initialize a contact enumerator. MUST be called before alp_postal_imps_session_get_contact_enumerator API. Parameters: [in]  iEnumeratorP  the enumerator to initialize

alp_status_t alp_postal_imps_session_buddy_release_enumerator (  AlpPostalEnumerator *  iEnumeratorP  )

free datas into the enumerator and release it, must be called when data access is over. Parameters: [in]  iEnumeratorP  the enumerator to release

alp_status_t alp_postal_imps_session_connect (  alp_postal_session_id_t  iSessionId, char *  iLoginPasswd, AlpPostalImpsSessionConnectAsyncReplyCallback  iCallbackFuncP )

Connect the given session - async request. Parameters: [in]  iSessionId  The session Id to connect. [in]  iLoginPasswd  If set, overrides the default account password for login. [in]  iCallbackFuncP  The call back function to be called when connection process will terminate. Returns: Returns an error code.

alp_status_t alp_postal_imps_session_contact_list_init_enumerator (  AlpPostalEnumerator *  iEnumeratorP  )

Initialize a contact list enumerator. MUST be called before alp_postal_imps_session_get_contact_list_enumerator API. Parameters: [in]  iEnumeratorP  the enumerator to initialize

alp_status_t alp_postal_imps_session_contact_list_release_enumerator (  AlpPostalEnumerator *  iEnumeratorP  )

free datas into the enumerator and release it, must be called when data access is over. Parameters: [in]  iEnumeratorP  the enumerator to release

alp_status_t alp_postal_imps_session_disconnect (  alp_postal_session_id_t  iSessionId, AlpPostalImpsSessionDisconnectAsyncReplyCallback  iCallbackFuncP )

Disconnect the given session - async request. Parameters: [in]  iSessionId  The session Id to disconnect. [in]  iCallbackFuncP  The call back function to be called when disconnection process will terminate. Returns: Returns an error code.

alp_status_t alp_postal_imps_session_get_block_enumerator (  alp_postal_session_id_t  iSessionId, AlpPostalEnumerator *  oBlockEnumeratorP )

Get an enumerator of blocked entity in a specific session. Parameters: [in]  iSessionId  The session Id to work on. [out]  oBlockEnumeratorP  enumerator contening results. Returns: Returns an error code.

alp_status_t alp_postal_imps_session_get_buddy_enumerator (  alp_postal_session_id_t  iSessionId, AlpPostalSearchNode *  iFilterP, AlpPostalSortCriteria *  iSortInfoP, AlpPostalEnumerator *  oBuddyEnumeratorP )

Get an enumerator of contact in a specific session. Parameters: [in]  iSessionId  The session Id to work on. [in]  iFilterP  filter criteria. [in]  iSortInfoP  sort criteria. [out]  oBuddyEnumeratorP  enumerator contening results. Returns: Returns an error code.

alp_status_t alp_postal_imps_session_get_contact_list_enumerator (  alp_postal_session_id_t  iSessionId, AlpPostalEnumerator *  oEnumeratorP )

Get an enumerator of contactList in a specific session. Parameters: [in]  iSessionId  The session Id to work on. [out]  oEnumeratorP  enumerator contening results. Returns: Returns an error code.

alp_status_t alp_postal_imps_session_get_grant_enumerator (  alp_postal_session_id_t  iSessionId, AlpPostalEnumerator *  oGrantEnumeratorP )

Get an enumerator of granted entity in a specific session. Parameters: [in]  iSessionId  The session Id to work on. [out]  oGrantEnumeratorP  enumerator contening results. Returns: Returns an error code.

alp_status_t alp_postal_imps_session_get_next_buddy (  AlpPostalEnumerator *  iEnumeratorP, AlpPostalImpsBuddy *  oImpsBuddy )

Return the contact structure for the current position and increment it. Parameters: [in]  iEnumeratorP  enumerator contening results. [in,out]  oImpsBuddy  a filled buddy. Returns: Returns an error code.

alp_status_t alp_postal_imps_session_get_next_contact_list (  AlpPostalEnumerator *  iEnumeratorP, AlpPostalImpsContactList *  ioImpsContactListP )

Return the contactList structure for the current position and increment it. Parameters: [in]  iEnumeratorP  enumerator contening results. [in,out]  ioImpsContactListP  contact to be filled. Returns: Returns an error code.

alp_status_t alp_postal_imps_session_get_next_entity (  AlpPostalEnumerator *  iEnumeratorP, AlpPostalImpsEntity *  oImpsEntity )

Return the entity structure for the current position and increment it. Parameters: [in]  iEnumeratorP  enumerator contening results. [out]  oImpsEntity  a filled entity. Returns: Returns an error code.

alp_status_t alp_postal_imps_session_get_presence (  alp_postal_session_id_t  iSessionId, const char *  iUserId, AlpPostalSessionGetPresenceReplyCallbackPtr  iCallbackFuncP )

free datas into the enumerator and release it, must be called when data access is over. Parameters: [in]  iSessionId  The session Id to work on. [in]  iUserId  userId to retreive presence to. [in]  iCallbackFuncP  The call back function to be called when connection process will terminate. Returns: Returns an error code.

alp_status_t alp_postal_imps_session_get_system_message_enumerator (  alp_postal_session_id_t  iSessionId, AlpPostalEnumerator *  oSystemMessageEnumeratorP )

Get an enumerator of system message in a specific session. Parameters: [in]  iSessionId  The session Id to work on. [out]  oSystemMessageEnumeratorP  enumerator contening results. Returns: Returns an error code.

alp_status_t alp_postal_imps_session_get_watcher_list (  alp_postal_session_id_t  iSessionId, int  iHistoryPeriod, AlpPostalSessionGetWatcherListReplyCallbackPtr  iCallbackFuncP )

Get Watcher List. Parameters: [in]  iSessionId  The session Id to work on. [in]  iHistoryPeriod  The time period in seconds on the longest possible history of the watcher that should be returned. 0 indicates to request the watcher list at the time of the request. [in]  iCallbackFuncP  The call back function to be called when connection process will terminate.

alp_status_t alp_postal_imps_session_invite_to_group (  alp_postal_session_id_t  iSessionId, AlpPostalImpsNickList *  iNickListP, char *  iGroupId, char *  iInviteNote, AlpPostalSessionInviteToGroupReplyCallbackPtr  iCallbackP )

invite a contact to join a group chat. Parameters: [in]  iSessionId  The session Id to work on. [in]  iNickListP  The list of userId to invite. [in]  iGroupId  the groupId where to invite the users. [in]  iInviteNote  Textual description of invitation (max size is IMPS_GROUP_INVITE_NOTE_MAXSIZE). [in]  iCallbackP  The callback that will be called when async call terminate. Returns: Returns an error code.

alp_status_t alp_postal_imps_session_proactive_auth (  alp_postal_session_id_t  iSessionId, const char *  iUserId, AlpPostalSessionProactiveAuthResponseReplyCallbackPtr  iCallbackFuncP )

Send a proactive authorization for default presence attibutes. Parameters: [in]  iSessionId  The session Id to work on. [in]  iUserId  the WV user. [in]  iCallbackFuncP  The call back function to be called when connection process will terminate.

alp_status_t alp_postal_imps_session_public_profile_get (  alp_postal_session_id_t  iSessionId, const char *  iUserId, AlpPostalSessionPublicProfileGetReplyCallbackPtr  iCallbackFuncP )

Get Public Profile of iUserId. Parameters: [in]  iSessionId  The session Id to work on. [in]  iUserId  the WV user. [in]  iCallbackFuncP  The call back function to be called when connection process will terminate.

alp_status_t alp_postal_imps_session_public_profile_update (  alp_postal_session_id_t  iSessionId, AlpPostalImpsPublicProfile *  iPublicProfile, AlpPostalSessionPublicProfileUpdateReplyCallbackPtr  iCallbackFuncP )

Update My Public Profile. Parameters: [in]  iSessionId  The session Id to work on. [in]  iPublicProfile  a set of PublicProfile properties. [in]  iCallbackFuncP  The call back function to be called when connection process will terminate.

alp_status_t alp_postal_imps_session_refresh (  alp_postal_session_id_t  iSessionId  )

poll the imps server. Parameters: [in]  iSessionId  The session Id to work on. Returns: Returns an error code.

alp_status_t alp_postal_imps_session_restriction_in_use (  alp_postal_session_id_t  iSessionId, bool *  oBlockListInUse, bool *  oGrantListInUse )

Return a bool value indicating if block/grant list are in use. Parameters: [in]  iSessionId  The session Id to work on. [out]  oBlockListInUse  true if list is in use. [out]  oGrantListInUse  true if list is in use. Returns: Returns an error code.

alp_status_t alp_postal_imps_session_restriction_init_enumerator (  AlpPostalEnumerator *  iEnumeratorP  )

Initialize an entity enumerator. MUST be called before alp_postal_imps_session_get_block_enumerator or alp_postal_imps_session_get_grant_enumerator API. Parameters: [in]  iEnumeratorP  the enumerator to initialize

alp_status_t alp_postal_imps_session_restriction_release_enumerator (  AlpPostalEnumerator *  iEnumeratorP  )

free datas into the enumerator and release it, must be called when data access is over. Parameters: [in]  iEnumeratorP  the enumerator to release

alp_status_t alp_postal_imps_session_system_message_get_next (  AlpPostalEnumerator *  iSystemMessageEnumeratorP, AlpPostalImpsSystemMessage *  oImpsSystemMessage )

Return the system message structure for the current position and increment enumerator cursor. Parameters: [in]  iSystemMessageEnumeratorP  enumerator contening results. [out]  oImpsSystemMessage  a system message. Returns: Returns an error code.

alp_status_t alp_postal_imps_session_system_message_init_enumerator (  AlpPostalEnumerator *  iSystemMessageEnumeratorP  )

Initialize a system message enumerator. MUST be called before alp_postal_imps_session_get_system_message_enumerator API. Parameters: [in]  iSystemMessageEnumeratorP  the enumerator to initialize

alp_status_t alp_postal_imps_session_system_message_release_enumerator (  AlpPostalEnumerator *  iSystemMessageEnumeratorP  )

free datas into the enumerator and release it, must be called when data access is over. Parameters: [in]  iSystemMessageEnumeratorP  the enumerator to release

alp_status_t alp_postal_imps_session_system_message_send_response (  alp_postal_session_id_t  iSessionId, AlpPostalImpsSystemMessageResponseList *  iImpsResponseList, AlpPostalSessionSystemMessageResponseyReplyCallbackPtr  iCallbackFuncP )

Send a list of System Message Response. Parameters: [in]  iSessionId  The session Id to work on. [in]  iImpsResponseList  the list contening the responses. [in]  iCallbackFuncP  The call back function to be called when connection process will terminate.

alp_status_t alp_postal_imps_session_unsubscribe (  alp_postal_session_id_t  iSessionId, const char *  iUserId, AlpPostalSessionUnsubscribeResponseReplyCallbackPtr  iCallbackFuncP )

Unsubscribe presence. Parameters: [in]  iSessionId  The session Id to work on. [in]  iUserId  the WV user. [in]  iCallbackFuncP  The call back function to be called when connection process will terminate.

alp_status_t alp_postal_imps_session_watcher_get_next (  AlpPostalEnumerator *  iWatcherEnumeratorP, AlpPostalImpsWatcher *  oImpsWatcher )

Return the watcher structure for the current position and increment enumerator cursor. Parameters: [in]  iWatcherEnumeratorP  enumerator contening results. [out]  oImpsWatcher  a watcher. Returns: Returns an error code.

alp_status_t alp_postal_imps_session_watcher_release_enumerator (  AlpPostalEnumerator **  iWatcherEnumeratorP  )

free datas into the enumerator and release it, must be called when data access is over. Parameters: [in]  iWatcherEnumeratorP  the enumerator to release. Returns: Returns an error code.

---

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

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