Safe Haskell	None
Language	Haskell98

Web.VKHS.Types

Synopsis

Documentation

data AccessToken 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.com/developers.php?oid=-1&p=Авторизация_клиентских_приложений (in Russian) for more details

See also modifyAccessToken and readInitialAccessToken

Constructors

AccessToken
Fields at_access_token :: String at_user_id :: String at_expires_in :: String

Instances

Eq AccessToken Source #
Methods (==) :: AccessToken -> AccessToken -> Bool # (/=) :: AccessToken -> AccessToken -> Bool #
Ord AccessToken Source #
Methods compare :: AccessToken -> AccessToken -> Ordering # (<) :: AccessToken -> AccessToken -> Bool # (<=) :: AccessToken -> AccessToken -> Bool # (>) :: AccessToken -> AccessToken -> Bool # (>=) :: AccessToken -> AccessToken -> Bool # max :: AccessToken -> AccessToken -> AccessToken # min :: AccessToken -> AccessToken -> AccessToken #
Read AccessToken Source #
Methods readsPrec :: Int -> ReadS AccessToken # readList :: ReadS [AccessToken] # readPrec :: ReadPrec AccessToken # readListPrec :: ReadPrec [AccessToken] #
Show AccessToken Source #
Methods showsPrec :: Int -> AccessToken -> ShowS # show :: AccessToken -> String # showList :: [AccessToken] -> ShowS #

data AccessRight Source #

Access rigth to request from VK. See API docs http://vk.com/developers.php?oid=-1&p=Права_доступа_приложений (in Russian) for details

Constructors

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

Instances

Enum AccessRight Source #
Methods succ :: AccessRight -> AccessRight # pred :: AccessRight -> AccessRight # toEnum :: Int -> AccessRight # fromEnum :: AccessRight -> Int # enumFrom :: AccessRight -> [AccessRight] # enumFromThen :: AccessRight -> AccessRight -> [AccessRight] # enumFromTo :: AccessRight -> AccessRight -> [AccessRight] # enumFromThenTo :: AccessRight -> AccessRight -> AccessRight -> [AccessRight] #
Eq AccessRight Source #
Methods (==) :: AccessRight -> AccessRight -> Bool # (/=) :: AccessRight -> AccessRight -> Bool #
Ord AccessRight Source #
Methods compare :: AccessRight -> AccessRight -> Ordering # (<) :: AccessRight -> AccessRight -> Bool # (<=) :: AccessRight -> AccessRight -> Bool # (>) :: AccessRight -> AccessRight -> Bool # (>=) :: AccessRight -> AccessRight -> Bool # max :: AccessRight -> AccessRight -> AccessRight # min :: AccessRight -> AccessRight -> AccessRight #
Show AccessRight Source #
Methods showsPrec :: Int -> AccessRight -> ShowS # show :: AccessRight -> String # showList :: [AccessRight] -> ShowS #

toUrlArg :: [AccessRight] -> String Source #

allAccess :: [AccessRight] Source #

newtype AppID Source #

Constructors

AppID
Fields aid_string :: String

Instances

Eq AppID Source #
Methods (==) :: AppID -> AppID -> Bool # (/=) :: AppID -> AppID -> Bool #
Ord AppID Source #
Methods compare :: AppID -> AppID -> Ordering # (<) :: AppID -> AppID -> Bool # (<=) :: AppID -> AppID -> Bool # (>) :: AppID -> AppID -> Bool # (>=) :: AppID -> AppID -> Bool # max :: AppID -> AppID -> AppID # min :: AppID -> AppID -> AppID #
Show AppID Source #
Methods showsPrec :: Int -> AppID -> ShowS # show :: AppID -> String # showList :: [AppID] -> ShowS #

data JSON Source #

Constructors

JSON
Fields js_aeson :: Value

Instances

Data JSON Source #
Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> JSON -> c JSON # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c JSON # toConstr :: JSON -> Constr # dataTypeOf :: JSON -> DataType # dataCast1 :: Typeable (* -> ) t => (forall d. Data d => c (t d)) -> Maybe (c JSON) # dataCast2 :: Typeable ( -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c JSON) # gmapT :: (forall b. Data b => b -> b) -> JSON -> JSON # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> JSON -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> JSON -> r # gmapQ :: (forall d. Data d => d -> u) -> JSON -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> JSON -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> JSON -> m JSON # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> JSON -> m JSON # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> JSON -> m JSON #
Show JSON Source #
Methods showsPrec :: Int -> JSON -> ShowS # show :: JSON -> String # showList :: [JSON] -> ShowS #

parseJSON :: FromJSON a => JSON -> Either String a Source #

data Form Source #

Constructors

Form
Fields form_title :: String form :: Form

Instances

Show Form Source #
Methods showsPrec :: Int -> Form -> ShowS # show :: Form -> String # showList :: [Form] -> ShowS #

data FilledForm Source #

Constructors

FilledForm
Fields fform_title :: String fform :: Form

Instances

Show FilledForm Source #
Methods showsPrec :: Int -> FilledForm -> ShowS # show :: FilledForm -> String # showList :: [FilledForm] -> ShowS #

data GenericOptions Source #

Generic parameters of the VK execution. For accessing from VK runtime, use getGenericOptions function

Constructors

GenericOptions

Fields

o_login_host :: String
o_api_host :: String
o_port :: Int
o_verbose :: Bool
o_use_https :: Bool
o_max_request_rate_per_sec :: Rational
How many requests per second is allowed
o_allow_interactive :: Bool
l_appid :: AppID
l_username :: String
VK user name, (typically, an email). Empty string means no value is given
l_password :: String
VK password. Empty string means no value is given * FIXME Hide plain-text passwords
l_access_token :: String
Initial access token, empty means 'not set'. Has higher precedence than l_access_token_file
l_access_token_file :: FilePath
Filename to store actual access token, should be used to pass its value between sessions

Instances

Show GenericOptions Source #
Methods showsPrec :: Int -> GenericOptions -> ShowS # show :: GenericOptions -> String # showList :: [GenericOptions] -> ShowS #

defaultOptions :: GenericOptions Source #

class ToGenericOptions s where Source #

Minimal complete definition

toGenericOptions

Methods

toGenericOptions :: s -> GenericOptions Source #

Instances

ToGenericOptions State Source #
Methods toGenericOptions :: State -> GenericOptions Source #

data Verbosity Source #

Constructors

Normal
Trace
Debug

Instances

Enum Verbosity Source #
Methods succ :: Verbosity -> Verbosity # pred :: Verbosity -> Verbosity # toEnum :: Int -> Verbosity # fromEnum :: Verbosity -> Int # enumFrom :: Verbosity -> [Verbosity] # enumFromThen :: Verbosity -> Verbosity -> [Verbosity] # enumFromTo :: Verbosity -> Verbosity -> [Verbosity] # enumFromThenTo :: Verbosity -> Verbosity -> Verbosity -> [Verbosity] #
Eq Verbosity Source #
Methods (==) :: Verbosity -> Verbosity -> Bool # (/=) :: Verbosity -> Verbosity -> Bool #
Ord Verbosity Source #
Methods compare :: Verbosity -> Verbosity -> Ordering # (<) :: Verbosity -> Verbosity -> Bool # (<=) :: Verbosity -> Verbosity -> Bool # (>) :: Verbosity -> Verbosity -> Bool # (>=) :: Verbosity -> Verbosity -> Bool # max :: Verbosity -> Verbosity -> Verbosity # min :: Verbosity -> Verbosity -> Verbosity #
Show Verbosity Source #
Methods showsPrec :: Int -> Verbosity -> ShowS # show :: Verbosity -> String # showList :: [Verbosity] -> ShowS #

debug :: (ToGenericOptions s, MonadState s m, MonadIO m) => Text -> m () Source #

alert :: (ToGenericOptions s, MonadState s m, MonadIO m) => Text -> m () Source #

data MusicOptions Source #

Constructors

MusicOptions
Fields m_list_music :: Bool m_search_string :: String m_name_format :: String m_output_format :: String m_out_dir :: Maybe String m_records_id :: [String] m_skip_existing :: Bool

Instances

Show MusicOptions Source #
Methods showsPrec :: Int -> MusicOptions -> ShowS # show :: MusicOptions -> String # showList :: [MusicOptions] -> ShowS #

data UserOptions Source #

Constructors

UserOptions
Fields u_queryString :: String

Instances

Show UserOptions Source #
Methods showsPrec :: Int -> UserOptions -> ShowS # show :: UserOptions -> String # showList :: [UserOptions] -> ShowS #

data WallOptions Source #

Constructors

WallOptions
Fields w_woid :: String

Instances

Show WallOptions Source #
Methods showsPrec :: Int -> WallOptions -> ShowS # show :: WallOptions -> String # showList :: [WallOptions] -> ShowS #

data GroupOptions Source #

Constructors

GroupOptions
Fields g_search_string :: String g_output_format :: String

Instances

Show GroupOptions Source #
Methods showsPrec :: Int -> GroupOptions -> ShowS # show :: GroupOptions -> String # showList :: [GroupOptions] -> ShowS #

type MethodName = String Source #

type MethodArgs = [(String, Text)] Source #