ECal.ComponentId¶

Fields¶

None

Methods¶

class	`new` (uid, rid)
class	`new_take` (uid, rid)
	`copy` ()
	`equal` (id2)
	`get_rid` ()
	`get_uid` ()
	`hash` ()
	`set_rid` (rid)
	`set_uid` (uid)

Details¶

class ECal.ComponentId¶

An opaque structure containing UID of a component and its recurrence ID (which can be None). Use the functions below to work with it.

classmethod new(uid, rid)¶

Parameters:

uid (str) – a unique ID string
rid (str or None) – an optional recurrence ID string

Returns:

an ECal.ComponentId

Return type:

ECal.ComponentId

Creates a new ECal.ComponentId from uid and rid, which should be freed with e_cal_component_id_free().

New in version 3.10.

classmethod new_take(uid, rid)¶

Parameters:

uid (str) – a unique ID string
rid (str or None) – an optional recurrence ID string

Returns:

an ECal.ComponentId

Return type:

ECal.ComponentId

Creates a new ECal.ComponentId from uid and rid, which should be freed with e_cal_component_id_free(). The function assumes ownership of uid and rid parameters.

New in version 3.34.

copy()¶

Returns:: a newly allocated copy of self
Return type:: ECal.ComponentId

Returns a newly allocated copy of self, which should be freed with e_cal_component_id_free().

New in version 3.10.

equal(id2)¶

Parameters:: id2 (ECal.ComponentId) – the second ECal.ComponentId
Returns:: True if self and id2 are equal
Return type:: bool

Compares two ECal.ComponentId structs for equality.

New in version 3.10.

get_rid()¶

Returns:: The RECURRENCE-ID Camel.part of the self. The returned string is owned by self and it’s valid until it’s changed with ECal.ComponentId.set_rid() or until the self is freed.
Return type:: str or None

New in version 3.34.

get_uid()¶

Returns:: The UID Camel.part of the self. The returned string is owned by self and it’s valid until it’s changed with ECal.ComponentId.set_uid() or until the self is freed.
Return type:: str

New in version 3.34.

hash()¶

Returns:: a hash value for self
Return type:: int

Generates a hash value for self.

New in version 3.10.

set_rid(rid)¶

Parameters:: rid (str or None) – the RECURRENCE-ID to set

Sets the RECURRENCE-ID Camel.part of the self. The rid can be None or an empty string, where both are treated as None, which means the self has not RECURRENCE-ID.

New in version 3.34.

set_uid(uid)¶

Parameters:: uid (str) – the UID to set

Sets the UID Camel.part of the self.

New in version 3.34.