Account
[IMPS]

---

Detailed Description

Account APIs. An account must belong to a session.

POSTAL ACCOUNT IMPS ACCOUNT ENCODING
Defines the encoding to be used.
#define	ALP_POSTAL_IMPS_ACCOUNT_ENCODING_WBXML   ((alp_postal_imps_account_encoding_t)1)
	WBXML.
#define	ALP_POSTAL_IMPS_ACCOUNT_ENCODING_XML   ((alp_postal_imps_account_encoding_t)0)
	XML.
POSTAL ACCOUNT IMPS PASSWORD METHOD
Defines the password encryption that the plugin can use.
#define	ALP_POSTAL_IMPS_ACCOUNT_PASSWORD_MD4   ((alp_postal_imps_account_password_method_t)1)
	MD4.
#define	ALP_POSTAL_IMPS_ACCOUNT_PASSWORD_MD5   ((alp_postal_imps_account_password_method_t)2)
	MD5.
#define	ALP_POSTAL_IMPS_ACCOUNT_PASSWORD_NONE   ((alp_postal_imps_account_password_method_t)0)
	None.
#define	ALP_POSTAL_IMPS_ACCOUNT_PASSWORD_SHA   ((alp_postal_imps_account_password_method_t)3)
	SHA.
POSTAL ACCOUNT IMPS ACCOUNT REFRESH RATE
Defines the refresh rate when plugin use polling mechanism.
#define	ALP_POSTAL_IMPS_ACCOUNT_REFRESH_HIGH   ((alp_postal_imps_account_refresh_t)2)
	HIGH. Polling will be more often.
#define	ALP_POSTAL_IMPS_ACCOUNT_REFRESH_LOW   ((alp_postal_imps_account_refresh_t)0)
	LOW. Polling will be less often.
#define	ALP_POSTAL_IMPS_ACCOUNT_REFRESH_NORMAL   ((alp_postal_imps_account_refresh_t)1)
	NORMAL.
POSTAL ACCOUNT IMPS TRANSPORT
Defines the transport that the plugin can use.
#define	ALP_POSTAL_IMPS_ACCOUNT_TRANSPORT_HTTP   ((alp_postal_imps_account_transport_t)0)
	HTTP.
#define	ALP_POSTAL_IMPS_ACCOUNT_TRANSPORT_HTTPS   ((alp_postal_imps_account_transport_t)1)
	HTTPS.
#define	ALP_POSTAL_IMPS_ACCOUNT_TRANSPORT_SMS   ((alp_postal_imps_account_transport_t)2)
	SMS.
Defines
#define	ALP_POSTAL_IMPS_PROPERTY_ACCOUNT_CLIENT_ID   ALP_POSTAL_PROPERTY(ALP_POSTAL_SERVICE_ID_IMPS, ALP_POSTAL_SERVICE_CLASS_ID_ACCOUNT, ALP_POSTAL_PROPERTY_TYPE_C_STRING, 12)
	ClientID is a unique identifier for the application.
#define	ALP_POSTAL_IMPS_PROPERTY_ACCOUNT_DOMAIN_NAME   ALP_POSTAL_PROPERTY(ALP_POSTAL_SERVICE_ID_IMPS, ALP_POSTAL_SERVICE_CLASS_ID_ACCOUNT, ALP_POSTAL_PROPERTY_TYPE_C_STRING, 13)
	Domain name (e.g: hotmail.com) without '@' sign.
#define	ALP_POSTAL_IMPS_PROPERTY_ACCOUNT_ENCODING   ALP_POSTAL_PROPERTY(ALP_POSTAL_SERVICE_ID_IMPS, ALP_POSTAL_SERVICE_CLASS_ID_ACCOUNT, ALP_POSTAL_PROPERTY_TYPE_INT, 14)
	Protocol encoding.
#define	ALP_POSTAL_IMPS_PROPERTY_ACCOUNT_FORCE_POLLING   ALP_POSTAL_PROPERTY(ALP_POSTAL_SERVICE_ID_IMPS, ALP_POSTAL_SERVICE_CLASS_ID_ACCOUNT, ALP_POSTAL_PROPERTY_TYPE_INT, 6)
	if value is 1, the plugin will use polling mechanism even if other CIR notifications mechanisms are available.
#define	ALP_POSTAL_IMPS_PROPERTY_ACCOUNT_HTTP_TIMEOUT   ALP_POSTAL_PROPERTY(ALP_POSTAL_SERVICE_ID_IMPS, ALP_POSTAL_SERVICE_CLASS_ID_ACCOUNT, ALP_POSTAL_PROPERTY_TYPE_INT, 10)
	Timeout value in second when waiting for server response.
#define	ALP_POSTAL_IMPS_PROPERTY_ACCOUNT_LOGIN   ALP_POSTAL_PROPERTY(ALP_POSTAL_SERVICE_ID_IMPS, ALP_POSTAL_SERVICE_CLASS_ID_ACCOUNT, ALP_POSTAL_PROPERTY_TYPE_C_STRING, 3)
#define	ALP_POSTAL_IMPS_PROPERTY_ACCOUNT_PASSWORD   ALP_POSTAL_PROPERTY(ALP_POSTAL_SERVICE_ID_IMPS, ALP_POSTAL_SERVICE_CLASS_ID_ACCOUNT, ALP_POSTAL_PROPERTY_TYPE_C_STRING, 4)
	passwd.
#define	ALP_POSTAL_IMPS_PROPERTY_ACCOUNT_PASSWORD_METHOD   ALP_POSTAL_PROPERTY(ALP_POSTAL_SERVICE_ID_IMPS, ALP_POSTAL_SERVICE_CLASS_ID_ACCOUNT, ALP_POSTAL_PROPERTY_TYPE_INT, 8)
	password method in 4W.
#define	ALP_POSTAL_IMPS_PROPERTY_ACCOUNT_REFRESH_RATE   ALP_POSTAL_PROPERTY(ALP_POSTAL_SERVICE_ID_IMPS, ALP_POSTAL_SERVICE_CLASS_ID_ACCOUNT, ALP_POSTAL_PROPERTY_TYPE_INT, 11)
	a level of refresh rate when server use polling mechanism.
#define	ALP_POSTAL_IMPS_PROPERTY_ACCOUNT_SERVER_ADDRESS   ALP_POSTAL_PROPERTY(ALP_POSTAL_SERVICE_ID_IMPS, ALP_POSTAL_SERVICE_CLASS_ID_ACCOUNT, ALP_POSTAL_PROPERTY_TYPE_C_STRING, 1)
	Server address.
#define	ALP_POSTAL_IMPS_PROPERTY_ACCOUNT_SERVER_PORT   ALP_POSTAL_PROPERTY(ALP_POSTAL_SERVICE_ID_IMPS, ALP_POSTAL_SERVICE_CLASS_ID_ACCOUNT, ALP_POSTAL_PROPERTY_TYPE_INT, 2)
	Server port.
#define	ALP_POSTAL_IMPS_PROPERTY_ACCOUNT_SMSC   ALP_POSTAL_PROPERTY(ALP_POSTAL_SERVICE_ID_IMPS, ALP_POSTAL_SERVICE_CLASS_ID_ACCOUNT, ALP_POSTAL_PROPERTY_TYPE_C_STRING, 9)
	SMSC to use when transport is SMS.
#define	ALP_POSTAL_IMPS_PROPERTY_ACCOUNT_TRANSPORT   ALP_POSTAL_PROPERTY(ALP_POSTAL_SERVICE_ID_IMPS, ALP_POSTAL_SERVICE_CLASS_ID_ACCOUNT, ALP_POSTAL_PROPERTY_TYPE_INT, 7)
	transport to use for connection with the server.
#define	ALP_POSTAL_IMPS_PROPERTY_ACCOUNT_USE_PROVISIONNED_CNC   ALP_POSTAL_PROPERTY(ALP_POSTAL_SERVICE_ID_IMPS, ALP_POSTAL_SERVICE_CLASS_ID_ACCOUNT, ALP_POSTAL_PROPERTY_TYPE_BOOLEAN, 15)
	Account is provisionned, use autoconnection.
Typedefs
typedef uint8_t	alp_postal_imps_account_encoding_t
	IMPS Encoding method.
typedef uint8_t	alp_postal_imps_account_password_method_t
	IMPS Account password method type.
typedef uint8_t	alp_postal_imps_account_refresh_t
	IMPS Account Refresh type.
typedef uint8_t	alp_postal_imps_account_transport_t
	IMPS Account transport type.

---

Define Documentation

#define ALP_POSTAL_IMPS_ACCOUNT_ENCODING_WBXML   ((alp_postal_imps_account_encoding_t)1)

WBXML.

#define ALP_POSTAL_IMPS_ACCOUNT_ENCODING_XML   ((alp_postal_imps_account_encoding_t)0)

XML.

#define ALP_POSTAL_IMPS_ACCOUNT_PASSWORD_MD4   ((alp_postal_imps_account_password_method_t)1)

MD4.

#define ALP_POSTAL_IMPS_ACCOUNT_PASSWORD_MD5   ((alp_postal_imps_account_password_method_t)2)

MD5.

#define ALP_POSTAL_IMPS_ACCOUNT_PASSWORD_NONE   ((alp_postal_imps_account_password_method_t)0)

None.

#define ALP_POSTAL_IMPS_ACCOUNT_PASSWORD_SHA   ((alp_postal_imps_account_password_method_t)3)

SHA.

#define ALP_POSTAL_IMPS_ACCOUNT_REFRESH_HIGH   ((alp_postal_imps_account_refresh_t)2)

HIGH. Polling will be more often.

#define ALP_POSTAL_IMPS_ACCOUNT_REFRESH_LOW   ((alp_postal_imps_account_refresh_t)0)

LOW. Polling will be less often.

#define ALP_POSTAL_IMPS_ACCOUNT_REFRESH_NORMAL   ((alp_postal_imps_account_refresh_t)1)

NORMAL.

#define ALP_POSTAL_IMPS_ACCOUNT_TRANSPORT_HTTP   ((alp_postal_imps_account_transport_t)0)

HTTP.

#define ALP_POSTAL_IMPS_ACCOUNT_TRANSPORT_HTTPS   ((alp_postal_imps_account_transport_t)1)

HTTPS.

#define ALP_POSTAL_IMPS_ACCOUNT_TRANSPORT_SMS   ((alp_postal_imps_account_transport_t)2)

SMS.

#define ALP_POSTAL_IMPS_PROPERTY_ACCOUNT_CLIENT_ID   ALP_POSTAL_PROPERTY(ALP_POSTAL_SERVICE_ID_IMPS, ALP_POSTAL_SERVICE_CLASS_ID_ACCOUNT, ALP_POSTAL_PROPERTY_TYPE_C_STRING, 12)

ClientID is a unique identifier for the application.

#define ALP_POSTAL_IMPS_PROPERTY_ACCOUNT_DOMAIN_NAME   ALP_POSTAL_PROPERTY(ALP_POSTAL_SERVICE_ID_IMPS, ALP_POSTAL_SERVICE_CLASS_ID_ACCOUNT, ALP_POSTAL_PROPERTY_TYPE_C_STRING, 13)

Domain name (e.g: hotmail.com) without '@' sign.

#define ALP_POSTAL_IMPS_PROPERTY_ACCOUNT_ENCODING   ALP_POSTAL_PROPERTY(ALP_POSTAL_SERVICE_ID_IMPS, ALP_POSTAL_SERVICE_CLASS_ID_ACCOUNT, ALP_POSTAL_PROPERTY_TYPE_INT, 14)

Protocol encoding.

#define ALP_POSTAL_IMPS_PROPERTY_ACCOUNT_FORCE_POLLING   ALP_POSTAL_PROPERTY(ALP_POSTAL_SERVICE_ID_IMPS, ALP_POSTAL_SERVICE_CLASS_ID_ACCOUNT, ALP_POSTAL_PROPERTY_TYPE_INT, 6)

if value is 1, the plugin will use polling mechanism even if other CIR notifications mechanisms are available.

#define ALP_POSTAL_IMPS_PROPERTY_ACCOUNT_HTTP_TIMEOUT   ALP_POSTAL_PROPERTY(ALP_POSTAL_SERVICE_ID_IMPS, ALP_POSTAL_SERVICE_CLASS_ID_ACCOUNT, ALP_POSTAL_PROPERTY_TYPE_INT, 10)

Timeout value in second when waiting for server response.

#define ALP_POSTAL_IMPS_PROPERTY_ACCOUNT_LOGIN   ALP_POSTAL_PROPERTY(ALP_POSTAL_SERVICE_ID_IMPS, ALP_POSTAL_SERVICE_CLASS_ID_ACCOUNT, ALP_POSTAL_PROPERTY_TYPE_C_STRING, 3)

login. must not contains the domain name, e.g: bob. Domain name (e.g: hotmail.com) should be specified in ALP_POSTAL_IMPS_PROPERTY_ACCOUNT_DOMAIN_NAME

#define ALP_POSTAL_IMPS_PROPERTY_ACCOUNT_PASSWORD   ALP_POSTAL_PROPERTY(ALP_POSTAL_SERVICE_ID_IMPS, ALP_POSTAL_SERVICE_CLASS_ID_ACCOUNT, ALP_POSTAL_PROPERTY_TYPE_C_STRING, 4)

passwd.

#define ALP_POSTAL_IMPS_PROPERTY_ACCOUNT_PASSWORD_METHOD   ALP_POSTAL_PROPERTY(ALP_POSTAL_SERVICE_ID_IMPS, ALP_POSTAL_SERVICE_CLASS_ID_ACCOUNT, ALP_POSTAL_PROPERTY_TYPE_INT, 8)

password method in 4W.

#define ALP_POSTAL_IMPS_PROPERTY_ACCOUNT_REFRESH_RATE   ALP_POSTAL_PROPERTY(ALP_POSTAL_SERVICE_ID_IMPS, ALP_POSTAL_SERVICE_CLASS_ID_ACCOUNT, ALP_POSTAL_PROPERTY_TYPE_INT, 11)

a level of refresh rate when server use polling mechanism.

#define ALP_POSTAL_IMPS_PROPERTY_ACCOUNT_SERVER_ADDRESS   ALP_POSTAL_PROPERTY(ALP_POSTAL_SERVICE_ID_IMPS, ALP_POSTAL_SERVICE_CLASS_ID_ACCOUNT, ALP_POSTAL_PROPERTY_TYPE_C_STRING, 1)

Server address.

#define ALP_POSTAL_IMPS_PROPERTY_ACCOUNT_SERVER_PORT   ALP_POSTAL_PROPERTY(ALP_POSTAL_SERVICE_ID_IMPS, ALP_POSTAL_SERVICE_CLASS_ID_ACCOUNT, ALP_POSTAL_PROPERTY_TYPE_INT, 2)

Server port.

#define ALP_POSTAL_IMPS_PROPERTY_ACCOUNT_SMSC   ALP_POSTAL_PROPERTY(ALP_POSTAL_SERVICE_ID_IMPS, ALP_POSTAL_SERVICE_CLASS_ID_ACCOUNT, ALP_POSTAL_PROPERTY_TYPE_C_STRING, 9)

SMSC to use when transport is SMS.

#define ALP_POSTAL_IMPS_PROPERTY_ACCOUNT_TRANSPORT   ALP_POSTAL_PROPERTY(ALP_POSTAL_SERVICE_ID_IMPS, ALP_POSTAL_SERVICE_CLASS_ID_ACCOUNT, ALP_POSTAL_PROPERTY_TYPE_INT, 7)

transport to use for connection with the server.

#define ALP_POSTAL_IMPS_PROPERTY_ACCOUNT_USE_PROVISIONNED_CNC   ALP_POSTAL_PROPERTY(ALP_POSTAL_SERVICE_ID_IMPS, ALP_POSTAL_SERVICE_CLASS_ID_ACCOUNT, ALP_POSTAL_PROPERTY_TYPE_BOOLEAN, 15)

Account is provisionned, use autoconnection.

---

Typedef Documentation

typedef uint8_t alp_postal_imps_account_encoding_t

IMPS Encoding method.

typedef uint8_t alp_postal_imps_account_password_method_t

IMPS Account password method type.

typedef uint8_t alp_postal_imps_account_refresh_t

IMPS Account Refresh type.

typedef uint8_t alp_postal_imps_account_transport_t

IMPS Account transport type.

---

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.