Copyright | Will Thompson Iñaki García Etxebarria and Jonas Platte |
---|---|
License | LGPL-2.1 |
Maintainer | Iñaki García Etxebarria |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
An object representing a read-only view of a secret item in the Secret Service.
Since: 0.19.0
Synopsis
- newtype Retrievable = Retrievable (ManagedPtr Retrievable)
- class (GObject o, IsDescendantOf Retrievable o) => IsRetrievable o
- toRetrievable :: (MonadIO m, IsRetrievable o) => o -> m Retrievable
- retrievableGetAttributes :: (HasCallStack, MonadIO m, IsRetrievable a) => a -> m (Map Text Text)
- retrievableGetCreated :: (HasCallStack, MonadIO m, IsRetrievable a) => a -> m Word64
- retrievableGetLabel :: (HasCallStack, MonadIO m, IsRetrievable a) => a -> m Text
- retrievableGetModified :: (HasCallStack, MonadIO m, IsRetrievable a) => a -> m Word64
- retrievableRetrieveSecret :: (HasCallStack, MonadIO m, IsRetrievable a, IsCancellable b) => a -> Maybe b -> Maybe AsyncReadyCallback -> m ()
- retrievableRetrieveSecretFinish :: (HasCallStack, MonadIO m, IsRetrievable a, IsAsyncResult b) => a -> b -> m (Maybe Value)
- retrievableRetrieveSecretSync :: (HasCallStack, MonadIO m, IsRetrievable a, IsCancellable b) => a -> Maybe b -> m (Maybe Value)
- constructRetrievableCreated :: (IsRetrievable o, MonadIO m) => Word64 -> m (GValueConstruct o)
- getRetrievableCreated :: (MonadIO m, IsRetrievable o) => o -> m Word64
- setRetrievableCreated :: (MonadIO m, IsRetrievable o) => o -> Word64 -> m ()
- clearRetrievableLabel :: (MonadIO m, IsRetrievable o) => o -> m ()
- constructRetrievableLabel :: (IsRetrievable o, MonadIO m) => Text -> m (GValueConstruct o)
- getRetrievableLabel :: (MonadIO m, IsRetrievable o) => o -> m (Maybe Text)
- setRetrievableLabel :: (MonadIO m, IsRetrievable o) => o -> Text -> m ()
- constructRetrievableModified :: (IsRetrievable o, MonadIO m) => Word64 -> m (GValueConstruct o)
- getRetrievableModified :: (MonadIO m, IsRetrievable o) => o -> m Word64
- setRetrievableModified :: (MonadIO m, IsRetrievable o) => o -> Word64 -> m ()
Exported types
newtype Retrievable Source #
Memory-managed wrapper type.
Retrievable (ManagedPtr Retrievable) |
Instances
Eq Retrievable Source # | |
Defined in GI.Secret.Interfaces.Retrievable (==) :: Retrievable -> Retrievable -> Bool # (/=) :: Retrievable -> Retrievable -> Bool # | |
GObject Retrievable Source # | |
Defined in GI.Secret.Interfaces.Retrievable | |
ManagedPtrNewtype Retrievable Source # | |
Defined in GI.Secret.Interfaces.Retrievable toManagedPtr :: Retrievable -> ManagedPtr Retrievable | |
TypedObject Retrievable Source # | |
Defined in GI.Secret.Interfaces.Retrievable | |
HasParentTypes Retrievable Source # | |
Defined in GI.Secret.Interfaces.Retrievable | |
IsGValue (Maybe Retrievable) Source # | Convert |
Defined in GI.Secret.Interfaces.Retrievable gvalueGType_ :: IO GType gvalueSet_ :: Ptr GValue -> Maybe Retrievable -> IO () gvalueGet_ :: Ptr GValue -> IO (Maybe Retrievable) | |
type ParentTypes Retrievable Source # | |
Defined in GI.Secret.Interfaces.Retrievable |
class (GObject o, IsDescendantOf Retrievable o) => IsRetrievable o Source #
Type class for types which can be safely cast to Retrievable
, for instance with toRetrievable
.
Instances
(GObject o, IsDescendantOf Retrievable o) => IsRetrievable o Source # | |
Defined in GI.Secret.Interfaces.Retrievable |
toRetrievable :: (MonadIO m, IsRetrievable o) => o -> m Retrievable Source #
Cast to Retrievable
, 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
Methods
bindProperty, bindPropertyFull, forceFloating, freezeNotify, getv, isFloating, notify, notifyByPspec, ref, refSink, retrieveSecret, retrieveSecretFinish, retrieveSecretSync, runDispose, stealData, stealQdata, thawNotify, unref, watchClosure.
Getters
getAttributes, getCreated, getData, getLabel, getModified, getProperty, getQdata.
Setters
getAttributes
retrievableGetAttributes Source #
:: (HasCallStack, MonadIO m, IsRetrievable a) | |
=> a |
|
-> m (Map Text Text) | Returns: a new reference
to the attributes, which should not be modified, and
released with |
Get the attributes of this object.
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 attribute returned by this method.
Since: 0.19.0
getCreated
retrievableGetCreated Source #
:: (HasCallStack, MonadIO m, IsRetrievable a) | |
=> a |
|
-> m Word64 | Returns: the created date and time |
Get the created date and time of the object. The return value is the number of seconds since the unix epoch, January 1st 1970.
Since: 0.19.0
getLabel
:: (HasCallStack, MonadIO m, IsRetrievable a) | |
=> a |
|
-> m Text | Returns: the label, which should be freed with |
Get the label of this item.
Since: 0.19.0
getModified
retrievableGetModified Source #
:: (HasCallStack, MonadIO m, IsRetrievable a) | |
=> a |
|
-> m Word64 | Returns: the modified date and time |
Get the modified date and time of the object. The return value is the number of seconds since the unix epoch, January 1st 1970.
Since: 0.19.0
retrieveSecret
retrievableRetrieveSecret Source #
:: (HasCallStack, MonadIO m, IsRetrievable a, IsCancellable b) | |
=> a |
|
-> Maybe b |
|
-> Maybe AsyncReadyCallback |
|
-> m () |
Retrieve the secret value of this object.
Each retrievable object has a single secret which might be a password or some other secret binary value.
This function returns immediately and completes asynchronously.
Since: 0.19.0
retrieveSecretFinish
retrievableRetrieveSecretFinish Source #
:: (HasCallStack, MonadIO m, IsRetrievable a, IsAsyncResult b) | |
=> a |
|
-> b |
|
-> m (Maybe Value) | Returns: the secret value which should be
released with |
Complete asynchronous operation to retrieve the secret value of this object.
Since: 0.19.0
retrieveSecretSync
retrievableRetrieveSecretSync Source #
:: (HasCallStack, MonadIO m, IsRetrievable a, IsCancellable b) | |
=> a |
|
-> Maybe b |
|
-> m (Maybe Value) | Returns: the secret value which should be
released with |
Retrieve the secret value of this object synchronously.
Each retrievable object has a single secret which might be a password or some other secret binary value.
This method may block indefinitely and should not be used in user interface threads.
Since: 0.19.0
Properties
attributes
created
The date and time (in seconds since the UNIX epoch) that this item was created.
Since: 0.19.0
constructRetrievableCreated :: (IsRetrievable o, MonadIO m) => Word64 -> m (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “created
” property. This is rarely needed directly, but it is used by new
.
getRetrievableCreated :: (MonadIO m, IsRetrievable o) => o -> m Word64 Source #
Get the value of the “created
” property.
When overloading is enabled, this is equivalent to
get
retrievable #created
setRetrievableCreated :: (MonadIO m, IsRetrievable o) => o -> Word64 -> m () Source #
Set the value of the “created
” property.
When overloading is enabled, this is equivalent to
set
retrievable [ #created:=
value ]
label
The human readable label for the item.
Since: 0.19.0
clearRetrievableLabel :: (MonadIO m, IsRetrievable o) => o -> m () Source #
Set the value of the “label
” property to Nothing
.
When overloading is enabled, this is equivalent to
clear
#label
constructRetrievableLabel :: (IsRetrievable o, MonadIO m) => Text -> m (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “label
” property. This is rarely needed directly, but it is used by new
.
getRetrievableLabel :: (MonadIO m, IsRetrievable o) => o -> m (Maybe Text) Source #
Get the value of the “label
” property.
When overloading is enabled, this is equivalent to
get
retrievable #label
setRetrievableLabel :: (MonadIO m, IsRetrievable o) => o -> Text -> m () Source #
Set the value of the “label
” property.
When overloading is enabled, this is equivalent to
set
retrievable [ #label:=
value ]
modified
The date and time (in seconds since the UNIX epoch) that this item was last modified.
Since: 0.19.0
constructRetrievableModified :: (IsRetrievable o, MonadIO m) => Word64 -> m (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “modified
” property. This is rarely needed directly, but it is used by new
.
getRetrievableModified :: (MonadIO m, IsRetrievable o) => o -> m Word64 Source #
Get the value of the “modified
” property.
When overloading is enabled, this is equivalent to
get
retrievable #modified
setRetrievableModified :: (MonadIO m, IsRetrievable o) => o -> Word64 -> m () Source #
Set the value of the “modified
” property.
When overloading is enabled, this is equivalent to
set
retrievable [ #modified:=
value ]