Safe Haskell	Safe-Inferred
Language	Haskell2010

Desktop.Portal

Contents

Connection Management
Request Management
Signal Management
Common Types
Portal Interfaces

Description

Wrappers around the XDG Desktop Portal D-BUS API.

See the documentation for the underlying API: https://flatpak.github.io/xdg-desktop-portal

Synopsis

data Client
connect :: IO Client
disconnect :: Client -> IO ()
clientName :: Client -> BusName
data Request a
await :: Request a -> IO (Maybe a)
cancel :: Request a -> IO ()
data SignalHandler
cancelSignalHandler :: SignalHandler -> IO ()
data FileSpec
- = FileSpecPath OsPath
- | FileSpecFd Fd
module Desktop.Portal.Account
module Desktop.Portal.Camera
module Desktop.Portal.FileChooser
module Desktop.Portal.Notification
data OpenDirectoryOptions = OpenDirectoryOptions {
- fileSpec :: FileSpec
- parentWindow :: Maybe Text
- activationToken :: Maybe Text
}
data OpenURIOptions = OpenURIOptions {
- uri :: URI
- parentWindow :: Maybe Text
- writable :: Maybe Bool
- ask :: Maybe Bool
- activationToken :: Maybe Text
}
openURIOptions :: URI -> OpenURIOptions
openDirectoryOptions :: FileSpec -> OpenDirectoryOptions
openURI :: Client -> OpenURIOptions -> IO (Request ())
openDirectory :: Client -> OpenDirectoryOptions -> IO (Request ())
module Desktop.Portal.Secret

Connection Management

data Client Source #

A handle for an active desktop portal session. Can send requests and listen for signals.

Instances

Instances details

Show Client Source #
Instance details Defined in Desktop.Portal.Internal Methods showsPrec :: Int -> Client -> ShowS # show :: Client -> String # showList :: [Client] -> ShowS #
Eq Client Source #
Instance details Defined in Desktop.Portal.Internal Methods (==) :: Client -> Client -> Bool # (/=) :: Client -> Client -> Bool #

connect :: IO Client Source #

Open a new client connection. This can be used to send requests and listen for signals and finally can be closed using disconnect.

disconnect :: Client -> IO () Source #

clientName :: Client -> BusName Source #

Get the unique name given to the client by D-BUS.

Request Management

data Request a Source #

A portal request that may be in-progress, finished, or cancelled.

Instances

Instances details

Show (Request a) Source #
Instance details Defined in Desktop.Portal.Internal Methods showsPrec :: Int -> Request a -> ShowS # show :: Request a -> String # showList :: [Request a] -> ShowS #
Eq (Request a) Source #
Instance details Defined in Desktop.Portal.Internal Methods (==) :: Request a -> Request a -> Bool # (/=) :: Request a -> Request a -> Bool #

await :: Request a -> IO (Maybe a) Source #

Wait for a request to be finished, and return the result if it succeeded. If the request is cancelled, either by the user interface or by calling cancel, then Nothing will be returned.

cancel :: Request a -> IO () Source #

Cancel a request. This will cause any threads blocked on await to receive Nothing. Has no effect if the client is already cancelled or finished successfully.

Signal Management

data SignalHandler Source #

A listener for a particular signal. Can be cancelled with cancelSignalHandler.

cancelSignalHandler :: SignalHandler -> IO () Source #

Prevent any future invocations of the given signal handler.

Common Types

data FileSpec Source #

Specifies a file, either with a file descriptor or a path (which will be resolved to a file descriptor before passing it to the portals API, since the API typically requires file descriptors).

Constructors

FileSpecPath OsPath
FileSpecFd Fd

Instances

Instances details

Show FileSpec Source #
Instance details Defined in Desktop.Portal.Internal Methods showsPrec :: Int -> FileSpec -> ShowS # show :: FileSpec -> String # showList :: [FileSpec] -> ShowS #
Eq FileSpec Source #
Instance details Defined in Desktop.Portal.Internal Methods (==) :: FileSpec -> FileSpec -> Bool # (/=) :: FileSpec -> FileSpec -> Bool #

Portal Interfaces

module Desktop.Portal.Account

module Desktop.Portal.Camera

module Desktop.Portal.FileChooser

module Desktop.Portal.Notification

data OpenDirectoryOptions Source #

Constructors

OpenDirectoryOptions
Fields fileSpec :: FileSpec parentWindow :: Maybe Text activationToken :: Maybe Text

Instances

Instances details

Show OpenDirectoryOptions Source #
Instance details Defined in Desktop.Portal.OpenURI Methods showsPrec :: Int -> OpenDirectoryOptions -> ShowS # show :: OpenDirectoryOptions -> String # showList :: [OpenDirectoryOptions] -> ShowS #
Eq OpenDirectoryOptions Source #
Instance details Defined in Desktop.Portal.OpenURI Methods (==) :: OpenDirectoryOptions -> OpenDirectoryOptions -> Bool # (/=) :: OpenDirectoryOptions -> OpenDirectoryOptions -> Bool #

data OpenURIOptions Source #

Constructors

OpenURIOptions
Fields uri :: URI parentWindow :: Maybe Text writable :: Maybe Bool ask :: Maybe Bool activationToken :: Maybe Text

Instances

Instances details

Show OpenURIOptions Source #
Instance details Defined in Desktop.Portal.OpenURI Methods showsPrec :: Int -> OpenURIOptions -> ShowS # show :: OpenURIOptions -> String # showList :: [OpenURIOptions] -> ShowS #
Eq OpenURIOptions Source #
Instance details Defined in Desktop.Portal.OpenURI Methods (==) :: OpenURIOptions -> OpenURIOptions -> Bool # (/=) :: OpenURIOptions -> OpenURIOptions -> Bool #

openURIOptions Source #

Arguments

:: URI	The URI to open.
-> OpenURIOptions

openDirectoryOptions Source #

Arguments

:: FileSpec	The directory to open.
-> OpenDirectoryOptions

openURI :: Client -> OpenURIOptions -> IO (Request ()) Source #

openDirectory :: Client -> OpenDirectoryOptions -> IO (Request ()) Source #

module Desktop.Portal.Secret