Copyright | Will Thompson and Iñaki García Etxebarria |
---|---|
License | LGPL-2.1 |
Maintainer | Iñaki García Etxebarria |
Safe Haskell | None |
Language | Haskell2010 |
GI.Secret.Objects.Item
Contents
- Exported types
- Methods
- create
- createFinish
- createSync
- delete
- deleteFinish
- deleteSync
- getAttributes
- getCreated
- getFlags
- getLabel
- getLocked
- getModified
- getSchemaName
- getSecret
- getService
- loadSecret
- loadSecretFinish
- loadSecretSync
- loadSecrets
- loadSecretsFinish
- loadSecretsSync
- refresh
- setAttributes
- setAttributesFinish
- setAttributesSync
- setLabel
- setLabelFinish
- setLabelSync
- setSecret
- setSecretFinish
- setSecretSync
- Properties
Description
A secret item
Item
represents a secret item stored in the Secret Service.
Each item has a value, represented by a [structvalue
], which can be
retrieved by [methoditem
.get_secret] or set by [methoditem
.set_secret].
The item is only available when the item is not locked.
Items can be locked or unlocked using the [methodservice
.lock] or
[methodservice
.unlock] functions. The Secret Service may not be able to
unlock individual items, and may unlock an entire collection when a single
item is unlocked.
Each item has a set of attributes, which are used to locate the item later.
These are not stored or transferred in a secure manner. Each attribute has
a string name and a string value. Use [methodservice
.search] to search for
items based on their attributes, and [methoditem
.set_attributes] to change
the attributes associated with an item.
Items can be created with Item.create
or [methodservice
.store].
Synopsis
- newtype Item = Item (ManagedPtr Item)
- class (GObject o, IsDescendantOf Item o) => IsItem o
- toItem :: (MonadIO m, IsItem o) => o -> m Item
- type family ResolveItemMethod (t :: Symbol) o where ...
- itemCreate :: (HasCallStack, MonadIO m, IsCollection a, IsCancellable b) => a -> Maybe Schema -> Map Text Text -> Text -> Value -> [ItemCreateFlags] -> Maybe b -> Maybe AsyncReadyCallback -> m ()
- itemCreateFinish :: (HasCallStack, MonadIO m, IsAsyncResult a) => a -> m Item
- itemCreateSync :: (HasCallStack, MonadIO m, IsCollection a, IsCancellable b) => a -> Maybe Schema -> Map Text Text -> Text -> Value -> [ItemCreateFlags] -> Maybe b -> m Item
- data ItemDeleteMethodInfo
- itemDelete :: (HasCallStack, MonadIO m, IsItem a, IsCancellable b) => a -> Maybe b -> Maybe AsyncReadyCallback -> m ()
- data ItemDeleteFinishMethodInfo
- itemDeleteFinish :: (HasCallStack, MonadIO m, IsItem a, IsAsyncResult b) => a -> b -> m ()
- data ItemDeleteSyncMethodInfo
- itemDeleteSync :: (HasCallStack, MonadIO m, IsItem a, IsCancellable b) => a -> Maybe b -> m ()
- data ItemGetAttributesMethodInfo
- itemGetAttributes :: (HasCallStack, MonadIO m, IsItem a) => a -> m (Map Text Text)
- data ItemGetCreatedMethodInfo
- itemGetCreated :: (HasCallStack, MonadIO m, IsItem a) => a -> m Word64
- data ItemGetFlagsMethodInfo
- itemGetFlags :: (HasCallStack, MonadIO m, IsItem a) => a -> m [ItemFlags]
- data ItemGetLabelMethodInfo
- itemGetLabel :: (HasCallStack, MonadIO m, IsItem a) => a -> m Text
- data ItemGetLockedMethodInfo
- itemGetLocked :: (HasCallStack, MonadIO m, IsItem a) => a -> m Bool
- data ItemGetModifiedMethodInfo
- itemGetModified :: (HasCallStack, MonadIO m, IsItem a) => a -> m Word64
- data ItemGetSchemaNameMethodInfo
- itemGetSchemaName :: (HasCallStack, MonadIO m, IsItem a) => a -> m (Maybe Text)
- data ItemGetSecretMethodInfo
- itemGetSecret :: (HasCallStack, MonadIO m, IsItem a) => a -> m (Maybe Value)
- data ItemGetServiceMethodInfo
- itemGetService :: (HasCallStack, MonadIO m, IsItem a) => a -> m Service
- data ItemLoadSecretMethodInfo
- itemLoadSecret :: (HasCallStack, MonadIO m, IsItem a, IsCancellable b) => a -> Maybe b -> Maybe AsyncReadyCallback -> m ()
- data ItemLoadSecretFinishMethodInfo
- itemLoadSecretFinish :: (HasCallStack, MonadIO m, IsItem a, IsAsyncResult b) => a -> b -> m ()
- data ItemLoadSecretSyncMethodInfo
- itemLoadSecretSync :: (HasCallStack, MonadIO m, IsItem a, IsCancellable b) => a -> Maybe b -> m ()
- itemLoadSecrets :: (HasCallStack, MonadIO m, IsItem a, IsCancellable b) => [a] -> Maybe b -> Maybe AsyncReadyCallback -> m ()
- itemLoadSecretsFinish :: (HasCallStack, MonadIO m, IsAsyncResult a) => a -> m ()
- itemLoadSecretsSync :: (HasCallStack, MonadIO m, IsItem a, IsCancellable b) => [a] -> Maybe b -> m ()
- data ItemRefreshMethodInfo
- itemRefresh :: (HasCallStack, MonadIO m, IsItem a) => a -> m ()
- data ItemSetAttributesMethodInfo
- itemSetAttributes :: (HasCallStack, MonadIO m, IsItem a, IsCancellable b) => a -> Maybe Schema -> Map Text Text -> Maybe b -> Maybe AsyncReadyCallback -> m ()
- data ItemSetAttributesFinishMethodInfo
- itemSetAttributesFinish :: (HasCallStack, MonadIO m, IsItem a, IsAsyncResult b) => a -> b -> m ()
- data ItemSetAttributesSyncMethodInfo
- itemSetAttributesSync :: (HasCallStack, MonadIO m, IsItem a, IsCancellable b) => a -> Maybe Schema -> Map Text Text -> Maybe b -> m ()
- data ItemSetLabelMethodInfo
- itemSetLabel :: (HasCallStack, MonadIO m, IsItem a, IsCancellable b) => a -> Text -> Maybe b -> Maybe AsyncReadyCallback -> m ()
- data ItemSetLabelFinishMethodInfo
- itemSetLabelFinish :: (HasCallStack, MonadIO m, IsItem a, IsAsyncResult b) => a -> b -> m ()
- data ItemSetLabelSyncMethodInfo
- itemSetLabelSync :: (HasCallStack, MonadIO m, IsItem a, IsCancellable b) => a -> Text -> Maybe b -> m ()
- data ItemSetSecretMethodInfo
- itemSetSecret :: (HasCallStack, MonadIO m, IsItem a, IsCancellable b) => a -> Value -> Maybe b -> Maybe AsyncReadyCallback -> m ()
- data ItemSetSecretFinishMethodInfo
- itemSetSecretFinish :: (HasCallStack, MonadIO m, IsItem a, IsAsyncResult b) => a -> b -> m ()
- data ItemSetSecretSyncMethodInfo
- itemSetSecretSync :: (HasCallStack, MonadIO m, IsItem a, IsCancellable b) => a -> Value -> Maybe b -> m ()
- data ItemFlagsPropertyInfo
- constructItemFlags :: (IsItem o, MonadIO m) => [ItemFlags] -> m (GValueConstruct o)
- getItemFlags :: (MonadIO m, IsItem o) => o -> m [ItemFlags]
- itemFlags :: AttrLabelProxy "flags"
- data ItemLockedPropertyInfo
- getItemLocked :: (MonadIO m, IsItem o) => o -> m Bool
- itemLocked :: AttrLabelProxy "locked"
- data ItemServicePropertyInfo
- constructItemService :: (IsItem o, MonadIO m, IsService a) => a -> m (GValueConstruct o)
- getItemService :: (MonadIO m, IsItem o) => o -> m Service
- itemService :: AttrLabelProxy "service"
Exported types
Memory-managed wrapper type.
Constructors
Item (ManagedPtr Item) |
Instances
Methods
Click to display all available methods, including inherited ones
Methods
bindProperty, bindPropertyFull, call, callFinish, callSync, callWithUnixFdList, callWithUnixFdListFinish, callWithUnixFdListSync, delete, deleteFinish, deleteSync, forceFloating, freezeNotify, getv, init, initAsync, initFinish, isFloating, loadSecret, loadSecretFinish, loadSecretSync, notify, notifyByPspec, ref, refSink, refresh, retrieveSecret, retrieveSecretFinish, retrieveSecretSync, runDispose, stealData, stealQdata, thawNotify, unref, watchClosure.
Getters
getAttributes, getCachedProperty, getCachedPropertyNames, getConnection, getCreated, getData, getDefaultTimeout, getFlags, getInfo, getInterfaceInfo, getInterfaceName, getLabel, getLocked, getModified, getName, getNameOwner, getObject, getObjectPath, getProperty, getQdata, getSchemaName, getSecret, getService.
Setters
setAttributes, setAttributesFinish, setAttributesSync, setCachedProperty, setData, setDataFull, setDefaultTimeout, setInterfaceInfo, setLabel, setLabelFinish, setLabelSync, setObject, setProperty, setSecret, setSecretFinish, setSecretSync.
type family ResolveItemMethod (t :: Symbol) o where ... Source #
Equations
ResolveItemMethod "bindProperty" o = ObjectBindPropertyMethodInfo | |
ResolveItemMethod "bindPropertyFull" o = ObjectBindPropertyFullMethodInfo | |
ResolveItemMethod "call" o = DBusProxyCallMethodInfo | |
ResolveItemMethod "callFinish" o = DBusProxyCallFinishMethodInfo | |
ResolveItemMethod "callSync" o = DBusProxyCallSyncMethodInfo | |
ResolveItemMethod "callWithUnixFdList" o = DBusProxyCallWithUnixFdListMethodInfo | |
ResolveItemMethod "callWithUnixFdListFinish" o = DBusProxyCallWithUnixFdListFinishMethodInfo | |
ResolveItemMethod "callWithUnixFdListSync" o = DBusProxyCallWithUnixFdListSyncMethodInfo | |
ResolveItemMethod "delete" o = ItemDeleteMethodInfo | |
ResolveItemMethod "deleteFinish" o = ItemDeleteFinishMethodInfo | |
ResolveItemMethod "deleteSync" o = ItemDeleteSyncMethodInfo | |
ResolveItemMethod "forceFloating" o = ObjectForceFloatingMethodInfo | |
ResolveItemMethod "freezeNotify" o = ObjectFreezeNotifyMethodInfo | |
ResolveItemMethod "getv" o = ObjectGetvMethodInfo | |
ResolveItemMethod "init" o = InitableInitMethodInfo | |
ResolveItemMethod "initAsync" o = AsyncInitableInitAsyncMethodInfo | |
ResolveItemMethod "initFinish" o = AsyncInitableInitFinishMethodInfo | |
ResolveItemMethod "isFloating" o = ObjectIsFloatingMethodInfo | |
ResolveItemMethod "loadSecret" o = ItemLoadSecretMethodInfo | |
ResolveItemMethod "loadSecretFinish" o = ItemLoadSecretFinishMethodInfo | |
ResolveItemMethod "loadSecretSync" o = ItemLoadSecretSyncMethodInfo | |
ResolveItemMethod "notify" o = ObjectNotifyMethodInfo | |
ResolveItemMethod "notifyByPspec" o = ObjectNotifyByPspecMethodInfo | |
ResolveItemMethod "ref" o = ObjectRefMethodInfo | |
ResolveItemMethod "refSink" o = ObjectRefSinkMethodInfo | |
ResolveItemMethod "refresh" o = ItemRefreshMethodInfo | |
ResolveItemMethod "retrieveSecret" o = RetrievableRetrieveSecretMethodInfo | |
ResolveItemMethod "retrieveSecretFinish" o = RetrievableRetrieveSecretFinishMethodInfo | |
ResolveItemMethod "retrieveSecretSync" o = RetrievableRetrieveSecretSyncMethodInfo | |
ResolveItemMethod "runDispose" o = ObjectRunDisposeMethodInfo | |
ResolveItemMethod "stealData" o = ObjectStealDataMethodInfo | |
ResolveItemMethod "stealQdata" o = ObjectStealQdataMethodInfo | |
ResolveItemMethod "thawNotify" o = ObjectThawNotifyMethodInfo | |
ResolveItemMethod "unref" o = ObjectUnrefMethodInfo | |
ResolveItemMethod "watchClosure" o = ObjectWatchClosureMethodInfo | |
ResolveItemMethod "getAttributes" o = ItemGetAttributesMethodInfo | |
ResolveItemMethod "getCachedProperty" o = DBusProxyGetCachedPropertyMethodInfo | |
ResolveItemMethod "getCachedPropertyNames" o = DBusProxyGetCachedPropertyNamesMethodInfo | |
ResolveItemMethod "getConnection" o = DBusProxyGetConnectionMethodInfo | |
ResolveItemMethod "getCreated" o = ItemGetCreatedMethodInfo | |
ResolveItemMethod "getData" o = ObjectGetDataMethodInfo | |
ResolveItemMethod "getDefaultTimeout" o = DBusProxyGetDefaultTimeoutMethodInfo | |
ResolveItemMethod "getFlags" o = ItemGetFlagsMethodInfo | |
ResolveItemMethod "getInfo" o = DBusInterfaceGetInfoMethodInfo | |
ResolveItemMethod "getInterfaceInfo" o = DBusProxyGetInterfaceInfoMethodInfo | |
ResolveItemMethod "getInterfaceName" o = DBusProxyGetInterfaceNameMethodInfo | |
ResolveItemMethod "getLabel" o = ItemGetLabelMethodInfo | |
ResolveItemMethod "getLocked" o = ItemGetLockedMethodInfo | |
ResolveItemMethod "getModified" o = ItemGetModifiedMethodInfo | |
ResolveItemMethod "getName" o = DBusProxyGetNameMethodInfo | |
ResolveItemMethod "getNameOwner" o = DBusProxyGetNameOwnerMethodInfo | |
ResolveItemMethod "getObject" o = DBusInterfaceGetObjectMethodInfo | |
ResolveItemMethod "getObjectPath" o = DBusProxyGetObjectPathMethodInfo | |
ResolveItemMethod "getProperty" o = ObjectGetPropertyMethodInfo | |
ResolveItemMethod "getQdata" o = ObjectGetQdataMethodInfo | |
ResolveItemMethod "getSchemaName" o = ItemGetSchemaNameMethodInfo | |
ResolveItemMethod "getSecret" o = ItemGetSecretMethodInfo | |
ResolveItemMethod "getService" o = ItemGetServiceMethodInfo | |
ResolveItemMethod "setAttributes" o = ItemSetAttributesMethodInfo | |
ResolveItemMethod "setAttributesFinish" o = ItemSetAttributesFinishMethodInfo | |
ResolveItemMethod "setAttributesSync" o = ItemSetAttributesSyncMethodInfo | |
ResolveItemMethod "setCachedProperty" o = DBusProxySetCachedPropertyMethodInfo | |
ResolveItemMethod "setData" o = ObjectSetDataMethodInfo | |
ResolveItemMethod "setDataFull" o = ObjectSetDataFullMethodInfo | |
ResolveItemMethod "setDefaultTimeout" o = DBusProxySetDefaultTimeoutMethodInfo | |
ResolveItemMethod "setInterfaceInfo" o = DBusProxySetInterfaceInfoMethodInfo | |
ResolveItemMethod "setLabel" o = ItemSetLabelMethodInfo | |
ResolveItemMethod "setLabelFinish" o = ItemSetLabelFinishMethodInfo | |
ResolveItemMethod "setLabelSync" o = ItemSetLabelSyncMethodInfo | |
ResolveItemMethod "setObject" o = DBusInterfaceSetObjectMethodInfo | |
ResolveItemMethod "setProperty" o = ObjectSetPropertyMethodInfo | |
ResolveItemMethod "setSecret" o = ItemSetSecretMethodInfo | |
ResolveItemMethod "setSecretFinish" o = ItemSetSecretFinishMethodInfo | |
ResolveItemMethod "setSecretSync" o = ItemSetSecretSyncMethodInfo | |
ResolveItemMethod l o = MethodResolutionFailed l o :: Type |
create
Arguments
:: (HasCallStack, MonadIO m, IsCollection a, IsCancellable b) | |
=> a |
|
-> Maybe Schema |
|
-> Map Text Text |
|
-> Text |
|
-> Value |
|
-> [ItemCreateFlags] |
|
-> Maybe b |
|
-> Maybe AsyncReadyCallback |
|
-> m () |
Create a new item in the secret service.
If the flags
contains ItemCreateFlagsReplace
, then the secret
service will search for an item matching the attributes
, and update that item
instead of creating a new one.
This method may block indefinitely and should not be used in user interface
threads. The secret service may prompt the user. [methodservice
.prompt]
will be used to handle any prompts that are required.
createFinish
Arguments
:: (HasCallStack, MonadIO m, IsAsyncResult a) | |
=> a |
|
-> m Item | Returns: the new item, which should be unreferenced
with |
Finish operation to create a new item in the secret service.
createSync
Arguments
:: (HasCallStack, MonadIO m, IsCollection a, IsCancellable b) | |
=> a |
|
-> Maybe Schema |
|
-> Map Text Text |
|
-> Text |
|
-> Value |
|
-> [ItemCreateFlags] |
|
-> Maybe b |
|
-> m Item | Returns: the new item, which should be unreferenced
with |
Create a new item in the secret service.
If the flags
contains ItemCreateFlagsReplace
, then the secret
service will search for an item matching the attributes
, and update that item
instead of creating a new one.
This method may block indefinitely and should not be used in user interface
threads. The secret service may prompt the user. [methodservice
.prompt]
will be used to handle any prompts that are required.
delete
data ItemDeleteMethodInfo Source #
Instances
(signature ~ (Maybe b -> Maybe AsyncReadyCallback -> m ()), MonadIO m, IsItem a, IsCancellable b) => OverloadedMethod ItemDeleteMethodInfo a signature Source # | |
Defined in GI.Secret.Objects.Item Methods overloadedMethod :: a -> signature | |
OverloadedMethodInfo ItemDeleteMethodInfo (a :: Type) Source # | |
Defined in GI.Secret.Objects.Item Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo |
Arguments
:: (HasCallStack, MonadIO m, IsItem a, IsCancellable b) | |
=> a |
|
-> Maybe b |
|
-> Maybe AsyncReadyCallback |
|
-> m () |
Delete this item.
This method returns immediately and completes asynchronously. The secret
service may prompt the user. [methodservice
.prompt] will be used to handle
any prompts that show up.
deleteFinish
data ItemDeleteFinishMethodInfo Source #
Instances
(signature ~ (b -> m ()), MonadIO m, IsItem a, IsAsyncResult b) => OverloadedMethod ItemDeleteFinishMethodInfo a signature Source # | |
Defined in GI.Secret.Objects.Item Methods overloadedMethod :: a -> signature | |
OverloadedMethodInfo ItemDeleteFinishMethodInfo (a :: Type) Source # | |
Defined in GI.Secret.Objects.Item Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo |
Arguments
:: (HasCallStack, MonadIO m, IsItem a, IsAsyncResult b) | |
=> a |
|
-> b |
|
-> m () | (Can throw |
Complete asynchronous operation to delete the secret item.
deleteSync
data ItemDeleteSyncMethodInfo Source #
Instances
(signature ~ (Maybe b -> m ()), MonadIO m, IsItem a, IsCancellable b) => OverloadedMethod ItemDeleteSyncMethodInfo a signature Source # | |
Defined in GI.Secret.Objects.Item Methods overloadedMethod :: a -> signature | |
OverloadedMethodInfo ItemDeleteSyncMethodInfo (a :: Type) Source # | |
Defined in GI.Secret.Objects.Item Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo |
Arguments
:: (HasCallStack, MonadIO m, IsItem a, IsCancellable b) | |
=> a |
|
-> Maybe b |
|
-> m () | (Can throw |
Delete this secret item.
This method may block indefinitely and should not be used in user
interface threads. The secret service may prompt the user.
[methodservice
.prompt] will be used to handle any prompts that show up.
getAttributes
data ItemGetAttributesMethodInfo Source #
Instances
(signature ~ m (Map Text Text), MonadIO m, IsItem a) => OverloadedMethod ItemGetAttributesMethodInfo a signature Source # | |
Defined in GI.Secret.Objects.Item Methods overloadedMethod :: a -> signature | |
OverloadedMethodInfo ItemGetAttributesMethodInfo (a :: Type) Source # | |
Defined in GI.Secret.Objects.Item Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo |
Arguments
:: (HasCallStack, MonadIO m, IsItem a) | |
=> a |
|
-> m (Map Text Text) | Returns: a new reference
to the attributes, which should not be modified, and
released with |
Set the attributes of this item.
The attributes
are a mapping of string keys to string values.
Attributes are used to search for items. Attributes are not stored
or transferred securely by the secret service.
Do not modify the attributes returned by this method. Use
[methoditem
.set_attributes] instead.
getCreated
data ItemGetCreatedMethodInfo Source #
Instances
(signature ~ m Word64, MonadIO m, IsItem a) => OverloadedMethod ItemGetCreatedMethodInfo a signature Source # | |
Defined in GI.Secret.Objects.Item Methods overloadedMethod :: a -> signature | |
OverloadedMethodInfo ItemGetCreatedMethodInfo (a :: Type) Source # | |
Defined in GI.Secret.Objects.Item Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo |
Arguments
:: (HasCallStack, MonadIO m, IsItem a) | |
=> a |
|
-> m Word64 | Returns: the created date and time |
Get the created date and time of the item.
The return value is the number of seconds since the unix epoch, January 1st 1970.
getFlags
data ItemGetFlagsMethodInfo Source #
Instances
(signature ~ m [ItemFlags], MonadIO m, IsItem a) => OverloadedMethod ItemGetFlagsMethodInfo a signature Source # | |
Defined in GI.Secret.Objects.Item Methods overloadedMethod :: a -> signature | |
OverloadedMethodInfo ItemGetFlagsMethodInfo (a :: Type) Source # | |
Defined in GI.Secret.Objects.Item Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo |
Arguments
:: (HasCallStack, MonadIO m, IsItem a) | |
=> a |
|
-> m [ItemFlags] | Returns: the flags for features initialized |
Get the flags representing what features of the Item
proxy
have been initialized.
Use [methoditem
.load_secret] to initialize further features
and change the flags.
getLabel
data ItemGetLabelMethodInfo Source #
Instances
(signature ~ m Text, MonadIO m, IsItem a) => OverloadedMethod ItemGetLabelMethodInfo a signature Source # | |
Defined in GI.Secret.Objects.Item Methods overloadedMethod :: a -> signature | |
OverloadedMethodInfo ItemGetLabelMethodInfo (a :: Type) Source # | |
Defined in GI.Secret.Objects.Item Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo |
Arguments
:: (HasCallStack, MonadIO m, IsItem a) | |
=> a |
|
-> m Text | Returns: the label, which should be freed with |
Get the label of this item.
getLocked
data ItemGetLockedMethodInfo Source #
Instances
(signature ~ m Bool, MonadIO m, IsItem a) => OverloadedMethod ItemGetLockedMethodInfo a signature Source # | |
Defined in GI.Secret.Objects.Item Methods overloadedMethod :: a -> signature | |
OverloadedMethodInfo ItemGetLockedMethodInfo (a :: Type) Source # | |
Defined in GI.Secret.Objects.Item Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo |
Arguments
:: (HasCallStack, MonadIO m, IsItem a) | |
=> a |
|
-> m Bool | Returns: whether the item is locked or not |
Get whether the item is locked or not.
Depending on the secret service an item may not be able to be locked independently from the collection that it is in.
getModified
data ItemGetModifiedMethodInfo Source #
Instances
(signature ~ m Word64, MonadIO m, IsItem a) => OverloadedMethod ItemGetModifiedMethodInfo a signature Source # | |
Defined in GI.Secret.Objects.Item Methods overloadedMethod :: a -> signature | |
OverloadedMethodInfo ItemGetModifiedMethodInfo (a :: Type) Source # | |
Defined in GI.Secret.Objects.Item Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo |
Arguments
:: (HasCallStack, MonadIO m, IsItem a) | |
=> a |
|
-> m Word64 | Returns: the modified date and time |
Get the modified date and time of the item.
The return value is the number of seconds since the unix epoch, January 1st 1970.
getSchemaName
data ItemGetSchemaNameMethodInfo Source #
Instances
(signature ~ m (Maybe Text), MonadIO m, IsItem a) => OverloadedMethod ItemGetSchemaNameMethodInfo a signature Source # | |
Defined in GI.Secret.Objects.Item Methods overloadedMethod :: a -> signature | |
OverloadedMethodInfo ItemGetSchemaNameMethodInfo (a :: Type) Source # | |
Defined in GI.Secret.Objects.Item Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo |
Arguments
:: (HasCallStack, MonadIO m, IsItem a) | |
=> a |
|
-> m (Maybe Text) | Returns: the schema name |
Gets the name of the schema that this item was stored with. This is also
available at the xdg:schema
attribute.
getSecret
data ItemGetSecretMethodInfo Source #
Instances
(signature ~ m (Maybe Value), MonadIO m, IsItem a) => OverloadedMethod ItemGetSecretMethodInfo a signature Source # | |
Defined in GI.Secret.Objects.Item Methods overloadedMethod :: a -> signature | |
OverloadedMethodInfo ItemGetSecretMethodInfo (a :: Type) Source # | |
Defined in GI.Secret.Objects.Item Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo |
Arguments
:: (HasCallStack, MonadIO m, IsItem a) | |
=> a |
|
-> m (Maybe Value) | Returns: the secret value which should be
released with [method |
Get the secret value of this item.
If this item is locked or the secret has not yet been loaded then this will
return Nothing
.
To load the secret call the [methoditem
.load_secret] method.
getService
data ItemGetServiceMethodInfo Source #
Instances
(signature ~ m Service, MonadIO m, IsItem a) => OverloadedMethod ItemGetServiceMethodInfo a signature Source # | |
Defined in GI.Secret.Objects.Item Methods overloadedMethod :: a -> signature | |
OverloadedMethodInfo ItemGetServiceMethodInfo (a :: Type) Source # | |
Defined in GI.Secret.Objects.Item Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo |
Arguments
:: (HasCallStack, MonadIO m, IsItem a) | |
=> a |
|
-> m Service | Returns: the Secret Service object |
Get the Secret Service object that this item was created with.
loadSecret
data ItemLoadSecretMethodInfo Source #
Instances
(signature ~ (Maybe b -> Maybe AsyncReadyCallback -> m ()), MonadIO m, IsItem a, IsCancellable b) => OverloadedMethod ItemLoadSecretMethodInfo a signature Source # | |
Defined in GI.Secret.Objects.Item Methods overloadedMethod :: a -> signature | |
OverloadedMethodInfo ItemLoadSecretMethodInfo (a :: Type) Source # | |
Defined in GI.Secret.Objects.Item Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo |
Arguments
:: (HasCallStack, MonadIO m, IsItem a, IsCancellable b) | |
=> a |
|
-> Maybe b |
|
-> Maybe AsyncReadyCallback |
|
-> m () |
Load the secret value of this item.
Each item has a single secret which might be a password or some other secret binary value.
This function will fail if the secret item is locked.
This function returns immediately and completes asynchronously.
loadSecretFinish
data ItemLoadSecretFinishMethodInfo Source #
Instances
(signature ~ (b -> m ()), MonadIO m, IsItem a, IsAsyncResult b) => OverloadedMethod ItemLoadSecretFinishMethodInfo a signature Source # | |
Defined in GI.Secret.Objects.Item Methods overloadedMethod :: a -> signature | |
OverloadedMethodInfo ItemLoadSecretFinishMethodInfo (a :: Type) Source # | |
Defined in GI.Secret.Objects.Item Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo |
Arguments
:: (HasCallStack, MonadIO m, IsItem a, IsAsyncResult b) | |
=> a |
|
-> b |
|
-> m () | (Can throw |
Complete asynchronous operation to load the secret value of this item.
The newly loaded secret value can be accessed by calling
[methoditem
.get_secret].
loadSecretSync
data ItemLoadSecretSyncMethodInfo Source #
Instances
(signature ~ (Maybe b -> m ()), MonadIO m, IsItem a, IsCancellable b) => OverloadedMethod ItemLoadSecretSyncMethodInfo a signature Source # | |
Defined in GI.Secret.Objects.Item Methods overloadedMethod :: a -> signature | |
OverloadedMethodInfo ItemLoadSecretSyncMethodInfo (a :: Type) Source # | |
Defined in GI.Secret.Objects.Item Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo |
Arguments
:: (HasCallStack, MonadIO m, IsItem a, IsCancellable b) | |
=> a |
|
-> Maybe b |
|
-> m () | (Can throw |
Load the secret value of this item.
Each item has a single secret which might be a password or some other secret binary value.
This function may block indefinitely. Use the asynchronous version in user interface threads.
loadSecrets
Arguments
:: (HasCallStack, MonadIO m, IsItem a, IsCancellable b) | |
=> [a] |
|
-> Maybe b |
|
-> Maybe AsyncReadyCallback |
|
-> m () |
Load the secret values for a secret item stored in the service.
The items
must all have the same [propertyitem
:service] property.
This function returns immediately and completes asynchronously.
loadSecretsFinish
itemLoadSecretsFinish Source #
Arguments
:: (HasCallStack, MonadIO m, IsAsyncResult a) | |
=> a |
|
-> m () | (Can throw |
Complete asynchronous operation to load the secret values for secret items stored in the service.
Items that are locked will not have their secrets loaded.
loadSecretsSync
Arguments
:: (HasCallStack, MonadIO m, IsItem a, IsCancellable b) | |
=> [a] |
|
-> Maybe b |
|
-> m () | (Can throw |
Load the secret values for a secret item stored in the service.
The items
must all have the same [propertyitem
:service] property.
This method may block indefinitely and should not be used in user interface threads.
Items that are locked will not have their secrets loaded.
refresh
data ItemRefreshMethodInfo Source #
Instances
(signature ~ m (), MonadIO m, IsItem a) => OverloadedMethod ItemRefreshMethodInfo a signature Source # | |
Defined in GI.Secret.Objects.Item Methods overloadedMethod :: a -> signature | |
OverloadedMethodInfo ItemRefreshMethodInfo (a :: Type) Source # | |
Defined in GI.Secret.Objects.Item Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo |
Arguments
:: (HasCallStack, MonadIO m, IsItem a) | |
=> a |
|
-> m () |
Refresh the properties on this item.
This fires off a request to refresh, and the properties will be updated later.
Calling this method is not normally necessary, as the secret service will notify the client when properties change.
setAttributes
data ItemSetAttributesMethodInfo Source #
Instances
(signature ~ (Maybe Schema -> Map Text Text -> Maybe b -> Maybe AsyncReadyCallback -> m ()), MonadIO m, IsItem a, IsCancellable b) => OverloadedMethod ItemSetAttributesMethodInfo a signature Source # | |
Defined in GI.Secret.Objects.Item Methods overloadedMethod :: a -> signature | |
OverloadedMethodInfo ItemSetAttributesMethodInfo (a :: Type) Source # | |
Defined in GI.Secret.Objects.Item Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo |
Arguments
:: (HasCallStack, MonadIO m, IsItem a, IsCancellable b) | |
=> a |
|
-> Maybe Schema |
|
-> Map Text Text |
|
-> Maybe b |
|
-> Maybe AsyncReadyCallback |
|
-> m () |
Set the attributes of this item.
The attributes
are a mapping of string keys to string values.
Attributes are used to search for items. Attributes are not stored
or transferred securely by the secret service.
This function returns immediately and completes asynchronously.
setAttributesFinish
data ItemSetAttributesFinishMethodInfo Source #
Instances
(signature ~ (b -> m ()), MonadIO m, IsItem a, IsAsyncResult b) => OverloadedMethod ItemSetAttributesFinishMethodInfo a signature Source # | |
Defined in GI.Secret.Objects.Item Methods overloadedMethod :: a -> signature | |
OverloadedMethodInfo ItemSetAttributesFinishMethodInfo (a :: Type) Source # | |
Defined in GI.Secret.Objects.Item Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo |
itemSetAttributesFinish Source #
Arguments
:: (HasCallStack, MonadIO m, IsItem a, IsAsyncResult b) | |
=> a |
|
-> b |
|
-> m () | (Can throw |
Complete operation to set the attributes of this item.
setAttributesSync
data ItemSetAttributesSyncMethodInfo Source #
Instances
(signature ~ (Maybe Schema -> Map Text Text -> Maybe b -> m ()), MonadIO m, IsItem a, IsCancellable b) => OverloadedMethod ItemSetAttributesSyncMethodInfo a signature Source # | |
Defined in GI.Secret.Objects.Item Methods overloadedMethod :: a -> signature | |
OverloadedMethodInfo ItemSetAttributesSyncMethodInfo (a :: Type) Source # | |
Defined in GI.Secret.Objects.Item Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo |
itemSetAttributesSync Source #
Arguments
:: (HasCallStack, MonadIO m, IsItem a, IsCancellable b) | |
=> a |
|
-> Maybe Schema |
|
-> Map Text Text |
|
-> Maybe b |
|
-> m () | (Can throw |
Set the attributes of this item.
The attributes
are a mapping of string keys to string values.
Attributes are used to search for items. Attributes are not stored
or transferred securely by the secret service.
This function may block indefinitely. Use the asynchronous version in user interface threads.
setLabel
data ItemSetLabelMethodInfo Source #
Instances
(signature ~ (Text -> Maybe b -> Maybe AsyncReadyCallback -> m ()), MonadIO m, IsItem a, IsCancellable b) => OverloadedMethod ItemSetLabelMethodInfo a signature Source # | |
Defined in GI.Secret.Objects.Item Methods overloadedMethod :: a -> signature | |
OverloadedMethodInfo ItemSetLabelMethodInfo (a :: Type) Source # | |
Defined in GI.Secret.Objects.Item Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo |
Arguments
:: (HasCallStack, MonadIO m, IsItem a, IsCancellable b) | |
=> a |
|
-> Text |
|
-> Maybe b |
|
-> Maybe AsyncReadyCallback |
|
-> m () |
Set the label of this item.
This function returns immediately and completes asynchronously.
setLabelFinish
data ItemSetLabelFinishMethodInfo Source #
Instances
(signature ~ (b -> m ()), MonadIO m, IsItem a, IsAsyncResult b) => OverloadedMethod ItemSetLabelFinishMethodInfo a signature Source # | |
Defined in GI.Secret.Objects.Item Methods overloadedMethod :: a -> signature | |
OverloadedMethodInfo ItemSetLabelFinishMethodInfo (a :: Type) Source # | |
Defined in GI.Secret.Objects.Item Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo |
Arguments
:: (HasCallStack, MonadIO m, IsItem a, IsAsyncResult b) | |
=> a |
|
-> b |
|
-> m () | (Can throw |
Complete asynchronous operation to set the label of this collection.
setLabelSync
data ItemSetLabelSyncMethodInfo Source #
Instances
(signature ~ (Text -> Maybe b -> m ()), MonadIO m, IsItem a, IsCancellable b) => OverloadedMethod ItemSetLabelSyncMethodInfo a signature Source # | |
Defined in GI.Secret.Objects.Item Methods overloadedMethod :: a -> signature | |
OverloadedMethodInfo ItemSetLabelSyncMethodInfo (a :: Type) Source # | |
Defined in GI.Secret.Objects.Item Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo |
Arguments
:: (HasCallStack, MonadIO m, IsItem a, IsCancellable b) | |
=> a |
|
-> Text |
|
-> Maybe b |
|
-> m () | (Can throw |
Set the label of this item.
This function may block indefinitely. Use the asynchronous version in user interface threads.
setSecret
data ItemSetSecretMethodInfo Source #
Instances
(signature ~ (Value -> Maybe b -> Maybe AsyncReadyCallback -> m ()), MonadIO m, IsItem a, IsCancellable b) => OverloadedMethod ItemSetSecretMethodInfo a signature Source # | |
Defined in GI.Secret.Objects.Item Methods overloadedMethod :: a -> signature | |
OverloadedMethodInfo ItemSetSecretMethodInfo (a :: Type) Source # | |
Defined in GI.Secret.Objects.Item Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo |
Arguments
:: (HasCallStack, MonadIO m, IsItem a, IsCancellable b) | |
=> a |
|
-> Value |
|
-> Maybe b |
|
-> Maybe AsyncReadyCallback |
|
-> m () |
Set the secret value of this item.
Each item has a single secret which might be a password or some other secret binary value.
This function returns immediately and completes asynchronously.
setSecretFinish
data ItemSetSecretFinishMethodInfo Source #
Instances
(signature ~ (b -> m ()), MonadIO m, IsItem a, IsAsyncResult b) => OverloadedMethod ItemSetSecretFinishMethodInfo a signature Source # | |
Defined in GI.Secret.Objects.Item Methods overloadedMethod :: a -> signature | |
OverloadedMethodInfo ItemSetSecretFinishMethodInfo (a :: Type) Source # | |
Defined in GI.Secret.Objects.Item Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo |
Arguments
:: (HasCallStack, MonadIO m, IsItem a, IsAsyncResult b) | |
=> a |
|
-> b |
|
-> m () | (Can throw |
Complete asynchronous operation to set the secret value of this item.
setSecretSync
data ItemSetSecretSyncMethodInfo Source #
Instances
(signature ~ (Value -> Maybe b -> m ()), MonadIO m, IsItem a, IsCancellable b) => OverloadedMethod ItemSetSecretSyncMethodInfo a signature Source # | |
Defined in GI.Secret.Objects.Item Methods overloadedMethod :: a -> signature | |
OverloadedMethodInfo ItemSetSecretSyncMethodInfo (a :: Type) Source # | |
Defined in GI.Secret.Objects.Item Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo |
Arguments
:: (HasCallStack, MonadIO m, IsItem a, IsCancellable b) | |
=> a |
|
-> Value |
|
-> Maybe b |
|
-> m () | (Can throw |
Set the secret value of this item.
Each item has a single secret which might be a password or some other secret binary value.
This function may block indefinitely. Use the asynchronous version in user interface threads.
Properties
flags
A set of flags describing which parts of the secret item have been initialized.
data ItemFlagsPropertyInfo Source #
Instances
constructItemFlags :: (IsItem o, MonadIO m) => [ItemFlags] -> m (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “flags
” property. This is rarely needed directly, but it is used by new
.
getItemFlags :: (MonadIO m, IsItem o) => o -> m [ItemFlags] Source #
Get the value of the “flags
” property.
When overloading is enabled, this is equivalent to
get
item #flags
locked
Whether the item is locked or not.
An item may not be independently lockable separate from other items in its collection.
To lock or unlock a item use the [methodservice
.lock] or
[methodservice
.unlock] functions.
data ItemLockedPropertyInfo Source #
Instances
AttrInfo ItemLockedPropertyInfo Source # | |||||||||||||||||||||||||||||||||
Defined in GI.Secret.Objects.Item Associated Types
Methods attrGet :: AttrBaseTypeConstraint ItemLockedPropertyInfo o => o -> IO (AttrGetType ItemLockedPropertyInfo) attrSet :: (AttrBaseTypeConstraint ItemLockedPropertyInfo o, AttrSetTypeConstraint ItemLockedPropertyInfo b) => o -> b -> IO () attrClear :: AttrBaseTypeConstraint ItemLockedPropertyInfo o => o -> IO () attrConstruct :: (AttrBaseTypeConstraint ItemLockedPropertyInfo o, AttrSetTypeConstraint ItemLockedPropertyInfo b) => b -> IO (GValueConstruct o) attrTransfer :: (AttrBaseTypeConstraint ItemLockedPropertyInfo o, AttrTransferTypeConstraint ItemLockedPropertyInfo b) => Proxy o -> b -> IO (AttrTransferType ItemLockedPropertyInfo) dbgAttrInfo :: Maybe ResolvedSymbolInfo | |||||||||||||||||||||||||||||||||
type AttrAllowedOps ItemLockedPropertyInfo Source # | |||||||||||||||||||||||||||||||||
Defined in GI.Secret.Objects.Item type AttrAllowedOps ItemLockedPropertyInfo = '['AttrGet] | |||||||||||||||||||||||||||||||||
type AttrBaseTypeConstraint ItemLockedPropertyInfo Source # | |||||||||||||||||||||||||||||||||
Defined in GI.Secret.Objects.Item | |||||||||||||||||||||||||||||||||
type AttrGetType ItemLockedPropertyInfo Source # | |||||||||||||||||||||||||||||||||
Defined in GI.Secret.Objects.Item | |||||||||||||||||||||||||||||||||
type AttrLabel ItemLockedPropertyInfo Source # | |||||||||||||||||||||||||||||||||
Defined in GI.Secret.Objects.Item type AttrLabel ItemLockedPropertyInfo = "locked" | |||||||||||||||||||||||||||||||||
type AttrOrigin ItemLockedPropertyInfo Source # | |||||||||||||||||||||||||||||||||
Defined in GI.Secret.Objects.Item | |||||||||||||||||||||||||||||||||
type AttrSetTypeConstraint ItemLockedPropertyInfo Source # | |||||||||||||||||||||||||||||||||
Defined in GI.Secret.Objects.Item | |||||||||||||||||||||||||||||||||
type AttrTransferType ItemLockedPropertyInfo Source # | |||||||||||||||||||||||||||||||||
Defined in GI.Secret.Objects.Item type AttrTransferType ItemLockedPropertyInfo = () | |||||||||||||||||||||||||||||||||
type AttrTransferTypeConstraint ItemLockedPropertyInfo Source # | |||||||||||||||||||||||||||||||||
Defined in GI.Secret.Objects.Item |
getItemLocked :: (MonadIO m, IsItem o) => o -> m Bool Source #
Get the value of the “locked
” property.
When overloading is enabled, this is equivalent to
get
item #locked
itemLocked :: AttrLabelProxy "locked" Source #
service
The [classservice
] object that this item is associated with and
uses to interact with the actual D-Bus Secret Service.
data ItemServicePropertyInfo Source #
Instances
AttrInfo ItemServicePropertyInfo Source # | |||||||||||||||||||||||||||||||||
Defined in GI.Secret.Objects.Item Associated Types
Methods attrGet :: AttrBaseTypeConstraint ItemServicePropertyInfo o => o -> IO (AttrGetType ItemServicePropertyInfo) attrSet :: (AttrBaseTypeConstraint ItemServicePropertyInfo o, AttrSetTypeConstraint ItemServicePropertyInfo b) => o -> b -> IO () attrClear :: AttrBaseTypeConstraint ItemServicePropertyInfo o => o -> IO () attrConstruct :: (AttrBaseTypeConstraint ItemServicePropertyInfo o, AttrSetTypeConstraint ItemServicePropertyInfo b) => b -> IO (GValueConstruct o) attrTransfer :: (AttrBaseTypeConstraint ItemServicePropertyInfo o, AttrTransferTypeConstraint ItemServicePropertyInfo b) => Proxy o -> b -> IO (AttrTransferType ItemServicePropertyInfo) dbgAttrInfo :: Maybe ResolvedSymbolInfo | |||||||||||||||||||||||||||||||||
type AttrAllowedOps ItemServicePropertyInfo Source # | |||||||||||||||||||||||||||||||||
Defined in GI.Secret.Objects.Item type AttrAllowedOps ItemServicePropertyInfo = '['AttrConstruct, 'AttrGet, 'AttrClear] | |||||||||||||||||||||||||||||||||
type AttrBaseTypeConstraint ItemServicePropertyInfo Source # | |||||||||||||||||||||||||||||||||
Defined in GI.Secret.Objects.Item | |||||||||||||||||||||||||||||||||
type AttrGetType ItemServicePropertyInfo Source # | |||||||||||||||||||||||||||||||||
Defined in GI.Secret.Objects.Item | |||||||||||||||||||||||||||||||||
type AttrLabel ItemServicePropertyInfo Source # | |||||||||||||||||||||||||||||||||
Defined in GI.Secret.Objects.Item type AttrLabel ItemServicePropertyInfo = "service" | |||||||||||||||||||||||||||||||||
type AttrOrigin ItemServicePropertyInfo Source # | |||||||||||||||||||||||||||||||||
Defined in GI.Secret.Objects.Item | |||||||||||||||||||||||||||||||||
type AttrSetTypeConstraint ItemServicePropertyInfo Source # | |||||||||||||||||||||||||||||||||
Defined in GI.Secret.Objects.Item | |||||||||||||||||||||||||||||||||
type AttrTransferType ItemServicePropertyInfo Source # | |||||||||||||||||||||||||||||||||
Defined in GI.Secret.Objects.Item | |||||||||||||||||||||||||||||||||
type AttrTransferTypeConstraint ItemServicePropertyInfo Source # | |||||||||||||||||||||||||||||||||
Defined in GI.Secret.Objects.Item |
constructItemService :: (IsItem o, MonadIO m, IsService a) => a -> m (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “service
” property. This is rarely needed directly, but it is used by new
.
getItemService :: (MonadIO m, IsItem o) => o -> m Service Source #
Get the value of the “service
” property.
When overloading is enabled, this is equivalent to
get
item #service
itemService :: AttrLabelProxy "service" Source #