Web.Telegraph.API

The telegraph API. Every function that runs in MonadTelegraph might throw a TelegraphError.

Types

data AccountInfo

Constructors

AccountInfo

Fields

• shortName :: Text
• authorName :: Text
• authorUrl :: Text

Instances

Eq AccountInfo

Defined in Web.Telegraph.API

Methods

(==) :: AccountInfo -> AccountInfo -> Bool

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

Show AccountInfo

Defined in Web.Telegraph.API

Methods

showsPrec :: Int -> AccountInfo -> ShowS

show :: AccountInfo -> String

showList :: [AccountInfo] -> ShowS

Generic AccountInfo

Defined in Web.Telegraph.API

Associated Types

type Rep AccountInfo :: Type -> Type

Methods

from :: AccountInfo -> Rep AccountInfo x

to :: Rep AccountInfo x -> AccountInfo

ToJSON AccountInfo

Defined in Web.Telegraph.API

Methods

toJSON :: AccountInfo -> Value

toEncoding :: AccountInfo -> Encoding

toJSONList :: [AccountInfo] -> Value

toEncodingList :: [AccountInfo] -> Encoding

FromJSON AccountInfo

Defined in Web.Telegraph.API

Methods

parseJSON :: Value -> Parser AccountInfo

parseJSONList :: Value -> Parser [AccountInfo]

type Rep AccountInfo

Defined in Web.Telegraph.API

type Rep AccountInfo = D1 ('MetaData "AccountInfo" "Web.Telegraph.API" "telegraph-1.0.0-inplace" 'False) (C1 ('MetaCons "AccountInfo" 'PrefixI 'True) (S1 ('MetaSel ('Just "shortName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: (S1 ('MetaSel ('Just "authorName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "authorUrl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text))))

data TS

Telegraph state

Constructors

TS

Fields

• accessToken :: Text
• shortName :: Text
• authorName :: Text
• authorUrl :: Text

Instances

Eq TS

Defined in Control.Effect.Telegraph

Methods

(==) :: TS -> TS -> Bool

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

Show TS

Defined in Control.Effect.Telegraph

Methods

showsPrec :: Int -> TS -> ShowS

show :: TS -> String

showList :: [TS] -> ShowS

Generic TS

Defined in Control.Effect.Telegraph

Associated Types

type Rep TS :: Type -> Type

Methods

from :: TS -> Rep TS x

to :: Rep TS x -> TS

type Rep TS

Defined in Control.Effect.Telegraph

type Rep TS = D1 ('MetaData "TS" "Control.Effect.Telegraph" "telegraph-1.0.0-inplace" 'False) (C1 ('MetaCons "TS" 'PrefixI 'True) ((S1 ('MetaSel ('Just "accessToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "shortName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "authorName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "authorUrl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text))))

Effects

data Telegraph :: Effect where

Constructors

TakeTS :: Telegraph m TS

ReadTS :: Telegraph m TS

PutTS :: TS -> Telegraph m ()

Instances

Effs '[Embed IO, Reader (MVar TS)] m => Handler TelegraphH Telegraph m

Defined in Control.Effect.Telegraph

Methods

effHandler :: EffHandler Telegraph m

data Http :: Effect where

Constructors

HttpLbs :: Request -> Http m (Response ByteString)

GenBoundary :: Http m ByteString

Instances

Effs '[Embed IO, Reader Manager] m => Handler HttpH Http m

Defined in Control.Effect.Telegraph

Methods

effHandler :: EffHandler Http m

type Telegraph' = Bundle '[Telegraph, Http, Error HttpException]

type Http' = Bundle '[Http, Error HttpException]

Interpreters

runTelegraph :: (Effs '[Embed IO, Reader Manager, Error HttpException, Throw TelegraphError] m, Threaders '[ReaderThreads] m p) => Text -> TelegraphToIOC m a -> m a

runTelegraph' :: (Effs '[Embed IO, Reader Manager, Error HttpException, Throw TelegraphError] m, Threaders '[ReaderThreads] m p) => AccountInfo -> TelegraphToIOC m a -> m a

Error Interpreters

errorToIO' :: (Exception e, Eff (Embed IO) m, MonadCatch m) => ErrorToIOC e m a -> m (Either e a)

errorToErrorIO' :: (Exception e, Effs '[ErrorIO, Embed IO] m) => InterpretErrorC e m a -> m (Either e a)

errorToIOThrowing :: (Exception e, Eff (Embed IO) m, MonadCatch m) => ErrorToIOC e m a -> m a

errorToErrorIOThrowing :: (Exception e, Effs '[ErrorIO, Embed IO] m) => InterpretErrorC e m a -> m a

Account related APIs

editAccountInfo :: Effs '[Telegraph', Bracket, Throw TelegraphError] m => AccountInfo -> m ()

Use this method to update information about this Telegraph account

getAccountInfo :: Effs '[Telegraph', Throw TelegraphError] m => m Account

Use this method to get information about this Telegraph account

revokeAccessToken :: Effs '[Telegraph', Bracket, Error TelegraphError] m => m Account

Use this method to revoke access_token and generate a new one

createPage

Arguments

:: Effs '[Telegraph', Error TelegraphError] m

=> Text

title

-> [Node]

content

-> m Page

Use this method to create a new Telegraph page

editPage

Arguments

:: Effs '[Telegraph', Throw TelegraphError] m

=> Text

path

-> Text

title

-> [Node]

content

-> m Page

Use this method to edit an existing Telegraph page

getPageList

Arguments

:: Effs '[Telegraph', Throw TelegraphError] m

=> Int

offset

-> Int

limit (0 - 200)

-> m PageList

Use this method to get a list of pages belonging to this Telegraph account

Account independent APIs

createAccount :: Eff Http' m => AccountInfo -> m (Result Account)

Use this method to create a new Telegraph account

getAccountInfo' :: Eff Http' m => Text -> m (Result Account)

getPage :: Eff Http' m => Text -> m (Result Page)

Use this method to get a Telegraph page

getTotalViews :: Eff Http' m => Text -> m (Result PageViews)

Use this method to get the total number of views for a Telegraph article

Image uploading API

uploadImageFromFile :: Effs '[Telegraph', Bracket, Embed IO] m => FilePath -> m UploadResult

Upload a image from a filepath to Telegraph

uploadImageFromFiles :: Effs '[Telegraph', Bracket, Embed IO] m => [FilePath] -> m UploadResult

Upload a list of images to Telegraph. The resulting list of images will be in the same order

data ImgStream

Constructors

ImgStream

Fields

• name :: Text

  an image stream needs a filename

• stream :: forall i n. MonadIO n => ConduitT i ByteString n ()

uploadImageStreaming :: Eff Telegraph' m => ImgStream -> m UploadResult

Upload a image stream to Telegraph

uploadImagesStreaming :: Eff Telegraph' m => [ImgStream] -> m UploadResult

Upload a list of image streams to Telegraph. The resulting list of images

uploadParts :: Eff Telegraph' m => [PartM m] -> m UploadResult

Interpreter primitives

type TelegraphToIOC = CompositionC '[TelegraphC, ReaderC (MVar TS), HttpC]

type TelegraphC = InterpretC TelegraphH Telegraph

type HttpC = InterpretC HttpH Http

data TelegraphH

Instances

Effs '[Embed IO, Reader (MVar TS)] m => Handler TelegraphH Telegraph m

Defined in Control.Effect.Telegraph

Methods

effHandler :: EffHandler Telegraph m

data HttpH

Instances

Effs '[Embed IO, Reader Manager] m => Handler HttpH Http m

Defined in Control.Effect.Telegraph

Methods

effHandler :: EffHandler Http m

telegraph :: Effs '[Embed IO, Reader (MVar TS)] m => TelegraphC m a -> m a

http :: Effs '[Embed IO, Reader Manager] m => HttpC m a -> m a