Blame doc/html/gdbus-org.gnome.OnlineAccounts.Account.html

Packit Service c6b9b0
Packit Service c6b9b0
<html>
Packit Service c6b9b0
<head>
Packit Service c6b9b0
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
Packit Service c6b9b0
<title>org.gnome.OnlineAccounts.Account: GNOME Online Accounts Reference Manual</title>
Packit Service c6b9b0
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
Packit Service c6b9b0
<link rel="home" href="index.html" title="GNOME Online Accounts Reference Manual">
Packit Service c6b9b0
<link rel="up" href="ch03.html" title="Core Interfaces">
Packit Service c6b9b0
<link rel="prev" href="ch03.html" title="Core Interfaces">
Packit Service c6b9b0
<link rel="next" href="gdbus-org.gnome.OnlineAccounts.Manager.html" title="org.gnome.OnlineAccounts.Manager">
Packit Service c6b9b0
<meta name="generator" content="GTK-Doc V1.28 (XML mode)">
Packit Service c6b9b0
<link rel="stylesheet" href="style.css" type="text/css">
Packit Service c6b9b0
</head>
Packit Service c6b9b0
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Top  | 
Packit Service c6b9b0
                  Description  | 
Packit Service c6b9b0
                  Properties
Packit Service c6b9b0
Packit Service c6b9b0
Home
Packit Service c6b9b0
Up
Packit Service c6b9b0
Prev
Packit Service c6b9b0
Next
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0

org.gnome.OnlineAccounts.Account

Packit Service c6b9b0

org.gnome.OnlineAccounts.Account

Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0

Methods

Packit Service c6b9b0
Packit Service c6b9b0
Remove            ();
Packit Service c6b9b0
EnsureCredentials (OUT i expires_in);
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0

Properties

Packit Service c6b9b0
Packit Service c6b9b0
ProviderType          readable   s
Packit Service c6b9b0
ProviderName          readable   s
Packit Service c6b9b0
ProviderIcon          readable   s
Packit Service c6b9b0
Id                    readable   s
Packit Service c6b9b0
IsLocked              readable   b
Packit Service c6b9b0
IsTemporary           readwrite  b
Packit Service c6b9b0
AttentionNeeded       readable   b
Packit Service c6b9b0
Identity              readable   s
Packit Service c6b9b0
PresentationIdentity  readable   s
Packit Service c6b9b0
MailDisabled          readwrite  b
Packit Service c6b9b0
CalendarDisabled      readwrite  b
Packit Service c6b9b0
ContactsDisabled      readwrite  b
Packit Service c6b9b0
ChatDisabled          readwrite  b
Packit Service c6b9b0
DocumentsDisabled     readwrite  b
Packit Service c6b9b0
MapsDisabled          readwrite  b
Packit Service c6b9b0
MusicDisabled         readwrite  b
Packit Service c6b9b0
PrintersDisabled      readwrite  b
Packit Service c6b9b0
PhotosDisabled        readwrite  b
Packit Service c6b9b0
FilesDisabled         readwrite  b
Packit Service c6b9b0
TicketingDisabled     readwrite  b
Packit Service c6b9b0
TodoDisabled          readwrite  b
Packit Service c6b9b0
ReadLaterDisabled     readwrite  b
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0

Description

Packit Service c6b9b0

The base account interface.

Packit Service c6b9b0

Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0

Method Details

Packit Service c6b9b0
Packit Service c6b9b0

The Remove() method

Packit Service c6b9b0
Packit Service c6b9b0
Remove ();
Packit Service c6b9b0
Packit Service c6b9b0

Removes the account. Note that this does not removes the

Packit Service c6b9b0
        account at the remote service.
Packit Service c6b9b0

Packit Service c6b9b0
Packit Service c6b9b0

Packit Service c6b9b0
Packit Service c6b9b0

The EnsureCredentials() method

Packit Service c6b9b0
Packit Service c6b9b0
EnsureCredentials (OUT i expires_in);
Packit Service c6b9b0
Packit Service c6b9b0

Ensures that valid credentials exist for the account and

Packit Service c6b9b0
        returns how long they are still valid for, if known. Returns
Packit Service c6b9b0
        an error if the cached credentials are not valid or
Packit Service c6b9b0
        non-existant.
Packit Service c6b9b0

Packit Service c6b9b0

If this method fails because the token service indicates that

Packit Service c6b9b0
        authorization has expired, the
Packit Service c6b9b0
        "AttentionNeeded" property
Packit Service c6b9b0
        will be set to TRUE. On the other hand, if this property was
Packit Service c6b9b0
        already TRUE and this method succeeds, it is set to FALSE.
Packit Service c6b9b0

Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0

OUT i expires_in:

Packit Service c6b9b0

The duration that the cached credentials are valid for, in seconds, or 0 if unknown.

Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0

Property Details

Packit Service c6b9b0
Packit Service c6b9b0

The "ProviderType" property

Packit Service c6b9b0
Packit Service c6b9b0
ProviderType  readable   s
Packit Service c6b9b0
Packit Service c6b9b0

The type of provider of the account.

Packit Service c6b9b0

Packit Service c6b9b0

This value describes how data is accessed, e.g. what API

Packit Service c6b9b0
        applications should use. Use
Packit Service c6b9b0
        "ProviderName" for the name of
Packit Service c6b9b0
        the provider (which might differ from the provider name in
Packit Service c6b9b0
        hosted scenarios) to display in the user interface.
Packit Service c6b9b0

Packit Service c6b9b0
Packit Service c6b9b0

Packit Service c6b9b0
Packit Service c6b9b0

The "ProviderName" property

Packit Service c6b9b0
Packit Service c6b9b0
ProviderName  readable   s
Packit Service c6b9b0
Packit Service c6b9b0

The name of the provider to display in the user interface.

Packit Service c6b9b0

Packit Service c6b9b0
Packit Service c6b9b0

Packit Service c6b9b0
Packit Service c6b9b0

The "ProviderIcon" property

Packit Service c6b9b0
Packit Service c6b9b0
ProviderIcon  readable   s
Packit Service c6b9b0
Packit Service c6b9b0

The icon/logo of the provider.

Packit Service c6b9b0

Packit Service c6b9b0

This is a serialized GIcon

Packit Service c6b9b0
        - use e.g. g_icon_new_for_string()
Packit Service c6b9b0
        to create an instance.
Packit Service c6b9b0

Packit Service c6b9b0
Packit Service c6b9b0

Packit Service c6b9b0
Packit Service c6b9b0

The "Id" property

Packit Service c6b9b0
Packit Service c6b9b0
Id  readable   s
Packit Service c6b9b0
Packit Service c6b9b0

An identifier for this account.

Packit Service c6b9b0

This identifier cannot be changed and should never be

Packit Service c6b9b0
         displayed in any user interface.
Packit Service c6b9b0

Packit Service c6b9b0
Packit Service c6b9b0

Packit Service c6b9b0
Packit Service c6b9b0

The "IsLocked" property

Packit Service c6b9b0
Packit Service c6b9b0
IsLocked  readable   b
Packit Service c6b9b0
Packit Service c6b9b0

Whether or not the user is discouraged from removing this account.

Packit Service c6b9b0

Packit Service c6b9b0

Locked accounts can be those that there added by the administrator to

Packit Service c6b9b0
         pre-configure systems in an enterprise deployment. If TRUE, the UI
Packit Service c6b9b0
         should prevent, or atleast discourage, removal of these accounts.
Packit Service c6b9b0

Packit Service c6b9b0

Since 3.16.0

Packit Service c6b9b0
Packit Service c6b9b0

Packit Service c6b9b0
Packit Service c6b9b0

The "IsTemporary" property

Packit Service c6b9b0
Packit Service c6b9b0
IsTemporary  readwrite  b
Packit Service c6b9b0
Packit Service c6b9b0

Whether or not the account is remembered from session to session.

Packit Service c6b9b0

Packit Service c6b9b0

Temporary accounts are added implicitly when the user is granted

Packit Service c6b9b0
         credentials from some mechanism other than Online Accounts, but that
Packit Service c6b9b0
         Online Accounts still knows how to deal with.
Packit Service c6b9b0

Packit Service c6b9b0

They are specific to the machine/session and are silently disregarded

Packit Service c6b9b0
         after logout.
Packit Service c6b9b0

Packit Service c6b9b0

Accounts are permanant by default unless created with "IsTemporary"

Packit Service c6b9b0
         "true" detail.
Packit Service c6b9b0

Packit Service c6b9b0
Packit Service c6b9b0

Packit Service c6b9b0
Packit Service c6b9b0

The "AttentionNeeded" property

Packit Service c6b9b0
Packit Service c6b9b0
AttentionNeeded  readable   b
Packit Service c6b9b0
Packit Service c6b9b0

Set to TRUE if the account is in need of attention.

Packit Service c6b9b0

This is used when a human operator is needed to service the

Packit Service c6b9b0
         account (e.g. for authentication and/or authorization).
Packit Service c6b9b0

Packit Service c6b9b0
Packit Service c6b9b0

Packit Service c6b9b0
Packit Service c6b9b0

The "Identity" property

Packit Service c6b9b0
Packit Service c6b9b0
Identity  readable   s
Packit Service c6b9b0
Packit Service c6b9b0

A string that uniquely identifies the account at the

Packit Service c6b9b0
         provider.
Packit Service c6b9b0

Packit Service c6b9b0

Note that this may be the same string for different kinds of

Packit Service c6b9b0
         providers (for example, if the user is using the same
Packit Service c6b9b0
         email-address for several providers) - use
Packit Service c6b9b0
         "Id" to uniquely identify the
Packit Service c6b9b0
         account.
Packit Service c6b9b0

Packit Service c6b9b0

This string might not be suitable for presentation in an user

Packit Service c6b9b0
         interface - use
Packit Service c6b9b0
         "PresentationIdentity" instead.
Packit Service c6b9b0

Packit Service c6b9b0
Packit Service c6b9b0

Packit Service c6b9b0
Packit Service c6b9b0

The "PresentationIdentity" property

Packit Service c6b9b0
Packit Service c6b9b0
PresentationIdentity  readable   s
Packit Service c6b9b0
Packit Service c6b9b0

Like the "Identity" property but

Packit Service c6b9b0
         suitable for presentation in an user interface.
Packit Service c6b9b0

Packit Service c6b9b0
Packit Service c6b9b0

Packit Service c6b9b0
Packit Service c6b9b0

The "MailDisabled" property

Packit Service c6b9b0
Packit Service c6b9b0
MailDisabled  readwrite  b
Packit Service c6b9b0
Packit Service c6b9b0

If TRUE, the account will not expose any

Packit Service c6b9b0
         org.gnome.OnlineAccounts.Mail interface. If the account does not
Packit Service c6b9b0
         provide email-like messaging capabilities, this property does
Packit Service c6b9b0
         nothing.
Packit Service c6b9b0

Packit Service c6b9b0

Note that the #org.gnomeOnlineAccounts.Mail interface is added or

Packit Service c6b9b0
         removed from the account asynchronously.
Packit Service c6b9b0

Packit Service c6b9b0
Packit Service c6b9b0

Packit Service c6b9b0
Packit Service c6b9b0

The "CalendarDisabled" property

Packit Service c6b9b0
Packit Service c6b9b0
CalendarDisabled  readwrite  b
Packit Service c6b9b0
Packit Service c6b9b0

If TRUE, the account will not expose any

Packit Service c6b9b0
         org.gnome.OnlineAccounts.Calendar interface. If the account does not
Packit Service c6b9b0
         provide calendar-like capabilities, this property does nothing.
Packit Service c6b9b0

Packit Service c6b9b0

Note that the #org.gnomeOnlineAccounts.Calendar interface is added or

Packit Service c6b9b0
         removed from the account asynchronously.
Packit Service c6b9b0

Packit Service c6b9b0
Packit Service c6b9b0

Packit Service c6b9b0
Packit Service c6b9b0

The "ContactsDisabled" property

Packit Service c6b9b0
Packit Service c6b9b0
ContactsDisabled  readwrite  b
Packit Service c6b9b0
Packit Service c6b9b0

If TRUE, the account will not expose any

Packit Service c6b9b0
         org.gnome.OnlineAccounts.Contacts interface. If the account does not
Packit Service c6b9b0
         provide contacts-like capabilities, this property does nothing.
Packit Service c6b9b0

Packit Service c6b9b0

Note that the #org.gnomeOnlineAccounts.Contacts interface is added or

Packit Service c6b9b0
         removed from the account asynchronously.
Packit Service c6b9b0

Packit Service c6b9b0
Packit Service c6b9b0

Packit Service c6b9b0
Packit Service c6b9b0

The "ChatDisabled" property

Packit Service c6b9b0
Packit Service c6b9b0
ChatDisabled  readwrite  b
Packit Service c6b9b0
Packit Service c6b9b0

If TRUE, the account will not expose any

Packit Service c6b9b0
         org.gnome.OnlineAccounts.Chat interface. If the account does not
Packit Service c6b9b0
         provide chat-like messaging capabilities, this property does
Packit Service c6b9b0
         nothing.
Packit Service c6b9b0

Packit Service c6b9b0

Note that the #org.gnomeOnlineAccounts.Chat interface is added or

Packit Service c6b9b0
         removed from the account asynchronously.
Packit Service c6b9b0

Packit Service c6b9b0
Packit Service c6b9b0

Packit Service c6b9b0
Packit Service c6b9b0

The "DocumentsDisabled" property

Packit Service c6b9b0
Packit Service c6b9b0
DocumentsDisabled  readwrite  b
Packit Service c6b9b0
Packit Service c6b9b0

If TRUE, the account will not expose any

Packit Service c6b9b0
         org.gnome.OnlineAccounts.Documents interface. If the account does not
Packit Service c6b9b0
         provide documents-like capabilities, this property does nothing.
Packit Service c6b9b0

Packit Service c6b9b0

Note that the #org.gnomeOnlineAccounts.Documents interface is added or

Packit Service c6b9b0
         removed from the account asynchronously.
Packit Service c6b9b0

Packit Service c6b9b0
Packit Service c6b9b0

Packit Service c6b9b0
Packit Service c6b9b0

The "MapsDisabled" property

Packit Service c6b9b0
Packit Service c6b9b0
MapsDisabled  readwrite  b
Packit Service c6b9b0
Packit Service c6b9b0

If TRUE, the account will not expose any

Packit Service c6b9b0
         org.gnome.OnlineAccounts.Maps interface. If the account does not
Packit Service c6b9b0
         provide maps-like capabilities, this property does nothing.
Packit Service c6b9b0

Packit Service c6b9b0

Note that the #org.gnomeOnlineAccounts.Maps interface is added or

Packit Service c6b9b0
         removed from the account asynchronously.
Packit Service c6b9b0

Packit Service c6b9b0

Since 3.14.0

Packit Service c6b9b0
Packit Service c6b9b0

Packit Service c6b9b0
Packit Service c6b9b0

The "MusicDisabled" property

Packit Service c6b9b0
Packit Service c6b9b0
MusicDisabled  readwrite  b
Packit Service c6b9b0
Packit Service c6b9b0

If TRUE, the account will not expose any

Packit Service c6b9b0
         org.gnome.OnlineAccounts.Music interface. If the account does not
Packit Service c6b9b0
         provide music-like capabilities, this property does nothing.
Packit Service c6b9b0

Packit Service c6b9b0

Note that the #org.gnomeOnlineAccounts.Music interface is added or

Packit Service c6b9b0
         removed from the account asynchronously.
Packit Service c6b9b0

Packit Service c6b9b0

Since 3.18.0

Packit Service c6b9b0
Packit Service c6b9b0

Packit Service c6b9b0
Packit Service c6b9b0

The "PrintersDisabled" property

Packit Service c6b9b0
Packit Service c6b9b0
PrintersDisabled  readwrite  b
Packit Service c6b9b0
Packit Service c6b9b0

If TRUE, the account will not expose any

Packit Service c6b9b0
         org.gnome.OnlineAccounts.Printers interface. If the account does not
Packit Service c6b9b0
         provide printers-like capabilities, this property does nothing.
Packit Service c6b9b0

Packit Service c6b9b0

Note that the #org.gnomeOnlineAccounts.Printers interface is added or

Packit Service c6b9b0
         removed from the account asynchronously.
Packit Service c6b9b0

Packit Service c6b9b0

Since 3.12.0

Packit Service c6b9b0
Packit Service c6b9b0

Packit Service c6b9b0
Packit Service c6b9b0

The "PhotosDisabled" property

Packit Service c6b9b0
Packit Service c6b9b0
PhotosDisabled  readwrite  b
Packit Service c6b9b0
Packit Service c6b9b0

If TRUE, the account will not expose any

Packit Service c6b9b0
         org.gnome.OnlineAccounts.Photos interface. If the account does not
Packit Service c6b9b0
         provide photos-like capabilities, this property does nothing.
Packit Service c6b9b0

Packit Service c6b9b0

Note that the #org.gnomeOnlineAccounts.Photos interface is added or

Packit Service c6b9b0
         removed from the account asynchronously.
Packit Service c6b9b0

Packit Service c6b9b0

Since 3.8.0

Packit Service c6b9b0
Packit Service c6b9b0

Packit Service c6b9b0
Packit Service c6b9b0

The "FilesDisabled" property

Packit Service c6b9b0
Packit Service c6b9b0
FilesDisabled  readwrite  b
Packit Service c6b9b0
Packit Service c6b9b0

If TRUE, the account will not expose any

Packit Service c6b9b0
         org.gnome.OnlineAccounts.Files interface. If the account does not
Packit Service c6b9b0
         provide files-like capabilities, this property does nothing.
Packit Service c6b9b0

Packit Service c6b9b0

Note that the #org.gnomeOnlineAccounts.Files interface is added or

Packit Service c6b9b0
         removed from the account asynchronously.
Packit Service c6b9b0

Packit Service c6b9b0

Since 3.8.0

Packit Service c6b9b0
Packit Service c6b9b0

Packit Service c6b9b0
Packit Service c6b9b0

The "TicketingDisabled" property

Packit Service c6b9b0
Packit Service c6b9b0
TicketingDisabled  readwrite  b
Packit Service c6b9b0
Packit Service c6b9b0

If TRUE, the account will not expose any

Packit Service c6b9b0
         org.gnome.OnlineAccounts.Ticketing interface. If the account does not
Packit Service c6b9b0
         provide ticketing-like capabilities, this property does nothing.
Packit Service c6b9b0

Packit Service c6b9b0

Note that the #org.gnomeOnlineAccounts.Ticketing interface is added or

Packit Service c6b9b0
         removed from the account asynchronously.
Packit Service c6b9b0

Packit Service c6b9b0

Since 3.6.0

Packit Service c6b9b0
Packit Service c6b9b0

Packit Service c6b9b0
Packit Service c6b9b0

The "TodoDisabled" property

Packit Service c6b9b0
Packit Service c6b9b0
TodoDisabled  readwrite  b
Packit Service c6b9b0
Packit Service c6b9b0

If TRUE, the account will not expose any

Packit Service c6b9b0
         org.gnome.OnlineAccounts.Todo interface. If the account does not
Packit Service c6b9b0
         provide todo-like capabilities, this property does nothing.
Packit Service c6b9b0

Packit Service c6b9b0

Note that the #org.gnomeOnlineAccounts.Todo interface is added or

Packit Service c6b9b0
         removed from the account asynchronously.
Packit Service c6b9b0

Packit Service c6b9b0

Since 3.26.0

Packit Service c6b9b0
Packit Service c6b9b0

Packit Service c6b9b0
Packit Service c6b9b0

The "ReadLaterDisabled" property

Packit Service c6b9b0
Packit Service c6b9b0
ReadLaterDisabled  readwrite  b
Packit Service c6b9b0
Packit Service c6b9b0

If TRUE, the account will not expose any

Packit Service c6b9b0
         org.gnome.OnlineAccounts.ReadLater interface. If the account does not
Packit Service c6b9b0
         provide read-later-like capabilities, this property does nothing.
Packit Service c6b9b0

Packit Service c6b9b0

Note that the #org.gnomeOnlineAccounts.ReadLater interface is added or

Packit Service c6b9b0
         removed from the account asynchronously.
Packit Service c6b9b0

Packit Service c6b9b0

Since 3.12.0

Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0
Packit Service c6b9b0

Generated by GTK-Doc V1.28
Packit Service c6b9b0
</body>
Packit Service c6b9b0
</html>