Group
[IMPS]

Detailed Description

Postal IMPS group APIs.


Defines

#define ALP_POSTAL_IMPS_PROPERTY_GROUP_ACCESS_TYPE   ALP_POSTAL_PROPERTY(ALP_POSTAL_SERVICE_ID_IMPS, ALP_POSTAL_IMPS_SERVICE_CLASS_ID_GROUP, ALP_POSTAL_PROPERTY_TYPE_C_STRING, 3)
 Open (for everyone) or Restricted (members only).
#define ALP_POSTAL_IMPS_PROPERTY_GROUP_ID   ALP_POSTAL_PROPERTY(ALP_POSTAL_SERVICE_ID_IMPS, ALP_POSTAL_IMPS_SERVICE_CLASS_ID_GROUP, ALP_POSTAL_PROPERTY_TYPE_C_STRING, 6)
 WV ID of the the group.
#define ALP_POSTAL_IMPS_PROPERTY_GROUP_NAME   ALP_POSTAL_PROPERTY(ALP_POSTAL_SERVICE_ID_IMPS, ALP_POSTAL_IMPS_SERVICE_CLASS_ID_GROUP, ALP_POSTAL_PROPERTY_TYPE_C_STRING, 1)
 Name a string that is the name of the group.
#define ALP_POSTAL_IMPS_PROPERTY_GROUP_SCREEN_NAME   ALP_POSTAL_PROPERTY(ALP_POSTAL_SERVICE_ID_IMPS, ALP_POSTAL_IMPS_SERVICE_CLASS_ID_GROUP, ALP_POSTAL_PROPERTY_TYPE_C_STRING, 4)
 ScreenName of the user in the group.
#define ALP_POSTAL_IMPS_PROPERTY_GROUP_WELCOME_NOTE   ALP_POSTAL_PROPERTY(ALP_POSTAL_SERVICE_ID_IMPS, ALP_POSTAL_IMPS_SERVICE_CLASS_ID_GROUP, ALP_POSTAL_PROPERTY_TYPE_C_STRING, 2)
 Welcome note a string that is presented as text to the user when he/she joins the group.

Typedefs

typedef _AlpPostalPropertyList AlpPostalImpsGroup
 Group structure.
typedef void(* AlpPostalImpsGroupCreateAsyncReplyCallback )(alp_postal_session_id_t iSessionId, char *iGroupID, alp_status_t iRequestResult)
 Postal Imps Async CreateGroup Callback.
typedef void(* AlpPostalImpsGroupDeleteAsyncReplyCallback )(alp_postal_session_id_t iSessionId, alp_postal_imps_group_char_t iGroupWVId, alp_status_t iRequestResult)
 Postal Imps Async DeleteGroup Callback.

Functions

alp_status_t alp_postal_imps_group_cancel_create (alp_postal_session_id_t iSessionId)
 Cancel the group_create process.
alp_status_t alp_postal_imps_group_create (alp_postal_session_id_t iSessionId, AlpPostalImpsGroup *iGroupP, AlpPostalImpsGroupCreateAsyncReplyCallback iCallbackFuncP)
 Create a group according the properties it contains.
alp_status_t alp_postal_imps_group_delete (alp_postal_session_id_t iSessionId, alp_postal_imps_group_char_t iGroupWVId, AlpPostalImpsGroupDeleteAsyncReplyCallback iCallbackFuncP)
 Delete a group.
alp_status_t alp_postal_imps_group_free (AlpPostalImpsGroup *iImpsGroupP)
 Free a group.
alp_status_t alp_postal_imps_group_free_property (AlpPostalProperty *iImpsGroupPropertyP)
 Free a retrieved group property.
alp_status_t alp_postal_imps_group_get_property (AlpPostalImpsGroup *iImpsGroupP, alp_postal_property_id_t iPropertyId, AlpPostalProperty **oImpsGroupPropertyP)
 Get a property from a Group.
alp_status_t alp_postal_imps_group_init (AlpPostalImpsGroup *iImpsGroupP)
 Initialize an ImpsGroup. MUST be called before used.
alp_status_t alp_postal_imps_group_set_property (AlpPostalImpsGroup *ioImpsGroupP, alp_postal_property_id_t iImpsGroupPropertyId, alp_postal_property_const_value_t iImpsGroupPropertyDataP, uint16_t iImpsGroupPropertyDataSize)
 Set a property to a Imps Goup.

Define Documentation

#define ALP_POSTAL_IMPS_PROPERTY_GROUP_ACCESS_TYPE   ALP_POSTAL_PROPERTY(ALP_POSTAL_SERVICE_ID_IMPS, ALP_POSTAL_IMPS_SERVICE_CLASS_ID_GROUP, ALP_POSTAL_PROPERTY_TYPE_C_STRING, 3)
 

Open (for everyone) or Restricted (members only).

#define ALP_POSTAL_IMPS_PROPERTY_GROUP_ID   ALP_POSTAL_PROPERTY(ALP_POSTAL_SERVICE_ID_IMPS, ALP_POSTAL_IMPS_SERVICE_CLASS_ID_GROUP, ALP_POSTAL_PROPERTY_TYPE_C_STRING, 6)
 

WV ID of the the group.

#define ALP_POSTAL_IMPS_PROPERTY_GROUP_NAME   ALP_POSTAL_PROPERTY(ALP_POSTAL_SERVICE_ID_IMPS, ALP_POSTAL_IMPS_SERVICE_CLASS_ID_GROUP, ALP_POSTAL_PROPERTY_TYPE_C_STRING, 1)
 

Name a string that is the name of the group.

#define ALP_POSTAL_IMPS_PROPERTY_GROUP_SCREEN_NAME   ALP_POSTAL_PROPERTY(ALP_POSTAL_SERVICE_ID_IMPS, ALP_POSTAL_IMPS_SERVICE_CLASS_ID_GROUP, ALP_POSTAL_PROPERTY_TYPE_C_STRING, 4)
 

ScreenName of the user in the group.

#define ALP_POSTAL_IMPS_PROPERTY_GROUP_WELCOME_NOTE   ALP_POSTAL_PROPERTY(ALP_POSTAL_SERVICE_ID_IMPS, ALP_POSTAL_IMPS_SERVICE_CLASS_ID_GROUP, ALP_POSTAL_PROPERTY_TYPE_C_STRING, 2)
 

Welcome note a string that is presented as text to the user when he/she joins the group.

Typedef Documentation

typedef struct _AlpPostalPropertyList AlpPostalImpsGroup
 

Group structure.

typedef void(* AlpPostalImpsGroupCreateAsyncReplyCallback)(alp_postal_session_id_t iSessionId, char *iGroupID, alp_status_t iRequestResult)
 

Postal Imps Async CreateGroup Callback.

typedef void(* AlpPostalImpsGroupDeleteAsyncReplyCallback)(alp_postal_session_id_t iSessionId, alp_postal_imps_group_char_t iGroupWVId, alp_status_t iRequestResult)
 

Postal Imps Async DeleteGroup Callback.

Function Documentation

alp_status_t alp_postal_imps_group_cancel_create (  alp_postal_session_id_t  iSessionId  ) 
 

Cancel the group_create process.

Parameters:
[in] iSessionId The session where the group_create has been called.
Returns:
Returns an error code.

alp_status_t alp_postal_imps_group_create (  alp_postal_session_id_t  iSessionId,
AlpPostalImpsGroup *  iGroupP,
AlpPostalImpsGroupCreateAsyncReplyCallback  iCallbackFuncP
) 
 

Create a group according the properties it contains.

Parameters:
[in] iSessionId The session where to create the group.
[in] iGroupP a group structure.
[in] iCallbackFuncP The call back function to be called when process will terminate.
Returns:
Returns an error code.

alp_status_t alp_postal_imps_group_delete (  alp_postal_session_id_t  iSessionId,
alp_postal_imps_group_char_t  iGroupWVId,
AlpPostalImpsGroupDeleteAsyncReplyCallback  iCallbackFuncP
) 
 

Delete a group.

Parameters:
[in] iSessionId The session where to delete the group.
[in] iGroupWVId the group identifier.
[in] iCallbackFuncP The call back function to be called when process will terminate.
Returns:
Returns an error code.

alp_status_t alp_postal_imps_group_free (  AlpPostalImpsGroup *  iImpsGroupP  ) 
 

Free a group.

Parameters:
[in] iImpsGroupP a group structure.
Returns:
Returns an error code.

alp_status_t alp_postal_imps_group_free_property (  AlpPostalProperty *  iImpsGroupPropertyP  ) 
 

Free a retrieved group property.

Parameters:
[in] iImpsGroupPropertyP a pointer on a retrieved group property to be freed.
Returns:
Returns an error code.

alp_status_t alp_postal_imps_group_get_property (  AlpPostalImpsGroup *  iImpsGroupP,
alp_postal_property_id_t  iPropertyId,
AlpPostalProperty **  oImpsGroupPropertyP
) 
 

Get a property from a Group.

Parameters:
[in] iImpsGroupP A group Ptr.
[in] iPropertyId 
[out] oImpsGroupPropertyP A group property to retrieve.
Returns:
Returns an error code.

alp_status_t alp_postal_imps_group_init (  AlpPostalImpsGroup *  iImpsGroupP  ) 
 

Initialize an ImpsGroup. MUST be called before used.

Parameters:
[in] iImpsGroupP A contact to initialize.
Returns:
Returns an error code.

alp_status_t alp_postal_imps_group_set_property (  AlpPostalImpsGroup *  ioImpsGroupP,
alp_postal_property_id_t  iImpsGroupPropertyId,
alp_postal_property_const_value_t  iImpsGroupPropertyDataP,
uint16_t  iImpsGroupPropertyDataSize
) 
 

Set a property to a Imps Goup.

Parameters:
[in,out] ioImpsGroupP The Postal ImpsGroup in which a property must be set.
[in] iImpsGroupPropertyId The Id of the property to be created.
[in] iImpsGroupPropertyDataP The value of the property to be created.
[in] iImpsGroupPropertyDataSize the size of the data, strlen+1 if it's a string
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.