EDataServer.SourceRefresh

g EDataServer.SourceExtension EDataServer.SourceExtension EDataServer.SourceRefresh EDataServer.SourceRefresh EDataServer.SourceExtension->EDataServer.SourceRefresh GObject.Object GObject.Object GObject.Object->EDataServer.SourceExtension

Subclasses:None

Virtual Methods

Inherited:GObject.Object (7)

Properties

Inherited:EDataServer.SourceExtension (1)
Name Type Flags Short Description
enabled bool r/w/c/en Whether to periodically refresh
interval-minutes int r/w/c/en Refresh interval in minutes

Signals

Inherited:GObject.Object (1)

Fields

Inherited:GObject.Object (1)
Name Type Access Description
parent EDataServer.SourceExtension r  

Class Details

class EDataServer.SourceRefresh(**kwargs)
Bases:EDataServer.SourceExtension
Abstract:No
Structure:EDataServer.SourceRefreshClass

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

New in version 3.6.

get_enabled()
Returns:whether periodic refresh is enabled
Return type:bool

Returns whether to periodically fetch updates from a remote server.

The refresh interval is determined by the EDataServer.SourceRefresh :interval-minutes property.

New in version 3.6.

get_interval_minutes()
Returns:the interval in minutes
Return type:int

Returns the interval for fetching updates from a remote server.

Note this value is only effective when the EDataServer.SourceRefresh :enabled property is True.

New in version 3.6.

set_enabled(enabled)
Parameters:enabled (bool) – whether to enable periodic refresh

Sets whether to periodically fetch updates from a remote server.

The refresh interval is determined by the EDataServer.SourceRefresh :interval-minutes property.

New in version 3.6.

set_interval_minutes(interval_minutes)
Parameters:interval_minutes (int) – the interval in minutes

Sets the interval for fetching updates from a remote server.

Note this value is only effective when the EDataServer.SourceRefresh :enabled property is True.

New in version 3.6.

Property Details

EDataServer.SourceRefresh.props.enabled
Name:enabled
Type:bool
Default Value:True
Flags:READABLE, WRITABLE, CONSTRUCT, EXPLICIT_NOTIFY

Whether to periodically refresh

EDataServer.SourceRefresh.props.interval_minutes
Name:interval-minutes
Type:int
Default Value:60
Flags:READABLE, WRITABLE, CONSTRUCT, EXPLICIT_NOTIFY

Refresh interval in minutes