Safe Haskell	None
Language	Haskell2010

MatrixBot.Options

Contents

Commands, options, and their specs
Authorization
Bot start
Send message command options
Edit existing message command options
Re-usable parsers
Parsing command-line arguments

Description

Application’s command-line interface

Synopsis

data AppCommand
appCommandParserInfo :: ParserInfo AppCommand
appCommandParser :: Parser AppCommand
data AuthOptions = AuthOptions {
- authOptionsMxid :: Mxid
- authOptionsPassword :: Either Password FilePath
- authOptionsOutputFile :: FilePath
- authOptionsLogLevel :: Maybe LogLevel
}
authOptionsParser :: Parser AuthOptions
data StartOptions = StartOptions {
- startOptionsCredentialsFile :: FilePath
- startOptionsBotConfigFile :: FilePath
- startOptionsRetryLimit :: RetryLimit
- startOptionsRetryDelay :: RetryDelay
- startOptionsEventTokenFile :: Maybe FilePath
- startOptionsEventsTimeout :: EventsTimeout
- startOptionsLogLevel :: Maybe LogLevel
}
startOptionsParser :: Parser StartOptions
data SendMessageOptions = SendMessageOptions {
- sendMessageOptionsCredentialsFile :: FilePath
- sendMessageOptionsRoomId :: RoomId
- sendMessageOptionsReplyTo :: Maybe EventId
- sendMessageOptionsMessage :: Either Text FilePath
- sendMessageOptionsHtmlMessage :: Maybe (Either Text FilePath)
- sendMessageOptionsTransactionId :: Maybe TransactionId
- sendMessageOptionsLogLevel :: Maybe LogLevel
}
sendMessageOptionsParser :: Parser SendMessageOptions
data EditMessageOptions = EditMessageOptions {
- editMessageOptionsCredentialsFile :: FilePath
- editMessageOptionsRoomId :: RoomId
- editMessageOptionsMessageId :: EventId
- editMessageOptionsReplyTo :: Maybe EventId
- editMessageOptionsMessage :: Either Text FilePath
- editMessageOptionsHtmlMessage :: Maybe (Either Text FilePath)
- editMessageOptionsMessageCompat :: Maybe (Either Text FilePath)
- editMessageOptionsHtmlMessageCompat :: Maybe (Either Text FilePath)
- editMessageOptionsTransactionId :: Maybe TransactionId
- editMessageOptionsLogLevel :: Maybe LogLevel
}
editMessageOptionsParser :: Parser EditMessageOptions
credentialsFile :: Parser FilePath
roomId :: Parser RoomId
transactionId :: Parser (Maybe TransactionId)
logLevel :: Parser (Maybe LogLevel)
parseAppCommand :: MonadIO m => m AppCommand

Commands, options, and their specs

data AppCommand Source #

Constructors

AppCommandAuth AuthOptions
AppCommandStart StartOptions
AppCommandSendMessage SendMessageOptions
AppCommandEditMessage EditMessageOptions

appCommandParserInfo :: ParserInfo AppCommand Source #

appCommandParser :: Parser AppCommand Source #

Authorization

data AuthOptions Source #

Constructors

AuthOptions
Fields authOptionsMxid :: Mxid Where to save credentials JSON output to (can be `devstdout`) authOptionsPassword :: Either Password FilePath Either file to read the password from (can be `devstdin`) or the password as-is authOptionsOutputFile :: FilePath authOptionsLogLevel :: Maybe LogLevel

Instances

Instances details

Show AuthOptions Source #
Instance details Defined in MatrixBot.Options Methods showsPrec :: Int -> AuthOptions -> ShowS show :: AuthOptions -> String showList :: [AuthOptions] -> ShowS
Eq AuthOptions Source #
Instance details Defined in MatrixBot.Options Methods (==) :: AuthOptions -> AuthOptions -> Bool (/=) :: AuthOptions -> AuthOptions -> Bool

authOptionsParser :: Parser AuthOptions Source #

Bot start

data StartOptions Source #

Constructors

StartOptions

Fields

startOptionsCredentialsFile :: FilePath
Path to the file with credentials obtained via calling “auth” command
startOptionsBotConfigFile :: FilePath
Bot configuration JSON file
startOptionsRetryLimit :: RetryLimit
In case of Matrix API request exception how many times to retry before bot dies
startOptionsRetryDelay :: RetryDelay
In case of Matrix API request exception how long to wait before each retry
startOptionsEventTokenFile :: Maybe FilePath
Path to a JSON file that contains last event token to start listening events from (when application starts it reads from this file, when it receives new events it writes to it)
startOptionsEventsTimeout :: EventsTimeout
startOptionsLogLevel :: Maybe LogLevel

Instances

Instances details

Show StartOptions Source #
Instance details Defined in MatrixBot.Options Methods showsPrec :: Int -> StartOptions -> ShowS show :: StartOptions -> String showList :: [StartOptions] -> ShowS
Eq StartOptions Source #
Instance details Defined in MatrixBot.Options Methods (==) :: StartOptions -> StartOptions -> Bool (/=) :: StartOptions -> StartOptions -> Bool

startOptionsParser :: Parser StartOptions Source #

Send message command options

data SendMessageOptions Source #

Constructors

SendMessageOptions

Fields

sendMessageOptionsCredentialsFile :: FilePath
sendMessageOptionsRoomId :: RoomId
sendMessageOptionsReplyTo :: Maybe EventId
Optionaly make the message a reply to a specified event
sendMessageOptionsMessage :: Either Text FilePath
Message body either as plain value or a file to read it from (e.g. devstdin)
sendMessageOptionsHtmlMessage :: Maybe (Either Text FilePath)
Optional HTML-formatted message body in addition to the plain text one
sendMessageOptionsTransactionId :: Maybe TransactionId
sendMessageOptionsLogLevel :: Maybe LogLevel

Instances

Instances details

Show SendMessageOptions Source #
Instance details Defined in MatrixBot.Options Methods showsPrec :: Int -> SendMessageOptions -> ShowS show :: SendMessageOptions -> String showList :: [SendMessageOptions] -> ShowS
Eq SendMessageOptions Source #
Instance details Defined in MatrixBot.Options Methods (==) :: SendMessageOptions -> SendMessageOptions -> Bool (/=) :: SendMessageOptions -> SendMessageOptions -> Bool

sendMessageOptionsParser :: Parser SendMessageOptions Source #

Edit existing message command options

data EditMessageOptions Source #

Constructors

EditMessageOptions

Fields

editMessageOptionsCredentialsFile :: FilePath
editMessageOptionsRoomId :: RoomId
editMessageOptionsMessageId :: EventId
Original message event that we are editing
editMessageOptionsReplyTo :: Maybe EventId
Optionaly make the message a reply to a specified event
editMessageOptionsMessage :: Either Text FilePath
New message body either as a plain value or a file to read it from (e.g. devstdin)
editMessageOptionsHtmlMessage :: Maybe (Either Text FilePath)
Optional new HTML-formatted message body in addition to the plain text one
editMessageOptionsMessageCompat :: Maybe (Either Text FilePath)
Old API compatibility new message body (default template is used if not specified)
editMessageOptionsHtmlMessageCompat :: Maybe (Either Text FilePath)
Old API compatibility new HTML-formatted message body (default template is used if not specified)
editMessageOptionsTransactionId :: Maybe TransactionId
editMessageOptionsLogLevel :: Maybe LogLevel

Instances

Instances details

Show EditMessageOptions Source #
Instance details Defined in MatrixBot.Options Methods showsPrec :: Int -> EditMessageOptions -> ShowS show :: EditMessageOptions -> String showList :: [EditMessageOptions] -> ShowS
Eq EditMessageOptions Source #
Instance details Defined in MatrixBot.Options Methods (==) :: EditMessageOptions -> EditMessageOptions -> Bool (/=) :: EditMessageOptions -> EditMessageOptions -> Bool

editMessageOptionsParser :: Parser EditMessageOptions Source #

Re-usable parsers

credentialsFile :: Parser FilePath Source #

roomId :: Parser RoomId Source #

transactionId :: Parser (Maybe TransactionId) Source #

logLevel :: Parser (Maybe LogLevel) Source #

Parsing command-line arguments

parseAppCommand :: MonadIO m => m AppCommand Source #