Class UnreadManager

Hierarchy

MiniMapEmitter<APIUnread>
- UnreadManager

Index

Constructors

Properties

Methods

[iterator] clear delete entries fireUpdate forEach get has keys markMention markRead markUnread offUpdate onUpdate set sync values

Constructors

constructor

new UnreadManager(client: Client): UnreadManager
Parameters
- client: Client
Returns UnreadManager
Overrides MiniMapEmitter.constructor
- Defined in core/src/managers/UnreadManager.ts:9

Properties

`Readonly` [toStringTag]

[toStringTag]: string

client

client: Client

`Readonly` size

size: number

Returns

the number of elements in the Map.

`Static` `Readonly` [species]

[species]: MapConstructor

Methods

[iterator]

[iterator](): IterableIterator<[string, APIUnread]>
Returns an iterable of entries in the map.

Returns IterableIterator<[string, APIUnread]>
Inherited from MiniMapEmitter.[iterator]
- Defined in node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es2015.iterable.d.ts:119

clear

clear(): void
Returns void
Inherited from MiniMapEmitter.clear
- Defined in node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es2015.collection.d.ts:21

delete

delete(key: string): boolean
Returns
true if an element in the Map existed and has been removed, or false if the element does not exist.
Parameters
- key: string
Returns boolean
Inherited from MiniMapEmitter.delete
- Defined in node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es2015.collection.d.ts:25

entries

entries(): IterableIterator<[string, APIUnread]>
Returns an iterable of key, value pairs for every entry in the map.

Returns IterableIterator<[string, APIUnread]>
Inherited from MiniMapEmitter.entries
- Defined in node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es2015.iterable.d.ts:124

fireUpdate

fireUpdate(updated?: APIUnread[]): void
Runs all of the callbacks for this emitter. (meant to run when an update occurs)
Parameters
- Optional updated: APIUnread[]
  
  The objects that caused this update.
Returns void
Inherited from MiniMapEmitter.fireUpdate
- Defined in core/src/utils/MiniEmitter.ts:67

forEach

forEach(callbackfn: ((value: APIUnread, key: string, map: Map<string, APIUnread>) => void), thisArg?: any): void
Executes a provided function once per each key/value pair in the Map, in insertion order.
Parameters
- callbackfn: ((value: APIUnread, key: string, map: Map<string, APIUnread>) => void)
  - - (value: APIUnread, key: string, map: Map<string, APIUnread>): void
    - Parameters
      
      value: APIUnread
      
      key: string
      
      map: Map<string, APIUnread>
      
      Returns void
- Optional thisArg: any
Returns void
Inherited from MiniMapEmitter.forEach
- Defined in node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es2015.collection.d.ts:29

get

get(key: string): APIUnread
Returns a specified element from the Map object. If the value that is associated to the provided key is an object, then you will get a reference to that object and any change made to that object will effectively modify it inside the Map.

Returns
Returns the element associated with the specified key. If no element is associated with the specified key, undefined is returned.
Parameters
- key: string
Returns APIUnread
Inherited from MiniMapEmitter.get
- Defined in node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es2015.collection.d.ts:34

has

has(key: string): boolean
Returns
boolean indicating whether an element with the specified key exists or not.
Parameters
- key: string
Returns boolean
Inherited from MiniMapEmitter.has
- Defined in node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es2015.collection.d.ts:38

keys

keys(): IterableIterator<string>
Returns an iterable of keys in the map

Returns IterableIterator<string>
Inherited from MiniMapEmitter.keys
- Defined in node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es2015.iterable.d.ts:129

markMention

markMention(message: Message): void
Add a mention to a message.
Parameters
- message: Message
Returns void
- Defined in core/src/managers/UnreadManager.ts:40

markRead

markRead(channel: Channel, message_id?: string, emit?: boolean): Promise<void>
Mark a channel as read and optionally send to server.
Parameters
- channel: Channel
- Optional message_id: string
- emit: boolean = true
Returns Promise<void>
- Defined in core/src/managers/UnreadManager.ts:24

markUnread

markUnread(channel: Channel, last_id: string): void
Mark a channel unread with a custom last_id.
Parameters
- channel: Channel
- last_id: string
Returns void
- Defined in core/src/managers/UnreadManager.ts:32

offUpdate

offUpdate(callback: MiniEmitterCallback<APIUnread>): UnreadManager
Stops listening for Map updates.

Returns
this, useful for chaining.
Parameters
- callback: MiniEmitterCallback<APIUnread>
  
  The callback to stop listening for updates on.
Returns UnreadManager
Inherited from MiniMapEmitter.offUpdate
- Defined in core/src/utils/MiniEmitter.ts:58

onUpdate

onUpdate(callback: MiniEmitterCallback<APIUnread>): UnreadManager
Listen for an update to this Map.

Returns
this, useful for chaining.
Parameters
- callback: MiniEmitterCallback<APIUnread>
  
  The callback to run when an update occurs.
Returns UnreadManager
Inherited from MiniMapEmitter.onUpdate
- Defined in core/src/utils/MiniEmitter.ts:49

set

set(key: string, value: APIUnread): UnreadManager
Adds a new element with a specified key and value to the Map. If an element with the same key already exists, the element will be updated.
Parameters
- key: string
- value: APIUnread
Returns UnreadManager
Inherited from MiniMapEmitter.set
- Defined in node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es2015.collection.d.ts:42

sync

sync(): Promise<void>
Fetch new unread data from server.

Returns Promise<void>
- Defined in core/src/managers/UnreadManager.ts:14

values

values(): IterableIterator<APIUnread>
Returns an iterable of values in the map

Returns IterableIterator<APIUnread>
Inherited from MiniMapEmitter.values
- Defined in node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es2015.iterable.d.ts:134

Class UnreadManager

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

client: Client

Returns UnreadManager

Properties

Readonly [toStringTag]

client

Readonly size

Returns

Static Readonly [species]

Methods

[iterator]

Returns IterableIterator<[string, APIUnread]>

clear

Returns void

delete

Returns

Parameters

key: string

Returns boolean

entries

Returns IterableIterator<[string, APIUnread]>

fireUpdate

Parameters

Optional updated: APIUnread[]

Returns void

forEach

Parameters

callbackfn: ((value: APIUnread, key: string, map: Map<string, APIUnread>) => void)

Parameters

value: APIUnread

key: string

map: Map<string, APIUnread>

Returns void

Optional thisArg: any

Returns void

get

Returns

Parameters

key: string

Returns APIUnread

has

Returns

Parameters

key: string

Returns boolean

keys

Returns IterableIterator<string>

markMention

Parameters

message: Message

Returns void

markRead

Parameters

channel: Channel

Optional message_id: string

emit: boolean = true

Returns Promise<void>

markUnread

Parameters

channel: Channel

last_id: string

Returns void

offUpdate

Returns

Parameters

callback: MiniEmitterCallback<APIUnread>

Returns UnreadManager

onUpdate

Returns

Parameters

callback: MiniEmitterCallback<APIUnread>

Returns UnreadManager

`Readonly` [toStringTag]

`Readonly` size

`Static` `Readonly` [species]

`Optional` updated: APIUnread[]

`Optional` thisArg: any

`Optional` message_id: string