![]() |
![]() |
![]() |
GData Reference Manual | ![]() |
---|---|---|---|---|
Top | Description | Object Hierarchy | Properties |
#include <gdata/gd/gdata-gd-email-address.h> GDataGDEmailAddress; GDataGDEmailAddressClass; GDataGDEmailAddress * gdata_gd_email_address_new (const gchar *address
,const gchar *relation_type
,const gchar *label
,gboolean is_primary
); gint gdata_gd_email_address_compare (const GDataGDEmailAddress *a
,const GDataGDEmailAddress *b
); const gchar * gdata_gd_email_address_get_address (GDataGDEmailAddress *self
); void gdata_gd_email_address_set_address (GDataGDEmailAddress *self
,const gchar *address
); const gchar * gdata_gd_email_address_get_relation_type (GDataGDEmailAddress *self
); void gdata_gd_email_address_set_relation_type (GDataGDEmailAddress *self
,const gchar *relation_type
); const gchar * gdata_gd_email_address_get_label (GDataGDEmailAddress *self
); void gdata_gd_email_address_set_label (GDataGDEmailAddress *self
,const gchar *label
); gboolean gdata_gd_email_address_is_primary (GDataGDEmailAddress *self
); void gdata_gd_email_address_set_is_primary (GDataGDEmailAddress *self
,gboolean is_primary
); const gchar * gdata_gd_email_address_get_display_name (GDataGDEmailAddress *self
); void gdata_gd_email_address_set_display_name (GDataGDEmailAddress *self
,const gchar *display_name
);
"address" gchar* : Read / Write "display-name" gchar* : Read / Write "is-primary" gboolean : Read / Write "label" gchar* : Read / Write "relation-type" gchar* : Read / Write
typedef struct _GDataGDEmailAddress GDataGDEmailAddress;
All the fields in the GDataGDEmailAddress structure are private and should never be accessed directly.
Since 0.2.0
typedef struct { } GDataGDEmailAddressClass;
All the fields in the GDataGDEmailAddressClass structure are private and should never be accessed directly.
Since 0.4.0
GDataGDEmailAddress * gdata_gd_email_address_new (const gchar *address
,const gchar *relation_type
,const gchar *label
,gboolean is_primary
);
Creates a new GDataGDEmailAddress. More information is available in the GData specification.
|
the e-mail address |
|
the relationship between the e-mail address and its owner, or NULL . [allow-none]
|
|
a human-readable label for the e-mail address, or NULL . [allow-none]
|
|
TRUE if this e-mail address is its owner's primary address, FALSE otherwise
|
Returns : |
a new GDataGDEmailAddress, or NULL ; unref with g_object_unref()
|
Since 0.2.0
gint gdata_gd_email_address_compare (const GDataGDEmailAddress *a
,const GDataGDEmailAddress *b
);
Compares the two e-mail addresses in a strcmp()
fashion. NULL
values are handled gracefully, with
0
returned if both a
and b
are NULL
, -1
if a
is NULL
and 1
if b
is NULL
.
The comparison of non-NULL
values is done on the basis of the address
property of the GDataGDEmailAddresses.
|
a GDataGDEmailAddress, or NULL
|
|
another GDataGDEmailAddress, or NULL
|
Returns : |
0 if a equals b , -1 or 1 as
appropriate otherwise
|
Since 0.4.0
const gchar * gdata_gd_email_address_get_address (GDataGDEmailAddress *self
);
Gets the "address" property.
|
a GDataGDEmailAddress |
Returns : |
the e-mail address itself, or NULL
|
Since 0.4.0
void gdata_gd_email_address_set_address (GDataGDEmailAddress *self
,const gchar *address
);
Sets the "address" property to address
.
|
a GDataGDEmailAddress |
|
the new e-mail address |
Since 0.4.0
const gchar * gdata_gd_email_address_get_relation_type
(GDataGDEmailAddress *self
);
Gets the "relation-type" property.
|
a GDataGDEmailAddress |
Returns : |
the e-mail address' relation type, or NULL
|
Since 0.4.0
void gdata_gd_email_address_set_relation_type (GDataGDEmailAddress *self
,const gchar *relation_type
);
Sets the "relation-type" property to relation_type
.
Set relation_type
to NULL
to unset the property in the e-mail address.
|
a GDataGDEmailAddress |
|
the new relation type for the email_address, or NULL . [allow-none]
|
Since 0.4.0
const gchar * gdata_gd_email_address_get_label (GDataGDEmailAddress *self
);
Gets the "label" property.
|
a GDataGDEmailAddress |
Returns : |
the e-mail address' label, or NULL
|
Since 0.4.0
void gdata_gd_email_address_set_label (GDataGDEmailAddress *self
,const gchar *label
);
Sets the "label" property to label
.
Set label
to NULL
to unset the property in the e-mail address.
|
a GDataGDEmailAddress |
|
the new label for the e-mail address, or NULL . [allow-none]
|
Since 0.4.0
gboolean gdata_gd_email_address_is_primary (GDataGDEmailAddress *self
);
Gets the "is-primary" property.
|
a GDataGDEmailAddress |
Returns : |
TRUE if this is the primary e-mail address, FALSE otherwise
|
Since 0.4.0
void gdata_gd_email_address_set_is_primary (GDataGDEmailAddress *self
,gboolean is_primary
);
Sets the "is-primary" property to is_primary
.
|
a GDataGDEmailAddress |
|
TRUE if this is the primary e-mail address, FALSE otherwise
|
Since 0.4.0
const gchar * gdata_gd_email_address_get_display_name
(GDataGDEmailAddress *self
);
Gets the "display-name" property.
|
a GDataGDEmailAddress |
Returns : |
a display name for the e-mail address, or NULL
|
Since 0.6.0
void gdata_gd_email_address_set_display_name (GDataGDEmailAddress *self
,const gchar *display_name
);
Sets the "display-name" property to display_name
.
Set display_name
to NULL
to unset the property in the e-mail address.
|
a GDataGDEmailAddress |
|
the new display name, or NULL . [allow-none]
|
Since 0.6.0
"address"
property "address" gchar* : Read / Write
The e-mail address itself.
For more information, see the GData specification.
Default value: NULL
Since 0.4.0
"display-name"
property "display-name" gchar* : Read / Write
A display name of the entity (e.g. a person) the e-mail address belongs to.
For more information, see the GData specification.
Default value: NULL
Since 0.6.0
"is-primary"
property "is-primary" gboolean : Read / Write
Indicates which e-mail address out of a group is primary.
For more information, see the GData specification.
Default value: FALSE
Since 0.4.0
"label"
property "label" gchar* : Read / Write
A simple string value used to name this e-mail address. It allows UIs to display a label such as "Work", "Personal", "Preferred", etc.
For more information, see the GData specification.
Default value: NULL
Since 0.4.0
"relation-type"
property "relation-type" gchar* : Read / Write
A programmatic value that identifies the type of e-mail address.
For more information, see the GData specification.
Default value: NULL
Since 0.4.0