![]() | ![]() | ![]() | MIME Directory Library Reference Manual | ![]() |
---|
#include <mimedir/mimedir-vcard.h> enum MIMEDirVCardKeyType; #define MIMEDIR_VCARD_TIMEZONE_MAX #define MIMEDIR_VCARD_TIMEZONE_MIN #define MIMEDIR_VCARD_LATITUDE_MAX #define MIMEDIR_VCARD_LATITUDE_MIN #define MIMEDIR_VCARD_LONGITUDE_MAX #define MIMEDIR_VCARD_LONGITUDE_MIN struct MIMEDirVCard;void mimedir_vcard_free_list ();
GList *listgboolean mimedir_vcard_write_list (const
,gchar *filename,
GList *list);
GError **errorgboolean mimedir_vcard_write_list_to_channel (,
GIOChannel *channel,
GList *list); MIMEDirVCard * mimedir_vcard_new (
GError **errorvoid
); MIMEDirVCard * mimedir_vcard_new_from_profile (MIMEDirProfile *profile
,);
GError **errorgboolean mimedir_vcard_read_from_profile (MIMEDirVCard *vcard
,MIMEDirProfile *profile
,); MIMEDirProfile * mimedir_vcard_write_to_profile (
GError **errorMIMEDirVCard *vcard
);gboolean mimedir_vcard_write_to_channel (MIMEDirVCard *vcard
,,
GIOChannel *channel);
GError **errorgchar * mimedir_vcard_write_to_string (MIMEDirVCard *vcard
);void mimedir_vcard_set_birthday (MIMEDirVCard *vcard
,MIMEDirDateTime *birthday
); MIMEDirDateTime * mimedir_vcard_get_birthday (MIMEDirVCard *vcard
);void mimedir_vcard_set_timezone (MIMEDirVCard *vcard
,);
gint timezonegboolean mimedir_vcard_get_timezone (MIMEDirVCard *vcard
,);
gint *timezonevoid mimedir_vcard_clear_timezone (MIMEDirVCard *vcard
);void mimedir_vcard_set_geo_position (MIMEDirVCard *vcard
,,
gdouble latitude);
gdouble longitudegboolean mimedir_vcard_get_geo_position (MIMEDirVCard *vcard
,,
gdouble *latitude);
gdouble *longitudevoid mimedir_vcard_clear_geo_position (MIMEDirVCard *vcard
);void mimedir_vcard_append_address (MIMEDirVCard *vcard
,MIMEDirVCardAddress *address
);void mimedir_vcard_remove_address (MIMEDirVCard *vcard
,MIMEDirVCardAddress *address
);void mimedir_vcard_append_email (MIMEDirVCard *vcard
,MIMEDirVCardEMail *email
);void mimedir_vcard_remove_email (MIMEDirVCard *vcard
,MIMEDirVCardEMail *email
);void mimedir_vcard_append_phone (MIMEDirVCard *vcard
,MIMEDirVCardPhone *phone
);void mimedir_vcard_remove_phone (MIMEDirVCard *vcard
,MIMEDirVCardPhone *phone
); MIMEDirVCardAddress * mimedir_vcard_get_preferred_address (MIMEDirVCard *vcard
); MIMEDirVCardEMail * mimedir_vcard_get_preferred_email (MIMEDirVCard *vcard
); MIMEDirVCardPhone * mimedir_vcard_get_preferred_phone (MIMEDirVCard *vcard
);gchar * mimedir_vcard_get_as_string (MIMEDirVCard *vcard
);
typedef enum { MIMEDIR_VCARD_KEY_UNKNOWN, /* Key type is not known */ MIMEDIR_VCARD_KEY_X509, /* Key is a X.509 key */ MIMEDIR_VCARD_KEY_PGP /* Key is a PGP/GnuPG key */ } MIMEDirVCardKeyType;
The type of a public key that is associated with the vCard.
MIMEDIR_VCARD_KEY_UNKNOWN | unknown/unsupported key type |
MIMEDIR_VCARD_KEY_X509 | X.509 key |
MIMEDIR_VCARD_KEY_PGP | PGP/GnuPG key |
#define MIMEDIR_VCARD_TIMEZONE_MAX (+23 * 60 + 59)
Maximum valid value for the timezone parameter.
#define MIMEDIR_VCARD_TIMEZONE_MIN (-23 * 60 + 59)
Minimum valid value for the timezone parameter.
#define MIMEDIR_VCARD_LATITUDE_MAX (+90.0)
Maximum valid value for the latitude parameter.
#define MIMEDIR_VCARD_LATITUDE_MIN (-90.0)
Minimum valid value for the latitude parameter.
#define MIMEDIR_VCARD_LONGITUDE_MAX (+180.0)
Maximum valid value for the longitude parameter.
#define MIMEDIR_VCARD_LONGITUDE_MIN (-180.0)
Minimum valid value for the longitude parameter.
struct MIMEDirVCard { GObject parent; MIMEDirVCardPriv *priv; };
The
void mimedir_vcard_free_list ();
GList *list
Frees a list of vCards as returned by mimedir_vcard_read_list_from_file()
mimedir_vcard_read_list_from_channel()
list : | list of vCards |
gboolean mimedir_vcard_write_list (const
,gchar *filename,
GList *list);
GError **error
Saves a list of vCard to a file.
filename : | file to save to |
list : | list of vCard objects |
error : | error storage location or |
Returns : | success indicator |
gboolean mimedir_vcard_write_list_to_channel (,
GIOChannel *channel,
GList *list);
GError **error
Saves a list of vCard to an I/O channel.
channel : | I/O channel to save to |
list : | list of vCard objects |
error : | error storage location or |
Returns : | success indicator |
MIMEDirVCard * mimedir_vcard_new (void
);
Creates a new (empty) vCard object.
Returns : | a new vCard object |
MIMEDirVCard * mimedir_vcard_new_from_profile (MIMEDirProfile *profile
,);
GError **error
Create a new vCard object and fills it with data retrieved from the
supplied profile object. If an error occurs during the read, error
will be set and
profile : | a profile object |
error : | error storage location or |
Returns : | the new vCard object or |
gboolean mimedir_vcard_read_from_profile (MIMEDirVCard *vcard
,MIMEDirProfile *profile
,);
GError **error
Clears the supplied vCard object and re-initializes it with data read
from the supplied profile. If an error occurs during the read, error
will be set and
vcard : | a vCard |
profile : | a profile object |
error : | error storage location or |
Returns : | success indicator |
MIMEDirProfile * mimedir_vcard_write_to_profile (MIMEDirVCard *vcard
);
Saves the vCard object to a newly allocated profile object.
vcard : | a vCard |
Returns : | a new profile |
gboolean mimedir_vcard_write_to_channel (MIMEDirVCard *vcard
,,
GIOChannel *channel);
GError **error
Saves the vCard object to the supplied I/O channel. If an error occurs
during the write, error
will be set and
vcard : | a vCard |
channel : | I/O channel to save to |
error : | error storage location or |
Returns : | success indicator |
gchar * mimedir_vcard_write_to_string (MIMEDirVCard *vcard
);
Saves the vCard object to a newly allocated memory buffer. You should
free the returned buffer with g_free()
vcard : | a vCard |
Returns : | a newly allocated memory buffer |
void mimedir_vcard_set_birthday (MIMEDirVCard *vcard
,MIMEDirDateTime *birthday
);
Set's the person's birthday. Setting the birthday to
vcard : | a vCard |
birthday : | a MIMEDirDateTime object or |
MIMEDirDateTime * mimedir_vcard_get_birthday (MIMEDirVCard *vcard
);
Get's the person's birthday. The return value is not ref'fed.
vcard : | a vCard |
Returns : | a MIMEDirDateTime object or |
void mimedir_vcard_set_timezone (MIMEDirVCard *vcard
,);
gint timezone
Sets the time zone to timezone
.
vcard : | a vCard |
timezone : | time zone in minutes from UTC |
gboolean mimedir_vcard_get_timezone (MIMEDirVCard *vcard
,);
gint *timezone
If the object's time zone is cleared, timezone
is
left unchanged. Otherwise timezone
is set to the
vCard's time zone.
vcard : | a vCard |
timezone : | pointer to the timezone storage location or |
Returns : |
void mimedir_vcard_clear_timezone (MIMEDirVCard *vcard
);
Clears the card's time zone information.
vcard : | a vCard |
void mimedir_vcard_set_geo_position (MIMEDirVCard *vcard
,,
gdouble latitude);
gdouble longitude
Sets the vCard's geographical position to latitude
and longitude
.
vcard : | a vCard |
latitude : | new latitude |
longitude : | new longitude |
gboolean mimedir_vcard_get_geo_position (MIMEDirVCard *vcard
,,
gdouble *latitude);
gdouble *longitude
If the object's geographical position is cleared, latitude
and longitude
are left unchanged. Otherwise latitude
and longitude
are set to the vCard's geographical position.
vcard : | a vCard |
latitude : | pointer to the latitude storage location or |
longitude : | pointer to the longitude storage location or |
Returns : |
void mimedir_vcard_clear_geo_position (MIMEDirVCard *vcard
);
Clears the vCard's geographical position.
vcard : | a vCard |
void mimedir_vcard_append_address (MIMEDirVCard *vcard
,MIMEDirVCardAddress *address
);
Appends the supplied address object to the vCard.
vcard : | a vCard |
address : | a vCard address |
void mimedir_vcard_remove_address (MIMEDirVCard *vcard
,MIMEDirVCardAddress *address
);
Removes the supplied address to the vCard.
vcard : | a vCard |
address : | a vCard address |
void mimedir_vcard_append_email (MIMEDirVCard *vcard
,MIMEDirVCardEMail *email
);
Appends the supplied e-mail address to the vCard.
vcard : | a vCard |
email : | a vCard e-mail |
void mimedir_vcard_remove_email (MIMEDirVCard *vcard
,MIMEDirVCardEMail *email
);
Removes the supplied e-mail address from the vCard.
vcard : | a vCard |
email : | a vCard e-mail |
void mimedir_vcard_append_phone (MIMEDirVCard *vcard
,MIMEDirVCardPhone *phone
);
Appends the supplied telephone number to the vCard.
vcard : | a vCard |
phone : | a vCard phone |
void mimedir_vcard_remove_phone (MIMEDirVCard *vcard
,MIMEDirVCardPhone *phone
);
Removes the supplied telephone number from the vCard.
vcard : | a vCard |
phone : | a vCard phone |
MIMEDirVCardAddress * mimedir_vcard_get_preferred_address
(MIMEDirVCard *vcard
);
Returns the preferred address of the supplied vCard object. If no address
has the preferred flag set, the first address of the address list is
returned. If the address list is empty,
vcard : | a vCard |
Returns : | an address object or |
MIMEDirVCardEMail * mimedir_vcard_get_preferred_email (MIMEDirVCard *vcard
);
Returns the preferred email address of the supplied vCard object. If no
email address has the preferred flag set, the first email address of the
email address list is returned. If the email address list is empty,
vcard : | a vCard |
Returns : | an email address object or |
MIMEDirVCardPhone * mimedir_vcard_get_preferred_phone (MIMEDirVCard *vcard
);
Returns the preferred phone number of the supplied vCard object. If no
phone number has the preferred flag set, the first phone number of the
phone number list is returned. If the phone number list is empty,
vcard : | a vCard |
Returns : | a phone number object or |
gchar * mimedir_vcard_get_as_string (MIMEDirVCard *vcard
);
Returns the contents of the vCard object as a multi-line human-readable
string. It is not guaranteed that this string is of a particular
format or contains all information from the vCard object. Nevertheless,
it will contain all vital information. You should free the returned
string with g_free()
vcard : | a vCard |
Returns : | a multi-line string |
<<< vCard Object Reference | MIMEDirVCardAddress >>> |