Desktop.Portal

Wrappers around the XDG Desktop Portal D-BUS API.

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

Connection Management

data Client

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

Instances

Show Client

Defined in Desktop.Portal.Internal

Methods

showsPrec :: Int -> Client -> ShowS

show :: Client -> String

showList :: [Client] -> ShowS

Eq Client

Defined in Desktop.Portal.Internal

Methods

(==) :: Client -> Client -> Bool

(/=) :: Client -> Client -> Bool

connect :: IO Client

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 ()

clientName :: Client -> BusName

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

Request Management

data Request a

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

Instances

Show (Request a)

Defined in Desktop.Portal.Internal

Methods

showsPrec :: Int -> Request a -> ShowS

show :: Request a -> String

showList :: [Request a] -> ShowS

Eq (Request a)

Defined in Desktop.Portal.Internal

Methods

(==) :: Request a -> Request a -> Bool

(/=) :: Request a -> Request a -> Bool

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

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 ()

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

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

cancelSignalHandler :: SignalHandler -> IO ()

Prevent any future invocations of the given signal handler.

Common Types

data FileSpec

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

Show FileSpec

Defined in Desktop.Portal.Internal

Methods

showsPrec :: Int -> FileSpec -> ShowS

show :: FileSpec -> String

showList :: [FileSpec] -> ShowS

Eq FileSpec

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 OpenURIOptions

Constructors

OpenURIOptions

Fields

• uri :: URI
• parentWindow :: Maybe Text
• writable :: Maybe Bool
• ask :: Maybe Bool
• activationToken :: Maybe Text

Instances

Show OpenURIOptions

Defined in Desktop.Portal.OpenURI

Methods

showsPrec :: Int -> OpenURIOptions -> ShowS

show :: OpenURIOptions -> String

showList :: [OpenURIOptions] -> ShowS

Eq OpenURIOptions

Defined in Desktop.Portal.OpenURI

Methods

(==) :: OpenURIOptions -> OpenURIOptions -> Bool

(/=) :: OpenURIOptions -> OpenURIOptions -> Bool

data OpenDirectoryOptions

Constructors

OpenDirectoryOptions

Fields

• fileSpec :: FileSpec
• parentWindow :: Maybe Text
• activationToken :: Maybe Text

Instances

Show OpenDirectoryOptions

Defined in Desktop.Portal.OpenURI

Methods

showsPrec :: Int -> OpenDirectoryOptions -> ShowS

show :: OpenDirectoryOptions -> String

showList :: [OpenDirectoryOptions] -> ShowS

Eq OpenDirectoryOptions

Defined in Desktop.Portal.OpenURI

Methods

(==) :: OpenDirectoryOptions -> OpenDirectoryOptions -> Bool

(/=) :: OpenDirectoryOptions -> OpenDirectoryOptions -> Bool

openURIOptions

Arguments

:: URI

The URI to open.

-> OpenURIOptions

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

openDirectoryOptions

Arguments

:: FileSpec

The directory to open.

-> OpenDirectoryOptions

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

module Desktop.Portal.Secret