Options
All
  • Public
  • Public/Protected
  • All
Menu

A notice interface for modifying it and subscribing to events.

Hierarchy

  • EventEmitter
    • Notice

Constructors

constructor

  • new Notice(data: any): Notice

Parameters

  • data: any

Returns Notice

Properties

data

data: notice

Private nextTickRefresh

nextTickRefresh: boolean = false

Private state

state: object

Please do not modify this. It is used internally to emit events only if the data has changed.

Static defaultMaxListeners

defaultMaxListeners: number

Accessors

buttonText

  • get buttonText(): string
  • set buttonText(buttonText: string): void

Returns string

Parameters

  • buttonText: string

Returns void

id

  • get id(): string

The id of the notice.

Returns string

index

  • get index(): number

The position in the queue, 0 is showing.

Returns number

onClick

  • get onClick(): function
  • set onClick(onClick: function): void

Returns function

    • (): void
    • Returns void

Parameters

  • onClick: function
      • (): void
      • Returns void

Returns void

removed

  • get removed(): boolean

if the notice is not, and will not show anymore.

Returns boolean

showing

  • get showing(): boolean

If the notice is showing right now.

Returns boolean

text

  • get text(): string
  • set text(text: string): void

Returns string

Parameters

  • text: string

Returns void

type

  • get type(): "brand" | "default" | "spotify" | "facebook" | "info" | "danger" | "success" | "streamerMode" | "download" | "notification" | "premium" | "richPresence" | "premiumTier1" | "premiumTier2" | "survey"
  • set type(type: "brand" | "default" | "spotify" | "facebook" | "info" | "danger" | "success" | "streamerMode" | "download" | "notification" | "premium" | "richPresence" | "premiumTier1" | "premiumTier2" | "survey"): void

Returns "brand" | "default" | "spotify" | "facebook" | "info" | "danger" | "success" | "streamerMode" | "download" | "notification" | "premium" | "richPresence" | "premiumTier1" | "premiumTier2" | "survey"

Parameters

  • type: "brand" | "default" | "spotify" | "facebook" | "info" | "danger" | "success" | "streamerMode" | "download" | "notification" | "premium" | "richPresence" | "premiumTier1" | "premiumTier2" | "survey"

Returns void

Methods

addListener

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

Parameters

  • event: string | symbol
  • listener: function
      • (...args: any []): void
      • Parameters

        • ...args: any [] Rest

        Returns void

Returns this

emit

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

Parameters

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

Returns boolean

eventNames

  • eventNames(): Array<string | symbol>

Returns Array<string | symbol>

getMaxListeners

  • getMaxListeners(): number

Returns number

listenerCount

  • listenerCount(type: string | symbol): number

Parameters

  • type: string | symbol

Returns number

listeners

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

Parameters

  • event: string | symbol

Returns Function []

off

  • off(event: "removed", listener: function): this
  • off(event: "showing", listener: function): this
  • off(event: "index", listener: function): this

Parameters

  • event: "removed"
  • listener: function
      • (): void
      • Returns void

Returns this

Parameters

  • event: "showing"
  • listener: function
      • (isShowing: boolean): void
      • Parameters

        • isShowing: boolean

        Returns void

Returns this

Parameters

  • event: "index"
  • listener: function
      • (index: number): void
      • Parameters

        • index: number

        Returns void

Returns this

on

  • on(event: "removed", listener: function): this
  • on(event: "showing", listener: function): this
  • on(event: "index", listener: function): this

Will be called whem the notice is removed.

Parameters

  • event: "removed"
  • listener: function
      • (): void
      • Returns void

Returns this

Will be called when the notice is visible or not.

Parameters

  • event: "showing"
  • listener: function
      • (isShowing: boolean): void
      • Parameters

        • isShowing: boolean

        Returns void

Returns this

Will be called when the notice queue changes.

Parameters

  • event: "index"
  • listener: function
      • (index: number): void
      • Parameters

        • index: number

        Returns void

Returns this

once

  • once(event: "removed", listener: function): this
  • once(event: "showing", listener: function): this
  • once(event: "index", listener: function): this

Will be called whem the notice is removed.

Parameters

  • event: "removed"
  • listener: function
      • (): void
      • Returns void

Returns this

Will be called when the notice is visible or not.

Parameters

  • event: "showing"
  • listener: function
      • (isShowing: boolean): void
      • Parameters

        • isShowing: boolean

        Returns void

Returns this

Will be called when the notice queue changes.

Parameters

  • event: "index"
  • listener: function
      • (index: number): void
      • Parameters

        • index: number

        Returns void

Returns this

prependListener

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

Parameters

  • event: string | symbol
  • listener: function
      • (...args: any []): void
      • Parameters

        • ...args: any [] Rest

        Returns void

Returns this

prependOnceListener

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

Parameters

  • event: string | symbol
  • listener: function
      • (...args: any []): void
      • Parameters

        • ...args: any [] Rest

        Returns void

Returns this

rawListeners

  • rawListeners(event: string | symbol): Function []

Parameters

  • event: string | symbol

Returns Function []

remove

  • remove(): void

Returns void

removeAllListeners

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

Parameters

  • event: string | symbol Optional

Returns this

removeListener

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

Parameters

  • event: string | symbol
  • listener: function
      • (...args: any []): void
      • Parameters

        • ...args: any [] Rest

        Returns void

Returns this

setMaxListeners

  • setMaxListeners(n: number): this

Parameters

  • n: number

Returns this

update

  • update(data: Partial<notice>): void

Parameters

Returns void

Static listenerCount

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

Parameters

  • emitter: EventEmitter
  • event: string | symbol

Returns number

  • Inherited
  • Protected
  • Private
  • Static
  • Module
  • Object
  • Property
  • Function
  • Variable
  • Index
  • Type
  • Class
  • Interface
  • Enum
  • Constructor
  • Getter/Setter
Made with ❤️ by pirix-gh. Documentation generated by TypeDoc.