Options
All
  • Public
  • Public/Protected
  • All
Menu

Class User

Light but immensely hacky wrapper around Morebits.wiki.user that presets the change tags and promisifies the core methods.

Hierarchy

  • user
    • User

Index

Constructors

Methods

Constructors

constructor

  • new User(userName: string, status?: string | status): User

  • Parameters

    • userName: string
    • Optional status: string | status

    Returns User

Methods

block

  • block(): Promise<api, any, any>

  • Returns Promise<api, any, any>

exists

  • exists(): boolean

getActionResponse

  • getActionResponse(): Record<string, any>

  • Returns Record<string, any>

getAllowusertalk

  • getAllowusertalk(): boolean

getAnononly

  • getAnononly(): boolean

getAutoblock

  • getAutoblock(): boolean

getBlockExpiry

  • getBlockExpiry(): string

getBlockInfo

  • getBlockInfo(): any

getBlockReason

  • getBlockReason(): string

getBlockTimestamp

  • getBlockTimestamp(): string

getBlockedRange

  • getBlockedRange(): string

getBlockingSysop

  • getBlockingSysop(): string

getEditCount

  • getEditCount(): number

getGrantedGroups

  • getGrantedGroups(): string[]

getGroupExpiry

  • getGroupExpiry(group: string): boolean

  • Parameters

    • group: string

    Returns boolean

getGroups

  • getGroups(): string[]

getHidename

  • getHidename(): boolean

getImplicitGroups

  • getImplicitGroups(): string[]

getLastBlockLogEntry

  • getLastBlockLogEntry(): any

getLoadTime

  • getLoadTime(): string

getNocreate

  • getNocreate(): boolean

getNoemail

  • getNoemail(): boolean

getPartial

  • getPartial(): boolean

getPartialNamespaces

  • getPartialNamespaces(): number[]

getPartialPages

  • getPartialPages(): string[]

getRegistration

  • getRegistration(): string

getRights

  • getRights(): string[]

getStatusElement

  • getStatusElement(): status

getTalkExists

  • getTalkExists(): boolean

getTalkLastEditor

  • getTalkLastEditor(): string

getTalkLinks

  • getTalkLinks(): string[]

getTalkTemplates

  • getTalkTemplates(): string[]

getTalkText

  • getTalkText(): string

getTalkTimestamp

  • getTalkTimestamp(): string

getTalkTitle

  • getTalkTitle(): string

getUserID

  • getUserID(): number

getUserName

  • getUserName(): string

groups

  • groups(onSuccess?: any, onFailure?: any): void

  • Parameters

    • Optional onSuccess: any
    • Optional onFailure: any

    Returns void

hasBlockLog

  • hasBlockLog(): boolean

hasRight

  • hasRight(right: string): boolean

  • Parameters

    • right: string

    Returns boolean

isBlocked

  • isBlocked(): boolean

isBot

  • isBot(): boolean

isHidden

  • isHidden(): boolean

isIP

  • isIP(): boolean

isIPRange

  • isIPRange(): boolean

isInGroup

  • isInGroup(group: string): boolean

  • Parameters

    • group: string

    Returns boolean

isRangeBlocked

  • isRangeBlocked(): boolean

isSysop

  • isSysop(): boolean

load

  • load(): Promise<api, any, any>

  • Returns Promise<api, any, any>

notify

  • notify(): Promise<api, any, any>

  • Returns Promise<api, any, any>

setAddGroups

  • setAddGroups(addGroups: string[]): void

  • Parameters

    • addGroups: string[]

    Returns void

setAllowusertalk

  • setAllowusertalk(allowusertalk: boolean): void

  • Parameters

    • allowusertalk: boolean

    Returns void

setAnononly

  • setAnononly(anononly: boolean): void

  • Parameters

    • anononly: boolean

    Returns void

setAutoblock

  • setAutoblock(autoblock: boolean): void

  • Parameters

    • autoblock: boolean

    Returns void

setChangeTags

  • setChangeTags(tags: string | string[]): void

  • Parameters

    • tags: string | string[]

    Returns void

setExpiry

  • setExpiry(expiry: string | number | Date | string[] | date): void

  • Parameters

    • expiry: string | number | Date | string[] | date

    Returns void

setHidename

  • setHidename(hidename: string): void

  • Parameters

    • hidename: string

    Returns void

setMessage

  • setMessage(message: string): void

  • Parameters

    • message: string

    Returns void

setNocreate

  • setNocreate(nocreate: boolean): void

  • Parameters

    • nocreate: boolean

    Returns void

setNoemail

  • setNoemail(noemail: boolean): void

  • Parameters

    • noemail: boolean

    Returns void

setNotifyBots

  • setNotifyBots(notifyBots: boolean): void

  • Parameters

    • notifyBots: boolean

    Returns void

setNotifyIndef

  • setNotifyIndef(notifyIndef: boolean): void

  • Parameters

    • notifyIndef: boolean

    Returns void

setNotifySelf

  • setNotifySelf(notifySelf: boolean): void

  • Parameters

    • notifySelf: boolean

    Returns void

setNotifySkips

  • setNotifySkips(link: string, templates: string | string[]): void

  • Parameters

    • link: string
    • templates: string | string[]

    Returns void

setPageobjectFunctions

  • setPageobjectFunctions(pageobjectFunctions: any): void

  • Parameters

    • pageobjectFunctions: any

    Returns void

setPartial

  • setPartial(partial: boolean): void

  • Parameters

    • partial: boolean

    Returns void

setPartialNamespaces

  • setPartialNamespaces(namespaces: string | number | string[] | number[]): void

  • Parameters

    • namespaces: string | number | string[] | number[]

    Returns void

setPartialPages

  • setPartialPages(pages: string | string[]): void

  • Parameters

    • pages: string | string[]

    Returns void

setReason

  • setReason(reason: string): void

  • Parameters

    • reason: string

    Returns void

setReblock

  • setReblock(reblock: boolean): void

  • Parameters

    • reblock: boolean

    Returns void

setRemoveGroups

  • setRemoveGroups(removeGroups: string | string[]): void

  • Parameters

    • removeGroups: string | string[]

    Returns void

setSectionTitle

  • setSectionTitle(title: string): void

  • Parameters

    • title: string

    Returns void

setStatusElement

  • setStatusElement(statusElement: status): void

  • Parameters

    • statusElement: status

    Returns void

setWatchlistExpiry

  • setWatchlistExpiry(watchlistExpiry: string | number | Date | date): void

  • Parameters

    • watchlistExpiry: string | number | Date | date

    Returns void

setWatchuser

  • setWatchuser(watchuser: boolean): void

  • Parameters

    • watchuser: boolean

    Returns void

unblock

  • unblock(onSuccess?: any, onFailure?: any): void

  • Parameters

    • Optional onSuccess: any
    • Optional onFailure: any

    Returns void

useOriginalBlock

  • useOriginalBlock(useOriginalBlockParams: boolean): void

  • Parameters

    • useOriginalBlockParams: boolean

    Returns void

Generated using TypeDoc