include/alp/postal_imps_presence.h File Reference

Detailed Description

Postal IMPS presence APIs.

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

Go to the source code of this file.

IMPS PRESENCE ATTRIBUTES

Defines presence attributes

#define ALP_POSTAL_IMPS_NOTIFICATION_PRESENCE_AUTH   ALP_POSTAL_NOTIFICATION(ALP_POSTAL_SERVICE_ID_IMPS, ALP_POSTAL_IMPS_SERVICE_CLASS_ID_PRESENCE, 2)

Notification ID for a presence authorization.

#define ALP_POSTAL_IMPS_NOTIFICATION_PRESENCE_UPDATE   ALP_POSTAL_NOTIFICATION(ALP_POSTAL_SERVICE_ID_IMPS, ALP_POSTAL_IMPS_SERVICE_CLASS_ID_PRESENCE, 1)

Notification ID for a presence update.

#define ALP_POSTAL_IMPS_PROPERTY_PRESENCE_ALIAS   ALP_POSTAL_PROPERTY(ALP_POSTAL_SERVICE_ID_IMPS, ALP_POSTAL_IMPS_SERVICE_CLASS_ID_PRESENCE, ALP_POSTAL_PROPERTY_TYPE_C_STRING, 5)

Alias of the user.

#define ALP_POSTAL_IMPS_PROPERTY_PRESENCE_AVAILABILITY   ALP_POSTAL_PROPERTY(ALP_POSTAL_SERVICE_ID_IMPS, ALP_POSTAL_IMPS_SERVICE_CLASS_ID_PRESENCE, ALP_POSTAL_PROPERTY_TYPE_INT, 2)

Availability of the user for communication.

#define ALP_POSTAL_IMPS_PROPERTY_PRESENCE_BUDDY_ICON_PATH   ALP_POSTAL_PROPERTY(ALP_POSTAL_SERVICE_ID_IMPS, ALP_POSTAL_IMPS_SERVICE_CLASS_ID_PRESENCE, ALP_POSTAL_PROPERTY_TYPE_C_STRING, 9)

Buddy Icon.

#define ALP_POSTAL_IMPS_PROPERTY_PRESENCE_CLIENT_TYPE   ALP_POSTAL_PROPERTY(ALP_POSTAL_SERVICE_ID_IMPS, ALP_POSTAL_IMPS_SERVICE_CLASS_ID_PRESENCE, ALP_POSTAL_PROPERTY_TYPE_INT, 8)

Client type.

#define ALP_POSTAL_IMPS_PROPERTY_PRESENCE_DEFAULT_ATTRIBUTE_LIST   ALP_POSTAL_PROPERTY(ALP_POSTAL_SERVICE_ID_IMPS, ALP_POSTAL_IMPS_SERVICE_CLASS_ID_PRESENCE, ALP_POSTAL_PROPERTY_TYPE_BOOLEAN, 7)

Default presence list when retrieving attribute list.

#define ALP_POSTAL_IMPS_PROPERTY_PRESENCE_MOOD   ALP_POSTAL_PROPERTY(ALP_POSTAL_SERVICE_ID_IMPS, ALP_POSTAL_IMPS_SERVICE_CLASS_ID_PRESENCE, ALP_POSTAL_PROPERTY_TYPE_INT, 4)

Mood of the user.

#define ALP_POSTAL_IMPS_PROPERTY_PRESENCE_ONLINE_STATUS   ALP_POSTAL_PROPERTY(ALP_POSTAL_SERVICE_ID_IMPS, ALP_POSTAL_IMPS_SERVICE_CLASS_ID_PRESENCE, ALP_POSTAL_PROPERTY_TYPE_BOOLEAN, 1)

Shows if the client is logged on a IMPS server.

#define ALP_POSTAL_IMPS_PROPERTY_PRESENCE_PREFERRED_LANGUAGE   ALP_POSTAL_PROPERTY(ALP_POSTAL_SERVICE_ID_IMPS, ALP_POSTAL_IMPS_SERVICE_CLASS_ID_PRESENCE, ALP_POSTAL_PROPERTY_TYPE_C_STRING, 6)

Preferred language.

#define ALP_POSTAL_IMPS_PROPERTY_PRESENCE_STATUS_TEXT   ALP_POSTAL_PROPERTY(ALP_POSTAL_SERVICE_ID_IMPS, ALP_POSTAL_IMPS_SERVICE_CLASS_ID_PRESENCE, ALP_POSTAL_PROPERTY_TYPE_C_STRING, 3)

User specified status text.

IMPS PRESENCE AUTH

Defines possible action for authorization request.

#define ALP_POSTAL_IMPS_PRESENCE_AUTH_ACCEPT   (alp_postal_imps_auth_type_t)1

Accept to share presence.

#define ALP_POSTAL_IMPS_PRESENCE_AUTH_CANCEL   (alp_postal_imps_auth_type_t)3

Cancel auth mechanism.

#define ALP_POSTAL_IMPS_PRESENCE_AUTH_REJECT   (alp_postal_imps_auth_type_t)2

Refuse to share presence.

IMPS PRESENCE AVAILABILTY

Defines possible availability status

#define ALP_POSTAL_IMPS_PRESENCE_AVAILABILITY_AVAILABLE   1

User is available for all forms of communication.

#define ALP_POSTAL_IMPS_PRESENCE_AVAILABILITY_DISCREET   3

The communication with the publisher is left at the discretion of the user.

#define ALP_POSTAL_IMPS_PRESENCE_AVAILABILITY_NOT_AVAILABLE   2

User is not available for instant (e.g. call and IM) communication.

IMPS PRESENCE CLIENT TYPE

Defines possible client type.

#define ALP_POSTAL_IMPS_PRESENCE_CLIENT_TYPE_COMPUTER   2

Client type is a computer.

#define ALP_POSTAL_IMPS_PRESENCE_CLIENT_TYPE_MOBILE   1

Client type is mobile phone.

#define ALP_POSTAL_IMPS_PRESENCE_CLIENT_TYPE_OTHER   4

Client type is a other.

#define ALP_POSTAL_IMPS_PRESENCE_CLIENT_TYPE_PDA   3

Client type is a pda.

IMPS PRESENCE MOOD

Defines possible mood.

#define ALP_POSTAL_IMPS_PRESENCE_MOOD_ANGRY   3

publisher feels angry.

#define ALP_POSTAL_IMPS_PRESENCE_MOOD_ANXIOUS   11

publisher feels anxious.

#define ALP_POSTAL_IMPS_PRESENCE_MOOD_ASHAMED   5

publisher feels ashamed.

#define ALP_POSTAL_IMPS_PRESENCE_MOOD_BORED   9

publisher feels bored.

#define ALP_POSTAL_IMPS_PRESENCE_MOOD_EXCITED   10

publisher feels excited.

#define ALP_POSTAL_IMPS_PRESENCE_MOOD_HAPPY   1

publisher feels happy.

#define ALP_POSTAL_IMPS_PRESENCE_MOOD_IN_LOVE   7

publisher feels being in love.

#define ALP_POSTAL_IMPS_PRESENCE_MOOD_INVINCIBLE   6

publisher feels invincible.

#define ALP_POSTAL_IMPS_PRESENCE_MOOD_JEALOUS   4

publisher feels jealous.

#define ALP_POSTAL_IMPS_PRESENCE_MOOD_SAD   2

publisher feels sad.

#define ALP_POSTAL_IMPS_PRESENCE_MOOD_SLEEPY   8

publisher feels sleepy.

#define ALP_POSTAL_IMPS_PRESENCE_MOOD_UNKNOWN   0

publisher feels bad.

IMPS PRESENCE SERVICE TYPE

Defines possible service type.

#define ALP_POSTAL_IMPS_PRESENCE_SERVICE_AOL   2

aol im service.

#define ALP_POSTAL_IMPS_PRESENCE_SERVICE_ICQ   4

icq im service.

#define ALP_POSTAL_IMPS_PRESENCE_SERVICE_JABBER   5

jabber im service.

#define ALP_POSTAL_IMPS_PRESENCE_SERVICE_MSN   1

msn im service.

#define ALP_POSTAL_IMPS_PRESENCE_SERVICE_XMPP   6

xmpp based service.

#define ALP_POSTAL_IMPS_PRESENCE_SERVICE_YAHOO   3

yahoo im service.

Typedefs

typedef void(* AlpPostalImpsPresenceAuthNotificationCallbackPtr )(alp_postal_session_id_t iSessionId, char iUserId[IMPS_USERID_MAXSIZE], char iAuthIdentifier[IMPS_TRANSACTIONID_MAXSIZE])

Postal Imps Presence Auth Notification Callback.

typedef void(* AlpPostalImpsPresenceChangeNotificationCallbackPtr )(alp_postal_session_id_t iSessionId, alp_postal_imps_buddy_id_t iBuddy)

Postal Imps Presence Notification Callback.

typedef void(* AlpPostalPresenceAuthAsyncReplyCallback )(alp_postal_session_id_t iSessionId, char iAuthId[IMPS_TRANSACTIONID_MAXSIZE], alp_status_t iRequestResult)

Postal Imps Async Presence Auth Callback.

typedef void(* AlpPostalPresenceUpdateAsyncReplyCallback )(alp_postal_session_id_t iSessionId, alp_status_t iRequestResult)

Postal Imps Async Presence Update Callback.

Functions

alp_status_t alp_postal_imps_presence_auth_response (alp_postal_session_id_t iSessionId, char iUserId[IMPS_USERID_MAXSIZE], char iAuthId[IMPS_TRANSACTIONID_MAXSIZE], alp_postal_imps_auth_type_t iAuthType, AlpPostalPresenceAuthAsyncReplyCallback iCallbackFuncP)

Send a response to the Auth Notification.

alp_status_t alp_postal_imps_presence_cancel_auth_response (alp_postal_session_id_t iSessionId)

Cancel the send response to the Auth Notification.

alp_status_t alp_postal_imps_presence_get_attribute_list (alp_postal_session_id_t iSessionId)

Retrieve the attribute lists.

alp_status_t alp_postal_imps_presence_get_property (AlpPostalImpsPresence *iImpsPresenceP, alp_postal_property_id_t iImpsPresencePropertyId, AlpPostalProperty **oImpsPresencePropertyP)

Get a property from a Contact.

alp_status_t alp_postal_imps_presence_init (AlpPostalImpsPresence *iImpsPresenceP)

Initialize an ImpsPresence. MUST be called before used.

alp_status_t alp_postal_imps_presence_set_property (AlpPostalImpsPresence *ioImpsPresenceP, alp_postal_property_id_t iImpsPresencePropertyId, alp_postal_property_const_value_t iImpsPresencePropertyDataP, uint16_t iImpsPresencePropertyDataSize)

Set a property to a Postal ImpsPresence.

alp_status_t alp_postal_imps_presence_update (alp_postal_session_id_t iSessionId, AlpPostalImpsPresence *iPresenceP, AlpPostalPresenceUpdateAsyncReplyCallback iCallbackFuncP)

update my presence status with given attributes.

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


IMPS PRESENCE ATTRIBUTES
Defines presence attributes
#define	ALP_POSTAL_IMPS_NOTIFICATION_PRESENCE_AUTH ALP_POSTAL_NOTIFICATION(ALP_POSTAL_SERVICE_ID_IMPS, ALP_POSTAL_IMPS_SERVICE_CLASS_ID_PRESENCE, 2)
	Notification ID for a presence authorization.
#define	ALP_POSTAL_IMPS_NOTIFICATION_PRESENCE_UPDATE ALP_POSTAL_NOTIFICATION(ALP_POSTAL_SERVICE_ID_IMPS, ALP_POSTAL_IMPS_SERVICE_CLASS_ID_PRESENCE, 1)
	Notification ID for a presence update.
#define	ALP_POSTAL_IMPS_PROPERTY_PRESENCE_ALIAS ALP_POSTAL_PROPERTY(ALP_POSTAL_SERVICE_ID_IMPS, ALP_POSTAL_IMPS_SERVICE_CLASS_ID_PRESENCE, ALP_POSTAL_PROPERTY_TYPE_C_STRING, 5)
	Alias of the user.
#define	ALP_POSTAL_IMPS_PROPERTY_PRESENCE_AVAILABILITY ALP_POSTAL_PROPERTY(ALP_POSTAL_SERVICE_ID_IMPS, ALP_POSTAL_IMPS_SERVICE_CLASS_ID_PRESENCE, ALP_POSTAL_PROPERTY_TYPE_INT, 2)
	Availability of the user for communication.
#define	ALP_POSTAL_IMPS_PROPERTY_PRESENCE_BUDDY_ICON_PATH ALP_POSTAL_PROPERTY(ALP_POSTAL_SERVICE_ID_IMPS, ALP_POSTAL_IMPS_SERVICE_CLASS_ID_PRESENCE, ALP_POSTAL_PROPERTY_TYPE_C_STRING, 9)
	Buddy Icon.
#define	ALP_POSTAL_IMPS_PROPERTY_PRESENCE_CLIENT_TYPE ALP_POSTAL_PROPERTY(ALP_POSTAL_SERVICE_ID_IMPS, ALP_POSTAL_IMPS_SERVICE_CLASS_ID_PRESENCE, ALP_POSTAL_PROPERTY_TYPE_INT, 8)
	Client type.
#define	ALP_POSTAL_IMPS_PROPERTY_PRESENCE_DEFAULT_ATTRIBUTE_LIST ALP_POSTAL_PROPERTY(ALP_POSTAL_SERVICE_ID_IMPS, ALP_POSTAL_IMPS_SERVICE_CLASS_ID_PRESENCE, ALP_POSTAL_PROPERTY_TYPE_BOOLEAN, 7)
	Default presence list when retrieving attribute list.
#define	ALP_POSTAL_IMPS_PROPERTY_PRESENCE_MOOD ALP_POSTAL_PROPERTY(ALP_POSTAL_SERVICE_ID_IMPS, ALP_POSTAL_IMPS_SERVICE_CLASS_ID_PRESENCE, ALP_POSTAL_PROPERTY_TYPE_INT, 4)
	Mood of the user.
#define	ALP_POSTAL_IMPS_PROPERTY_PRESENCE_ONLINE_STATUS ALP_POSTAL_PROPERTY(ALP_POSTAL_SERVICE_ID_IMPS, ALP_POSTAL_IMPS_SERVICE_CLASS_ID_PRESENCE, ALP_POSTAL_PROPERTY_TYPE_BOOLEAN, 1)
	Shows if the client is logged on a IMPS server.
#define	ALP_POSTAL_IMPS_PROPERTY_PRESENCE_PREFERRED_LANGUAGE ALP_POSTAL_PROPERTY(ALP_POSTAL_SERVICE_ID_IMPS, ALP_POSTAL_IMPS_SERVICE_CLASS_ID_PRESENCE, ALP_POSTAL_PROPERTY_TYPE_C_STRING, 6)
	Preferred language.
#define	ALP_POSTAL_IMPS_PROPERTY_PRESENCE_STATUS_TEXT ALP_POSTAL_PROPERTY(ALP_POSTAL_SERVICE_ID_IMPS, ALP_POSTAL_IMPS_SERVICE_CLASS_ID_PRESENCE, ALP_POSTAL_PROPERTY_TYPE_C_STRING, 3)
	User specified status text.
IMPS PRESENCE AUTH
Defines possible action for authorization request.
#define	ALP_POSTAL_IMPS_PRESENCE_AUTH_ACCEPT (alp_postal_imps_auth_type_t)1
	Accept to share presence.
#define	ALP_POSTAL_IMPS_PRESENCE_AUTH_CANCEL (alp_postal_imps_auth_type_t)3
	Cancel auth mechanism.
#define	ALP_POSTAL_IMPS_PRESENCE_AUTH_REJECT (alp_postal_imps_auth_type_t)2
	Refuse to share presence.
IMPS PRESENCE AVAILABILTY
Defines possible availability status
#define	ALP_POSTAL_IMPS_PRESENCE_AVAILABILITY_AVAILABLE 1
	User is available for all forms of communication.
#define	ALP_POSTAL_IMPS_PRESENCE_AVAILABILITY_DISCREET 3
	The communication with the publisher is left at the discretion of the user.
#define	ALP_POSTAL_IMPS_PRESENCE_AVAILABILITY_NOT_AVAILABLE 2
	User is not available for instant (e.g. call and IM) communication.
IMPS PRESENCE CLIENT TYPE
Defines possible client type.
#define	ALP_POSTAL_IMPS_PRESENCE_CLIENT_TYPE_COMPUTER 2
	Client type is a computer.
#define	ALP_POSTAL_IMPS_PRESENCE_CLIENT_TYPE_MOBILE 1
	Client type is mobile phone.
#define	ALP_POSTAL_IMPS_PRESENCE_CLIENT_TYPE_OTHER 4
	Client type is a other.
#define	ALP_POSTAL_IMPS_PRESENCE_CLIENT_TYPE_PDA 3
	Client type is a pda.
IMPS PRESENCE MOOD
Defines possible mood.
#define	ALP_POSTAL_IMPS_PRESENCE_MOOD_ANGRY 3
	publisher feels angry.
#define	ALP_POSTAL_IMPS_PRESENCE_MOOD_ANXIOUS 11
	publisher feels anxious.
#define	ALP_POSTAL_IMPS_PRESENCE_MOOD_ASHAMED 5
	publisher feels ashamed.
#define	ALP_POSTAL_IMPS_PRESENCE_MOOD_BORED 9
	publisher feels bored.
#define	ALP_POSTAL_IMPS_PRESENCE_MOOD_EXCITED 10
	publisher feels excited.
#define	ALP_POSTAL_IMPS_PRESENCE_MOOD_HAPPY 1
	publisher feels happy.
#define	ALP_POSTAL_IMPS_PRESENCE_MOOD_IN_LOVE 7
	publisher feels being in love.
#define	ALP_POSTAL_IMPS_PRESENCE_MOOD_INVINCIBLE 6
	publisher feels invincible.
#define	ALP_POSTAL_IMPS_PRESENCE_MOOD_JEALOUS 4
	publisher feels jealous.
#define	ALP_POSTAL_IMPS_PRESENCE_MOOD_SAD 2
	publisher feels sad.
#define	ALP_POSTAL_IMPS_PRESENCE_MOOD_SLEEPY 8
	publisher feels sleepy.
#define	ALP_POSTAL_IMPS_PRESENCE_MOOD_UNKNOWN 0
	publisher feels bad.
IMPS PRESENCE SERVICE TYPE
Defines possible service type.
#define	ALP_POSTAL_IMPS_PRESENCE_SERVICE_AOL 2
	aol im service.
#define	ALP_POSTAL_IMPS_PRESENCE_SERVICE_ICQ 4
	icq im service.
#define	ALP_POSTAL_IMPS_PRESENCE_SERVICE_JABBER 5
	jabber im service.
#define	ALP_POSTAL_IMPS_PRESENCE_SERVICE_MSN 1
	msn im service.
#define	ALP_POSTAL_IMPS_PRESENCE_SERVICE_XMPP 6
	xmpp based service.
#define	ALP_POSTAL_IMPS_PRESENCE_SERVICE_YAHOO 3
	yahoo im service.
Typedefs
typedef void(*	AlpPostalImpsPresenceAuthNotificationCallbackPtr )(alp_postal_session_id_t iSessionId, char iUserId[IMPS_USERID_MAXSIZE], char iAuthIdentifier[IMPS_TRANSACTIONID_MAXSIZE])
	Postal Imps Presence Auth Notification Callback.
typedef void(*	AlpPostalImpsPresenceChangeNotificationCallbackPtr )(alp_postal_session_id_t iSessionId, alp_postal_imps_buddy_id_t iBuddy)
	Postal Imps Presence Notification Callback.
typedef void(*	AlpPostalPresenceAuthAsyncReplyCallback )(alp_postal_session_id_t iSessionId, char iAuthId[IMPS_TRANSACTIONID_MAXSIZE], alp_status_t iRequestResult)
	Postal Imps Async Presence Auth Callback.
typedef void(*	AlpPostalPresenceUpdateAsyncReplyCallback )(alp_postal_session_id_t iSessionId, alp_status_t iRequestResult)
	Postal Imps Async Presence Update Callback.
Functions
alp_status_t	alp_postal_imps_presence_auth_response (alp_postal_session_id_t iSessionId, char iUserId[IMPS_USERID_MAXSIZE], char iAuthId[IMPS_TRANSACTIONID_MAXSIZE], alp_postal_imps_auth_type_t iAuthType, AlpPostalPresenceAuthAsyncReplyCallback iCallbackFuncP)
	Send a response to the Auth Notification.
alp_status_t	alp_postal_imps_presence_cancel_auth_response (alp_postal_session_id_t iSessionId)
	Cancel the send response to the Auth Notification.
alp_status_t	alp_postal_imps_presence_get_attribute_list (alp_postal_session_id_t iSessionId)
	Retrieve the attribute lists.
alp_status_t	alp_postal_imps_presence_get_property (AlpPostalImpsPresence iImpsPresenceP, alp_postal_property_id_t iImpsPresencePropertyId, AlpPostalProperty *oImpsPresencePropertyP)
	Get a property from a Contact.
alp_status_t	alp_postal_imps_presence_init (AlpPostalImpsPresence *iImpsPresenceP)
	Initialize an ImpsPresence. MUST be called before used.
alp_status_t	alp_postal_imps_presence_set_property (AlpPostalImpsPresence *ioImpsPresenceP, alp_postal_property_id_t iImpsPresencePropertyId, alp_postal_property_const_value_t iImpsPresencePropertyDataP, uint16_t iImpsPresencePropertyDataSize)
	Set a property to a Postal ImpsPresence.
alp_status_t	alp_postal_imps_presence_update (alp_postal_session_id_t iSessionId, AlpPostalImpsPresence *iPresenceP, AlpPostalPresenceUpdateAsyncReplyCallback iCallbackFuncP)
	update my presence status with given attributes.