Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ITextbox

Hierarchy

Implemented by

Index

Properties

client

client: IClient

Optional controlID

controlID: string

An id, unique to the session.

cooldown

cooldown: number

cost

cost: number

Optional disabled

disabled: boolean

Wether or not this control is disabled.

Optional etag

etag: ETag
deprecated

etags are no longer used, you can always omit/ignore this

hasSubmit

hasSubmit: boolean

Optional kind

kind: string

The type of control.

Optional meta

meta: IMeta

The collection of Meta properties for this control.

multiline

multiline: boolean

placeholder

placeholder: string

Optional position

position: IGridPlacement[]

A collection of grid placements controlling where the control is positioned on screen.

submitText

submitText: string

Static defaultMaxListeners

defaultMaxListeners: number

Methods

addListener

  • addListener(event: string | symbol, listener: Function): this
  • Parameters

    • event: string | symbol
    • listener: Function

    Returns this

destroy

  • destroy(): void

disable

  • disable(): Promise<void>

emit

  • emit(event: string | symbol, ...args: any[]): boolean
  • Parameters

    • event: string | symbol
    • Rest ...args: any[]

    Returns boolean

enable

  • enable(): Promise<void>

eventNames

  • eventNames(): (string | symbol)[]
  • Returns (string | symbol)[]

getMaxListeners

  • getMaxListeners(): number
  • Returns number

Optional giveInput

  • giveInput(input: IInput): Promise<void>

listenerCount

  • listenerCount(type: string | symbol): number
  • Parameters

    • type: string | symbol

    Returns number

listeners

  • listeners(event: string | symbol): Function[]
  • Parameters

    • event: string | symbol

    Returns Function[]

on

  • on(event: "change", listener: function): this
  • on(event: "submit", listener: function): this
  • on(event: string, listener: Function): this

onUpdate

once

  • once(event: string | symbol, listener: Function): this
  • Parameters

    • event: string | symbol
    • listener: Function

    Returns this

prependListener

  • prependListener(event: string | symbol, listener: Function): this
  • Parameters

    • event: string | symbol
    • listener: Function

    Returns this

prependOnceListener

  • prependOnceListener(event: string | symbol, listener: Function): this
  • Parameters

    • event: string | symbol
    • listener: Function

    Returns this

receiveInput

removeAllListeners

  • removeAllListeners(event?: string | symbol): this
  • Parameters

    • Optional event: string | symbol

    Returns this

removeListener

  • removeListener(event: string | symbol, listener: Function): this
  • Parameters

    • event: string | symbol
    • listener: Function

    Returns this

setCooldown

  • setCooldown(duration: number): Promise<void>

setCost

  • setCost(cost: number): Promise<void>

setMaxListeners

  • setMaxListeners(n: number): this
  • Parameters

    • n: number

    Returns this

setPlaceholder

  • setPlaceholder(placeholder: string): Promise<void>

setSubmitText

  • setSubmitText(submitText: string): Promise<void>

update

Static listenerCount

  • listenerCount(emitter: EventEmitter, event: string | symbol): number
  • Parameters

    • emitter: EventEmitter
    • event: string | symbol

    Returns number

Generated using TypeDoc