mediawiki-0.2: Interfacing with the MediaWiki API Source code Contents Index

MediaWiki.API.Types Portability portable Stability provisional Maintainer Sigbjorn Finne <sof@forkIO.com>

Description

Basic MediaWiki API types

Documentation

type UserName = String Source

type NamespaceID = String Source

type TimeString = String Source

data Direction Source

Constructors Up Down Instances Eq Direction

type RevID = String Source

type PageName = String Source

type UserID = String Source

data TimeArrow Source

Constructors Earlier Later Instances Eq TimeArrow

type Timestamp = String Source

type Redirect = String Source

type SortKind = String Source

type CatName = String Source

type GroupName = String Source

type FilterLang = String Source

type WithRedirects = String Source

type URLString = String Source

type Token = String Source

type LangName = String Source

nullRevId :: RevID Source

nullTimestamp :: Timestamp Source

nullUser :: UserName Source

data PageTitle Source

Constructors PageTitle pgNS :: NamespaceID pgTitle :: Title pgMbId :: Maybe PageID pgMissing :: Bool

emptyPageTitle :: PageTitle Source

mainNamespace :: NamespaceID Source

ns_MAIN :: NamespaceID Source

ns_IMAGE :: NamespaceID Source

data Format Source

Constructors Format formatKind :: FormatKind formatFormatted :: Bool

emptyFormat :: Format Source

xmlFormat :: Format Source

data FormatKind Source

Constructors FormatJSON FormatPHP FormatWDDX FormatXML FormatYAML FormatTxt FormatDbg

type User = String Source

type Password = String Source

type LoginToken = String Source

type SessionID = String Source

type SessionToken = String Source

type ValueName = (String, String) Source

data UserInfo Source

Constructors UserInfo uiName :: UserName uiId :: UserID uiIsAnon :: Bool uiHasMessage :: Bool uiBlocked :: Maybe (UserName, String) uiGroups :: [String] uiRights :: [String] uiOptions :: [(String, String)] uiRateLimits :: [RateLimit] uiEditCount :: Maybe Int

emptyUserInfo :: UserInfo Source

data RateLimit Source

Constructors RateLimit rlName :: String rlHits :: Int rlSeconds :: Int

data NamespaceInfo Source

Constructors NamespaceInfo nsId :: String nsTitle :: String nsSubpages :: Bool

data InterwikiEntry Source

Constructors InterwikiEntry iwPrefix :: String iwLocal :: Bool iwTranscludable :: Maybe Bool iwUrl :: String iwLanguage :: Maybe String

data UserSession Source

Constructors UserSession sessUserId :: UserID sessUserName :: UserName sessPassword :: Maybe Password sessCookiePrefix :: Maybe String sessSessionId :: Maybe SessionID sessToken :: LoginToken

data HelpRequest Source

Constructors HelpRequest helpVersion :: Maybe Bool

type Title = String Source

type PageID = String Source

type RevisionID = String Source

newtype PropKind Source

Constructors PropKind prKind :: String

newtype MetaKind Source

Constructors MetaKind meKind :: String

newtype ListKind Source

Constructors ListKind liKind :: String

newtype GeneratorKind Source

Constructors GeneratorKind genKind :: String

class APIRequest a where Source

Methods showReq :: a -> [Maybe (String, String)] Source isPostable :: a -> Bool Source queryKind :: a -> QueryKind Source Instances APIRequest SiteInfoRequest APIRequest LoginRequest APIRequest AllLinksRequest APIRequest AllMessagesRequest APIRequest AllPagesRequest APIRequest AllUsersRequest APIRequest BackLinksRequest APIRequest BlocksRequest APIRequest CategoriesRequest APIRequest CategoryInfoRequest APIRequest AllCategoriesRequest APIRequest CategoryMembersRequest APIRequest DeletedRevisionsRequest APIRequest EmbeddedInRequest APIRequest ExternalLinksRequest APIRequest ExternalURLUsageRequest APIRequest ImageInfoRequest APIRequest AllImagesRequest APIRequest ImagesRequest APIRequest ImageUsageRequest APIRequest InfoRequest APIRequest LangLinksRequest APIRequest LogEventsRequest APIRequest RandomPagesRequest APIRequest RecentChangesRequest APIRequest RevisionRequest APIRequest SearchRequest APIRequest TemplatesRequest APIRequest UserContribsRequest APIRequest UserInfoRequest APIRequest UsersRequest APIRequest WatchListRequest APIRequest UnblockRequest APIRequest WatchRequest APIRequest EmailUserRequest APIRequest EditRequest APIRequest MoveRequest APIRequest BlockRequest APIRequest ProtectRequest APIRequest UndeleteRequest APIRequest DeleteRequest APIRequest RollbackRequest APIRequest LinksRequest

data QueryKind Source

Constructors QProp String QMeta String QList String QGen String Instances Eq QueryKind

data QueryRequest Source

Constructors QueryRequest quTitles :: [Title] quPageIds :: [PageID] quRevIds :: [RevisionID] quProps :: [PropKind] quLists :: [ListKind] quMetas :: [MetaKind] quGenerator :: Maybe GeneratorKind quFollowRedirects :: Maybe Bool quIndexPageIds :: Maybe Bool

emptyQuery :: QueryRequest Source

Produced by Haddock version 2.7.2