EBookContacts.Contact¶
- Subclasses:
None
Methods¶
- Inherited:
- Structs:
class |
|
class |
|
class |
|
class |
|
class |
|
class |
|
class |
|
class |
|
class |
|
class |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Virtual Methods¶
- Inherited:
Properties¶
Name |
Type |
Flags |
Short Description |
---|---|---|---|
r/w |
Last Revision |
||
r/w |
Address List |
||
r/w |
Home Address |
||
r/w |
Home Address Label |
||
r/w |
Other Address Label |
||
r/w |
Work Address Label |
||
r/w |
Other Address |
||
r/w |
Work Address |
||
r/w |
Anniversary |
||
r/w |
Assistant |
||
r/w |
Assistant Phone |
||
r/w |
Birth Date |
||
r/w |
Weblog URL |
||
r/w |
Book UID |
||
r/w |
Business Fax |
||
r/w |
Business Phone |
||
r/w |
Business Phone 2 |
||
r/w |
Callback Phone |
||
r/w |
Calendar URI |
||
r/w |
Car Phone |
||
r/w |
Categories |
||
r/w |
Category List |
||
r/w |
Company Phone |
||
r/w |
Email List |
||
r/w |
Email 1 |
||
r/w |
Email 2 |
||
r/w |
Email 3 |
||
r/w |
Email 4 |
||
r/w |
Family Name |
||
r/w |
Free/Busy URL |
||
r/w |
File Under |
||
r/w |
Full Name |
||
r/w |
Geographic Information |
||
r/w |
Given Name |
||
r/w |
Home Fax |
||
r/w |
Home Phone |
||
r/w |
Home Phone 2 |
||
r/w |
Homepage URL |
||
r/w |
ICS Calendar |
||
r/w |
Unique ID |
||
r/w |
AIM Screen Name List |
||
r/w |
AIM Home Screen Name 1 |
||
r/w |
AIM Home Screen Name 2 |
||
r/w |
AIM Home Screen Name 3 |
||
r/w |
AIM Work Screen Name 1 |
||
r/w |
AIM Work Screen Name 2 |
||
r/w |
AIM Work Screen Name 3 |
||
r/w |
Gadu-Gadu ID List |
||
r/w |
Gadu-Gadu Home ID 1 |
||
r/w |
Gadu-Gadu Home ID 2 |
||
r/w |
Gadu-Gadu Home ID 3 |
||
r/w |
Gadu-Gadu Work ID 1 |
||
r/w |
Gadu-Gadu Work ID 2 |
||
r/w |
Gadu-Gadu Work ID 3 |
||
r/w |
Google Talk Name List |
||
r/w |
Google Talk Home Name 1 |
||
r/w |
Google Talk Home Name 2 |
||
r/w |
Google Talk Home Name 3 |
||
r/w |
Google Talk Work Name 1 |
||
r/w |
Google Talk Work Name 2 |
||
r/w |
Google Talk Work Name 3 |
||
r/w |
GroupWise ID List |
||
r/w |
GroupWise Home Screen Name 1 |
||
r/w |
GroupWise Home Screen Name 2 |
||
r/w |
GroupWise Home Screen Name 3 |
||
r/w |
GroupWise Work Screen Name 1 |
||
r/w |
GroupWise Work Screen Name 2 |
||
r/w |
GroupWise Work Screen Name 3 |
||
r/w |
ICQ ID List |
||
r/w |
ICQ Home ID 1 |
||
r/w |
ICQ Home ID 2 |
||
r/w |
ICQ Home ID 3 |
||
r/w |
ICQ Work ID 1 |
||
r/w |
ICQ Work ID 2 |
||
r/w |
ICQ Work ID 3 |
||
r/w |
Jabber ID List |
||
r/w |
Jabber Home ID 1 |
||
r/w |
Jabber Home ID 2 |
||
r/w |
Jabber Home ID 3 |
||
r/w |
Jabber Work ID 1 |
||
r/w |
Jabber Work ID 2 |
||
r/w |
Jabber Work ID 3 |
||
r/w |
Matrix ID List |
||
r/w |
Matrix Home ID 1 |
||
r/w |
Matrix Home ID 2 |
||
r/w |
Matrix Home ID 3 |
||
r/w |
Matrix Work ID 1 |
||
r/w |
Matrix Work ID 2 |
||
r/w |
Matrix Work ID 3 |
||
r/w |
MSN Screen Name List |
||
r/w |
MSN Home Screen Name 1 |
||
r/w |
MSN Home Screen Name 2 |
||
r/w |
MSN Home Screen Name 3 |
||
r/w |
MSN Work Screen Name 1 |
||
r/w |
MSN Work Screen Name 2 |
||
r/w |
MSN Work Screen Name 3 |
||
r/w |
Skype Name List |
||
r/w |
Skype Home Name 1 |
||
r/w |
Skype Home Name 2 |
||
r/w |
Skype Home Name 3 |
||
r/w |
Skype Work Name 1 |
||
r/w |
Skype Work Name 2 |
||
r/w |
Skype Work Name 3 |
||
r/w |
Twitter Name List |
||
r/w |
Yahoo! Screen Name List |
||
r/w |
Yahoo! Home Screen Name 1 |
||
r/w |
Yahoo! Home Screen Name 2 |
||
r/w |
Yahoo! Home Screen Name 3 |
||
r/w |
Yahoo! Work Screen Name 1 |
||
r/w |
Yahoo! Work Screen Name 2 |
||
r/w |
Yahoo! Work Screen Name 3 |
||
r/w |
ISDN |
||
r/w |
List |
||
r/w |
List Shows Addresses |
||
r/w |
Logo |
||
r/w |
Mailer |
||
r/w |
Manager |
||
r/w |
Mobile Phone |
||
r/w |
Name |
||
r |
Name or Org |
||
r/w |
Nickname |
||
r/w |
Note |
||
r/w |
Office |
||
r/w |
Organization |
||
r/w |
Organizational Unit |
||
r/w |
Other Fax |
||
r/w |
Other Phone |
||
r/w |
Pager |
||
r/w |
PGP Certificate |
||
r/w |
Telephone |
||
r/w |
Photo |
||
r/w |
Primary Phone |
||
r/w |
Radio |
||
r/w |
Role |
||
r/w |
SIP address |
||
r/w |
Spouse’s Name |
||
r/w |
Telex |
||
r/w |
Title |
||
r/w |
TTY |
||
r/w |
Video Conferencing URL |
||
r/w |
Wants HTML Mail |
||
r/w |
X.509 Certificate |
Signals¶
- Inherited:
Fields¶
- Inherited:
Name |
Type |
Access |
Description |
---|---|---|---|
parent |
r |
Class Details¶
- class EBookContacts.Contact(**kwargs)¶
- Bases:
- Abstract:
No
- Structure:
- classmethod field_id(field_name)¶
- Parameters:
field_name (
str
) – a string representing a contact field- Returns:
An
EBookContacts.ContactField
corresponding to field_name, or 0 if it doesn’t exist.- Return type:
Gets the
EBookContacts.ContactField
corresponding to the field_name.
- classmethod field_id_from_vcard(vcard_field)¶
- Parameters:
vcard_field (
str
) – a string representing a vCard field- Returns:
An
EBookContacts.ContactField
corresponding to vcard_field, or 0 if it doesn’t exist.- Return type:
Gets the
EBookContacts.ContactField
corresponding to the vcard_field.New in version 2.26.
- classmethod field_is_string(field_id)¶
- Parameters:
field_id (
EBookContacts.ContactField
) – anEBookContacts.ContactField
- Returns:
Whether the field_id is of a string type.
- Return type:
Returns whether the field_id is of a string type, thus it can be used with
EBookContacts.Contact.get_const
().New in version 3.16.
- classmethod field_name(field_id)¶
- Parameters:
field_id (
EBookContacts.ContactField
) – anEBookContacts.ContactField
- Returns:
The string representation of field_id
- Return type:
Gets the string representation of field_id.
- classmethod field_type(field_id)¶
- Parameters:
field_id (
EBookContacts.ContactField
) – anEBookContacts.ContactField
- Returns:
The
GObject.GType
used for field_id, orGObject.TYPE_INVALID
if it doesn’t exist.- Return type:
Gets the
GObject.GType
used for this contact field, this indicates what kind of value can be passed toEBookContacts.Contact.set
().New in version 3.8.
- classmethod new()¶
- Returns:
A new
EBookContacts.Contact
.- Return type:
Creates a new, blank
EBookContacts.Contact
.
- classmethod new_from_vcard(vcard)¶
- Parameters:
vcard (
str
) – a string representing a vcard- Returns:
A new
EBookContacts.Contact
.- Return type:
Creates a new
EBookContacts.Contact
based on a vcard.
- classmethod new_from_vcard_with_uid(vcard, uid)¶
- Parameters:
- Returns:
A new
EBookContacts.Contact
.- Return type:
Creates a new
EBookContacts.Contact
based on a vcard and a predefined UID.New in version 3.4.
- classmethod pretty_name(field_id)¶
- Parameters:
field_id (
EBookContacts.ContactField
) – anEBookContacts.ContactField
- Returns:
The human-readable representation of field_id
- Return type:
Gets a human-readable, translated string representation of field_id.
- classmethod vcard_attribute(field_id)¶
- Parameters:
field_id (
EBookContacts.ContactField
) – anEBookContacts.ContactField
- Returns:
The vcard attribute corresponding to field_id
- Return type:
Gets the vcard attribute corresponding to field_id, as a string.
- duplicate()¶
- Returns:
A new
EBookContacts.Contact
identical to self.- Return type:
Creates a copy of self.
- get(field_id)¶
- Parameters:
field_id (
EBookContacts.ContactField
) – anEBookContacts.ContactField
- Returns:
Depends on the field’s type, owned by the caller. This may be
None
if the field isn’t set.- Return type:
Gets the value of self's field specified by field_id.
- get_attributes(field_id)¶
- Parameters:
field_id (
EBookContacts.ContactField
) – anEBookContacts.ContactField
- Returns:
A
GLib.List
of pointers toEBookContacts.VCardAttribute
, owned by the caller.- Return type:
Gets a list of the vcard attributes for self's field_id.
- get_attributes_set(field_ids)¶
- Parameters:
field_ids ([
EBookContacts.ContactField
]) – an array ofEBookContacts.ContactField
- Returns:
A
GLib.List
of pointers toEBookContacts.VCardAttribute
, owned by the caller.- Return type:
Gets a list of the vcard attributes for self's field_ids.
New in version 3.16.
- get_const(field_id)¶
- Parameters:
field_id (
EBookContacts.ContactField
) – anEBookContacts.ContactField
- Returns:
Depends on the field’s type, owned by the
EBookContacts.Contact
.- Return type:
Gets the value of self's field specified by field_id, caching the result so it can be freed later. Use
EBookContacts.Contact.field_is_string
() to check whether the field can be used here.
- inline_local_photos()¶
- Raises:
- Returns:
True
if there were no errors, upon errorFalse
is returned and error is set.- Return type:
Tries to modify any
EBookContacts.ContactPhoto
fields which are stored on the local file system as typeEBookContacts.ContactPhotoType.URI
to beEBookContacts.inlined
and stored asEBookContacts.ContactPhotoType.INLINED
instead.New in version 3.4.
- set(field_id, value)¶
- Parameters:
field_id (
EBookContacts.ContactField
) – anEBookContacts.ContactField
value (
object
orNone
) – a value whose type depends on the field_id
Sets the value of self's field specified by field_id to value.
- set_attributes(field_id, attributes)¶
- Parameters:
field_id (
EBookContacts.ContactField
) – anEBookContacts.ContactField
attributes ([
EBookContacts.VCardAttribute
]) – aGLib.List
of pointers toEBookContacts.VCardAttribute
Sets the vcard attributes for self's field_id. Attributes are added to the contact in the same order as they are in attributes.
Property Details¶
- EBookContacts.Contact.props.Rev¶
-
Last Revision
- EBookContacts.Contact.props.address¶
-
Address List
- EBookContacts.Contact.props.address_home¶
- Name:
address-home
- Type:
- Default Value:
- Flags:
Home Address
- EBookContacts.Contact.props.address_label_home¶
-
Home Address Label
- EBookContacts.Contact.props.address_label_other¶
-
Other Address Label
- EBookContacts.Contact.props.address_label_work¶
-
Work Address Label
- EBookContacts.Contact.props.address_other¶
- Name:
address-other
- Type:
- Default Value:
- Flags:
Other Address
- EBookContacts.Contact.props.address_work¶
- Name:
address-work
- Type:
- Default Value:
- Flags:
Work Address
- EBookContacts.Contact.props.anniversary¶
- Name:
anniversary
- Type:
- Default Value:
- Flags:
Anniversary
- EBookContacts.Contact.props.assistant¶
-
Assistant
- EBookContacts.Contact.props.assistant_phone¶
-
Assistant Phone
- EBookContacts.Contact.props.birth_date¶
- Name:
birth-date
- Type:
- Default Value:
- Flags:
Birth Date
- EBookContacts.Contact.props.blog_url¶
-
Weblog URL
- EBookContacts.Contact.props.book_uid¶
-
Book UID
- EBookContacts.Contact.props.business_fax¶
-
Business Fax
- EBookContacts.Contact.props.business_phone¶
-
Business Phone
- EBookContacts.Contact.props.business_phone_2¶
-
Business Phone 2
- EBookContacts.Contact.props.callback_phone¶
-
Callback Phone
- EBookContacts.Contact.props.caluri¶
-
Calendar URI
- EBookContacts.Contact.props.car_phone¶
-
Car Phone
- EBookContacts.Contact.props.categories¶
-
Categories
- EBookContacts.Contact.props.category_list¶
-
Category List
- EBookContacts.Contact.props.company_phone¶
-
Company Phone
- EBookContacts.Contact.props.email¶
-
Email List
- EBookContacts.Contact.props.email_1¶
-
Email 1
- EBookContacts.Contact.props.email_2¶
-
Email 2
- EBookContacts.Contact.props.email_3¶
-
Email 3
- EBookContacts.Contact.props.email_4¶
-
Email 4
- EBookContacts.Contact.props.family_name¶
-
Family Name
- EBookContacts.Contact.props.fburl¶
-
Free/Busy URL
- EBookContacts.Contact.props.file_as¶
-
File Under
- EBookContacts.Contact.props.full_name¶
-
Full Name
- EBookContacts.Contact.props.geo¶
- Name:
geo
- Type:
- Default Value:
- Flags:
Geographic Information
- EBookContacts.Contact.props.given_name¶
-
Given Name
- EBookContacts.Contact.props.home_fax¶
-
Home Fax
- EBookContacts.Contact.props.home_phone¶
-
Home Phone
- EBookContacts.Contact.props.home_phone_2¶
-
Home Phone 2
- EBookContacts.Contact.props.homepage_url¶
-
Homepage URL
- EBookContacts.Contact.props.icscalendar¶
-
ICS Calendar
- EBookContacts.Contact.props.id¶
-
Unique ID
- EBookContacts.Contact.props.im_aim¶
-
AIM Screen Name List
- EBookContacts.Contact.props.im_aim_home_1¶
-
AIM Home Screen Name 1
- EBookContacts.Contact.props.im_aim_home_2¶
-
AIM Home Screen Name 2
- EBookContacts.Contact.props.im_aim_home_3¶
-
AIM Home Screen Name 3
- EBookContacts.Contact.props.im_aim_work_1¶
-
AIM Work Screen Name 1
- EBookContacts.Contact.props.im_aim_work_2¶
-
AIM Work Screen Name 2
- EBookContacts.Contact.props.im_aim_work_3¶
-
AIM Work Screen Name 3
- EBookContacts.Contact.props.im_gadugadu¶
-
Gadu-Gadu ID List
- EBookContacts.Contact.props.im_gadugadu_home_1¶
-
Gadu-Gadu Home ID 1
- EBookContacts.Contact.props.im_gadugadu_home_2¶
-
Gadu-Gadu Home ID 2
- EBookContacts.Contact.props.im_gadugadu_home_3¶
-
Gadu-Gadu Home ID 3
- EBookContacts.Contact.props.im_gadugadu_work_1¶
-
Gadu-Gadu Work ID 1
- EBookContacts.Contact.props.im_gadugadu_work_2¶
-
Gadu-Gadu Work ID 2
- EBookContacts.Contact.props.im_gadugadu_work_3¶
-
Gadu-Gadu Work ID 3
- EBookContacts.Contact.props.im_google_talk¶
-
Google Talk Name List
- EBookContacts.Contact.props.im_google_talk_home_1¶
-
Google Talk Home Name 1
- EBookContacts.Contact.props.im_google_talk_home_2¶
-
Google Talk Home Name 2
- EBookContacts.Contact.props.im_google_talk_home_3¶
-
Google Talk Home Name 3
- EBookContacts.Contact.props.im_google_talk_work_1¶
-
Google Talk Work Name 1
- EBookContacts.Contact.props.im_google_talk_work_2¶
-
Google Talk Work Name 2
- EBookContacts.Contact.props.im_google_talk_work_3¶
-
Google Talk Work Name 3
- EBookContacts.Contact.props.im_groupwise¶
-
GroupWise ID List
- EBookContacts.Contact.props.im_groupwise_home_1¶
-
GroupWise Home Screen Name 1
- EBookContacts.Contact.props.im_groupwise_home_2¶
-
GroupWise Home Screen Name 2
- EBookContacts.Contact.props.im_groupwise_home_3¶
-
GroupWise Home Screen Name 3
- EBookContacts.Contact.props.im_groupwise_work_1¶
-
GroupWise Work Screen Name 1
- EBookContacts.Contact.props.im_groupwise_work_2¶
-
GroupWise Work Screen Name 2
- EBookContacts.Contact.props.im_groupwise_work_3¶
-
GroupWise Work Screen Name 3
- EBookContacts.Contact.props.im_icq¶
-
ICQ ID List
- EBookContacts.Contact.props.im_icq_home_1¶
-
ICQ Home ID 1
- EBookContacts.Contact.props.im_icq_home_2¶
-
ICQ Home ID 2
- EBookContacts.Contact.props.im_icq_home_3¶
-
ICQ Home ID 3
- EBookContacts.Contact.props.im_icq_work_1¶
-
ICQ Work ID 1
- EBookContacts.Contact.props.im_icq_work_2¶
-
ICQ Work ID 2
- EBookContacts.Contact.props.im_icq_work_3¶
-
ICQ Work ID 3
- EBookContacts.Contact.props.im_jabber¶
-
Jabber ID List
- EBookContacts.Contact.props.im_jabber_home_1¶
-
Jabber Home ID 1
- EBookContacts.Contact.props.im_jabber_home_2¶
-
Jabber Home ID 2
- EBookContacts.Contact.props.im_jabber_home_3¶
-
Jabber Home ID 3
- EBookContacts.Contact.props.im_jabber_work_1¶
-
Jabber Work ID 1
- EBookContacts.Contact.props.im_jabber_work_2¶
-
Jabber Work ID 2
- EBookContacts.Contact.props.im_jabber_work_3¶
-
Jabber Work ID 3
- EBookContacts.Contact.props.im_matrix¶
-
Matrix ID List
- EBookContacts.Contact.props.im_matrix_home_1¶
-
Matrix Home ID 1
- EBookContacts.Contact.props.im_matrix_home_2¶
-
Matrix Home ID 2
- EBookContacts.Contact.props.im_matrix_home_3¶
-
Matrix Home ID 3
- EBookContacts.Contact.props.im_matrix_work_1¶
-
Matrix Work ID 1
- EBookContacts.Contact.props.im_matrix_work_2¶
-
Matrix Work ID 2
- EBookContacts.Contact.props.im_matrix_work_3¶
-
Matrix Work ID 3
- EBookContacts.Contact.props.im_msn¶
-
MSN Screen Name List
- EBookContacts.Contact.props.im_msn_home_1¶
-
MSN Home Screen Name 1
- EBookContacts.Contact.props.im_msn_home_2¶
-
MSN Home Screen Name 2
- EBookContacts.Contact.props.im_msn_home_3¶
-
MSN Home Screen Name 3
- EBookContacts.Contact.props.im_msn_work_1¶
-
MSN Work Screen Name 1
- EBookContacts.Contact.props.im_msn_work_2¶
-
MSN Work Screen Name 2
- EBookContacts.Contact.props.im_msn_work_3¶
-
MSN Work Screen Name 3
- EBookContacts.Contact.props.im_skype¶
-
Skype Name List
- EBookContacts.Contact.props.im_skype_home_1¶
-
Skype Home Name 1
- EBookContacts.Contact.props.im_skype_home_2¶
-
Skype Home Name 2
- EBookContacts.Contact.props.im_skype_home_3¶
-
Skype Home Name 3
- EBookContacts.Contact.props.im_skype_work_1¶
-
Skype Work Name 1
- EBookContacts.Contact.props.im_skype_work_2¶
-
Skype Work Name 2
- EBookContacts.Contact.props.im_skype_work_3¶
-
Skype Work Name 3
- EBookContacts.Contact.props.im_twitter¶
-
Twitter Name List
- EBookContacts.Contact.props.im_yahoo¶
-
Yahoo! Screen Name List
- EBookContacts.Contact.props.im_yahoo_home_1¶
-
Yahoo! Home Screen Name 1
- EBookContacts.Contact.props.im_yahoo_home_2¶
-
Yahoo! Home Screen Name 2
- EBookContacts.Contact.props.im_yahoo_home_3¶
-
Yahoo! Home Screen Name 3
- EBookContacts.Contact.props.im_yahoo_work_1¶
-
Yahoo! Work Screen Name 1
- EBookContacts.Contact.props.im_yahoo_work_2¶
-
Yahoo! Work Screen Name 2
- EBookContacts.Contact.props.im_yahoo_work_3¶
-
Yahoo! Work Screen Name 3
- EBookContacts.Contact.props.isdn_phone¶
-
ISDN
- EBookContacts.Contact.props.list¶
-
List
- EBookContacts.Contact.props.list_show_addresses¶
-
List Shows Addresses
- EBookContacts.Contact.props.logo¶
- Name:
logo
- Type:
- Default Value:
- Flags:
Logo
- EBookContacts.Contact.props.mailer¶
-
Mailer
- EBookContacts.Contact.props.manager¶
-
Manager
- EBookContacts.Contact.props.mobile_phone¶
-
Mobile Phone
- EBookContacts.Contact.props.name¶
- Name:
name
- Type:
- Default Value:
- Flags:
Name
- EBookContacts.Contact.props.name_or_org¶
-
Name or Org
- EBookContacts.Contact.props.nickname¶
-
Nickname
- EBookContacts.Contact.props.note¶
-
Note
- EBookContacts.Contact.props.office¶
-
Office
- EBookContacts.Contact.props.org¶
-
Organization
- EBookContacts.Contact.props.org_unit¶
-
Organizational Unit
- EBookContacts.Contact.props.other_fax¶
-
Other Fax
- EBookContacts.Contact.props.other_phone¶
-
Other Phone
- EBookContacts.Contact.props.pager¶
-
Pager
- EBookContacts.Contact.props.pgpCert¶
- Name:
pgpCert
- Type:
- Default Value:
- Flags:
PGP Certificate
- EBookContacts.Contact.props.phone¶
-
Telephone
- EBookContacts.Contact.props.photo¶
- Name:
photo
- Type:
- Default Value:
- Flags:
Photo
- EBookContacts.Contact.props.primary_phone¶
-
Primary Phone
- EBookContacts.Contact.props.radio¶
-
Radio
- EBookContacts.Contact.props.role¶
-
Role
- EBookContacts.Contact.props.sip¶
-
SIP address
- EBookContacts.Contact.props.spouse¶
-
Spouse’s Name
- EBookContacts.Contact.props.telex¶
-
Telex
- EBookContacts.Contact.props.title¶
-
Title
- EBookContacts.Contact.props.tty¶
-
TTY
- EBookContacts.Contact.props.video_url¶
-
Video Conferencing URL
- EBookContacts.Contact.props.wants_html¶
-
Wants HTML Mail
- EBookContacts.Contact.props.x509Cert¶
- Name:
x509Cert
- Type:
- Default Value:
- Flags:
X.509 Certificate