Safe Haskell	Safe-Inferred
Language	Haskell2010

Desktop.Portal.Documents

Contents

Common Types
Documents Portal Methods

Synopsis

newtype ApplicationId = ApplicationId Text
newtype DocumentId = DocumentId Text
data AddFlag
data GrantPermission
- = GrantRead
- | GrantWrite
- | GrantGrantPermissions
- | GrantDelete
newtype ExtraResults = ExtraResults {
- mountpoint :: OsPath
}
getMountPoint :: Client -> IO OsPath
add :: Client -> FileSpec -> Bool -> Bool -> IO DocumentId
addFull :: Client -> [FileSpec] -> [AddFlag] -> Maybe ApplicationId -> [GrantPermission] -> IO ([DocumentId], ExtraResults)
addNamed :: Client -> FileSpec -> OsString -> Bool -> Bool -> IO DocumentId
addNamedFull :: Client -> FileSpec -> OsString -> [AddFlag] -> Maybe ApplicationId -> [GrantPermission] -> IO (DocumentId, ExtraResults)
grantPermissions :: Client -> DocumentId -> ApplicationId -> [GrantPermission] -> IO ()
revokePermissions :: Client -> DocumentId -> ApplicationId -> [GrantPermission] -> IO ()
delete :: Client -> DocumentId -> IO ()

Common Types

newtype ApplicationId Source #

Constructors

ApplicationId Text

Instances

Instances details

IsString ApplicationId Source #
Instance details Defined in Desktop.Portal.Documents Methods fromString :: String -> ApplicationId #
Show ApplicationId Source #
Instance details Defined in Desktop.Portal.Documents Methods showsPrec :: Int -> ApplicationId -> ShowS # show :: ApplicationId -> String # showList :: [ApplicationId] -> ShowS #
Eq ApplicationId Source #
Instance details Defined in Desktop.Portal.Documents Methods (==) :: ApplicationId -> ApplicationId -> Bool # (/=) :: ApplicationId -> ApplicationId -> Bool #
Ord ApplicationId Source #
Instance details Defined in Desktop.Portal.Documents Methods compare :: ApplicationId -> ApplicationId -> Ordering # (<) :: ApplicationId -> ApplicationId -> Bool # (<=) :: ApplicationId -> ApplicationId -> Bool # (>) :: ApplicationId -> ApplicationId -> Bool # (>=) :: ApplicationId -> ApplicationId -> Bool # max :: ApplicationId -> ApplicationId -> ApplicationId # min :: ApplicationId -> ApplicationId -> ApplicationId #

newtype DocumentId Source #

Constructors

DocumentId Text

Instances

Instances details

IsString DocumentId Source #
Instance details Defined in Desktop.Portal.Documents Methods fromString :: String -> DocumentId #
Show DocumentId Source #
Instance details Defined in Desktop.Portal.Documents Methods showsPrec :: Int -> DocumentId -> ShowS # show :: DocumentId -> String # showList :: [DocumentId] -> ShowS #
Eq DocumentId Source #
Instance details Defined in Desktop.Portal.Documents Methods (==) :: DocumentId -> DocumentId -> Bool # (/=) :: DocumentId -> DocumentId -> Bool #
Ord DocumentId Source #
Instance details Defined in Desktop.Portal.Documents Methods compare :: DocumentId -> DocumentId -> Ordering # (<) :: DocumentId -> DocumentId -> Bool # (<=) :: DocumentId -> DocumentId -> Bool # (>) :: DocumentId -> DocumentId -> Bool # (>=) :: DocumentId -> DocumentId -> Bool # max :: DocumentId -> DocumentId -> DocumentId # min :: DocumentId -> DocumentId -> DocumentId #

data AddFlag Source #

Constructors

AddReuseExisting
AddPersistent
AddAsNeededByApp
AddExportDirectory

Instances

Instances details

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

data GrantPermission Source #

Constructors

GrantRead
GrantWrite
GrantGrantPermissions
GrantDelete

Instances

Instances details

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

newtype ExtraResults Source #

Constructors

ExtraResults
Fields mountpoint :: OsPath

Instances

Instances details

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

Documents Portal Methods

getMountPoint :: Client -> IO OsPath Source #

add Source #

Arguments

:: Client
-> FileSpec	The file to add to the documents store.
-> Bool	Whether to re-use the existing entry in the documents store, if this file is already there.
-> Bool	Whether this file should stay in the documents store after this app shuts down.
-> IO DocumentId	The id (folder name) of the file in the store.

Add a file to the documents store, with basic configuration options.

addFull Source #

Arguments

:: Client
-> [FileSpec]	The files to add to the documents store.
-> [AddFlag]	The flags to apply to the files.
-> Maybe ApplicationId	The id of another application that will be granted access to the files.
-> [GrantPermission]	The permissions to grant to the other application.
-> IO ([DocumentId], ExtraResults)	The id (folder name) of each file in the store.

Add multiple files to the document store, with full configuration options.

addNamed Source #

Arguments

:: Client
-> FileSpec	The parent directory of the file to add to the documents store.
-> OsString	The basename of the file.
-> Bool	Whether to re-use the existing entry in the documents store, if this file is already there.
-> Bool	Whether this file should stay in the documents store after this app shuts down.
-> IO DocumentId	The id (folder name) of the file in the store.

Add a file to the document store with a specified name, with basic configuration options.

addNamedFull Source #

Arguments

:: Client
-> FileSpec	The parent directory of the file to add to the documents store.
-> OsString	The basename of the file.
-> [AddFlag]	The flags to apply to the file.
-> Maybe ApplicationId	The id of another application that will be granted access to the file.
-> [GrantPermission]	The permissions to grant to the other application.
-> IO (DocumentId, ExtraResults)	The id (folder name) of the file in the store.

Add a file to the document store with a specified name, with full configuration options.

grantPermissions :: Client -> DocumentId -> ApplicationId -> [GrantPermission] -> IO () Source #

revokePermissions :: Client -> DocumentId -> ApplicationId -> [GrantPermission] -> IO () Source #

delete :: Client -> DocumentId -> IO () Source #