Web.Telegraph.API

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

Types

data Telegraph

Constructors

Telegraph

Fields

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

Instances

Eq Telegraph

Defined in Web.Telegraph.API

Methods

(==) :: Telegraph -> Telegraph -> Bool

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

Show Telegraph

Defined in Web.Telegraph.API

Methods

showsPrec :: Int -> Telegraph -> ShowS

show :: Telegraph -> String

showList :: [Telegraph] -> ShowS

Generic Telegraph

Defined in Web.Telegraph.API

Associated Types

type Rep Telegraph :: Type -> Type

Methods

from :: Telegraph -> Rep Telegraph x

to :: Rep Telegraph x -> Telegraph

type Rep Telegraph

Defined in Web.Telegraph.API

type Rep Telegraph = D1 ('MetaData "Telegraph" "Web.Telegraph.API" "telegraph-0.1.0-inplace" 'False) (C1 ('MetaCons "Telegraph" '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))))

class MonadThrow m => MonadTelegraph m where

Methods

takeTelegraph :: m Telegraph

readTelegraph :: m Telegraph

putTelegraph :: Telegraph -> m ()

Instances

(MonadTelegraph m, MonadTrans f, MonadThrow (f m)) => MonadTelegraph (f m)

Defined in Web.Telegraph.API

Methods

takeTelegraph :: f m Telegraph

readTelegraph :: f m Telegraph

putTelegraph :: Telegraph -> f m ()

(MonadThrow m, MonadIO m) => MonadTelegraph (TelegraphT m)

Defined in Web.Telegraph.API

Methods

takeTelegraph :: TelegraphT m Telegraph

readTelegraph :: TelegraphT m Telegraph

putTelegraph :: Telegraph -> TelegraphT m ()

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-0.1.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))))

Interpreting MonadTelegraph

newtype TelegraphT m a

Constructors

TelegraphT

Fields

• runTelegraphT :: ReaderT (MVar Telegraph) m a

Instances

MonadTrans TelegraphT

Defined in Web.Telegraph.API

Methods

lift :: Monad m => m a -> TelegraphT m a

MonadBase b m => MonadBase b (TelegraphT m)

Defined in Web.Telegraph.API

Methods

liftBase :: b α -> TelegraphT m α

MonadBaseControl b m => MonadBaseControl b (TelegraphT m)

Defined in Web.Telegraph.API

Associated Types

type StM (TelegraphT m) a

Methods

liftBaseWith :: (RunInBase (TelegraphT m) b -> b a) -> TelegraphT m a

restoreM :: StM (TelegraphT m) a -> TelegraphT m a

MonadReader r m => MonadReader r (TelegraphT m)

Defined in Web.Telegraph.API

Methods

ask :: TelegraphT m r

local :: (r -> r) -> TelegraphT m a -> TelegraphT m a

reader :: (r -> a) -> TelegraphT m a

Monad m => Monad (TelegraphT m)

Defined in Web.Telegraph.API

Methods

(>>=) :: TelegraphT m a -> (a -> TelegraphT m b) -> TelegraphT m b

(>>) :: TelegraphT m a -> TelegraphT m b -> TelegraphT m b

return :: a -> TelegraphT m a

Functor m => Functor (TelegraphT m)

Defined in Web.Telegraph.API

Methods

fmap :: (a -> b) -> TelegraphT m a -> TelegraphT m b

(<$) :: a -> TelegraphT m b -> TelegraphT m a

Applicative m => Applicative (TelegraphT m)

Defined in Web.Telegraph.API

Methods

pure :: a -> TelegraphT m a

(<*>) :: TelegraphT m (a -> b) -> TelegraphT m a -> TelegraphT m b

liftA2 :: (a -> b -> c) -> TelegraphT m a -> TelegraphT m b -> TelegraphT m c

(*>) :: TelegraphT m a -> TelegraphT m b -> TelegraphT m b

(<*) :: TelegraphT m a -> TelegraphT m b -> TelegraphT m a

MonadIO m => MonadIO (TelegraphT m)

Defined in Web.Telegraph.API

Methods

liftIO :: IO a -> TelegraphT m a

MonadThrow m => MonadThrow (TelegraphT m)

Defined in Web.Telegraph.API

Methods

throwM :: Exception e => e -> TelegraphT m a

MonadCatch m => MonadCatch (TelegraphT m)

Defined in Web.Telegraph.API

Methods

catch :: Exception e => TelegraphT m a -> (e -> TelegraphT m a) -> TelegraphT m a

MonadMask m => MonadMask (TelegraphT m)

Defined in Web.Telegraph.API

Methods

mask :: ((forall a. TelegraphT m a -> TelegraphT m a) -> TelegraphT m b) -> TelegraphT m b

uninterruptibleMask :: ((forall a. TelegraphT m a -> TelegraphT m a) -> TelegraphT m b) -> TelegraphT m b

generalBracket :: TelegraphT m a -> (a -> ExitCase b -> TelegraphT m c) -> (a -> TelegraphT m b) -> TelegraphT m (b, c)

(MonadThrow m, MonadIO m) => MonadTelegraph (TelegraphT m)

Defined in Web.Telegraph.API

Methods

takeTelegraph :: TelegraphT m Telegraph

readTelegraph :: TelegraphT m Telegraph

putTelegraph :: Telegraph -> TelegraphT m ()

type StM (TelegraphT m) a

Defined in Web.Telegraph.API

type StM (TelegraphT m) a = StM (ReaderT (MVar Telegraph) m) a

runTelegraph :: HasHttpCap env m => Text -> TelegraphT m a -> m a

interprets TelegraphT using the access token of an existing account

runTelegraph' :: HasHttpCap env m => AccountInfo -> TelegraphT m a -> m a

Create a new account and interprets TelegraphT using that account

Type Synonyms

type HasHttpCap env m = (MonadIO m, HasHttpManager env, MonadReader env m)

Account related APIs

editAccountInfo :: (HasHttpCap env m, MonadTelegraph m, MonadMask m) => AccountInfo -> m ()

Use this method to update information about this Telegraph account

getAccountInfo :: (HasHttpCap env m, MonadTelegraph m) => m Account

Use this method to get information about this Telegraph account

revokeAccessToken :: (HasHttpCap env m, MonadTelegraph m, MonadMask m) => m Account

Use this method to revoke access_token and generate a new one

createPage

Arguments

:: (HasHttpCap env m, MonadTelegraph m)

=> Text

title

-> [Node]

content

-> m Page

Use this method to create a new Telegraph page

editPage

Arguments

:: (HasHttpCap env m, MonadTelegraph m)

=> Text

path

-> Text

title

-> [Node]

content

-> m Page

Use this method to edit an existing Telegraph page

getPageList

Arguments

:: (HasHttpCap env m, MonadTelegraph 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 :: HasHttpCap env m => AccountInfo -> m (Result Account)

Use this method to create a new Telegraph account

getAccountInfo' :: HasHttpCap env m => Text -> m (Result Account)

getPage :: HasHttpCap env m => Text -> m (Result Page)

Use this method to get a Telegraph page

getTotalViews :: HasHttpCap env m => Text -> m (Result PageViews)

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

Image uploading API

uploadImageFromFile :: (HasHttpCap env m, MonadMask m) => FilePath -> m UploadResult

Upload a image from a filepath to Telegraph

uploadImageFromFiles :: (HasHttpCap env m, MonadMask 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 :: HasHttpCap env m => ImgStream -> m UploadResult

Upload a image stream to Telegraph

uploadImagesStreaming :: HasHttpCap env m => [ImgStream] -> m UploadResult

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

uploadParts :: HasHttpCap env m => [PartM m] -> m UploadResult