Участник:VasilievVV/WikiAccess/Doc

Пространство имён WikiTools.Access

Класс AccessBrowser

Служит для доступа к HTML вики.

Свойства

• String PageName — текущая страница
• String PageText — текст текущей страницы
• WebBrowser WebBrowser — веб-браузер, который используется классом

Методы

• Boolean IsLoggedIn() — проверяет, залогинен ли текущий пользователь
• Boolean SetTextboxField(String name, String value) — устанавливает значение текстового поля
• String GetTextboxField(String name) — получает значение текстового поля
• Boolean SetCheckbox(String name, Boolean value) — устанавливает значение флажка
• Boolean ClickButton(String name) — кликает по кнопке
• Void Wait() — ожидает завершения текущего перехода
• String EncodeUrl(String str) — кодирует строку в формате URI
• String DownloadPage(String pgname) — загружает страницу через WebRequest
• Byte[] DownloadBinary(String pgname) — загружает бинарный файл
• Void Dispose() — деструктор
• DateTime ParseAPITimestamp(String p) — переводит временные метки API в DateTime
• Void Update() — обновляет текущую страницу

Класс Category

Свойства

• String[] Subcategories - подкатегории данной категории
• String[] Pages - страницы в данной категории
• Page CategoryPage - страница данной категории
• Boolean HasCategoryPage - имеет ли данная категория страницу-описание

Методы

• Void Load() - загружает содержимое категории. Автоматически вызывается про обращении к свойствам Subcategories и Pages
• String[] GetPagesRecursive() - получает страницы из категории и всех подкатегорий. Используйте GetPagesRecursive(false) для того, чтобы не удалять дубликаты из списка.

Класс Image

Методы

• Byte[] Download() — загружает изображение из MediaWiki. Требуется расширение Filepath.
• String CalculateMD5Hash(Byte[] img) — статический метод, который вычисляет MD5-хэш (с помощью .NET) и приводит его в строковую форму.

Класс MessageCache

Свойства

• String[] Months
• String[] MonthsGen
• String MonthRegex

Методы

• String MkName(String uri)
• Boolean SaveToFile(String fname)
• String GetMessage(String name)

Класс Namespaces

Методы

• SortedList<int, string> GetStandardNamespaces() — выдаёт список стандартных пространств имён
• Int32 GetNamespaceID(String nsName) — определяет ID пространства имён по его имени
• Int32 GetNamespaceByTitle(String title) — определяет ID пространства имён по названию статьи
• String GetNamespaceByID(Int32 ID) — возвращает имя пространства имён по его ID
• String TitleToTalk(String title) — преобразует название страницы в название её обсуждения
• String TitleFromTalk(String title) — преобразовывает название страницы обсуждение в названия основной страницы
• Boolean IsTalkNamespace(String title) — проверяет, является ли указанная страница обсуждением
• String RemoveNamespace(String pgname) — удаляет префикс пространства имён из названия страницы

Константы с номерами пространств имён

• Media
• Special
• Main
• Talk
• User
• UserTalk
• Project
• ProjectTalk
• Image
• ImageTalk
• MediaWiki
• MediaWikiTalk
• Template
• TemplateTalk
• Help
• HelpTalk
• Category
• CategoryTalk

Класс Page

Свойства

• String Text
• String[] Categories
• String RedirectsOn
• Revision[] History
• String[] InternalLinks
• String[] ExternalLinks
• String[] Subpages
• String[] Templates
• String[] Images
• Int32 PageID
• String PageName
• DateTime LastEditDateTime
• Int32 PageRevisionID
• Boolean IsRedirect
• Boolean Exists
• Int32 NamespaceID
• String NamespeceName
• Boolean IsTalkPage
• Page TalkPage

Методы

• Void LoadText()
• Void LoadInfo()
• Void LoadRedirectsOn()
• Void LoadInternalLinks()
• Void LoadExternalLinks()
• Void LoadTemplates()
• Void LoadImages()
• Void LoadHistory()
• Void LoadCategories()
• Void LoadSubpages()
• Void SetText(String newText, String summary, Boolean minor)
• Void SetText(String newText, String summary)
• Void SetText(String newText)
• Void SetText(String newText, String summary, Boolean minor, Boolean watch)
• Void LoadTextWritePrepared()
• Void Delete(String reason)
• Void Rename(String NewName, String Reason)
• Void Purge()
• Void BypassRedirect()
• Void Watch()
• Void Unwatch()

Класс PageList

Свойства

• String[] Pages

Методы

• Int32 Filter<T>(ParametrizedPageListFilter`1 plf, T param)
• PageList FromCategory(Wiki wiki, String catname, Boolean includeSubCategories)
• PageList FromLinksOnPage(Wiki wiki, String pagename)
• PageList FromWatchlist(Wiki wiki)
• PageList FromAllPages(Wiki wiki, String startfrom, Int32 limit, PageTypes filter, Int32 namespaceID)
• Int32 AllTitlesToTalk()
• Void RemoveDuplicates()
• Int32 AllTitlesFromTalk()
• Int32 Filter(PageListFilter plf)
• Int32 FilterAllowedNamespaces(Int32[] allowedNS)
• Int32 FilterDisallowedNamespaces(Int32[] disallowedNS)
• Object Clone()

Делегат PageListFilter

Служит для фильтрации страниц.

Синтаксис: Boolean PageListFilter(Page page)

Делегат ParametrizedPageListFilter<T>

Служит для фильтрации страниц. Имеет специальный параметр, который вы можете передать в функцию. Синтаксис: Boolean ParametrizedPageListFilter<T>(Page page, T param)

Перечисление PageTypes

Возможные значения:

• All
• Redirects
• NonRedirects

Структруа Revision

Методы

• String GetContent(Wiki w)

Поля

• Page
• ID
• Time
• Author
• Minor
• Comment

Структруа Statistics

Поля

• TotalPages
• GoodPages
• Views
• Edits
• Users
• Admins
• Images
• Jobs

Класс User

Свойства

• String[] Rights

Методы

• Void LoadRights()
• Boolean HasRight(String right)
• String[] GetAvailableFlags(Wiki wiki)
• Void Rename(String newname, Boolean movepages)
• Void GrantBotFlag(String comment)
• Void RevokeBotFlag(String comment)
• Void SendEmail(String subject, String text)

Класс Utils

Свойства

• Version Version

Методы

• List`1 RemoveDuplicates<T>(List`1 list)
• T[] RemoveDuplicates<T>(T[] list)
• Boolean ArrayContains<T>(T[] array, T value)
• Void Swap<T>(T& arg1, T& arg2)
• Boolean ContainsAttribure(XmlElement elem, String attrname)
• String[] RemoveDuplicates(String[] array)
• String FormatDateTimeRFC2822(DateTime dt)
• String[] AddPrefix(String[] orig, String prefix)
• Void DoEvents()
• Void Wait(TimeSpan ts)

Класс WatchList

Свойства

• String[] Pages

Методы

• Void LoadPages()
• Void Add(String page)
• Void Remove(String page)

Класс Wiki

Свойства

• String WikiURI
• WikiCapabilities Capabilities
• String[] UserFlags
• Namespaces NamespacesUtils
• MessageCache Messages
• Statistics Statistics
• Boolean HasNewMessages

Методы

• String[] GetAllPages(String startfrom, Int32 limit, PageTypes filter, Int32 namespaceID)
• String[] GetPrefixIndex(String prefix, PageTypes filter, Int32 namespaceID)
• Void LockDB(String reason)
• Void UnlockDB()
• Boolean Login(String username, String password)
• Void Logout()
• Boolean IsLoggedIn()
• String GetMessage(String messageName)
• Void UpdateMessageCache()
• Void CreatePage(String name, String text, String summary)
• Void CreatePage(String name, String text)
• Void CreatePage(String name, String text, Boolean overwrite)
• Void CreatePage(String name, String text, String summary, Boolean overwrite)
• Void ReadNewMessages()
• Void Dispose()

Структруа WikiCapabilities

Методы

• Boolean FromString(String s)

Поля

• Version
• HasCheckUser
• HasExpandTemplates
• HasFilePath
• HasMakeBot
• HasMakeSysop
• HasNewUserLog
• HasOversight
• HasRenameUser

Исключения

• WikiException
• WikiNotSupportedException
• WikiPageNotFoundExcecption
• WikiPermissionsExpection

Пространство имён WikiTools.Access.Wikimedia

Перечисление WikimediaProjects

Возможные значения:

• Wikipedia
• Wiktionary
• Wikibooks
• Wikinews
• Wikiquote
• Wikisource
• Wikiversity
• Commons
• Meta
• Incubator
• Sep11
• Sources
• Species
• Test
• Foundation
• MediaWiki
• Wikimania2005
• Wikimania2006
• Wikimania2007

Класс WikimediaUtils

Свойства

• WikiCapabilities Capabilities

Методы

• String MakeUri(WikimediaProjects proj)
• String MakeUri(WikimediaProjects proj, String langCode)