include/alp/postal_imps_group.h File Reference


Detailed Description

Postal IMPS group APIs.

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

Go to the source code of this file.

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.


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

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