Goa.Account¶

Implementations:: Goa.AccountProxy, Goa.AccountSkeleton

Methods¶

class	`interface_info` ()
class	`override_properties` (klass, property_id_begin)
	`call_ensure_credentials` (cancellable, callback, *user_data)
	`call_ensure_credentials_finish` (res)
	`call_ensure_credentials_sync` (cancellable)
	`call_remove` (cancellable, callback, *user_data)
	`call_remove_finish` (res)
	`call_remove_sync` (cancellable)
	`complete_ensure_credentials` (invocation, expires_in)
	`complete_remove` (invocation)

Virtual Methods¶

	`do_handle_ensure_credentials` (invocation)
	`do_handle_remove` (invocation)

Properties¶

Name	Type	Flags	Short Description
`attention-needed`	`bool`	r/w	AttentionNeeded
`calendar-disabled`	`bool`	r/w	CalendarDisabled
`chat-disabled`	`bool`	r/w	ChatDisabled
`contacts-disabled`	`bool`	r/w	ContactsDisabled
`documents-disabled`	`bool`	d/r/w	DocumentsDisabled `deprecated`
`files-disabled`	`bool`	r/w	FilesDisabled
`id`	`str`	r/w	Id
`identity`	`str`	r/w	Identity
`is-locked`	`bool`	r/w	IsLocked
`is-temporary`	`bool`	r/w	IsTemporary
`mail-disabled`	`bool`	r/w	MailDisabled
`maps-disabled`	`bool`	d/r/w	MapsDisabled `deprecated`
`music-disabled`	`bool`	r/w	MusicDisabled
`photos-disabled`	`bool`	r/w	PhotosDisabled
`presentation-identity`	`str`	r/w	PresentationIdentity
`printers-disabled`	`bool`	d/r/w	PrintersDisabled `deprecated`
`provider-icon`	`str`	r/w	ProviderIcon
`provider-name`	`str`	r/w	ProviderName
`provider-type`	`str`	r/w	ProviderType
`read-later-disabled`	`bool`	d/r/w	ReadLaterDisabled `deprecated`
`ticketing-disabled`	`bool`	r/w	TicketingDisabled
`todo-disabled`	`bool`	d/r/w	TodoDisabled `deprecated`

Signals¶

Name	Short Description
`handle-ensure-credentials`	Signal emitted when a remote caller is invoking the ‘EnsureCredentials() [gdbus-method-org-gnome-OnlineAccounts-Account.EnsureCredentials]’ D-Bus method.
`handle-remove`	Signal emitted when a remote caller is invoking the ‘Remove() [gdbus-method-org-gnome-OnlineAccounts-Account.Remove]’ D-Bus method.

Fields¶

None

Class Details¶

class Goa.Account¶

Bases:: GObject.GInterface
Structure:: Goa.AccountIface

Abstract interface type for the D-Bus interface ‘org.gnome.OnlineAccounts.Account [gdbus-interface-org-gnome-OnlineAccounts-Account.top_of_page]’.

classmethod interface_info()¶

Returns:: A Gio.DBusInterfaceInfo. Do not free.
Return type:: Gio.DBusInterfaceInfo

Gets a machine-readable description of the ‘org.gnome.OnlineAccounts.Account [gdbus-interface-org-gnome-OnlineAccounts-Account.top_of_page]’ D-Bus interface.

classmethod override_properties(klass, property_id_begin)¶

Parameters:

klass (GObject.ObjectClass) – The class structure for a GObject.Object derived class.
property_id_begin (int) – The property id to assign to the first overridden property.

Returns:

The last property id.

Return type:

int

Overrides all GObject.Object properties in the Goa.Account interface for a concrete class. The properties are overridden in the order they are defined.

call_ensure_credentials(cancellable, callback, *user_data)¶

Parameters:

cancellable (Gio.Cancellable or None) – A Gio.Cancellable or None.
callback (Gio.AsyncReadyCallback or None) – A Gio.AsyncReadyCallback to call when the request is satisfied or None.
user_data (object or None) – User data to pass to callback.

Asynchronously invokes the ‘EnsureCredentials() [gdbus-method-org-gnome-OnlineAccounts-Account.EnsureCredentials]’ D-Bus method on self. When the operation is finished, callback will be invoked in the thread-default main loop of the thread you are calling this method from (see GLib.MainContext.push_thread_default()). You can then call Goa.Account.call_ensure_credentials_finish() to get the result of the operation.

See Goa.Account.call_ensure_credentials_sync() for the synchronous, blocking version of this method.

call_ensure_credentials_finish(res)¶

Parameters:

res (Gio.AsyncResult) – The Gio.AsyncResult obtained from the Gio.AsyncReadyCallback passed to Goa.Account.call_ensure_credentials().

Raises:

GLib.Error

Returns:

True if the call succeeded, False if error is set.

out_expires_in:: Return location for return parameter or None to ignore.

Return type:

(bool, out_expires_in: int)

Finishes an operation started with Goa.Account.call_ensure_credentials().

call_ensure_credentials_sync(cancellable)¶

Parameters:

cancellable (Gio.Cancellable or None) – A Gio.Cancellable or None.

Raises:

GLib.Error

Returns:

True if the call succeeded, False if error is set.

out_expires_in:: Return location for return parameter or None to ignore.

Return type:

(bool, out_expires_in: int)

Synchronously invokes the ‘EnsureCredentials() [gdbus-method-org-gnome-OnlineAccounts-Account.EnsureCredentials]’ D-Bus method on self. The calling thread is blocked until a reply is received.

See Goa.Account.call_ensure_credentials() for the asynchronous version of this method.

call_remove(cancellable, callback, *user_data)¶

Parameters:

cancellable (Gio.Cancellable or None) – A Gio.Cancellable or None.
callback (Gio.AsyncReadyCallback or None) – A Gio.AsyncReadyCallback to call when the request is satisfied or None.
user_data (object or None) – User data to pass to callback.

Asynchronously invokes the ‘Remove() [gdbus-method-org-gnome-OnlineAccounts-Account.Remove]’ D-Bus method on self. When the operation is finished, callback will be invoked in the thread-default main loop of the thread you are calling this method from (see GLib.MainContext.push_thread_default()). You can then call Goa.Account.call_remove_finish() to get the result of the operation.

See Goa.Account.call_remove_sync() for the synchronous, blocking version of this method.

call_remove_finish(res)¶

Parameters:: res (Gio.AsyncResult) – The Gio.AsyncResult obtained from the Gio.AsyncReadyCallback passed to Goa.Account.call_remove().
Raises:: GLib.Error
Returns:: True if the call succeeded, False if error is set.
Return type:: bool

Finishes an operation started with Goa.Account.call_remove().

call_remove_sync(cancellable)¶

Parameters:: cancellable (Gio.Cancellable or None) – A Gio.Cancellable or None.
Raises:: GLib.Error
Returns:: True if the call succeeded, False if error is set.
Return type:: bool

Synchronously invokes the ‘Remove() [gdbus-method-org-gnome-OnlineAccounts-Account.Remove]’ D-Bus method on self. The calling thread is blocked until a reply is received.

See Goa.Account.call_remove() for the asynchronous version of this method.

complete_ensure_credentials(invocation, expires_in)¶

Parameters:

invocation (Gio.DBusMethodInvocation) – A Gio.DBusMethodInvocation.
expires_in (int) – Parameter to return.

Helper function used in service implementations to finish handling invocations of the ‘EnsureCredentials() [gdbus-method-org-gnome-OnlineAccounts-Account.EnsureCredentials]’ D-Bus method. If you instead want to finish handling an invocation by returning an error, use g_dbus_method_invocation_return_error() or similar.

This method will free invocation, you cannot use it afterwards.

complete_remove(invocation)¶

Parameters:: invocation (Gio.DBusMethodInvocation) – A Gio.DBusMethodInvocation.

Helper function used in service implementations to finish handling invocations of the ‘Remove() [gdbus-method-org-gnome-OnlineAccounts-Account.Remove]’ D-Bus method. If you instead want to finish handling an invocation by returning an error, use g_dbus_method_invocation_return_error() or similar.

This method will free invocation, you cannot use it afterwards.

do_handle_ensure_credentials(invocation) virtual¶

Parameters:: invocation (Gio.DBusMethodInvocation) –
Return type:: bool

do_handle_remove(invocation) virtual¶

Parameters:: invocation (Gio.DBusMethodInvocation) –
Return type:: bool

Signal Details¶

Goa.Account.signals.handle_ensure_credentials(account, invocation)¶

Signal Name:

handle-ensure-credentials

Flags:

RUN_LAST

Parameters:

account (Goa.Account) – The object which received the signal
invocation (Gio.DBusMethodInvocation) – A Gio.DBusMethodInvocation.

Returns:

Gio.DBUS_METHOD_INVOCATION_HANDLED or True if the invocation was handled, Gio.DBUS_METHOD_INVOCATION_UNHANDLED or False to let other signal handlers run.

Return type:

bool

Signal emitted when a remote caller is invoking the ‘EnsureCredentials() [gdbus-method-org-gnome-OnlineAccounts-Account.EnsureCredentials]’ D-Bus method.

If a signal handler returns True, it means the signal handler will handle the invocation (e.g. take a reference to invocation and eventually call Goa.Account.complete_ensure_credentials() or e.g. g_dbus_method_invocation_return_error() on it) and no other signal handlers will run. If no signal handler handles the invocation, the Gio.DBusError.UNKNOWN_METHOD error is returned.

Goa.Account.signals.handle_remove(account, invocation)¶

Signal Name:

handle-remove

Flags:

RUN_LAST

Parameters:

account (Goa.Account) – The object which received the signal
invocation (Gio.DBusMethodInvocation) – A Gio.DBusMethodInvocation.

Returns:

Gio.DBUS_METHOD_INVOCATION_HANDLED or True if the invocation was handled, Gio.DBUS_METHOD_INVOCATION_UNHANDLED or False to let other signal handlers run.

Return type:

bool

Signal emitted when a remote caller is invoking the ‘Remove() [gdbus-method-org-gnome-OnlineAccounts-Account.Remove]’ D-Bus method.

If a signal handler returns True, it means the signal handler will handle the invocation (e.g. take a reference to invocation and eventually call Goa.Account.complete_remove() or e.g. g_dbus_method_invocation_return_error() on it) and no other signal handlers will run. If no signal handler handles the invocation, the Gio.DBusError.UNKNOWN_METHOD error is returned.

Property Details¶

Goa.Account.props.attention_needed¶

Name:: attention-needed
Type:: bool
Default Value:: False
Flags:: READABLE, WRITABLE

Represents the D-Bus property ‘“AttentionNeeded” [gdbus-property-org-gnome-OnlineAccounts-Account.AttentionNeeded]’.

Since the D-Bus property for this GObject.Object property is readable but not writable, it is meaningful to read from it on both the client- and service-side. It is only meaningful, however, to write to it on the service-side.

Goa.Account.props.calendar_disabled¶

Name:: calendar-disabled
Type:: bool
Default Value:: False
Flags:: READABLE, WRITABLE

Represents the D-Bus property ‘“CalendarDisabled” [gdbus-property-org-gnome-OnlineAccounts-Account.CalendarDisabled]’.

Since the D-Bus property for this GObject.Object property is both readable and writable, it is meaningful to both read from it and write to it on both the service- and client-side.

Goa.Account.props.chat_disabled¶

Name:: chat-disabled
Type:: bool
Default Value:: False
Flags:: READABLE, WRITABLE

Represents the D-Bus property ‘“ChatDisabled” [gdbus-property-org-gnome-OnlineAccounts-Account.ChatDisabled]’.

Since the D-Bus property for this GObject.Object property is both readable and writable, it is meaningful to both read from it and write to it on both the service- and client-side.

Goa.Account.props.contacts_disabled¶

Name:: contacts-disabled
Type:: bool
Default Value:: False
Flags:: READABLE, WRITABLE

Represents the D-Bus property ‘“ContactsDisabled” [gdbus-property-org-gnome-OnlineAccounts-Account.ContactsDisabled]’.

Since the D-Bus property for this GObject.Object property is both readable and writable, it is meaningful to both read from it and write to it on both the service- and client-side.

Goa.Account.props.documents_disabled¶

Name:: documents-disabled
Type:: bool
Default Value:: False
Flags:: DEPRECATED, READABLE, WRITABLE

Represents the D-Bus property ‘“DocumentsDisabled” [gdbus-property-org-gnome-OnlineAccounts-Account.DocumentsDisabled]’.

Since the D-Bus property for this GObject.Object property is both readable and writable, it is meaningful to both read from it and write to it on both the service- and client-side.

Deprecated since version ???: The D-Bus property has been deprecated.

Goa.Account.props.files_disabled¶

Name:: files-disabled
Type:: bool
Default Value:: False
Flags:: READABLE, WRITABLE

Represents the D-Bus property ‘“FilesDisabled” [gdbus-property-org-gnome-OnlineAccounts-Account.FilesDisabled]’.

Since the D-Bus property for this GObject.Object property is both readable and writable, it is meaningful to both read from it and write to it on both the service- and client-side.

Goa.Account.props.id¶

Name:: id
Type:: str
Default Value:: None
Flags:: READABLE, WRITABLE

Represents the D-Bus property ‘“Id” [gdbus-property-org-gnome-OnlineAccounts-Account.Id]’.

Since the D-Bus property for this GObject.Object property is readable but not writable, it is meaningful to read from it on both the client- and service-side. It is only meaningful, however, to write to it on the service-side.

Goa.Account.props.identity¶

Name:: identity
Type:: str
Default Value:: None
Flags:: READABLE, WRITABLE

Represents the D-Bus property ‘“Identity” [gdbus-property-org-gnome-OnlineAccounts-Account.Identity]’.

Since the D-Bus property for this GObject.Object property is readable but not writable, it is meaningful to read from it on both the client- and service-side. It is only meaningful, however, to write to it on the service-side.

Goa.Account.props.is_locked¶

Name:: is-locked
Type:: bool
Default Value:: False
Flags:: READABLE, WRITABLE

Represents the D-Bus property ‘“IsLocked” [gdbus-property-org-gnome-OnlineAccounts-Account.IsLocked]’.

Since the D-Bus property for this GObject.Object property is readable but not writable, it is meaningful to read from it on both the client- and service-side. It is only meaningful, however, to write to it on the service-side.

Goa.Account.props.is_temporary¶

Name:: is-temporary
Type:: bool
Default Value:: False
Flags:: READABLE, WRITABLE

Represents the D-Bus property ‘“IsTemporary” [gdbus-property-org-gnome-OnlineAccounts-Account.IsTemporary]’.

Since the D-Bus property for this GObject.Object property is both readable and writable, it is meaningful to both read from it and write to it on both the service- and client-side.

Goa.Account.props.mail_disabled¶

Name:: mail-disabled
Type:: bool
Default Value:: False
Flags:: READABLE, WRITABLE

Represents the D-Bus property ‘“MailDisabled” [gdbus-property-org-gnome-OnlineAccounts-Account.MailDisabled]’.

Since the D-Bus property for this GObject.Object property is both readable and writable, it is meaningful to both read from it and write to it on both the service- and client-side.

Goa.Account.props.maps_disabled¶

Name:: maps-disabled
Type:: bool
Default Value:: False
Flags:: DEPRECATED, READABLE, WRITABLE

Represents the D-Bus property ‘“MapsDisabled” [gdbus-property-org-gnome-OnlineAccounts-Account.MapsDisabled]’.

Since the D-Bus property for this GObject.Object property is both readable and writable, it is meaningful to both read from it and write to it on both the service- and client-side.

Deprecated since version ???: The D-Bus property has been deprecated.

Goa.Account.props.music_disabled¶

Name:: music-disabled
Type:: bool
Default Value:: False
Flags:: READABLE, WRITABLE

Represents the D-Bus property ‘“MusicDisabled” [gdbus-property-org-gnome-OnlineAccounts-Account.MusicDisabled]’.

Since the D-Bus property for this GObject.Object property is both readable and writable, it is meaningful to both read from it and write to it on both the service- and client-side.

Goa.Account.props.photos_disabled¶

Name:: photos-disabled
Type:: bool
Default Value:: False
Flags:: READABLE, WRITABLE

Represents the D-Bus property ‘“PhotosDisabled” [gdbus-property-org-gnome-OnlineAccounts-Account.PhotosDisabled]’.

Since the D-Bus property for this GObject.Object property is both readable and writable, it is meaningful to both read from it and write to it on both the service- and client-side.

Goa.Account.props.presentation_identity¶

Name:: presentation-identity
Type:: str
Default Value:: None
Flags:: READABLE, WRITABLE

Represents the D-Bus property ‘“PresentationIdentity” [gdbus-property-org-gnome-OnlineAccounts-Account.PresentationIdentity]’.

Since the D-Bus property for this GObject.Object property is readable but not writable, it is meaningful to read from it on both the client- and service-side. It is only meaningful, however, to write to it on the service-side.

Goa.Account.props.printers_disabled¶

Name:: printers-disabled
Type:: bool
Default Value:: False
Flags:: DEPRECATED, READABLE, WRITABLE

Represents the D-Bus property ‘“PrintersDisabled” [gdbus-property-org-gnome-OnlineAccounts-Account.PrintersDisabled]’.

Since the D-Bus property for this GObject.Object property is both readable and writable, it is meaningful to both read from it and write to it on both the service- and client-side.

Deprecated since version ???: The D-Bus property has been deprecated.

Goa.Account.props.provider_icon¶

Name:: provider-icon
Type:: str
Default Value:: None
Flags:: READABLE, WRITABLE

Represents the D-Bus property ‘“ProviderIcon” [gdbus-property-org-gnome-OnlineAccounts-Account.ProviderIcon]’.

Since the D-Bus property for this GObject.Object property is readable but not writable, it is meaningful to read from it on both the client- and service-side. It is only meaningful, however, to write to it on the service-side.

Goa.Account.props.provider_name¶

Name:: provider-name
Type:: str
Default Value:: None
Flags:: READABLE, WRITABLE

Represents the D-Bus property ‘“ProviderName” [gdbus-property-org-gnome-OnlineAccounts-Account.ProviderName]’.

Since the D-Bus property for this GObject.Object property is readable but not writable, it is meaningful to read from it on both the client- and service-side. It is only meaningful, however, to write to it on the service-side.

Goa.Account.props.provider_type¶

Name:: provider-type
Type:: str
Default Value:: None
Flags:: READABLE, WRITABLE

Represents the D-Bus property ‘“ProviderType” [gdbus-property-org-gnome-OnlineAccounts-Account.ProviderType]’.

Since the D-Bus property for this GObject.Object property is readable but not writable, it is meaningful to read from it on both the client- and service-side. It is only meaningful, however, to write to it on the service-side.

Goa.Account.props.read_later_disabled¶

Name:: read-later-disabled
Type:: bool
Default Value:: False
Flags:: DEPRECATED, READABLE, WRITABLE

Represents the D-Bus property ‘“ReadLaterDisabled” [gdbus-property-org-gnome-OnlineAccounts-Account.ReadLaterDisabled]’.

Since the D-Bus property for this GObject.Object property is both readable and writable, it is meaningful to both read from it and write to it on both the service- and client-side.

Deprecated since version ???: The D-Bus property has been deprecated.

Goa.Account.props.ticketing_disabled¶

Name:: ticketing-disabled
Type:: bool
Default Value:: False
Flags:: READABLE, WRITABLE

Represents the D-Bus property ‘“TicketingDisabled” [gdbus-property-org-gnome-OnlineAccounts-Account.TicketingDisabled]’.

Since the D-Bus property for this GObject.Object property is both readable and writable, it is meaningful to both read from it and write to it on both the service- and client-side.

Goa.Account.props.todo_disabled¶

Name:: todo-disabled
Type:: bool
Default Value:: False
Flags:: DEPRECATED, READABLE, WRITABLE

Represents the D-Bus property ‘“TodoDisabled” [gdbus-property-org-gnome-OnlineAccounts-Account.TodoDisabled]’.

Since the D-Bus property for this GObject.Object property is both readable and writable, it is meaningful to both read from it and write to it on both the service- and client-side.

Deprecated since version ???: The D-Bus property has been deprecated.