Safe Haskell	Safe-Inferred
Language	Haskell98

Web.VKHS.Types

Synopsis

Documentation

type AccessToken = (String, String, String) Source

AccessToken is a authentication data, required by all VK API functions. It is a tuple of access_token, user_id, expires_in fields, returned by login procedure.

See http:/vk.comdevelopers.php?oid=-1&p=Авторизация_клиентских_приложений (in Russian) for more details

data AccessRight Source

Access rigth to request from VK.

Constructors

Notify
Friends
Photos
Audio
Video
Docs
Notes
Pages
Status
Offers
Questions
Wall
Groups
Messages
Notifications
Stats
Ads
Offline

Instances

Show AccessRight

allAccess :: [AccessRight] Source

data Verbosity Source

Verbosity level. Debug will dump *html and output curl log

Constructors

Normal
Trace
Debug

Instances

Enum Verbosity
Eq Verbosity
Ord Verbosity
Show Verbosity

type ClientId = String Source

data LoginEnv Source

Constructors

LoginEnv
Fields formdata :: [(String, String)] Dictionary containig forms input/value ac_rights :: [AccessRight] Access rights, required by later API calls clientId :: ClientId Application ID provided by vk.com

Instances

Show LoginEnv
Monad m => MonadReader (Env LoginEnv) (VKAPI m)

data CallEnv Source

Constructors

CallEnv
Fields access_token :: String Access token, the result of login operation

Instances

Show CallEnv

data Env subenv Source

VKHS environment

Constructors

Env
Fields sub :: subenv verbose :: Verbosity Verbosity level useragent :: String User agent identifier, defaults to Mozilla Firefox delay_ms :: Int Delay after each transaction, in milliseconds. Library uses it for preventing application from being banned for flooding.

Instances

Show subenv => Show (Env subenv)
Monad m => MonadReader (Env LoginEnv) (VKAPI m)

mkEnv :: s -> Env s Source

callEnv :: Env a -> String -> Env CallEnv Source