Camel.OfflineSettings¶

Subclasses:: None

Methods¶

Inherited:: Camel.StoreSettings (4), Camel.Settings (2), GObject.Object (37)
Structs:: GObject.ObjectClass (5)

	`get_limit_by_age` ()
	`get_limit_unit` ()
	`get_limit_value` ()
	`get_stay_synchronized` ()
	`get_store_changes_interval` ()
	`set_limit_by_age` (limit_by_age)
	`set_limit_unit` (limit_unit)
	`set_limit_value` (limit_value)
	`set_stay_synchronized` (stay_synchronized)
	`set_store_changes_interval` (interval)

Virtual Methods¶

Inherited:: Camel.Settings (2), GObject.Object (7)

Properties¶

Inherited:: Camel.StoreSettings (2)

Name	Type	Flags	Short Description
`limit-by-age`	`bool`	r/w/c/en	Whether to limit what will be synchronized by message date
`limit-unit`	`Camel.TimeUnit`	r/w/c/en	A unit for the limit-value
`limit-value`	`int`	r/w/c/en	How many days/weeks/months/years to download into the local cache, if limit-by-age is set to `True`
`stay-synchronized`	`bool`	r/w/c/en	Stay synchronized with the remote server

Signals¶

Inherited:: GObject.Object (1)

Fields¶

Inherited:: GObject.Object (1)

Name	Type	Access	Description
parent	`Camel.StoreSettings`	r

Class Details¶

class Camel.OfflineSettings(**kwargs)¶

Bases:: Camel.StoreSettings
Abstract:: No
Structure:: Camel.OfflineSettingsClass

Contains only private data that should be read and manipulated using the functions below.

Added in version 3.2.

get_limit_by_age()¶

Returns:: whether limit messages stored for offline use by their age
Return type:: bool

Added in version 3.24.

get_limit_unit()¶

Returns:: the limit unit to use when interpreting ‘limit-value’
Return type:: Camel.TimeUnit

Added in version 3.24.

get_limit_value()¶

Returns:: the limit, in ‘limit-unit’, to use when ‘limit-by-age’ is set to True
Return type:: int

Added in version 3.24.

get_stay_synchronized()¶

Returns:: whether to stay synchronized with the remote server
Return type:: bool

Returns whether to synchronize the local cache with the remote server before switching to offline mode, so the store’s content can still be read while offline.

Added in version 3.2.

get_store_changes_interval()¶

Returns:: the interval for automatic store of folder changes
Return type:: int

Returns the interval, in seconds, for the changes in the folder being saved automatically. 0 means immediately, while -1 means turning off automatic folder change saving.

Added in version 3.18.

Deprecated since version 3.40: Use Camel.StoreSettings.get_store_changes_interval() instead

set_limit_by_age(limit_by_age)¶

Parameters:: limit_by_age (bool) – a value to set

Set whether the messages to download for offline should be limited by age. If set to True, then messages older than ‘limit-value’ will not be downloaded automatically.

Added in version 3.24.

set_limit_unit(limit_unit)¶

Parameters:: limit_unit (Camel.TimeUnit) – a Camel.TimeUnit with a unit to use

Set the limit unit to use when interpreting ‘limit-value’.

Added in version 3.24.

set_limit_value(limit_value)¶

Parameters:: limit_value (bool) – a value to set

Set the limit, in ‘limit-unit’, to use when ‘limit-by-age’ is set to True.

Added in version 3.24.

set_stay_synchronized(stay_synchronized)¶

Parameters:: stay_synchronized (bool) – whether to stay synchronized with the remote server

Sets whether to synchronize the local cache with the remote server before switching to offline mode, so the store’s content can still be read while offline.

Added in version 3.2.

set_store_changes_interval(interval)¶

Parameters:: interval (int) – the interval, in seconds

Sets the interval, in seconds, for the changes in the folder being saved automatically. 0 means immediately, while -1 means turning off automatic folder change saving.

Added in version 3.18.

Deprecated since version 3.40: Use Camel.StoreSettings.set_store_changes_interval() instead

Property Details¶

Camel.OfflineSettings.props.limit_by_age¶

Name:: limit-by-age
Type:: bool
Default Value:: False
Flags:: READABLE, WRITABLE, CONSTRUCT, EXPLICIT_NOTIFY

Whether to limit what will be synchronized by message date

Camel.OfflineSettings.props.limit_unit¶

Name:: limit-unit
Type:: Camel.TimeUnit
Default Value:: Camel.TimeUnit.YEARS
Flags:: READABLE, WRITABLE, CONSTRUCT, EXPLICIT_NOTIFY

A unit for the limit-value

Camel.OfflineSettings.props.limit_value¶

Name:: limit-value
Type:: int
Default Value:: 1
Flags:: READABLE, WRITABLE, CONSTRUCT, EXPLICIT_NOTIFY

How many days/weeks/months/years to download into the local cache, if limit-by-age is set to True

Camel.OfflineSettings.props.stay_synchronized¶

Name:: stay-synchronized
Type:: bool
Default Value:: False
Flags:: READABLE, WRITABLE, CONSTRUCT, EXPLICIT_NOTIFY

Stay synchronized with the remote server