Web.Lightning.Session

Contents

Description

Defines interactions with the session endpoint.

Synopsis

Session Functions

Arguments

:: Monad m
=> Maybe Text	An optional session name
-> LightningT m Session	Returns the LightningT transformer stack

Creates a new session with an optional name.

Session Types

Represents a lightning-viz session. A session ID is required to create a plot.

Constructors

Session
Fields snId :: Text The unique session ID snName :: Maybe Text The optional session name snUpdated :: Maybe Text The timestamp of when the session was last updated snCreated :: Maybe Text Creation timestamp

Instances

Eq Session Source #
Methods (==) :: Session -> Session -> Bool # (/=) :: Session -> Session -> Bool #
Read Session Source #
Methods readsPrec :: Int -> ReadS Session # readList :: ReadS [Session] # readPrec :: ReadPrec Session # readListPrec :: ReadPrec [Session] #
Show Session Source #
Methods showsPrec :: Int -> Session -> ShowS # show :: Session -> String # showList :: [Session] -> ShowS #
FromJSON Session Source #
Methods parseJSON :: Value -> Parser Session #
Receivable Session Source #
Methods receive :: ErrorReceivable e => Response ByteString -> Either (APIError e) Session #
Default Session Source #
Methods def :: Session #