Watcher
[IMPS]


Detailed Description

Postal IMPS watcher APIs.


IMPS WATCHER STATUS

Defines possible watcher status

#define ALP_POSTAL_IMPS_WATCHER_CURRENT_SUBSCRIBER   1
 Current Subscriber.
#define ALP_POSTAL_IMPS_WATCHER_FORMER_SUBSCRIBER   2
 Former Subscriber.
#define ALP_POSTAL_IMPS_WATCHER_PRESENCE_ACCESS   3
 Presence Access.

Defines

#define ALP_POSTAL_IMPS_PROPERTY_WATCHER_CLIENT_ID   ALP_POSTAL_PROPERTY(ALP_POSTAL_SERVICE_ID_IMPS, ALP_POSTAL_IMPS_SERVICE_CLASS_ID_WATCHER, ALP_POSTAL_PROPERTY_TYPE_C_STRING, 2)
 Watcher ClientID.
#define ALP_POSTAL_IMPS_PROPERTY_WATCHER_STATUS   ALP_POSTAL_PROPERTY(ALP_POSTAL_SERVICE_ID_IMPS, ALP_POSTAL_IMPS_SERVICE_CLASS_ID_WATCHER, ALP_POSTAL_PROPERTY_TYPE_INT, 3)
 Watcher Status.
#define ALP_POSTAL_IMPS_PROPERTY_WATCHER_USER_ID   ALP_POSTAL_PROPERTY(ALP_POSTAL_SERVICE_ID_IMPS, ALP_POSTAL_IMPS_SERVICE_CLASS_ID_WATCHER, ALP_POSTAL_PROPERTY_TYPE_C_STRING, 1)
 Watcher UserID.

Typedefs

typedef _AlpPostalPropertyContainer AlpPostalImpsWatcher
 Defines IMPS Watcher.
typedef _AlpPostalPropertyContainerList AlpPostalImpsWatcherList
 Defines IMPS Watcher List.

Functions

alp_status_t alp_postal_imps_watcher_free (AlpPostalImpsWatcher *iImpsWatcher)
 Free a Watcher.
alp_status_t alp_postal_imps_watcher_get_property (AlpPostalImpsWatcher *iImpsWatcher, alp_postal_property_id_t iPropertyId, AlpPostalProperty **oPropertyP)
 Get a property from a AlpPostalImpsWatcher.


Define Documentation

#define ALP_POSTAL_IMPS_PROPERTY_WATCHER_CLIENT_ID   ALP_POSTAL_PROPERTY(ALP_POSTAL_SERVICE_ID_IMPS, ALP_POSTAL_IMPS_SERVICE_CLASS_ID_WATCHER, ALP_POSTAL_PROPERTY_TYPE_C_STRING, 2)
 

Watcher ClientID.

#define ALP_POSTAL_IMPS_PROPERTY_WATCHER_STATUS   ALP_POSTAL_PROPERTY(ALP_POSTAL_SERVICE_ID_IMPS, ALP_POSTAL_IMPS_SERVICE_CLASS_ID_WATCHER, ALP_POSTAL_PROPERTY_TYPE_INT, 3)
 

Watcher Status.

#define ALP_POSTAL_IMPS_PROPERTY_WATCHER_USER_ID   ALP_POSTAL_PROPERTY(ALP_POSTAL_SERVICE_ID_IMPS, ALP_POSTAL_IMPS_SERVICE_CLASS_ID_WATCHER, ALP_POSTAL_PROPERTY_TYPE_C_STRING, 1)
 

Watcher UserID.

#define ALP_POSTAL_IMPS_WATCHER_CURRENT_SUBSCRIBER   1
 

Current Subscriber.

#define ALP_POSTAL_IMPS_WATCHER_FORMER_SUBSCRIBER   2
 

Former Subscriber.

#define ALP_POSTAL_IMPS_WATCHER_PRESENCE_ACCESS   3
 

Presence Access.


Typedef Documentation

typedef struct _AlpPostalPropertyContainer AlpPostalImpsWatcher
 

Defines IMPS Watcher.

typedef struct _AlpPostalPropertyContainerList AlpPostalImpsWatcherList
 

Defines IMPS Watcher List.


Function Documentation

alp_status_t alp_postal_imps_watcher_free AlpPostalImpsWatcher iImpsWatcher  ) 
 

Free a Watcher.

Parameters:
[in] iImpsWatcher A Watcher object to free.
Returns:
Returns an error code.

alp_status_t alp_postal_imps_watcher_get_property AlpPostalImpsWatcher iImpsWatcher,
alp_postal_property_id_t  iPropertyId,
AlpPostalProperty **  oPropertyP
 

Get a property from a AlpPostalImpsWatcher.

Parameters:
[in] iImpsWatcher A watcher Ptr.
[in] iPropertyId A Property ID.
[out] oPropertyP A watcher property to retrieve.
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.