Interface Account.Interface.Storage1

Interface Index (Compact) | Summary | Description | Properties | Types

Properties

StorageProvider s Read only
StorageIdentifier v Read only
StorageSpecificInformation a{sv} Read only
StorageRestrictions u (Storage_Restriction_Flags) Read only

Types

Storage_Restriction_Flags Flags u
Added in 0.19.8.
Objects implementing this interface must also implement:

Description

This interface extends the core Account interface to specify details regarding the storage of this account.

Rationale:

Single-sign-on systems do not generally have directly user-editable properties for Accounts, and require the user to visit a specific UI to alter their account properties. User interfaces should know not to expose these account properties as user-editable, and instead redirect the user to the appropriate interface.

Properties

Accessed using the org.freedesktop.DBus.Properties interface.
(Permalink)

StorageProvider — s

Read only

The name of the account storage implementation, which SHOULD start with a reversed domain name in the same way as D-Bus interface names. When this is the empty string the account is internally stored.

This property cannot change once an Account has been created.

(Permalink)

StorageIdentifier — v

Read only

Unique identification of the account within the storage backend. The contents of the variant are defined by the StorageProvider.

This property cannot change once an Account has been created.

Rationale:

Different storage systems will have their own way of uniquely identifying an account, typically an integer or a string. Given that all users of this property should have direct knowledge of the backend they should know what types to expect and how to handle it.

(Permalink)

StorageSpecificInformation — a{sv}

Read only

Map containing information specific to the storage backend. The keys and the types of their values are defined by the StorageProvider, and are not interpreted by the AccountManager implementation.

As the values in this map may change at any time (due to an external application manipulating the storage provider directly), this property should not be cached; it should instead be retrieved each time it is needed.

Rationale:

This can be used to provide additional hints to user interfaces aware of a specific storage provider, without requiring those user interfaces to use the StorageIdentifier to query the storage provider directly.

(Permalink)

StorageRestrictions — u (Storage_Restriction_Flags)

Read only

Bitfield which defines what restrictions this Storage method has.

This property cannot change once an Account has been created.

Types

Flags (Permalink)

Storage_Restriction_Flags — u

Flags indicating restrictions imposed on an Account by its storage method.
  • Cannot_Set_Parameters (1)
  • The account's Parameters property can't be changed by calling UpdateParameters.
  • Cannot_Set_Enabled (2)
  • The account can't be enabled/disabled by setting the Enabled property.
  • Cannot_Set_Presence (4)
  • The account's presence can't be changed by setting the RequestedPresence and AutomaticPresence properties.
  • Cannot_Set_Service (8)
  • The account's Service property cannot be changed.