MediaWiki.API.Types

Basic MediaWiki API types

Documentation

type UserName = String

type NamespaceID = String

type TimeString = String

data Direction

Constructors

Up

Down

Instances

Eq Direction

type RevID = String

type PageName = String

type UserID = String

data TimeArrow

Constructors

Earlier

Later

Instances

Eq TimeArrow

type Timestamp = String

type Redirect = String

type SortKind = String

type CatName = String

type GroupName = String

type FilterLang = String

type WithRedirects = String

type URLString = String

type Token = String

type LangName = String

nullRevId :: RevID

nullTimestamp :: Timestamp

nullUser :: UserName

data PageTitle

Constructors

PageTitle

Fields

pgNS :: NamespaceID

pgTitle :: Title

pgMbId :: Maybe PageID

pgMissing :: Bool

emptyPageTitle :: PageTitle

mainNamespace :: NamespaceID

ns_MAIN :: NamespaceID

ns_IMAGE :: NamespaceID

data Format

Constructors

Format

Fields

formatKind :: FormatKind

formatFormatted :: Bool

emptyFormat :: Format

xmlFormat :: Format

data FormatKind

Constructors

FormatJSON

FormatPHP

FormatWDDX

FormatXML

FormatYAML

FormatTxt

FormatDbg

type User = String

type Password = String

type LoginToken = String

type SessionID = String

type SessionToken = String

type ValueName = (String, String)

data UserInfo

Constructors

UserInfo

Fields

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

data RateLimit

Constructors

RateLimit

Fields

rlName :: String

rlHits :: Int

rlSeconds :: Int

data NamespaceInfo

Constructors

NamespaceInfo

Fields

nsId :: String

nsTitle :: String

nsSubpages :: Bool

data InterwikiEntry

Constructors

InterwikiEntry

Fields

iwPrefix :: String

iwLocal :: Bool

iwTranscludable :: Maybe Bool

iwUrl :: String

iwLanguage :: Maybe String

data UserSession

Constructors

UserSession

Fields

sessUserId :: UserID

sessUserName :: UserName

sessPassword :: Maybe Password

sessCookiePrefix :: Maybe String

sessSessionId :: Maybe SessionID

sessToken :: LoginToken

data HelpRequest

Constructors

HelpRequest

Fields

helpVersion :: Maybe Bool

type Title = String

type PageID = String

type RevisionID = String

newtype PropKind

Constructors

PropKind

Fields

prKind :: String

newtype MetaKind

Constructors

MetaKind

Fields

meKind :: String

newtype ListKind

Constructors

ListKind

Fields

liKind :: String

newtype GeneratorKind

Constructors

GeneratorKind

Fields

genKind :: String

class APIRequest a where

Methods

showReq :: a -> [Maybe (String, String)]

isPostable :: a -> Bool

queryKind :: a -> QueryKind

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

Constructors

QProp String

QMeta String

QList String

QGen String

Instances

Eq QueryKind

data QueryRequest

Constructors

QueryRequest

Fields

quTitles :: [Title]

quPageIds :: [PageID]

quRevIds :: [RevisionID]

quProps :: [PropKind]

quLists :: [ListKind]

quMetas :: [MetaKind]

quGenerator :: Maybe GeneratorKind

quFollowRedirects :: Maybe Bool

quIndexPageIds :: Maybe Bool

emptyQuery :: QueryRequest