secret-service 1.8.1-jdk17 · org.freedesktop.secret.Item

Modifier and Type	Field and Description
private String	id

Access	Constructor and Description
public	Item(String collectionID, String itemID, Service service)
public	Item(ObjectPath item, Service service) References Deprecated `ObjectPath` is deprecated or references (maybe indirectly) at least one deprecated element.

Method Summary

Modifier and Type	Method and Description
public UInt64	created() Implements org.freedesktop.secret.interfaces.Item.created.
public static Map<String, Variant<T>>	Returns: properties — The properties for an item. Example: `properties = { "org.freedesktop.Secret.Item.Label": "MyItem", "org.freedesktop.Secret.Item.Attributes": { "Attribute1": "Value1", "Attribute2": "Value2" } }` Note Properties for a collection and properties for an item are not the same. See Also: `org.freedesktop.secret.interfaces.Item#getAttributes()` `org.freedesktop.secret.interfaces.Item#setAttributes(Map attributes)` `org.freedesktop.secret.interfaces.Collection#createItem(Map properties, Secret secret, boolean replace)` `org.freedesktop.secret.Collection#createProperties(String label)` `org.freedesktop.secret.interfaces.Service#createCollection(Map properties)` `org.freedesktop.secret.interfaces.Service#createCollection(Map properties, String alias)` createProperties(String The displayable label of the item. label, Map<String, String> String-valued attributes of the item. Note Please note that there is a distinction between the terms Property, which refers to D-Bus properties of an object, and Attribute, which refers to one of a secret item's string-valued attributes. attributes) Create properties for a new item.
public ObjectPath	delete() Implements org.freedesktop.secret.interfaces.Item.delete. References Deprecated `ObjectPath` is deprecated or references (maybe indirectly) at least one deprecated element. Delete this item.
public Map<String, String>	getAttributes() Implements org.freedesktop.secret.interfaces.Item.getAttributes. The lookup attributes for this item.
public String	getId()
public String	getLabel() Implements org.freedesktop.secret.interfaces.Item.getLabel. Label is a D-Bus Property.
public String	getObjectPath() Overrides org.freedesktop.secret.handlers.Messaging.getObjectPath. Implements org.freedesktop.dbus.interfaces.DBusInterface.getObjectPath. Returns the path of this object.
public Secret	getSecret(ObjectPath The session to use to encode the secret. session) Implements org.freedesktop.secret.interfaces.Item.getSecret. References Deprecated `ObjectPath` is deprecated or references (maybe indirectly) at least one deprecated element. Retrieve the secret for this item.
public String	getType() Implements org.freedesktop.secret.interfaces.Item.getType.
public boolean	isLocked() Implements org.freedesktop.secret.interfaces.Item.isLocked.
public boolean	isRemote() Overrides default org.freedesktop.dbus.interfaces.DBusInterface.isRemote. Returns true on remote objects.
public UInt64	modified() Implements org.freedesktop.secret.interfaces.Item.modified.
public void	setAttributes(Map<String, String> The attributes of the item. attributes) Implements org.freedesktop.secret.interfaces.Item.setAttributes. The lookup attributes for this item.
public void	setLabel(String The displayable label of this collection. Note The displayable `label` can differ from the actual `name` of a collection. label) Implements org.freedesktop.secret.interfaces.Item.setLabel. Label is a D-Bus Property.
public void	setSecret(Secret The secret to set, encoded for the included session. secret) Implements org.freedesktop.secret.interfaces.Item.setSecret. Set the secret for this item.

Inherited from org.freedesktop.secret.handlers.Messaging:: getAllProperties getConnection getInterfaceName getMessageHandler getPath getProperty getServiceName getSignalHandler send send setProperty

id	back to summary
private String id

Item	back to summary
public Item(String collectionID, String itemID, Service service)

Item	back to summary
public Item(ObjectPath item, Service service) References Deprecated `ObjectPath` is deprecated or references (maybe indirectly) at least one deprecated element. See corresponding docs for further information.

Method Detail

created	back to summary
public UInt64 created() Implements org.freedesktop.secret.interfaces.Item.created. Returns:UInt64 Doc from org.freedesktop.secret.interfaces.Item.created. The unix time when the item was created. Annotations @Override

created

back to summary

public UInt64 created()

Implements org.freedesktop.secret.interfaces.Item.created.

Returns:UInt64

Doc from org.freedesktop.secret.interfaces.Item.created.

The unix time when the item was created.

Annotations

@Override

createProperties back to summary

createProperties	back to summary
public static Map<String, Variant<T>> createProperties(String label, Map<String, String> attributes) Create properties for a new item. Parameters label:String The displayable label of the item. attributes:Map<String, String> String-valued attributes of the item. Note Please note that there is a distinction between the terms Property, which refers to D-Bus properties of an object, and Attribute, which refers to one of a secret item's string-valued attributes. Returns:Map<String, Variant<T>> properties — The properties for an item. Example: `properties = { "org.freedesktop.Secret.Item.Label": "MyItem", "org.freedesktop.Secret.Item.Attributes": { "Attribute1": "Value1", "Attribute2": "Value2" } }` Note Properties for a collection and properties for an item are not the same. See Also: `org.freedesktop.secret.interfaces.Item#getAttributes()` `org.freedesktop.secret.interfaces.Item#setAttributes(Map attributes)` `org.freedesktop.secret.interfaces.Collection#createItem(Map properties, Secret secret, boolean replace)` `org.freedesktop.secret.Collection#createProperties(String label)` `org.freedesktop.secret.interfaces.Service#createCollection(Map properties)` `org.freedesktop.secret.interfaces.Service#createCollection(Map properties, String alias)`

public static Map<String, Variant<T>> createProperties(String label, Map<String, String> attributes)

Create properties for a new item.

Parameters

label:String: The displayable label of the item.
attributes:Map<String, String>: String-valued attributes of the item.
Note
Please note that there is a distinction between the terms Property, which refers to D-Bus properties of an object, and Attribute, which refers to one of a secret item's string-valued attributes.

Returns:Map<String, Variant<T>>

properties — The properties for an item.

Example:
properties = { "org.freedesktop.Secret.Item.Label": "MyItem", "org.freedesktop.Secret.Item.Attributes": { "Attribute1": "Value1", "Attribute2": "Value2" } }

Note

Properties for a collection and properties for an item are not the same.

delete back to summary

delete	back to summary
public ObjectPath delete() Implements org.freedesktop.secret.interfaces.Item.delete. Doc from org.freedesktop.secret.interfaces.Item.delete. References Deprecated `ObjectPath` is deprecated or references (maybe indirectly) at least one deprecated element. See corresponding docs for further information. Delete this item. Returns:ObjectPath Prompt — A prompt objectpath, or the special value '/' if no prompt is necessary. Annotations @Override

public ObjectPath delete()

Implements org.freedesktop.secret.interfaces.Item.delete.

Doc from org.freedesktop.secret.interfaces.Item.delete.

References Deprecated

ObjectPath is deprecated or references (maybe indirectly) at least one deprecated element.

See corresponding docs for further information.

Delete this item.

Returns:ObjectPath

Prompt — A prompt objectpath, or the special value '/' if no prompt is necessary.

Annotations

@Override

getAttributes back to summary

getAttributes	back to summary
public Map<String, String> getAttributes() Implements org.freedesktop.secret.interfaces.Item.getAttributes. Doc from org.freedesktop.secret.interfaces.Item.getAttributes. The lookup attributes for this item. Attributes is a D-Bus Property. It is managed by using the `org.freedesktop.DBus.Properties` interface. Returns:Map<String, String> The attributes of the item. Annotations @Override

public Map<String, String> getAttributes()

Implements org.freedesktop.secret.interfaces.Item.getAttributes.

Doc from org.freedesktop.secret.interfaces.Item.getAttributes.

The lookup attributes for this item. Attributes is a D-Bus Property.

It is managed by using the org.freedesktop.DBus.Properties interface.

Returns:Map<String, String>

The attributes of the item.

Annotations

@Override

getId	back to summary
public String getId()

getLabel back to summary

getLabel	back to summary
public String getLabel() Implements org.freedesktop.secret.interfaces.Item.getLabel. Doc from org.freedesktop.secret.interfaces.Item.getLabel. Label is a D-Bus Property. It is managed by using the `org.freedesktop.DBus.Properties` interface. Returns:String The displayable label of this collection. Note The displayable `label` can differ from the actual `name` of a collection. Annotations @Override

public String getLabel()

Implements org.freedesktop.secret.interfaces.Item.getLabel.

Doc from org.freedesktop.secret.interfaces.Item.getLabel.

Label is a D-Bus Property.

It is managed by using the org.freedesktop.DBus.Properties interface.

Returns:String

The displayable label of this collection.

Note

The displayable label can differ from the actual name of a collection.

Annotations

@Override

getObjectPath	back to summary
public String getObjectPath() Overrides org.freedesktop.secret.handlers.Messaging.getObjectPath. Implements org.freedesktop.dbus.interfaces.DBusInterface.getObjectPath. Doc from org.freedesktop.dbus.interfaces.DBusInterface.getObjectPath. Returns the path of this object. Returns:String string Annotations @Override

getObjectPath

back to summary

public String getObjectPath()

Overrides org.freedesktop.secret.handlers.Messaging.getObjectPath.

Implements org.freedesktop.dbus.interfaces.DBusInterface.getObjectPath.

Doc from org.freedesktop.dbus.interfaces.DBusInterface.getObjectPath.

Returns the path of this object.

Returns:String

string

Annotations

@Override

getSecret back to summary

getSecret	back to summary
public Secret getSecret(ObjectPath session) Implements org.freedesktop.secret.interfaces.Item.getSecret. Doc from org.freedesktop.secret.interfaces.Item.getSecret. References Deprecated `ObjectPath` is deprecated or references (maybe indirectly) at least one deprecated element. See corresponding docs for further information. Retrieve the secret for this item. Parameters session:ObjectPath The session to use to encode the secret. Returns:Secret secret — The secret retrieved. Annotations @Override

public Secret getSecret(ObjectPath session)

Implements org.freedesktop.secret.interfaces.Item.getSecret.

Doc from org.freedesktop.secret.interfaces.Item.getSecret.

References Deprecated

ObjectPath is deprecated or references (maybe indirectly) at least one deprecated element.

See corresponding docs for further information.

Retrieve the secret for this item.

Parameters

session:ObjectPath: The session to use to encode the secret.

Returns:Secret

secret — The secret retrieved.

Annotations

@Override

getType	back to summary
public String getType() Implements org.freedesktop.secret.interfaces.Item.getType. Returns:String Doc from org.freedesktop.secret.interfaces.Item.getType. The "xdg:schema" of the item attributes. Annotations @Override

getType

back to summary

public String getType()

Implements org.freedesktop.secret.interfaces.Item.getType.

Returns:String

Doc from org.freedesktop.secret.interfaces.Item.getType.

The "xdg:schema" of the item attributes.

Annotations

@Override

isLocked	back to summary
public boolean isLocked() Implements org.freedesktop.secret.interfaces.Item.isLocked. Returns:boolean Doc from org.freedesktop.secret.interfaces.Item.isLocked. Whether the item is locked and requires authentication, or not. Annotations @Override

isLocked

back to summary

public boolean isLocked()

Implements org.freedesktop.secret.interfaces.Item.isLocked.

Returns:boolean

Doc from org.freedesktop.secret.interfaces.Item.isLocked.

Whether the item is locked and requires authentication, or not.

Annotations

@Override

isRemote	back to summary
public boolean isRemote() Overrides default org.freedesktop.dbus.interfaces.DBusInterface.isRemote. Doc from org.freedesktop.dbus.interfaces.DBusInterface.isRemote. Returns true on remote objects. Local objects implementing this interface MUST return false. Returns:boolean boolean Annotations @Override

isRemote

back to summary

public boolean isRemote()

Overrides default org.freedesktop.dbus.interfaces.DBusInterface.isRemote.

Doc from org.freedesktop.dbus.interfaces.DBusInterface.isRemote.

Returns true on remote objects. Local objects implementing this interface MUST return false.

Returns:boolean

boolean

Annotations

@Override

modified	back to summary
public UInt64 modified() Implements org.freedesktop.secret.interfaces.Item.modified. Returns:UInt64 Doc from org.freedesktop.secret.interfaces.Item.modified. The unix time when the item was last modified. Annotations @Override

modified

back to summary

public UInt64 modified()

Implements org.freedesktop.secret.interfaces.Item.modified.

Returns:UInt64

Doc from org.freedesktop.secret.interfaces.Item.modified.

The unix time when the item was last modified.

Annotations

@Override

setAttributes back to summary

setAttributes	back to summary
public void setAttributes(Map<String, String> attributes) Implements org.freedesktop.secret.interfaces.Item.setAttributes. Doc from org.freedesktop.secret.interfaces.Item.setAttributes. The lookup attributes for this item. Attributes is a D-Bus Property. It is managed by using the `org.freedesktop.DBus.Properties` interface. Parameters attributes:Map<String, String> The attributes of the item. Annotations @Override

public void setAttributes(Map<String, String> attributes)

Implements org.freedesktop.secret.interfaces.Item.setAttributes.

Doc from org.freedesktop.secret.interfaces.Item.setAttributes.

The lookup attributes for this item. Attributes is a D-Bus Property.

It is managed by using the org.freedesktop.DBus.Properties interface.

Parameters

attributes:Map<String, String>: The attributes of the item.

Annotations

@Override

setLabel back to summary

setLabel	back to summary
public void setLabel(String label) Implements org.freedesktop.secret.interfaces.Item.setLabel. Doc from org.freedesktop.secret.interfaces.Item.setLabel. Label is a D-Bus Property. It is managed by using the `org.freedesktop.DBus.Properties` interface. Parameters label:String The displayable label of this collection. Note The displayable `label` can differ from the actual `name` of a collection. Annotations @Override

public void setLabel(String label)

Implements org.freedesktop.secret.interfaces.Item.setLabel.

Doc from org.freedesktop.secret.interfaces.Item.setLabel.

Label is a D-Bus Property.

It is managed by using the org.freedesktop.DBus.Properties interface.

Parameters

label:String: The displayable label of this collection.
Note
The displayable label can differ from the actual name of a collection.

Annotations

@Override

setSecret	back to summary
public void setSecret(Secret secret) Implements org.freedesktop.secret.interfaces.Item.setSecret. Doc from org.freedesktop.secret.interfaces.Item.setSecret. Set the secret for this item. Parameters secret:Secret The secret to set, encoded for the included session. Annotations @Override

setSecret

back to summary

public void setSecret(Secret secret)

Implements org.freedesktop.secret.interfaces.Item.setSecret.

Doc from org.freedesktop.secret.interfaces.Item.setSecret.

Set the secret for this item.

Parameters