GData.ContactsGroup¶
- Subclasses:
None
Methods¶
- Inherited:
- Structs:
class |
|
|
|
|
|
|
|
|
Virtual Methods¶
- Inherited:
Properties¶
- Inherited:
Name |
Type |
Flags |
Short Description |
---|---|---|---|
r |
Whether the entry has been deleted. |
||
r |
The last time the group was edited. |
||
r |
The system group ID for this group, if it’s a system group. |
Signals¶
- Inherited:
Fields¶
- Inherited:
Name |
Type |
Access |
Description |
---|---|---|---|
parent |
r |
Class Details¶
- class GData.ContactsGroup(**kwargs)¶
- Bases:
- Abstract:
No
- Structure:
All the fields in the
GData.ContactsGroup
structure are private and should never be accessed directly.New in version 0.7.0.
- classmethod new(id)¶
- Parameters:
- Returns:
a new
GData.ContactsGroup
; unref withGObject.Object.unref
()- Return type:
Creates a new
GData.ContactsGroup
with the given ID and default properties.New in version 0.7.0.
- get_edited()¶
- Returns:
the UNIX timestamp for the time the file was last edited, or -1
- Return type:
Gets the
GData.ContactsGroup
:edited
property. If the property is unset, -1 will be returned.New in version 0.7.0.
- get_extended_properties()¶
- Returns:
a
GLib.HashTable
of extended properties- Return type:
Gets the full list of extended properties of the group; a hash table mapping property name to value.
New in version 0.7.0.
- get_extended_property(name)¶
- Parameters:
name (
str
) – the property name; an arbitrary, unique string- Returns:
the property’s value, or
None
- Return type:
Gets the value of an extended property of the group. Each group can have up to 10 client-set extended properties to store data of the client’s choosing.
New in version 0.7.0.
- get_system_group_id()¶
-
Gets the
GData.ContactsGroup
:system-group-id
property. If the group is not a system group,None
will be returned.New in version 0.7.0.
- is_deleted()¶
-
Returns whether the group has recently been deleted. This will always return
False
unlessGData.ContactsQuery
:show-deleted
has been set toTrue
for the query which returned the group; then this function will returnTrue
only if the group has been deleted.If a group has been deleted, no other information is available about it. This is designed to allow groups to be deleted from local address books using incremental updates from the server (e.g. with
GData.Query
:updated-min
andGData.ContactsQuery
:show-deleted
).New in version 0.7.0.
- set_extended_property(name, value)¶
- Parameters:
- Returns:
True
if the property was updated or deleted successfully,False
otherwise- Return type:
Sets the value of a group’s extended property. Extended property names are unique (but of the client’s choosing), and reusing the same property name will result in the old value of that property being overwritten.
To unset a property, set value to
None
or an empty string.A group may have up to 10 extended properties, and each should be reasonably small (i.e. not a photo or ringtone). For more information, see the
online documentation.
False
will be returned if you attempt to add more than 10 extended properties.New in version 0.7.0.
Property Details¶
- GData.ContactsGroup.props.deleted¶
-
Whether the entry has been deleted.
New in version 0.7.0.
- GData.ContactsGroup.props.edited¶
-
The last time the group was edited. If the group has not been edited yet, the content indicates the time it was created.
For more information, see the Atom Publishing Protocol specification.
New in version 0.7.0.
- GData.ContactsGroup.props.system_group_id¶
-
The system group ID for this group, if it’s a system group. If the group is not a system group, this is
None
. Otherwise, it is one of the four system group IDs:GData.CONTACTS_GROUP_CONTACTS
,GData.CONTACTS_GROUP_FRIENDS
,GData.CONTACTS_GROUP_FAMILY
andGData.CONTACTS_GROUP_COWORKERS
.If this is non-
None
, the group name stored inGData.Entry
:title
will not be localised, so clients should provide localised group names of their own for each of the system groups. Whether a group is a system group should be detected solely on the basis of the value of this property, not by comparing the group name (GData.Entry
:title
) or entry ID (GData.Entry
:id
). The entry ID is not the same as the system group ID.New in version 0.7.0.