Camel.Subscribable¶

Implementations:
	None

Methods¶

	`folder_is_subscribed` (folder_name)
	`folder_subscribed` (folder_info)
	`folder_unsubscribed` (folder_info)
	`subscribe_folder` (folder_name, io_priority, cancellable, callback, *user_data)
	`subscribe_folder_finish` (result)
	`subscribe_folder_sync` (folder_name, cancellable)
	`unsubscribe_folder` (folder_name, io_priority, cancellable, callback, *user_data)
	`unsubscribe_folder_finish` (result)
	`unsubscribe_folder_sync` (folder_name, cancellable)

Virtual Methods¶

	`do_folder_is_subscribed` (folder_name)
	`do_folder_subscribed` (folder_info)
	`do_folder_unsubscribed` (folder_info)
	`do_subscribe_folder_sync` (folder_name, cancellable)
	`do_unsubscribe_folder_sync` (folder_name, cancellable)

Properties¶

None

Signals¶

Name	Short Description
`folder-subscribed`
`folder-unsubscribed`

Fields¶

None

Class Details¶

class Camel.Subscribable¶

Bases:	`GObject.GInterface`
Structure:	`Camel.SubscribableInterface`

New in version 3.2.

folder_is_subscribed(folder_name)¶

Parameters:	folder_name (`str`) – full path of the folder
Returns:	`True` if the folder has been subscribed to or `False` otherwise
Return type:	`bool`

Find out if a folder has been subscribed to.

New in version 3.2.

folder_subscribed(folder_info)¶

Parameters:	folder_info (`Camel.FolderInfo`) – information about the subscribed folder

Emits the Camel.Subscribable ::folder-subscribed signal from an idle source on the main loop. The idle source’s priority is GLib.PRIORITY_HIGH_IDLE.

This function is only intended for Camel providers.

New in version 3.2.

folder_unsubscribed(folder_info)¶

Parameters:	folder_info (`Camel.FolderInfo`) – information about the unsubscribed folder

Emits the Camel.Subscribable ::folder-unsubscribed signal from an idle source on the main loop. The idle source’s priority is GLib.PRIORITY_HIGH_IDLE.

This function is only intended for Camel providers.

New in version 3.2.

subscribe_folder(folder_name, io_priority, cancellable, callback, *user_data)¶

Parameters:

folder_name (str) – full path of the folder
io_priority (int) – the I/O priority of the request
cancellable (Gio.Cancellable or None) – optional Gio.Cancellable object, or None
callback (Gio.AsyncReadyCallback or None) – a Gio.AsyncReadyCallback to call when the request is satisfied
user_data (object or None) – data to pass to the callback function

Asynchronously subscribes to the folder described by folder_name.

When the operation is finished, callback will be called. You can then call Camel.Subscribable.subscribe_folder_finish() to get the result of the operation.

New in version 3.2.

subscribe_folder_finish(result)¶

Parameters:	result (`Gio.AsyncResult`) – a `Gio.AsyncResult`
Raises:	`GLib.Error`
Returns:	`True` on success, `False` on error
Return type:	`bool`

Finishes the operation started with Camel.Subscribable.subscribe_folder().

New in version 3.2.

subscribe_folder_sync(folder_name, cancellable)¶

Parameters:	folder_name (`str`) – full path of the folder cancellable (`Gio.Cancellable` or `None`) – optional `Gio.Cancellable` object, or `None`
Raises:	`GLib.Error`
Returns:	`True` on success, `False` on error
Return type:	`bool`

Subscribes to the folder described by folder_name.

New in version 3.2.

unsubscribe_folder(folder_name, io_priority, cancellable, callback, *user_data)¶

Parameters:

folder_name (str) – full path of the folder
io_priority (int) – the I/O priority of the request
cancellable (Gio.Cancellable or None) – optional Gio.Cancellable object, or None
callback (Gio.AsyncReadyCallback or None) – a Gio.AsyncReadyCallback to call when the request is satisfied
user_data (object or None) – data to pass to the callback function

Asynchronously unsubscribes from the folder described by folder_name.

When the operation is finished, callback will be called. You can then call Camel.Subscribable.unsubscribe_folder_finish() to get the result of the operation.

New in version 3.2.

unsubscribe_folder_finish(result)¶

Parameters:	result (`Gio.AsyncResult`) – a `Gio.AsyncResult`
Raises:	`GLib.Error`
Returns:	`True` on success, `False` on error
Return type:	`bool`

Finishes the operation started with Camel.Subscribable.unsubscribe_folder().

New in version 3.2.

unsubscribe_folder_sync(folder_name, cancellable)¶

Parameters:	folder_name (`str`) – full path of the folder cancellable (`Gio.Cancellable` or `None`) – optional `Gio.Cancellable` object, or `None`
Raises:	`GLib.Error`
Returns:	`True` on success, `False` on error
Return type:	`bool`

Unsubscribes from the folder described by folder_name.

New in version 3.2.

do_folder_is_subscribed(folder_name) virtual¶

Parameters:	folder_name (`str`) – full path of the folder
Returns:	`True` if the folder has been subscribed to or `False` otherwise
Return type:	`bool`

Find out if a folder has been subscribed to.

New in version 3.2.

do_folder_subscribed(folder_info) virtual¶

Parameters:	folder_info (`Camel.FolderInfo`) – information about the subscribed folder

Emits the Camel.Subscribable ::folder-subscribed signal from an idle source on the main loop. The idle source’s priority is GLib.PRIORITY_HIGH_IDLE.

This function is only intended for Camel providers.

New in version 3.2.

do_folder_unsubscribed(folder_info) virtual¶

Parameters:	folder_info (`Camel.FolderInfo`) – information about the unsubscribed folder

Emits the Camel.Subscribable ::folder-unsubscribed signal from an idle source on the main loop. The idle source’s priority is GLib.PRIORITY_HIGH_IDLE.

This function is only intended for Camel providers.

New in version 3.2.

do_subscribe_folder_sync(folder_name, cancellable) virtual¶

Parameters:	folder_name (`str`) – full path of the folder cancellable (`Gio.Cancellable` or `None`) – optional `Gio.Cancellable` object, or `None`
Returns:	`True` on success, `False` on error
Return type:	`bool`

Subscribes to the folder described by folder_name.

New in version 3.2.

do_unsubscribe_folder_sync(folder_name, cancellable) virtual¶

Parameters:	folder_name (`str`) – full path of the folder cancellable (`Gio.Cancellable` or `None`) – optional `Gio.Cancellable` object, or `None`
Returns:	`True` on success, `False` on error
Return type:	`bool`

Unsubscribes from the folder described by folder_name.

New in version 3.2.

Signal Details¶

Camel.Subscribable.signals.folder_subscribed(subscribable, object)¶

Signal Name:	`folder-subscribed`
Flags:	`RUN_FIRST`
Parameters:	subscribable (`Camel.Subscribable`) – The object which received the signal object (`Camel.FolderInfo`) –

Camel.Subscribable.signals.folder_unsubscribed(subscribable, object)¶

Signal Name:	`folder-unsubscribed`
Flags:	`RUN_FIRST`
Parameters:	subscribable (`Camel.Subscribable`) – The object which received the signal object (`Camel.FolderInfo`) –