Object

class Object(**properties: Any)

Superclasses: Object

Subclasses: Array, Attach, CompIter, Component, Datetimeperiod, Duration, Geo, Parameter, Parser, Period, Property, RecurIterator, Recurrence, Reqstat, Time, TimeSpan, Timezone, Trigger, Value

This is an ICalObject instance struct.

Methods

class Object

add_depender(depender: Object) → None

Adds a depender into the list of objects which should not be destroyed before this iobject. It’s usually used for cases where the iobject uses native libical structure from the depender. The depender is referenced. It’s illegal to try to add one depender multiple times.

Added in version 1.0.

Parameters:

depender – a Object depender

classmethod free_global_objects() → None

Frees all global objects. Any references to them are invalidated by this call, unless they had been ref()-ed manually.

Added in version 3.0.5.

get_always_destroy() → bool

Obtain the ICalObject::always-destroy property value.

Added in version 3.0.11.

get_is_global_memory() → bool

Obtains whether the native libical structure is a global shared memory, thus should not be destroyed. This can be set only during construction time.

Added in version 1.0.

remove_depender(depender: Object) → None

Removes a depender from the list of objects which should not be destroyed before this iobject, previously added with add_depender(). It’s illegal to try to remove the depender which is not in the internal list.

Added in version 1.0.

Parameters:

depender – a Object depender

remove_owner() → None

Unref and remove the owner.

Added in version 1.0.

set_always_destroy(value: bool) → None

Sets the ICalObject::always-destroy property value. When True, the native libical structure is always freed, even when an owner of the iobject is set.

Added in version 3.0.11.

Parameters:

value – value to set

set_native_destroy_func(native_destroy_func: Callable[[Any], None]) → None

Sets a function to be used to destroy the native libical structure.

Added in version 1.0.

Parameters:

native_destroy_func – Function to be used to destroy the native libical structure

set_owner(owner: Object) → None

Sets an owner of the native libical structure, that is an object responsible for a destroy of the native libical structure.

Added in version 1.0.

Parameters:

owner – Owner of the native libical structure

Properties

class Object

props.always_destroy: bool

The type of the None singleton.

Added in version 3.0.11.

props.is_global_memory: bool

The type of the None singleton.

props.native: Any

The type of the None singleton.

props.native_destroy_func: Any

The type of the None singleton.

props.owner: Object

The type of the None singleton.

Fields

class Object

parent

priv