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.Service

Contents

Exported types
Methods

Description

A proxy object representing the Secret Service.

A Service object represents the Secret Service implementation which runs as a D-Bus service.

Normally a single Service object can be shared between multiple callers. The Service.get method is used to access this Service object. If a new independent Service object is required, use Service.open.

In order to securely transfer secrets to the Sercret Service, a session is established. This session can be established while initializing a Service object by passing the ServiceFlagsOpenSession flag to the Service.get or Service.open functions. In order to establish a session on an already existing Service, use the [methodservice.ensure_session] function.

To search for items, use the [methodservice.search] method.

Multiple collections can exist in the Secret Service, each of which contains secret items. In order to instantiate [classcollection] objects which represent those collections while initializing a Service then pass the ServiceFlagsLoadCollections flag to the Service.get or Service.open functions. In order to establish a session on an already existing Service, use the [methodservice.load_collections] function. To access the list of collections use [methodservice.get_collections].

Certain actions on the Secret Service require user prompting to complete, such as creating a collection, or unlocking a collection. When such a prompt is necessary, then a [classprompt] object is created by this library, and passed to the [methodservice.prompt] method. In this way it is handled automatically.

In order to customize prompt handling, override the [vfuncservice.prompt_async] and [vfuncservice.prompt_finish] virtual methods of the Service class.

Synopsis

data ServiceCreateItemDbusPathSyncMethodInfo
newtype Service = Service (ManagedPtr Service)
class (GObject o, IsDescendantOf Service o) => IsService o
toService :: (MonadIO m, IsService o) => o -> m Service
type family ResolveServiceMethod (t :: Symbol) o where ...
data ServiceClearMethodInfo
serviceClear :: (HasCallStack, MonadIO m, IsService a, IsCancellable b) => Maybe a -> Maybe Schema -> Map Text Text -> Maybe b -> Maybe AsyncReadyCallback -> m ()
data ServiceClearFinishMethodInfo
serviceClearFinish :: (HasCallStack, MonadIO m, IsService a, IsAsyncResult b) => Maybe a -> b -> m ()
data ServiceClearSyncMethodInfo
serviceClearSync :: (HasCallStack, MonadIO m, IsService a, IsCancellable b) => Maybe a -> Maybe Schema -> Map Text Text -> Maybe b -> m ()
data ServiceDecodeDbusSecretMethodInfo
serviceDecodeDbusSecret :: (HasCallStack, MonadIO m, IsService a) => a -> GVariant -> m Value
serviceDisconnect :: (HasCallStack, MonadIO m) => m ()
data ServiceEncodeDbusSecretMethodInfo
serviceEncodeDbusSecret :: (HasCallStack, MonadIO m, IsService a) => a -> Value -> m GVariant
data ServiceEnsureSessionMethodInfo
serviceEnsureSession :: (HasCallStack, MonadIO m, IsService a, IsCancellable b) => a -> Maybe b -> Maybe AsyncReadyCallback -> m ()
data ServiceEnsureSessionFinishMethodInfo
serviceEnsureSessionFinish :: (HasCallStack, MonadIO m, IsService a, IsAsyncResult b) => a -> b -> m ()
data ServiceEnsureSessionSyncMethodInfo
serviceEnsureSessionSync :: (HasCallStack, MonadIO m, IsService a, IsCancellable b) => a -> Maybe b -> m ()
serviceGet :: (HasCallStack, MonadIO m, IsCancellable a) => [ServiceFlags] -> Maybe a -> Maybe AsyncReadyCallback -> m ()
data ServiceGetCollectionGtypeMethodInfo
serviceGetCollectionGtype :: (HasCallStack, MonadIO m, IsService a) => a -> m GType
data ServiceGetCollectionsMethodInfo
serviceGetCollections :: (HasCallStack, MonadIO m, IsService a) => a -> m [Collection]
serviceGetFinish :: (HasCallStack, MonadIO m, IsAsyncResult a) => a -> m Service
data ServiceGetFlagsMethodInfo
serviceGetFlags :: (HasCallStack, MonadIO m, IsService a) => a -> m [ServiceFlags]
data ServiceGetItemGtypeMethodInfo
serviceGetItemGtype :: (HasCallStack, MonadIO m, IsService a) => a -> m GType
data ServiceGetSessionAlgorithmsMethodInfo
serviceGetSessionAlgorithms :: (HasCallStack, MonadIO m, IsService a) => a -> m (Maybe Text)
data ServiceGetSessionDbusPathMethodInfo
serviceGetSessionDbusPath :: (HasCallStack, MonadIO m, IsService a) => a -> m (Maybe Text)
serviceGetSync :: (HasCallStack, MonadIO m, IsCancellable a) => [ServiceFlags] -> Maybe a -> m Service
data ServiceLoadCollectionsMethodInfo
serviceLoadCollections :: (HasCallStack, MonadIO m, IsService a, IsCancellable b) => a -> Maybe b -> Maybe AsyncReadyCallback -> m ()
data ServiceLoadCollectionsFinishMethodInfo
serviceLoadCollectionsFinish :: (HasCallStack, MonadIO m, IsService a, IsAsyncResult b) => a -> b -> m ()
data ServiceLoadCollectionsSyncMethodInfo
serviceLoadCollectionsSync :: (HasCallStack, MonadIO m, IsService a, IsCancellable b) => a -> Maybe b -> m ()
data ServiceLockMethodInfo
serviceLock :: (HasCallStack, MonadIO m, IsService a, IsDBusProxy b, IsCancellable c) => Maybe a -> [b] -> Maybe c -> Maybe AsyncReadyCallback -> m ()
data ServiceLockFinishMethodInfo
serviceLockFinish :: (HasCallStack, MonadIO m, IsService a, IsAsyncResult b) => Maybe a -> b -> m (Int32, [DBusProxy])
data ServiceLockSyncMethodInfo
serviceLockSync :: (HasCallStack, MonadIO m, IsService a, IsDBusProxy b, IsCancellable c) => Maybe a -> [b] -> Maybe c -> m (Int32, [DBusProxy])
data ServiceLookupMethodInfo
serviceLookup :: (HasCallStack, MonadIO m, IsService a, IsCancellable b) => Maybe a -> Maybe Schema -> Map Text Text -> Maybe b -> Maybe AsyncReadyCallback -> m ()
data ServiceLookupFinishMethodInfo
serviceLookupFinish :: (HasCallStack, MonadIO m, IsService a, IsAsyncResult b) => Maybe a -> b -> m (Maybe Value)
data ServiceLookupSyncMethodInfo
serviceLookupSync :: (HasCallStack, MonadIO m, IsService a, IsCancellable b) => Maybe a -> Maybe Schema -> Map Text Text -> Maybe b -> m Value
serviceOpen :: (HasCallStack, MonadIO m, IsCancellable a) => GType -> Maybe Text -> [ServiceFlags] -> Maybe a -> Maybe AsyncReadyCallback -> m ()
serviceOpenFinish :: (HasCallStack, MonadIO m, IsAsyncResult a) => a -> m Service
serviceOpenSync :: (HasCallStack, MonadIO m, IsCancellable a) => GType -> Maybe Text -> [ServiceFlags] -> Maybe a -> m Service
data ServicePromptMethodInfo
servicePrompt :: (HasCallStack, MonadIO m, IsService a, IsPrompt b, IsCancellable c) => a -> b -> Maybe VariantType -> Maybe c -> Maybe AsyncReadyCallback -> m ()
data ServicePromptFinishMethodInfo
servicePromptFinish :: (HasCallStack, MonadIO m, IsService a, IsAsyncResult b) => a -> b -> m GVariant
data ServicePromptSyncMethodInfo
servicePromptSync :: (HasCallStack, MonadIO m, IsService a, IsPrompt b, IsCancellable c) => a -> b -> Maybe c -> VariantType -> m GVariant
data ServiceSearchMethodInfo
serviceSearch :: (HasCallStack, MonadIO m, IsService a, IsCancellable b) => Maybe a -> Maybe Schema -> Map Text Text -> [SearchFlags] -> Maybe b -> Maybe AsyncReadyCallback -> m ()
data ServiceSearchFinishMethodInfo
serviceSearchFinish :: (HasCallStack, MonadIO m, IsService a, IsAsyncResult b) => Maybe a -> b -> m [Item]
data ServiceSearchSyncMethodInfo
serviceSearchSync :: (HasCallStack, MonadIO m, IsService a, IsCancellable b) => Maybe a -> Maybe Schema -> Map Text Text -> [SearchFlags] -> Maybe b -> m [Item]
data ServiceSetAliasMethodInfo
serviceSetAlias :: (HasCallStack, MonadIO m, IsService a, IsCollection b, IsCancellable c) => Maybe a -> Text -> Maybe b -> Maybe c -> Maybe AsyncReadyCallback -> m ()
data ServiceSetAliasFinishMethodInfo
serviceSetAliasFinish :: (HasCallStack, MonadIO m, IsService a, IsAsyncResult b) => Maybe a -> b -> m ()
data ServiceSetAliasSyncMethodInfo
serviceSetAliasSync :: (HasCallStack, MonadIO m, IsService a, IsCollection b, IsCancellable c) => Maybe a -> Text -> Maybe b -> Maybe c -> m ()
data ServiceStoreMethodInfo
serviceStore :: (HasCallStack, MonadIO m, IsService a, IsCancellable b) => Maybe a -> Maybe Schema -> Map Text Text -> Maybe Text -> Text -> Value -> Maybe b -> Maybe AsyncReadyCallback -> m ()
data ServiceStoreFinishMethodInfo
serviceStoreFinish :: (HasCallStack, MonadIO m, IsService a, IsAsyncResult b) => Maybe a -> b -> m ()
data ServiceStoreSyncMethodInfo
serviceStoreSync :: (HasCallStack, MonadIO m, IsService a, IsCancellable b) => Maybe a -> Maybe Schema -> Map Text Text -> Maybe Text -> Text -> Value -> Maybe b -> m ()
data ServiceUnlockMethodInfo
serviceUnlock :: (HasCallStack, MonadIO m, IsService a, IsDBusProxy b, IsCancellable c) => Maybe a -> [b] -> Maybe c -> Maybe AsyncReadyCallback -> m ()
data ServiceUnlockFinishMethodInfo
serviceUnlockFinish :: (HasCallStack, MonadIO m, IsService a, IsAsyncResult b) => Maybe a -> b -> m (Int32, [DBusProxy])
data ServiceUnlockSyncMethodInfo
serviceUnlockSync :: (HasCallStack, MonadIO m, IsService a, IsDBusProxy b, IsCancellable c) => Maybe a -> [b] -> Maybe c -> m (Int32, [DBusProxy])

Documentation

data ServiceCreateItemDbusPathSyncMethodInfo Source #

Instances

Instances details

(p ~ (), o ~ UnsupportedMethodError "createItemDbusPathSync" Service) => OverloadedMethod ServiceCreateItemDbusPathSyncMethodInfo o p Source #
Instance details Defined in GI.Secret.Objects.Service Methods overloadedMethod :: o -> p
o ~ UnsupportedMethodError "createItemDbusPathSync" Service => OverloadedMethodInfo ServiceCreateItemDbusPathSyncMethodInfo (o :: Type) Source #
Instance details Defined in GI.Secret.Objects.Service Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo

Exported types

newtype Service Source #

Memory-managed wrapper type.

Constructors

Service (ManagedPtr Service)

Instances

Instances details

Eq Service Source #
Instance details Defined in GI.Secret.Objects.Service Methods (==) :: Service -> Service -> Bool # (/=) :: Service -> Service -> Bool #
GObject Service Source #
Instance details Defined in GI.Secret.Objects.Service
ManagedPtrNewtype Service Source #
Instance details Defined in GI.Secret.Objects.Service Methods toManagedPtr :: Service -> ManagedPtr Service #
TypedObject Service Source #
Instance details Defined in GI.Secret.Objects.Service Methods glibType :: IO GType #
HasParentTypes Service Source #
Instance details Defined in GI.Secret.Objects.Service
HasAttributeList Service Source #
Instance details Defined in GI.Secret.Objects.Service
(info ~ ResolveServiceMethod t Service, OverloadedMethod info Service p, HasField t Service p) => HasField (t :: Symbol) Service p Source #
Instance details Defined in GI.Secret.Objects.Service Methods getField :: Service -> p #
(info ~ ResolveServiceMethod t Service, OverloadedMethodInfo info Service) => IsLabel t (MethodProxy info Service) Source #
Instance details Defined in GI.Secret.Objects.Service Methods fromLabel :: MethodProxy info Service #
(info ~ ResolveServiceMethod t Service, OverloadedMethod info Service p) => IsLabel t (Service -> p) Source #
Instance details Defined in GI.Secret.Objects.Service Methods fromLabel :: Service -> p #
IsGValue (Maybe Service) Source #	Convert `Service` to and from `GValue`. See `toGValue` and `fromGValue`.
Instance details Defined in GI.Secret.Objects.Service Methods gvalueGType_ :: IO GType # gvalueSet_ :: Ptr GValue -> Maybe Service -> IO () # gvalueGet_ :: Ptr GValue -> IO (Maybe Service) #
type AttributeList Service Source #
Instance details Defined in GI.Secret.Objects.Service type AttributeList Service
type ParentTypes Service Source #
Instance details Defined in GI.Secret.Objects.Service type ParentTypes Service = '[DBusProxy, Object, AsyncInitable, DBusInterface, Initable, Backend]
type SignalList Service Source #
Instance details Defined in GI.Secret.Objects.Service type SignalList Service

class (GObject o, IsDescendantOf Service o) => IsService o Source #

Type class for types which can be safely cast to Service, for instance with toService.

Instances

Instances details

(GObject o, IsDescendantOf Service o) => IsService o Source #
Instance details Defined in GI.Secret.Objects.Service

toService :: (MonadIO m, IsService o) => o -> m Service Source #

Cast to Service, for types for which this is known to be safe. For general casts, use castTo.

Methods

Click to display all available methods, including inherited ones

Expand

type family ResolveServiceMethod (t :: Symbol) o where ... Source #

Equations

ResolveServiceMethod "bindProperty" o = ObjectBindPropertyMethodInfo
ResolveServiceMethod "bindPropertyFull" o = ObjectBindPropertyFullMethodInfo
ResolveServiceMethod "call" o = DBusProxyCallMethodInfo
ResolveServiceMethod "callFinish" o = DBusProxyCallFinishMethodInfo
ResolveServiceMethod "callSync" o = DBusProxyCallSyncMethodInfo
ResolveServiceMethod "callWithUnixFdList" o = DBusProxyCallWithUnixFdListMethodInfo
ResolveServiceMethod "callWithUnixFdListFinish" o = DBusProxyCallWithUnixFdListFinishMethodInfo
ResolveServiceMethod "callWithUnixFdListSync" o = DBusProxyCallWithUnixFdListSyncMethodInfo
ResolveServiceMethod "clear" o = ServiceClearMethodInfo
ResolveServiceMethod "clearFinish" o = ServiceClearFinishMethodInfo
ResolveServiceMethod "clearSync" o = ServiceClearSyncMethodInfo
ResolveServiceMethod "createItemDbusPathSync" o = ServiceCreateItemDbusPathSyncMethodInfo
ResolveServiceMethod "decodeDbusSecret" o = ServiceDecodeDbusSecretMethodInfo
ResolveServiceMethod "encodeDbusSecret" o = ServiceEncodeDbusSecretMethodInfo
ResolveServiceMethod "ensureSession" o = ServiceEnsureSessionMethodInfo
ResolveServiceMethod "ensureSessionFinish" o = ServiceEnsureSessionFinishMethodInfo
ResolveServiceMethod "ensureSessionSync" o = ServiceEnsureSessionSyncMethodInfo
ResolveServiceMethod "forceFloating" o = ObjectForceFloatingMethodInfo
ResolveServiceMethod "freezeNotify" o = ObjectFreezeNotifyMethodInfo
ResolveServiceMethod "getv" o = ObjectGetvMethodInfo
ResolveServiceMethod "init" o = InitableInitMethodInfo
ResolveServiceMethod "initAsync" o = AsyncInitableInitAsyncMethodInfo
ResolveServiceMethod "initFinish" o = AsyncInitableInitFinishMethodInfo
ResolveServiceMethod "isFloating" o = ObjectIsFloatingMethodInfo
ResolveServiceMethod "loadCollections" o = ServiceLoadCollectionsMethodInfo
ResolveServiceMethod "loadCollectionsFinish" o = ServiceLoadCollectionsFinishMethodInfo
ResolveServiceMethod "loadCollectionsSync" o = ServiceLoadCollectionsSyncMethodInfo
ResolveServiceMethod "lock" o = ServiceLockMethodInfo
ResolveServiceMethod "lockFinish" o = ServiceLockFinishMethodInfo
ResolveServiceMethod "lockSync" o = ServiceLockSyncMethodInfo
ResolveServiceMethod "lookup" o = ServiceLookupMethodInfo
ResolveServiceMethod "lookupFinish" o = ServiceLookupFinishMethodInfo
ResolveServiceMethod "lookupSync" o = ServiceLookupSyncMethodInfo
ResolveServiceMethod "notify" o = ObjectNotifyMethodInfo
ResolveServiceMethod "notifyByPspec" o = ObjectNotifyByPspecMethodInfo
ResolveServiceMethod "prompt" o = ServicePromptMethodInfo
ResolveServiceMethod "promptFinish" o = ServicePromptFinishMethodInfo
ResolveServiceMethod "promptSync" o = ServicePromptSyncMethodInfo
ResolveServiceMethod "ref" o = ObjectRefMethodInfo
ResolveServiceMethod "refSink" o = ObjectRefSinkMethodInfo
ResolveServiceMethod "runDispose" o = ObjectRunDisposeMethodInfo
ResolveServiceMethod "search" o = ServiceSearchMethodInfo
ResolveServiceMethod "searchFinish" o = ServiceSearchFinishMethodInfo
ResolveServiceMethod "searchSync" o = ServiceSearchSyncMethodInfo
ResolveServiceMethod "stealData" o = ObjectStealDataMethodInfo
ResolveServiceMethod "stealQdata" o = ObjectStealQdataMethodInfo
ResolveServiceMethod "store" o = ServiceStoreMethodInfo
ResolveServiceMethod "storeFinish" o = ServiceStoreFinishMethodInfo
ResolveServiceMethod "storeSync" o = ServiceStoreSyncMethodInfo
ResolveServiceMethod "thawNotify" o = ObjectThawNotifyMethodInfo
ResolveServiceMethod "unlock" o = ServiceUnlockMethodInfo
ResolveServiceMethod "unlockFinish" o = ServiceUnlockFinishMethodInfo
ResolveServiceMethod "unlockSync" o = ServiceUnlockSyncMethodInfo
ResolveServiceMethod "unref" o = ObjectUnrefMethodInfo
ResolveServiceMethod "watchClosure" o = ObjectWatchClosureMethodInfo
ResolveServiceMethod "getCachedProperty" o = DBusProxyGetCachedPropertyMethodInfo
ResolveServiceMethod "getCachedPropertyNames" o = DBusProxyGetCachedPropertyNamesMethodInfo
ResolveServiceMethod "getCollectionGtype" o = ServiceGetCollectionGtypeMethodInfo
ResolveServiceMethod "getCollections" o = ServiceGetCollectionsMethodInfo
ResolveServiceMethod "getConnection" o = DBusProxyGetConnectionMethodInfo
ResolveServiceMethod "getData" o = ObjectGetDataMethodInfo
ResolveServiceMethod "getDefaultTimeout" o = DBusProxyGetDefaultTimeoutMethodInfo
ResolveServiceMethod "getFlags" o = ServiceGetFlagsMethodInfo
ResolveServiceMethod "getInfo" o = DBusInterfaceGetInfoMethodInfo
ResolveServiceMethod "getInterfaceInfo" o = DBusProxyGetInterfaceInfoMethodInfo
ResolveServiceMethod "getInterfaceName" o = DBusProxyGetInterfaceNameMethodInfo
ResolveServiceMethod "getItemGtype" o = ServiceGetItemGtypeMethodInfo
ResolveServiceMethod "getName" o = DBusProxyGetNameMethodInfo
ResolveServiceMethod "getNameOwner" o = DBusProxyGetNameOwnerMethodInfo
ResolveServiceMethod "getObject" o = DBusInterfaceGetObjectMethodInfo
ResolveServiceMethod "getObjectPath" o = DBusProxyGetObjectPathMethodInfo
ResolveServiceMethod "getProperty" o = ObjectGetPropertyMethodInfo
ResolveServiceMethod "getQdata" o = ObjectGetQdataMethodInfo
ResolveServiceMethod "getSessionAlgorithms" o = ServiceGetSessionAlgorithmsMethodInfo
ResolveServiceMethod "getSessionDbusPath" o = ServiceGetSessionDbusPathMethodInfo
ResolveServiceMethod "setAlias" o = ServiceSetAliasMethodInfo
ResolveServiceMethod "setAliasFinish" o = ServiceSetAliasFinishMethodInfo
ResolveServiceMethod "setAliasSync" o = ServiceSetAliasSyncMethodInfo
ResolveServiceMethod "setCachedProperty" o = DBusProxySetCachedPropertyMethodInfo
ResolveServiceMethod "setData" o = ObjectSetDataMethodInfo
ResolveServiceMethod "setDataFull" o = ObjectSetDataFullMethodInfo
ResolveServiceMethod "setDefaultTimeout" o = DBusProxySetDefaultTimeoutMethodInfo
ResolveServiceMethod "setInterfaceInfo" o = DBusProxySetInterfaceInfoMethodInfo
ResolveServiceMethod "setObject" o = DBusInterfaceSetObjectMethodInfo
ResolveServiceMethod "setProperty" o = ObjectSetPropertyMethodInfo
ResolveServiceMethod l o = MethodResolutionFailed l o :: Type

clear

data ServiceClearMethodInfo Source #

Instances

Instances details

(signature ~ (Maybe Schema -> Map Text Text -> Maybe b -> Maybe AsyncReadyCallback -> m ()), MonadIO m, IsService a, IsCancellable b) => OverloadedMethod ServiceClearMethodInfo a signature Source #
Instance details Defined in GI.Secret.Objects.Service Methods overloadedMethod :: a -> signature
OverloadedMethodInfo ServiceClearMethodInfo (a :: Type) Source #
Instance details Defined in GI.Secret.Objects.Service Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo

serviceClear Source #

Arguments

:: (HasCallStack, MonadIO m, IsService a, IsCancellable b)
=> Maybe a	`service`: the secret service
-> Maybe Schema	`schema`: the schema for the attributes
-> Map Text Text	`attributes`: the attribute keys and values
-> Maybe b	`cancellable`: optional cancellation object
-> Maybe AsyncReadyCallback	`callback`: called when the operation completes
-> m ()

Remove unlocked items which match the attributes from the secret service.

The attributes should be a set of key and value string pairs.

If service is Nothing, then Service.get will be called to get the default [classservice] proxy.

This method will return immediately and complete asynchronously.

clearFinish

data ServiceClearFinishMethodInfo Source #

Instances

Instances details

(signature ~ (b -> m ()), MonadIO m, IsService a, IsAsyncResult b) => OverloadedMethod ServiceClearFinishMethodInfo a signature Source #
Instance details Defined in GI.Secret.Objects.Service Methods overloadedMethod :: a -> signature
OverloadedMethodInfo ServiceClearFinishMethodInfo (a :: Type) Source #
Instance details Defined in GI.Secret.Objects.Service Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo

serviceClearFinish Source #

Arguments

:: (HasCallStack, MonadIO m, IsService a, IsAsyncResult b)
=> Maybe a	`service`: the secret service
-> b	`result`: the asynchronous result passed to the callback
-> m ()	(Can throw `GError`)

Finish asynchronous operation to remove items from the secret service.

clearSync

data ServiceClearSyncMethodInfo Source #

Instances

Instances details

(signature ~ (Maybe Schema -> Map Text Text -> Maybe b -> m ()), MonadIO m, IsService a, IsCancellable b) => OverloadedMethod ServiceClearSyncMethodInfo a signature Source #
Instance details Defined in GI.Secret.Objects.Service Methods overloadedMethod :: a -> signature
OverloadedMethodInfo ServiceClearSyncMethodInfo (a :: Type) Source #
Instance details Defined in GI.Secret.Objects.Service Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo

serviceClearSync Source #

Arguments

:: (HasCallStack, MonadIO m, IsService a, IsCancellable b)
=> Maybe a	`service`: the secret service
-> Maybe Schema	`schema`: the schema for the attributes
-> Map Text Text	`attributes`: the attribute keys and values
-> Maybe b	`cancellable`: optional cancellation object
-> m ()	(Can throw `GError`)

Remove unlocked items which match the attributes from the secret service.

The attributes should be a set of key and value string pairs.

If service is Nothing, then Service.get_sync will be called to get the default [classservice] proxy.

This method may block indefinitely and should not be used in user interface threads.

decodeDbusSecret

data ServiceDecodeDbusSecretMethodInfo Source #

Instances

Instances details

(signature ~ (GVariant -> m Value), MonadIO m, IsService a) => OverloadedMethod ServiceDecodeDbusSecretMethodInfo a signature Source #
Instance details Defined in GI.Secret.Objects.Service Methods overloadedMethod :: a -> signature
OverloadedMethodInfo ServiceDecodeDbusSecretMethodInfo (a :: Type) Source #
Instance details Defined in GI.Secret.Objects.Service Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo

serviceDecodeDbusSecret Source #

Arguments

:: (HasCallStack, MonadIO m, IsService a)
=> a	`service`: the service
-> GVariant	`value`: the encoded secret
-> m Value	Returns: the decoded secret value

Decode a [structvalue] into GVariant received with the Secret Service DBus API.

The GVariant should have a (oayays) signature.

A session must have already been established by the [classservice], and the encoded secret must be valid for that session.

disconnect

serviceDisconnect :: (HasCallStack, MonadIO m) => m () Source #

Disconnect the default Service proxy returned by Service.get and Service.get_sync.

It is not necessary to call this function, but you may choose to do so at program exit. It is useful for testing that memory is not leaked.

This function is safe to call at any time. But if other objects in this library are still referenced, then this will not result in all memory being freed.

encodeDbusSecret

data ServiceEncodeDbusSecretMethodInfo Source #

Instances

Instances details

(signature ~ (Value -> m GVariant), MonadIO m, IsService a) => OverloadedMethod ServiceEncodeDbusSecretMethodInfo a signature Source #
Instance details Defined in GI.Secret.Objects.Service Methods overloadedMethod :: a -> signature
OverloadedMethodInfo ServiceEncodeDbusSecretMethodInfo (a :: Type) Source #
Instance details Defined in GI.Secret.Objects.Service Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo

serviceEncodeDbusSecret Source #

Arguments

:: (HasCallStack, MonadIO m, IsService a)
=> a	`service`: the service
-> Value	`value`: the secret value
-> m GVariant	Returns: the encoded secret

Encodes a [structvalue] into GVariant for use with the Secret Service DBus API.

The resulting GVariant will have a (oayays) signature.

A session must have already been established by the [classservice].

ensureSession

data ServiceEnsureSessionMethodInfo Source #

Instances

Instances details

(signature ~ (Maybe b -> Maybe AsyncReadyCallback -> m ()), MonadIO m, IsService a, IsCancellable b) => OverloadedMethod ServiceEnsureSessionMethodInfo a signature Source #
Instance details Defined in GI.Secret.Objects.Service Methods overloadedMethod :: a -> signature
OverloadedMethodInfo ServiceEnsureSessionMethodInfo (a :: Type) Source #
Instance details Defined in GI.Secret.Objects.Service Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo

serviceEnsureSession Source #

Arguments

:: (HasCallStack, MonadIO m, IsService a, IsCancellable b)
=> a	`self`: the secret service
-> Maybe b	`cancellable`: optional cancellation object
-> Maybe AsyncReadyCallback	`callback`: called when the operation completes
-> m ()

Ensure that the Service proxy has established a session with the Secret Service.

This session is used to transfer secrets.

It is not normally necessary to call this method, as the session is established as necessary. You can also pass the ServiceFlagsOpenSession to Service.get in order to ensure that a session has been established by the time you get the Service proxy.

This method will return immediately and complete asynchronously.

ensureSessionFinish

data ServiceEnsureSessionFinishMethodInfo Source #

Instances

Instances details

(signature ~ (b -> m ()), MonadIO m, IsService a, IsAsyncResult b) => OverloadedMethod ServiceEnsureSessionFinishMethodInfo a signature Source #
Instance details Defined in GI.Secret.Objects.Service Methods overloadedMethod :: a -> signature
OverloadedMethodInfo ServiceEnsureSessionFinishMethodInfo (a :: Type) Source #
Instance details Defined in GI.Secret.Objects.Service Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo

serviceEnsureSessionFinish Source #

Arguments

:: (HasCallStack, MonadIO m, IsService a, IsAsyncResult b)
=> a	`self`: the secret service
-> b	`result`: the asynchronous result passed to the callback
-> m ()	(Can throw `GError`)

Finish an asynchronous operation to ensure that the Service proxy has established a session with the Secret Service.

ensureSessionSync

data ServiceEnsureSessionSyncMethodInfo Source #

Instances

Instances details

(signature ~ (Maybe b -> m ()), MonadIO m, IsService a, IsCancellable b) => OverloadedMethod ServiceEnsureSessionSyncMethodInfo a signature Source #
Instance details Defined in GI.Secret.Objects.Service Methods overloadedMethod :: a -> signature
OverloadedMethodInfo ServiceEnsureSessionSyncMethodInfo (a :: Type) Source #
Instance details Defined in GI.Secret.Objects.Service Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo

serviceEnsureSessionSync Source #

Arguments

:: (HasCallStack, MonadIO m, IsService a, IsCancellable b)
=> a	`self`: the secret service
-> Maybe b	`cancellable`: optional cancellation object
-> m ()	(Can throw `GError`)

Ensure that the Service proxy has established a session with the Secret Service.

This session is used to transfer secrets.

It is not normally necessary to call this method, as the session is established as necessary. You can also pass the ServiceFlagsOpenSession to Service.get_sync in order to ensure that a session has been established by the time you get the Service proxy.

This method may block indefinitely and should not be used in user interface threads.

get

serviceGet Source #

Arguments

:: (HasCallStack, MonadIO m, IsCancellable a)
=> [ServiceFlags]	`flags`: flags for which service functionality to ensure is initialized
-> Maybe a	`cancellable`: optional cancellation object
-> Maybe AsyncReadyCallback	`callback`: called when the operation completes
-> m ()

Get a Service proxy for the Secret Service.

If such a proxy object already exists, then the same proxy is returned.

If flags contains any flags of which parts of the secret service to ensure are initialized, then those will be initialized before completing.

This method will return immediately and complete asynchronously.

getCollectionGtype

data ServiceGetCollectionGtypeMethodInfo Source #

Instances

Instances details

(signature ~ m GType, MonadIO m, IsService a) => OverloadedMethod ServiceGetCollectionGtypeMethodInfo a signature Source #
Instance details Defined in GI.Secret.Objects.Service Methods overloadedMethod :: a -> signature
OverloadedMethodInfo ServiceGetCollectionGtypeMethodInfo (a :: Type) Source #
Instance details Defined in GI.Secret.Objects.Service Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo

serviceGetCollectionGtype Source #

Arguments

:: (HasCallStack, MonadIO m, IsService a)
=> a	`self`: the secret service
-> m GType	Returns: the gobject type for collections

Get the GObject type for collections instantiated by this service.

This will always be either [classcollection] or derived from it.

getCollections

data ServiceGetCollectionsMethodInfo Source #

Instances

Instances details

(signature ~ m [Collection], MonadIO m, IsService a) => OverloadedMethod ServiceGetCollectionsMethodInfo a signature Source #
Instance details Defined in GI.Secret.Objects.Service Methods overloadedMethod :: a -> signature
OverloadedMethodInfo ServiceGetCollectionsMethodInfo (a :: Type) Source #
Instance details Defined in GI.Secret.Objects.Service Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo

serviceGetCollections Source #

Arguments

:: (HasCallStack, MonadIO m, IsService a)
=> a	`self`: the secret service proxy
-> m [Collection]	Returns: a list of the collections in the secret service

Get a list of [classcollection] objects representing all the collections in the secret service.

If the ServiceFlagsLoadCollections flag was not specified when initializing Service proxy object, then this method will return Nothing. Use [methodservice.load_collections] to load the collections.

getFinish

serviceGetFinish Source #

Arguments

:: (HasCallStack, MonadIO m, IsAsyncResult a)
=> a	`result`: the asynchronous result passed to the callback
-> m Service	Returns: a new reference to a `Service` proxy, which should be released with `objectUnref`. (Can throw `GError`)

Complete an asynchronous operation to get a Service proxy for the Secret Service.

getFlags

data ServiceGetFlagsMethodInfo Source #

Instances

Instances details

(signature ~ m [ServiceFlags], MonadIO m, IsService a) => OverloadedMethod ServiceGetFlagsMethodInfo a signature Source #
Instance details Defined in GI.Secret.Objects.Service Methods overloadedMethod :: a -> signature
OverloadedMethodInfo ServiceGetFlagsMethodInfo (a :: Type) Source #
Instance details Defined in GI.Secret.Objects.Service Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo

serviceGetFlags Source #

Arguments

:: (HasCallStack, MonadIO m, IsService a)
=> a	`self`: the secret service proxy
-> m [ServiceFlags]	Returns: the flags for features initialized

Get the flags representing what features of the Service proxy have been initialized.

Use [methodservice.ensure_session] or [methodservice.load_collections] to initialize further features and change the flags.

getItemGtype

data ServiceGetItemGtypeMethodInfo Source #

Instances

Instances details

(signature ~ m GType, MonadIO m, IsService a) => OverloadedMethod ServiceGetItemGtypeMethodInfo a signature Source #
Instance details Defined in GI.Secret.Objects.Service Methods overloadedMethod :: a -> signature
OverloadedMethodInfo ServiceGetItemGtypeMethodInfo (a :: Type) Source #
Instance details Defined in GI.Secret.Objects.Service Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo

serviceGetItemGtype Source #

Arguments

:: (HasCallStack, MonadIO m, IsService a)
=> a	`self`: the service
-> m GType	Returns: the gobject type for items

Get the GObject type for items instantiated by this service.

This will always be either [classitem] or derived from it.

getSessionAlgorithms

data ServiceGetSessionAlgorithmsMethodInfo Source #

Instances

Instances details

(signature ~ m (Maybe Text), MonadIO m, IsService a) => OverloadedMethod ServiceGetSessionAlgorithmsMethodInfo a signature Source #
Instance details Defined in GI.Secret.Objects.Service Methods overloadedMethod :: a -> signature
OverloadedMethodInfo ServiceGetSessionAlgorithmsMethodInfo (a :: Type) Source #
Instance details Defined in GI.Secret.Objects.Service Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo

serviceGetSessionAlgorithms Source #

Arguments

:: (HasCallStack, MonadIO m, IsService a)
=> a	`self`: the secret service proxy
-> m (Maybe Text)	Returns: a string representing the algorithms for transferring secrets

Get the set of algorithms being used to transfer secrets between this secret service proxy and the Secret Service itself.

This will be Nothing if no session has been established. Use [methodservice.ensure_session] to establish a session.

getSessionDbusPath

data ServiceGetSessionDbusPathMethodInfo Source #

Instances

Instances details

(signature ~ m (Maybe Text), MonadIO m, IsService a) => OverloadedMethod ServiceGetSessionDbusPathMethodInfo a signature Source #
Instance details Defined in GI.Secret.Objects.Service Methods overloadedMethod :: a -> signature
OverloadedMethodInfo ServiceGetSessionDbusPathMethodInfo (a :: Type) Source #
Instance details Defined in GI.Secret.Objects.Service Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo

serviceGetSessionDbusPath Source #

Arguments

:: (HasCallStack, MonadIO m, IsService a)
=> a	`self`: the secret service proxy
-> m (Maybe Text)	Returns: a string representing the D-Bus object path of the session

Get the D-Bus object path of the session object being used to transfer secrets between this secret service proxy and the Secret Service itself.

This will be Nothing if no session has been established. Use [methodservice.ensure_session] to establish a session.

getSync

serviceGetSync Source #

Arguments

:: (HasCallStack, MonadIO m, IsCancellable a)
=> [ServiceFlags]	`flags`: flags for which service functionality to ensure is initialized
-> Maybe a	`cancellable`: optional cancellation object
-> m Service	Returns: a new reference to a `Service` proxy, which should be released with `objectUnref`. (Can throw `GError`)

Get a Service proxy for the Secret Service.

If such a proxy object already exists, then the same proxy is returned.

If flags contains any flags of which parts of the secret service to ensure are initialized, then those will be initialized before returning.

This method may block indefinitely and should not be used in user interface threads.

loadCollections

data ServiceLoadCollectionsMethodInfo Source #

Instances

Instances details

(signature ~ (Maybe b -> Maybe AsyncReadyCallback -> m ()), MonadIO m, IsService a, IsCancellable b) => OverloadedMethod ServiceLoadCollectionsMethodInfo a signature Source #
Instance details Defined in GI.Secret.Objects.Service Methods overloadedMethod :: a -> signature
OverloadedMethodInfo ServiceLoadCollectionsMethodInfo (a :: Type) Source #
Instance details Defined in GI.Secret.Objects.Service Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo

serviceLoadCollections Source #

Arguments

:: (HasCallStack, MonadIO m, IsService a, IsCancellable b)
=> a	`self`: the secret service
-> Maybe b	`cancellable`: optional cancellation object
-> Maybe AsyncReadyCallback	`callback`: called when the operation completes
-> m ()

Ensure that the Service proxy has loaded all the collections present in the Secret Service.

This affects the result of [methodservice.get_collections].

You can also pass the ServiceFlagsLoadCollections to Service.get_sync in order to ensure that the collections have been loaded by the time you get the Service proxy.

This method will return immediately and complete asynchronously.

loadCollectionsFinish

data ServiceLoadCollectionsFinishMethodInfo Source #

Instances

Instances details

(signature ~ (b -> m ()), MonadIO m, IsService a, IsAsyncResult b) => OverloadedMethod ServiceLoadCollectionsFinishMethodInfo a signature Source #
Instance details Defined in GI.Secret.Objects.Service Methods overloadedMethod :: a -> signature
OverloadedMethodInfo ServiceLoadCollectionsFinishMethodInfo (a :: Type) Source #
Instance details Defined in GI.Secret.Objects.Service Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo

serviceLoadCollectionsFinish Source #

Arguments

:: (HasCallStack, MonadIO m, IsService a, IsAsyncResult b)
=> a	`self`: the secret service
-> b	`result`: the asynchronous result passed to the callback
-> m ()	(Can throw `GError`)

Complete an asynchronous operation to ensure that the Service proxy has loaded all the collections present in the Secret Service.

loadCollectionsSync

data ServiceLoadCollectionsSyncMethodInfo Source #

Instances

Instances details

(signature ~ (Maybe b -> m ()), MonadIO m, IsService a, IsCancellable b) => OverloadedMethod ServiceLoadCollectionsSyncMethodInfo a signature Source #
Instance details Defined in GI.Secret.Objects.Service Methods overloadedMethod :: a -> signature
OverloadedMethodInfo ServiceLoadCollectionsSyncMethodInfo (a :: Type) Source #
Instance details Defined in GI.Secret.Objects.Service Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo

serviceLoadCollectionsSync Source #

Arguments

:: (HasCallStack, MonadIO m, IsService a, IsCancellable b)
=> a	`self`: the secret service
-> Maybe b	`cancellable`: optional cancellation object
-> m ()	(Can throw `GError`)

Ensure that the Service proxy has loaded all the collections present in the Secret Service.

This affects the result of [methodservice.get_collections].

You can also pass the ServiceFlagsLoadCollections to Service.get_sync in order to ensure that the collections have been loaded by the time you get the Service proxy.

This method may block indefinitely and should not be used in user interface threads.

lock

data ServiceLockMethodInfo Source #

Instances

Instances details

(signature ~ ([b] -> Maybe c -> Maybe AsyncReadyCallback -> m ()), MonadIO m, IsService a, IsDBusProxy b, IsCancellable c) => OverloadedMethod ServiceLockMethodInfo a signature Source #
Instance details Defined in GI.Secret.Objects.Service Methods overloadedMethod :: a -> signature
OverloadedMethodInfo ServiceLockMethodInfo (a :: Type) Source #
Instance details Defined in GI.Secret.Objects.Service Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo

serviceLock Source #

Arguments

:: (HasCallStack, MonadIO m, IsService a, IsDBusProxy b, IsCancellable c)
=> Maybe a	`service`: the secret service
-> [b]	`objects`: the items or collections to lock
-> Maybe c	`cancellable`: optional cancellation object
-> Maybe AsyncReadyCallback	`callback`: called when the operation completes
-> m ()

Lock items or collections in the secret service.

The secret service may not be able to lock items individually, and may lock an entire collection instead.

If service is Nothing, then Service.get will be called to get the default [classservice] proxy.

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.

lockFinish

data ServiceLockFinishMethodInfo Source #

Instances

Instances details

(signature ~ (b -> m (Int32, [DBusProxy])), MonadIO m, IsService a, IsAsyncResult b) => OverloadedMethod ServiceLockFinishMethodInfo a signature Source #
Instance details Defined in GI.Secret.Objects.Service Methods overloadedMethod :: a -> signature
OverloadedMethodInfo ServiceLockFinishMethodInfo (a :: Type) Source #
Instance details Defined in GI.Secret.Objects.Service Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo

serviceLockFinish Source #

Arguments

:: (HasCallStack, MonadIO m, IsService a, IsAsyncResult b)
=> Maybe a	`service`: the secret service
-> b	`result`: asynchronous result passed to the callback
-> m (Int32, [DBusProxy])	Returns: the number of items or collections that were locked (Can throw `GError`)

Complete asynchronous operation to lock items or collections in the secret service.

The secret service may not be able to lock items individually, and may lock an entire collection instead.

lockSync

data ServiceLockSyncMethodInfo Source #

Instances

Instances details

(signature ~ ([b] -> Maybe c -> m (Int32, [DBusProxy])), MonadIO m, IsService a, IsDBusProxy b, IsCancellable c) => OverloadedMethod ServiceLockSyncMethodInfo a signature Source #
Instance details Defined in GI.Secret.Objects.Service Methods overloadedMethod :: a -> signature
OverloadedMethodInfo ServiceLockSyncMethodInfo (a :: Type) Source #
Instance details Defined in GI.Secret.Objects.Service Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo

serviceLockSync Source #

Arguments

:: (HasCallStack, MonadIO m, IsService a, IsDBusProxy b, IsCancellable c)
=> Maybe a	`service`: the secret service
-> [b]	`objects`: the items or collections to lock
-> Maybe c	`cancellable`: optional cancellation object
-> m (Int32, [DBusProxy])	Returns: the number of items or collections that were locked (Can throw `GError`)

Lock items or collections in the secret service.

The secret service may not be able to lock items individually, and may lock an entire collection instead.

If service is Nothing, then Service.get_sync will be called to get the default [classservice] proxy.

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.

lookup

data ServiceLookupMethodInfo Source #

Instances

Instances details

(signature ~ (Maybe Schema -> Map Text Text -> Maybe b -> Maybe AsyncReadyCallback -> m ()), MonadIO m, IsService a, IsCancellable b) => OverloadedMethod ServiceLookupMethodInfo a signature Source #
Instance details Defined in GI.Secret.Objects.Service Methods overloadedMethod :: a -> signature
OverloadedMethodInfo ServiceLookupMethodInfo (a :: Type) Source #
Instance details Defined in GI.Secret.Objects.Service Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo

serviceLookup Source #

Arguments

:: (HasCallStack, MonadIO m, IsService a, IsCancellable b)
=> Maybe a	`service`: the secret service
-> Maybe Schema	`schema`: the schema for the attributes
-> Map Text Text	`attributes`: the attribute keys and values
-> Maybe b	`cancellable`: optional cancellation object
-> Maybe AsyncReadyCallback	`callback`: called when the operation completes
-> m ()

Lookup a secret value in the secret service.

The attributes should be a set of key and value string pairs.

If service is Nothing, then Service.get will be called to get the default [classservice] proxy.

This method will return immediately and complete asynchronously.

lookupFinish

data ServiceLookupFinishMethodInfo Source #

Instances

Instances details

(signature ~ (b -> m (Maybe Value)), MonadIO m, IsService a, IsAsyncResult b) => OverloadedMethod ServiceLookupFinishMethodInfo a signature Source #
Instance details Defined in GI.Secret.Objects.Service Methods overloadedMethod :: a -> signature
OverloadedMethodInfo ServiceLookupFinishMethodInfo (a :: Type) Source #
Instance details Defined in GI.Secret.Objects.Service Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo

serviceLookupFinish Source #

Arguments

:: (HasCallStack, MonadIO m, IsService a, IsAsyncResult b)
=> Maybe a	`service`: the secret service
-> b	`result`: the asynchronous result passed to the callback
-> m (Maybe Value)	Returns: a newly allocated [struct`value`], which should be released with [method`value`.unref], or `Nothing` if no secret found (Can throw `GError`)

Finish asynchronous operation to lookup a secret value in the secret service.

If no secret is found then Nothing is returned.

lookupSync

data ServiceLookupSyncMethodInfo Source #

Instances

Instances details

(signature ~ (Maybe Schema -> Map Text Text -> Maybe b -> m Value), MonadIO m, IsService a, IsCancellable b) => OverloadedMethod ServiceLookupSyncMethodInfo a signature Source #
Instance details Defined in GI.Secret.Objects.Service Methods overloadedMethod :: a -> signature
OverloadedMethodInfo ServiceLookupSyncMethodInfo (a :: Type) Source #
Instance details Defined in GI.Secret.Objects.Service Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo

serviceLookupSync Source #

Arguments

:: (HasCallStack, MonadIO m, IsService a, IsCancellable b)
=> Maybe a	`service`: the secret service
-> Maybe Schema	`schema`: the schema for the attributes
-> Map Text Text	`attributes`: the attribute keys and values
-> Maybe b	`cancellable`: optional cancellation object
-> m Value	Returns: a newly allocated [struct`value`], which should be released with [method`value`.unref], or `Nothing` if no secret found (Can throw `GError`)

Lookup a secret value in the secret service.

The attributes should be a set of key and value string pairs.

If service is Nothing, then Service.get_sync will be called to get the default [classservice] proxy.

This method may block indefinitely and should not be used in user interface threads.

open

serviceOpen Source #

Arguments

:: (HasCallStack, MonadIO m, IsCancellable a)
=> GType	`serviceGtype`: the GType of the new secret service
-> Maybe Text	`serviceBusName`: the D-Bus service name of the secret service
-> [ServiceFlags]	`flags`: flags for which service functionality to ensure is initialized
-> Maybe a	`cancellable`: optional cancellation object
-> Maybe AsyncReadyCallback	`callback`: called when the operation completes
-> m ()

Create a new Service proxy for the Secret Service.

This function is rarely used, see Service.get instead.

The serviceGtype argument should be set to SECRET_TYPE_SERVICE or a the type of a derived class.

If flags contains any flags of which parts of the secret service to ensure are initialized, then those will be initialized before returning.

If serviceBusName is Nothing then the default is used.

This method will return immediately and complete asynchronously.

openFinish

serviceOpenFinish Source #

Arguments

:: (HasCallStack, MonadIO m, IsAsyncResult a)
=> a	`result`: the asynchronous result passed to the callback
-> m Service	Returns: a new reference to a `Service` proxy, which should be released with `objectUnref`. (Can throw `GError`)

Complete an asynchronous operation to create a new Service proxy for the Secret Service.

openSync

serviceOpenSync Source #

Arguments

:: (HasCallStack, MonadIO m, IsCancellable a)
=> GType	`serviceGtype`: the GType of the new secret service
-> Maybe Text	`serviceBusName`: the D-Bus service name of the secret service
-> [ServiceFlags]	`flags`: flags for which service functionality to ensure is initialized
-> Maybe a	`cancellable`: optional cancellation object
-> m Service	Returns: a new reference to a `Service` proxy, which should be released with `objectUnref`. (Can throw `GError`)

Create a new Service proxy for the Secret Service.

This function is rarely used, see Service.get_sync instead.

The serviceGtype argument should be set to SECRET_TYPE_SERVICE or a the type of a derived class.

If flags contains any flags of which parts of the secret service to ensure are initialized, then those will be initialized before returning.

If serviceBusName is Nothing then the default is used.

This method may block indefinitely and should not be used in user interface threads.

prompt

data ServicePromptMethodInfo Source #

Instances

Instances details

(signature ~ (b -> Maybe VariantType -> Maybe c -> Maybe AsyncReadyCallback -> m ()), MonadIO m, IsService a, IsPrompt b, IsCancellable c) => OverloadedMethod ServicePromptMethodInfo a signature Source #
Instance details Defined in GI.Secret.Objects.Service Methods overloadedMethod :: a -> signature
OverloadedMethodInfo ServicePromptMethodInfo (a :: Type) Source #
Instance details Defined in GI.Secret.Objects.Service Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo

servicePrompt Source #

Arguments

:: (HasCallStack, MonadIO m, IsService a, IsPrompt b, IsCancellable c)
=> a	`self`: the secret service
-> b	`prompt`: the prompt
-> Maybe VariantType	`returnType`: the variant type of the prompt result
-> Maybe c	`cancellable`: optional cancellation object
-> Maybe AsyncReadyCallback	`callback`: called when the operation completes
-> m ()

Perform prompting for a [classprompt].

This function is called by other parts of this library to handle prompts for the various actions that can require prompting.

Override the ServiceClass [vfuncservice.prompt_async] virtual method to change the behavior of the prompting. The default behavior is to simply run [methodprompt.perform] on the prompt.

promptFinish

data ServicePromptFinishMethodInfo Source #

Instances

Instances details

(signature ~ (b -> m GVariant), MonadIO m, IsService a, IsAsyncResult b) => OverloadedMethod ServicePromptFinishMethodInfo a signature Source #
Instance details Defined in GI.Secret.Objects.Service Methods overloadedMethod :: a -> signature
OverloadedMethodInfo ServicePromptFinishMethodInfo (a :: Type) Source #
Instance details Defined in GI.Secret.Objects.Service Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo

servicePromptFinish Source #

Arguments

:: (HasCallStack, MonadIO m, IsService a, IsAsyncResult b)
=> a	`self`: the secret service
-> b	`result`: the asynchronous result passed to the callback
-> m GVariant	Returns: `Nothing` if the prompt was dismissed or an error occurred, a variant result if the prompt was successful (Can throw `GError`)

Complete asynchronous operation to perform prompting for a [classprompt].

Returns a variant result if the prompt was completed and not dismissed. The type of result depends on the action the prompt is completing, and is defined in the Secret Service DBus API specification.

promptSync

data ServicePromptSyncMethodInfo Source #

Instances

Instances details

(signature ~ (b -> Maybe c -> VariantType -> m GVariant), MonadIO m, IsService a, IsPrompt b, IsCancellable c) => OverloadedMethod ServicePromptSyncMethodInfo a signature Source #
Instance details Defined in GI.Secret.Objects.Service Methods overloadedMethod :: a -> signature
OverloadedMethodInfo ServicePromptSyncMethodInfo (a :: Type) Source #
Instance details Defined in GI.Secret.Objects.Service Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo

servicePromptSync Source #

Arguments

:: (HasCallStack, MonadIO m, IsService a, IsPrompt b, IsCancellable c)
=> a	`self`: the secret service
-> b	`prompt`: the prompt
-> Maybe c	`cancellable`: optional cancellation object
-> VariantType	`returnType`: the variant type of the prompt result
-> m GVariant	Returns: `Nothing` if the prompt was dismissed or an error occurred, a variant result if the prompt was successful (Can throw `GError`)

Perform prompting for a [classprompt].

Runs a prompt and performs the prompting. Returns a variant result if the prompt was completed and not dismissed. The type of result depends on the action the prompt is completing, and is defined in the Secret Service DBus API specification.

This function is called by other parts of this library to handle prompts for the various actions that can require prompting.

Override the ServiceClass [vfuncservice.prompt_sync] virtual method to change the behavior of the prompting. The default behavior is to simply run [methodprompt.perform_sync] on the prompt with a Nothing window_id.

search

data ServiceSearchMethodInfo Source #

Instances

Instances details

(signature ~ (Maybe Schema -> Map Text Text -> [SearchFlags] -> Maybe b -> Maybe AsyncReadyCallback -> m ()), MonadIO m, IsService a, IsCancellable b) => OverloadedMethod ServiceSearchMethodInfo a signature Source #
Instance details Defined in GI.Secret.Objects.Service Methods overloadedMethod :: a -> signature
OverloadedMethodInfo ServiceSearchMethodInfo (a :: Type) Source #
Instance details Defined in GI.Secret.Objects.Service Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo

serviceSearch Source #

Arguments

:: (HasCallStack, MonadIO m, IsService a, IsCancellable b)
=> Maybe a	`service`: the secret service
-> Maybe Schema	`schema`: the schema for the attributes
-> Map Text Text	`attributes`: search for items matching these attributes
-> [SearchFlags]	`flags`: search option flags
-> Maybe b	`cancellable`: optional cancellation object
-> Maybe AsyncReadyCallback	`callback`: called when the operation completes
-> m ()

Search for items matching the attributes.

All collections are searched. The attributes should be a table of string keys and string values.

If service is Nothing, then Service.get will be called to get the default [classservice] proxy.

If SearchFlagsAll is set in flags, then all the items matching the search will be returned. Otherwise only the first item will be returned. This is almost always the unlocked item that was most recently stored.

If SearchFlagsUnlock is set in flags, then items will be unlocked if necessary. In either case, locked and unlocked items will match the search and be returned. If the unlock fails, the search does not fail.

If SearchFlagsLoadSecrets is set in flags, then the items will have their secret values loaded and available via [methoditem.get_secret].

This function returns immediately and completes asynchronously.

searchFinish

data ServiceSearchFinishMethodInfo Source #

Instances

Instances details

(signature ~ (b -> m [Item]), MonadIO m, IsService a, IsAsyncResult b) => OverloadedMethod ServiceSearchFinishMethodInfo a signature Source #
Instance details Defined in GI.Secret.Objects.Service Methods overloadedMethod :: a -> signature
OverloadedMethodInfo ServiceSearchFinishMethodInfo (a :: Type) Source #
Instance details Defined in GI.Secret.Objects.Service Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo

serviceSearchFinish Source #

Arguments

:: (HasCallStack, MonadIO m, IsService a, IsAsyncResult b)
=> Maybe a	`service`: the secret service
-> b	`result`: asynchronous result passed to callback
-> m [Item]	Returns: a list of items that matched the search (Can throw `GError`)

Complete asynchronous operation to search for items.

searchSync

data ServiceSearchSyncMethodInfo Source #

Instances

Instances details

(signature ~ (Maybe Schema -> Map Text Text -> [SearchFlags] -> Maybe b -> m [Item]), MonadIO m, IsService a, IsCancellable b) => OverloadedMethod ServiceSearchSyncMethodInfo a signature Source #
Instance details Defined in GI.Secret.Objects.Service Methods overloadedMethod :: a -> signature
OverloadedMethodInfo ServiceSearchSyncMethodInfo (a :: Type) Source #
Instance details Defined in GI.Secret.Objects.Service Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo

serviceSearchSync Source #

Arguments

:: (HasCallStack, MonadIO m, IsService a, IsCancellable b)
=> Maybe a	`service`: the secret service
-> Maybe Schema	`schema`: the schema for the attributes
-> Map Text Text	`attributes`: search for items matching these attributes
-> [SearchFlags]	`flags`: search option flags
-> Maybe b	`cancellable`: optional cancellation object
-> m [Item]	Returns: a list of items that matched the search (Can throw `GError`)

Search for items matching the attributes.

All collections are searched. The attributes should be a table of string keys and string values.

If service is Nothing, then Service.get_sync will be called to get the default [classservice] proxy.

If SearchFlagsAll is set in flags, then all the items matching the search will be returned. Otherwise only the first item will be returned. This is almost always the unlocked item that was most recently stored.

If SearchFlagsUnlock is set in flags, then items will be unlocked if necessary. In either case, locked and unlocked items will match the search and be returned. If the unlock fails, the search does not fail.

If SearchFlagsLoadSecrets is set in flags, then the items' secret values will be loaded for any unlocked items. Loaded item secret values are available via [methoditem.get_secret]. If the load of a secret values fail, then the

This function may block indefinitely. Use the asynchronous version in user interface threads.

setAlias

data ServiceSetAliasMethodInfo Source #

Instances

Instances details

(signature ~ (Text -> Maybe b -> Maybe c -> Maybe AsyncReadyCallback -> m ()), MonadIO m, IsService a, IsCollection b, IsCancellable c) => OverloadedMethod ServiceSetAliasMethodInfo a signature Source #
Instance details Defined in GI.Secret.Objects.Service Methods overloadedMethod :: a -> signature
OverloadedMethodInfo ServiceSetAliasMethodInfo (a :: Type) Source #
Instance details Defined in GI.Secret.Objects.Service Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo

serviceSetAlias Source #

Arguments

:: (HasCallStack, MonadIO m, IsService a, IsCollection b, IsCancellable c)
=> Maybe a	`service`: a secret service object
-> Text	`alias`: the alias to assign the collection to
-> Maybe b	`collection`: the collection to assign to the alias
-> Maybe c	`cancellable`: optional cancellation object
-> Maybe AsyncReadyCallback	`callback`: called when the operation completes
-> m ()

Assign a collection to this alias.

Aliases help determine well known collections, such as 'default'.

If service is Nothing, then Service.get will be called to get the default [classservice] proxy.

This method will return immediately and complete asynchronously.

setAliasFinish

data ServiceSetAliasFinishMethodInfo Source #

Instances

Instances details

(signature ~ (b -> m ()), MonadIO m, IsService a, IsAsyncResult b) => OverloadedMethod ServiceSetAliasFinishMethodInfo a signature Source #
Instance details Defined in GI.Secret.Objects.Service Methods overloadedMethod :: a -> signature
OverloadedMethodInfo ServiceSetAliasFinishMethodInfo (a :: Type) Source #
Instance details Defined in GI.Secret.Objects.Service Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo

serviceSetAliasFinish Source #

Arguments

:: (HasCallStack, MonadIO m, IsService a, IsAsyncResult b)
=> Maybe a	`service`: a secret service object
-> b	`result`: asynchronous result passed to callback
-> m ()	(Can throw `GError`)

Finish an asynchronous operation to assign a collection to an alias.

setAliasSync

data ServiceSetAliasSyncMethodInfo Source #

Instances

Instances details

(signature ~ (Text -> Maybe b -> Maybe c -> m ()), MonadIO m, IsService a, IsCollection b, IsCancellable c) => OverloadedMethod ServiceSetAliasSyncMethodInfo a signature Source #
Instance details Defined in GI.Secret.Objects.Service Methods overloadedMethod :: a -> signature
OverloadedMethodInfo ServiceSetAliasSyncMethodInfo (a :: Type) Source #
Instance details Defined in GI.Secret.Objects.Service Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo

serviceSetAliasSync Source #

Arguments

:: (HasCallStack, MonadIO m, IsService a, IsCollection b, IsCancellable c)
=> Maybe a	`service`: a secret service object
-> Text	`alias`: the alias to assign the collection to
-> Maybe b	`collection`: the collection to assign to the alias
-> Maybe c	`cancellable`: optional cancellation object
-> m ()	(Can throw `GError`)

Assign a collection to this alias. Aliases help determine well known collections, such as 'default'.

If service is Nothing, then Service.get_sync will be called to get the default [classservice] proxy.

This method may block and should not be used in user interface threads.

store

data ServiceStoreMethodInfo Source #

Instances

Instances details

(signature ~ (Maybe Schema -> Map Text Text -> Maybe Text -> Text -> Value -> Maybe b -> Maybe AsyncReadyCallback -> m ()), MonadIO m, IsService a, IsCancellable b) => OverloadedMethod ServiceStoreMethodInfo a signature Source #
Instance details Defined in GI.Secret.Objects.Service Methods overloadedMethod :: a -> signature
OverloadedMethodInfo ServiceStoreMethodInfo (a :: Type) Source #
Instance details Defined in GI.Secret.Objects.Service Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo

serviceStore Source #

Arguments

:: (HasCallStack, MonadIO m, IsService a, IsCancellable b)
=> Maybe a	`service`: the secret service
-> Maybe Schema	`schema`: the schema to use to check attributes
-> Map Text Text	`attributes`: the attribute keys and values
-> Maybe Text	`collection`: a collection alias, or D-Bus object path of the collection where to store the secret
-> Text	`label`: label for the secret
-> Value	`value`: the secret value
-> Maybe b	`cancellable`: optional cancellation object
-> Maybe AsyncReadyCallback	`callback`: called when the operation completes
-> m ()

Store a secret value in the secret service.

The attributes should be a set of key and value string pairs.

If the attributes match a secret item already stored in the collection, then the item will be updated with these new values.

If service is Nothing, then Service.get will be called to get the default [classservice] proxy.

If collection is not specified, then the default collection will be used. Use [constcOLLECTIONSESSION] to store the password in the session collection, which doesn't get stored across login sessions.

This method will return immediately and complete asynchronously.

storeFinish

data ServiceStoreFinishMethodInfo Source #

Instances

Instances details

(signature ~ (b -> m ()), MonadIO m, IsService a, IsAsyncResult b) => OverloadedMethod ServiceStoreFinishMethodInfo a signature Source #
Instance details Defined in GI.Secret.Objects.Service Methods overloadedMethod :: a -> signature
OverloadedMethodInfo ServiceStoreFinishMethodInfo (a :: Type) Source #
Instance details Defined in GI.Secret.Objects.Service Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo

serviceStoreFinish Source #

Arguments

:: (HasCallStack, MonadIO m, IsService a, IsAsyncResult b)
=> Maybe a	`service`: the secret service
-> b	`result`: the asynchronous result passed to the callback
-> m ()	(Can throw `GError`)

Finish asynchronous operation to store a secret value in the secret service.

storeSync

data ServiceStoreSyncMethodInfo Source #

Instances

Instances details

(signature ~ (Maybe Schema -> Map Text Text -> Maybe Text -> Text -> Value -> Maybe b -> m ()), MonadIO m, IsService a, IsCancellable b) => OverloadedMethod ServiceStoreSyncMethodInfo a signature Source #
Instance details Defined in GI.Secret.Objects.Service Methods overloadedMethod :: a -> signature
OverloadedMethodInfo ServiceStoreSyncMethodInfo (a :: Type) Source #
Instance details Defined in GI.Secret.Objects.Service Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo

serviceStoreSync Source #

Arguments

:: (HasCallStack, MonadIO m, IsService a, IsCancellable b)
=> Maybe a	`service`: the secret service
-> Maybe Schema	`schema`: the schema for the attributes
-> Map Text Text	`attributes`: the attribute keys and values
-> Maybe Text	`collection`: a collection alias, or D-Bus object path of the collection where to store the secret
-> Text	`label`: label for the secret
-> Value	`value`: the secret value
-> Maybe b	`cancellable`: optional cancellation object
-> m ()	(Can throw `GError`)

Store a secret value in the secret service.

The attributes should be a set of key and value string pairs.

If the attributes match a secret item already stored in the collection, then the item will be updated with these new values.

If collection is Nothing, then the default collection will be used. Use [constcOLLECTIONSESSION] to store the password in the session collection, which doesn't get stored across login sessions.

If service is Nothing, then Service.get_sync will be called to get the default [classservice] proxy.

This method may block indefinitely and should not be used in user interface threads.

unlock

data ServiceUnlockMethodInfo Source #

Instances

Instances details

(signature ~ ([b] -> Maybe c -> Maybe AsyncReadyCallback -> m ()), MonadIO m, IsService a, IsDBusProxy b, IsCancellable c) => OverloadedMethod ServiceUnlockMethodInfo a signature Source #
Instance details Defined in GI.Secret.Objects.Service Methods overloadedMethod :: a -> signature
OverloadedMethodInfo ServiceUnlockMethodInfo (a :: Type) Source #
Instance details Defined in GI.Secret.Objects.Service Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo

serviceUnlock Source #

Arguments

:: (HasCallStack, MonadIO m, IsService a, IsDBusProxy b, IsCancellable c)
=> Maybe a	`service`: the secret service
-> [b]	`objects`: the items or collections to unlock
-> Maybe c	`cancellable`: optional cancellation object
-> Maybe AsyncReadyCallback	`callback`: called when the operation completes
-> m ()

Unlock items or collections in the secret service.

The secret service may not be able to unlock items individually, and may unlock an entire collection instead.

If service is Nothing, then Service.get will be called to get the default [classservice] proxy.

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.

unlockFinish

data ServiceUnlockFinishMethodInfo Source #

Instances

Instances details

(signature ~ (b -> m (Int32, [DBusProxy])), MonadIO m, IsService a, IsAsyncResult b) => OverloadedMethod ServiceUnlockFinishMethodInfo a signature Source #
Instance details Defined in GI.Secret.Objects.Service Methods overloadedMethod :: a -> signature
OverloadedMethodInfo ServiceUnlockFinishMethodInfo (a :: Type) Source #
Instance details Defined in GI.Secret.Objects.Service Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo

serviceUnlockFinish Source #

Arguments

:: (HasCallStack, MonadIO m, IsService a, IsAsyncResult b)
=> Maybe a	`service`: the secret service
-> b	`result`: asynchronous result passed to the callback
-> m (Int32, [DBusProxy])	Returns: the number of items or collections that were unlocked (Can throw `GError`)

Complete asynchronous operation to unlock items or collections in the secret service.

The secret service may not be able to unlock items individually, and may unlock an entire collection instead.

unlockSync

data ServiceUnlockSyncMethodInfo Source #

Instances

Instances details

(signature ~ ([b] -> Maybe c -> m (Int32, [DBusProxy])), MonadIO m, IsService a, IsDBusProxy b, IsCancellable c) => OverloadedMethod ServiceUnlockSyncMethodInfo a signature Source #
Instance details Defined in GI.Secret.Objects.Service Methods overloadedMethod :: a -> signature
OverloadedMethodInfo ServiceUnlockSyncMethodInfo (a :: Type) Source #
Instance details Defined in GI.Secret.Objects.Service Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo

serviceUnlockSync Source #

Arguments

:: (HasCallStack, MonadIO m, IsService a, IsDBusProxy b, IsCancellable c)
=> Maybe a	`service`: the secret service
-> [b]	`objects`: the items or collections to unlock
-> Maybe c	`cancellable`: optional cancellation object
-> m (Int32, [DBusProxy])	Returns: the number of items or collections that were unlocked (Can throw `GError`)

Unlock items or collections in the secret service.

The secret service may not be able to unlock items individually, and may unlock an entire collection instead.

If service is Nothing, then Service.get_sync will be called to get the default [classservice] proxy.

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.

Documentation

Instances

Exported types

Instances

Instances

Methods

Click to display all available methods, including inherited ones

Methods

Getters

Setters

clear

Instances

clearFinish

Instances

clearSync

Instances

decodeDbusSecret

Instances

disconnect

encodeDbusSecret

Instances

ensureSession

Instances

ensureSessionFinish

Instances

ensureSessionSync

Instances

get

getCollectionGtype

Instances

getCollections

Instances

getFinish

getFlags

Instances

getItemGtype

Instances

getSessionAlgorithms

Instances

getSessionDbusPath

Instances

getSync

loadCollections

Instances

loadCollectionsFinish

Instances

loadCollectionsSync

Instances

lock

Instances

lockFinish

Instances

lockSync

Instances

lookup

Instances

lookupFinish

Instances

lookupSync

Instances

open

openFinish

openSync

prompt

Instances

promptFinish

Instances

promptSync

Instances

search

Instances

searchFinish

Instances

searchSync

Instances

setAlias

Instances

setAliasFinish

Instances

setAliasSync