A notice interface for modifying it and subscribing to events.

### Hierarchy

- EventEmitter
  - Notice

### Constructors

### Properties

### Accessors

### Methods

## Constructors

### constructor

- new Notice(data: any): Notice

#### Parameters

- data: any

#### Returns Notice

- Defined in LightcordApi/src/modules/DiscordTools.ts:125

## Properties

### data

data: notice

- Defined in LightcordApi/src/modules/DiscordTools.ts:264

### Private nextTickRefresh

nextTickRefresh: boolean = false

- Defined in LightcordApi/src/modules/DiscordTools.ts:189

### Private state

state: object

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

- Defined in LightcordApi/src/modules/DiscordTools.ts:183

### Static defaultMaxListeners

defaultMaxListeners: number

Inherited from Notice.defaultMaxListeners

- Defined in node_modules/@types/node/events.d.ts:18

## Accessors

### buttonText

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

#### Returns string

#### Parameters

- buttonText: string

#### Returns void

- Defined in LightcordApi/src/modules/DiscordTools.ts:241
- Defined in LightcordApi/src/modules/DiscordTools.ts:244

### id

- get id(): string

The id of the notice.

#### Returns string

- Defined in LightcordApi/src/modules/DiscordTools.ts:204

### index

- get index(): number

The position in the queue, 0 is showing.

#### Returns number

- Defined in LightcordApi/src/modules/DiscordTools.ts:200

### onClick

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

#### Returns function

- - (): void

  - #### Returns void

#### Parameters

- onClick: function
  - - (): void

    - #### Returns void

- Defined in LightcordApi/src/modules/DiscordTools.ts:250
- Defined in LightcordApi/src/modules/DiscordTools.ts:253

### removed

- get removed(): boolean

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

#### Returns boolean

- Defined in LightcordApi/src/modules/DiscordTools.ts:192

### showing

- get showing(): boolean

If the notice is showing right now.

#### Returns boolean

- Defined in LightcordApi/src/modules/DiscordTools.ts:196

### text

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

#### Returns string

#### Parameters

- text: string

#### Returns void

- Defined in LightcordApi/src/modules/DiscordTools.ts:223
- Defined in LightcordApi/src/modules/DiscordTools.ts:226

### 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

- Defined in LightcordApi/src/modules/DiscordTools.ts:232
- Defined in LightcordApi/src/modules/DiscordTools.ts:235

## 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

Inherited from Notice.addListener

Overrides EventEmitter.addListener

- Defined in node_modules/@types/node/events.d.ts:20

### emit

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

#### Parameters

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

#### Returns boolean

Inherited from Notice.emit

Overrides EventEmitter.emit

- Defined in node_modules/@types/node/events.d.ts:32

### eventNames

- eventNames(): Array<string | symbol>

#### Returns Array<string | symbol>

Inherited from Notice.eventNames

Overrides EventEmitter.eventNames

- Defined in node_modules/@types/node/events.d.ts:33

### getMaxListeners

- getMaxListeners(): number

#### Returns number

Inherited from Notice.getMaxListeners

Overrides EventEmitter.getMaxListeners

- Defined in node_modules/@types/node/events.d.ts:29

### listenerCount

- listenerCount(type: string | symbol): number

#### Parameters

- type: string | symbol

#### Returns number

Inherited from Notice.listenerCount

Overrides EventEmitter.listenerCount

- Defined in node_modules/@types/node/events.d.ts:34

### listeners

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

#### Parameters

- event: string | symbol

#### Returns Function []

Inherited from Notice.listeners

Overrides EventEmitter.listeners

- Defined in node_modules/@types/node/events.d.ts:30

### 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

Overrides EventEmitter.off

- Defined in LightcordApi/src/modules/DiscordTools.ts:175
- Defined in LightcordApi/src/modules/DiscordTools.ts:176
- Defined in LightcordApi/src/modules/DiscordTools.ts:177
- Defined in LightcordApi/src/modules/DiscordTools.ts:178

### 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

Overrides EventEmitter.on

- Defined in LightcordApi/src/modules/DiscordTools.ts:146
- Defined in LightcordApi/src/modules/DiscordTools.ts:150
- Defined in LightcordApi/src/modules/DiscordTools.ts:154
- Defined in LightcordApi/src/modules/DiscordTools.ts:155

### 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

Overrides EventEmitter.once

- Defined in LightcordApi/src/modules/DiscordTools.ts:162
- Defined in LightcordApi/src/modules/DiscordTools.ts:166
- Defined in LightcordApi/src/modules/DiscordTools.ts:170
- Defined in LightcordApi/src/modules/DiscordTools.ts:171

### 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

Inherited from Notice.prependListener

Overrides EventEmitter.prependListener

- Defined in node_modules/@types/node/events.d.ts:23

### 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

Inherited from Notice.prependOnceListener

Overrides EventEmitter.prependOnceListener

- Defined in node_modules/@types/node/events.d.ts:24

### rawListeners

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

#### Parameters

- event: string | symbol

#### Returns Function []

Inherited from Notice.rawListeners

Overrides EventEmitter.rawListeners

- Defined in node_modules/@types/node/events.d.ts:31

### remove

- remove(): void

#### Returns void

- Defined in LightcordApi/src/modules/DiscordTools.ts:259

### removeAllListeners

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

#### Parameters

- event: string | symbol Optional

#### Returns this

Inherited from Notice.removeAllListeners

Overrides EventEmitter.removeAllListeners

- Defined in node_modules/@types/node/events.d.ts:27

### 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

Inherited from Notice.removeListener

Overrides EventEmitter.removeListener

- Defined in node_modules/@types/node/events.d.ts:25

### setMaxListeners

- setMaxListeners(n: number): this

#### Parameters

- n: number

#### Returns this

Inherited from Notice.setMaxListeners

Overrides EventEmitter.setMaxListeners

- Defined in node_modules/@types/node/events.d.ts:28

### update

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

#### Parameters

- data: Partial<notice>

#### Returns void

- Defined in LightcordApi/src/modules/DiscordTools.ts:208

### Static listenerCount

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

#### Parameters

- emitter: EventEmitter
- event: string | symbol

#### Returns number

Inherited from Notice.listenerCount

- Defined in node_modules/@types/node/events.d.ts:17

Made with ❤️ by pirix-gh. Documentation generated by TypeDoc.