default | revolt.js

Hierarchy

default<string, Message>
- default

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new default(client: Client): default

Overrides default.constructor
- Defined in src/maps/Messages.ts:312
Parameters
- client: Client
Returns default

Properties

[$mobx]

[$mobx]: {}

Type declaration

changeListeners_

changeListeners_: any

client

client: Client

data_

data_: Map<string, ObservableValue<Message>>

dehancer

dehancer: any

enhancer_

enhancer_: IEnhancer<Message>

hasMap_

hasMap_: Map<string, ObservableValue<boolean>>

interceptors_

interceptors_: any

keysAtom_

keysAtom_: IAtom

name_

name_: string

Accessors

[toStringTag]

get [toStringTag](): string

- Defined in node_modules/mobx/dist/types/observablemap.d.ts:68
Returns string

size

get size(): number

- Defined in node_modules/mobx/dist/types/observablemap.d.ts:65
Returns number

Methods

$get

$get(id: string, data?: { _id: string; attachments?: null | { _id: string; content_type: string; deleted?: null | boolean; filename: string; message_id?: null | string; metadata: { type: "File" } | { type: "Text" } | { height: number; type: "Image"; width: number } | { height: number; type: "Video"; width: number } | { type: "Audio" }; object_id?: null | string; reported?: null | boolean; server_id?: null | string; size: number; tag: string; user_id?: null | string }[]; author: string; channel: string; content?: null | string; edited?: null | string; embeds?: null | ({ colour?: null | string; description?: null | string; icon_url?: null | string; image?: null | { height: number; size: "Large" | "Preview"; url: string; width: number }; original_url?: null | string; site_name?: null | string; special?: null | { type: "None" } | { type: "GIF" } | { id: string; timestamp?: null | string; type: "YouTube" } | { content_type: "Channel"; id: string; type: "Lightspeed" } | { content_type: "Channel" | "Video" | "Clip"; id: string; type: "Twitch" } | { content_type: string; id: string; type: "Spotify" } | { type: "Soundcloud" } | { content_type: "Album" | "Track"; id: string; type: "Bandcamp" } | { id: string; type: "Streamable" }; title?: null | string; type: "Website"; url?: null | string; video?: null | { height: number; url: string; width: number } } | { height: number; size: "Large" | "Preview"; type: "Image"; url: string; width: number } | { height: number; type: "Video"; url: string; width: number } | { colour?: null | string; description?: null | string; icon_url?: null | string; media?: null | { _id: string; content_type: string; deleted?: null | boolean; filename: string; message_id?: null | string; metadata: { type: "File" } | { type: "Text" } | { height: number; type: "Image"; width: number } | { height: number; type: "Video"; width: number } | { type: "Audio" }; object_id?: null | string; reported?: null | boolean; server_id?: null | string; size: number; tag: string; user_id?: null | string }; title?: null | string; type: "Text"; url?: null | string } | { type: "None" })[]; interactions?: { reactions?: null | string[]; restrict_reactions?: boolean }; masquerade?: null | { avatar?: null | string; colour?: null | string; name?: null | string }; mentions?: null | string[]; nonce?: null | string; reactions?: {}; replies?: null | string[]; system?: null | { content: string; type: "text" } | { by: string; id: string; type: "user_added" } | { by: string; id: string; type: "user_remove" } | { id: string; type: "user_joined" } | { id: string; type: "user_left" } | { id: string; type: "user_kicked" } | { id: string; type: "user_banned" } | { by: string; name: string; type: "channel_renamed" } | { by: string; type: "channel_description_changed" } | { by: string; type: "channel_icon_changed" } | { from: string; to: string; type: "channel_ownership_changed" } }): Message

- Defined in src/maps/Messages.ts:317
Parameters
- id: string
- Optional data: { _id: string; attachments?: null | { _id: string; content_type: string; deleted?: null | boolean; filename: string; message_id?: null | string; metadata: { type: "File" } | { type: "Text" } | { height: number; type: "Image"; width: number } | { height: number; type: "Video"; width: number } | { type: "Audio" }; object_id?: null | string; reported?: null | boolean; server_id?: null | string; size: number; tag: string; user_id?: null | string }[]; author: string; channel: string; content?: null | string; edited?: null | string; embeds?: null | ({ colour?: null | string; description?: null | string; icon_url?: null | string; image?: null | { height: number; size: "Large" | "Preview"; url: string; width: number }; original_url?: null | string; site_name?: null | string; special?: null | { type: "None" } | { type: "GIF" } | { id: string; timestamp?: null | string; type: "YouTube" } | { content_type: "Channel"; id: string; type: "Lightspeed" } | { content_type: "Channel" | "Video" | "Clip"; id: string; type: "Twitch" } | { content_type: string; id: string; type: "Spotify" } | { type: "Soundcloud" } | { content_type: "Album" | "Track"; id: string; type: "Bandcamp" } | { id: string; type: "Streamable" }; title?: null | string; type: "Website"; url?: null | string; video?: null | { height: number; url: string; width: number } } | { height: number; size: "Large" | "Preview"; type: "Image"; url: string; width: number } | { height: number; type: "Video"; url: string; width: number } | { colour?: null | string; description?: null | string; icon_url?: null | string; media?: null | { _id: string; content_type: string; deleted?: null | boolean; filename: string; message_id?: null | string; metadata: { type: "File" } | { type: "Text" } | { height: number; type: "Image"; width: number } | { height: number; type: "Video"; width: number } | { type: "Audio" }; object_id?: null | string; reported?: null | boolean; server_id?: null | string; size: number; tag: string; user_id?: null | string }; title?: null | string; type: "Text"; url?: null | string } | { type: "None" })[]; interactions?: { reactions?: null | string[]; restrict_reactions?: boolean }; masquerade?: null | { avatar?: null | string; colour?: null | string; name?: null | string }; mentions?: null | string[]; nonce?: null | string; reactions?: {}; replies?: null | string[]; system?: null | { content: string; type: "text" } | { by: string; id: string; type: "user_added" } | { by: string; id: string; type: "user_remove" } | { id: string; type: "user_joined" } | { id: string; type: "user_left" } | { id: string; type: "user_kicked" } | { id: string; type: "user_banned" } | { by: string; name: string; type: "channel_renamed" } | { by: string; type: "channel_description_changed" } | { by: string; type: "channel_icon_changed" } | { from: string; to: string; type: "channel_ownership_changed" } }
  - _id: string
    
    description
    
    Unique Id
  - Optional attachments?: null | { _id: string; content_type: string; deleted?: null | boolean; filename: string; message_id?: null | string; metadata: { type: "File" } | { type: "Text" } | { height: number; type: "Image"; width: number } | { height: number; type: "Video"; width: number } | { type: "Audio" }; object_id?: null | string; reported?: null | boolean; server_id?: null | string; size: number; tag: string; user_id?: null | string }[]
    
    description
    
    Array of attachments
  - author: string
    
    description
    
    Id of the user that sent this message
  - channel: string
    
    description
    
    Id of the channel this message was sent in
  - Optional content?: null | string
    
    description
    
    Message content
  - Optional edited?: null | string
    
    description
    
    Time at which this message was last edited
  - Optional embeds?: null | ({ colour?: null | string; description?: null | string; icon_url?: null | string; image?: null | { height: number; size: "Large" | "Preview"; url: string; width: number }; original_url?: null | string; site_name?: null | string; special?: null | { type: "None" } | { type: "GIF" } | { id: string; timestamp?: null | string; type: "YouTube" } | { content_type: "Channel"; id: string; type: "Lightspeed" } | { content_type: "Channel" | "Video" | "Clip"; id: string; type: "Twitch" } | { content_type: string; id: string; type: "Spotify" } | { type: "Soundcloud" } | { content_type: "Album" | "Track"; id: string; type: "Bandcamp" } | { id: string; type: "Streamable" }; title?: null | string; type: "Website"; url?: null | string; video?: null | { height: number; url: string; width: number } } | { height: number; size: "Large" | "Preview"; type: "Image"; url: string; width: number } | { height: number; type: "Video"; url: string; width: number } | { colour?: null | string; description?: null | string; icon_url?: null | string; media?: null | { _id: string; content_type: string; deleted?: null | boolean; filename: string; message_id?: null | string; metadata: { type: "File" } | { type: "Text" } | { height: number; type: "Image"; width: number } | { height: number; type: "Video"; width: number } | { type: "Audio" }; object_id?: null | string; reported?: null | boolean; server_id?: null | string; size: number; tag: string; user_id?: null | string }; title?: null | string; type: "Text"; url?: null | string } | { type: "None" })[]
    
    description
    
    Attached embeds to this message
  - Optional interactions?: { reactions?: null | string[]; restrict_reactions?: boolean }
    
    description
    
    Information about how this message should be interacted with
    - Optional reactions?: null | string[]
      
      description
      
      Reactions which should always appear and be distinct
    - Optional restrict_reactions?: boolean
      
      description
      
      Whether reactions should be restricted to the given list
      
      Can only be set to true if reactions list is of at least length 1
  - Optional masquerade?: null | { avatar?: null | string; colour?: null | string; name?: null | string }
    
    description
    
    Name and / or avatar overrides for this message
  - Optional mentions?: null | string[]
    
    description
    
    Array of user ids mentioned in this message
  - Optional nonce?: null | string
    
    description
    
    Unique value generated by client sending this message
  - Optional reactions?: {}
    
    description
    
    Hashmap of emoji IDs to array of user IDs
    - [key: string]: string[]
  - Optional replies?: null | string[]
    
    description
    
    Array of message ids this message is replying to
  - Optional system?: null | { content: string; type: "text" } | { by: string; id: string; type: "user_added" } | { by: string; id: string; type: "user_remove" } | { id: string; type: "user_joined" } | { id: string; type: "user_left" } | { id: string; type: "user_kicked" } | { id: string; type: "user_banned" } | { by: string; name: string; type: "channel_renamed" } | { by: string; type: "channel_description_changed" } | { by: string; type: "channel_icon_changed" } | { from: string; to: string; type: "channel_ownership_changed" }
    
    description
    
    System message
Returns Message

[iterator]

[iterator](): IterableIterator<IMapEntry<string, Message>>

Inherited from default.[iterator]
- Defined in node_modules/mobx/dist/types/observablemap.d.ts:59
Returns IterableIterator<IMapEntry<string, Message>>

clear

clear(): void

Inherited from default.clear
- Defined in node_modules/mobx/dist/types/observablemap.d.ts:63
Returns void

createObj

createObj(data: { _id: string; attachments?: null | { _id: string; content_type: string; deleted?: null | boolean; filename: string; message_id?: null | string; metadata: { type: "File" } | { type: "Text" } | { height: number; type: "Image"; width: number } | { height: number; type: "Video"; width: number } | { type: "Audio" }; object_id?: null | string; reported?: null | boolean; server_id?: null | string; size: number; tag: string; user_id?: null | string }[]; author: string; channel: string; content?: null | string; edited?: null | string; embeds?: null | ({ colour?: null | string; description?: null | string; icon_url?: null | string; image?: null | { height: number; size: "Large" | "Preview"; url: string; width: number }; original_url?: null | string; site_name?: null | string; special?: null | { type: "None" } | { type: "GIF" } | { id: string; timestamp?: null | string; type: "YouTube" } | { content_type: "Channel"; id: string; type: "Lightspeed" } | { content_type: "Channel" | "Video" | "Clip"; id: string; type: "Twitch" } | { content_type: string; id: string; type: "Spotify" } | { type: "Soundcloud" } | { content_type: "Album" | "Track"; id: string; type: "Bandcamp" } | { id: string; type: "Streamable" }; title?: null | string; type: "Website"; url?: null | string; video?: null | { height: number; url: string; width: number } } | { height: number; size: "Large" | "Preview"; type: "Image"; url: string; width: number } | { height: number; type: "Video"; url: string; width: number } | { colour?: null | string; description?: null | string; icon_url?: null | string; media?: null | { _id: string; content_type: string; deleted?: null | boolean; filename: string; message_id?: null | string; metadata: { type: "File" } | { type: "Text" } | { height: number; type: "Image"; width: number } | { height: number; type: "Video"; width: number } | { type: "Audio" }; object_id?: null | string; reported?: null | boolean; server_id?: null | string; size: number; tag: string; user_id?: null | string }; title?: null | string; type: "Text"; url?: null | string } | { type: "None" })[]; interactions?: { reactions?: null | string[]; restrict_reactions?: boolean }; masquerade?: null | { avatar?: null | string; colour?: null | string; name?: null | string }; mentions?: null | string[]; nonce?: null | string; reactions?: {}; replies?: null | string[]; system?: null | { content: string; type: "text" } | { by: string; id: string; type: "user_added" } | { by: string; id: string; type: "user_remove" } | { id: string; type: "user_joined" } | { id: string; type: "user_left" } | { id: string; type: "user_kicked" } | { id: string; type: "user_banned" } | { by: string; name: string; type: "channel_renamed" } | { by: string; type: "channel_description_changed" } | { by: string; type: "channel_icon_changed" } | { from: string; to: string; type: "channel_ownership_changed" } }, emit?: number | boolean): Message

- Defined in src/maps/Messages.ts:330
Create a message object. This is meant for internal use only.

Parameters
- data: { _id: string; attachments?: null | { _id: string; content_type: string; deleted?: null | boolean; filename: string; message_id?: null | string; metadata: { type: "File" } | { type: "Text" } | { height: number; type: "Image"; width: number } | { height: number; type: "Video"; width: number } | { type: "Audio" }; object_id?: null | string; reported?: null | boolean; server_id?: null | string; size: number; tag: string; user_id?: null | string }[]; author: string; channel: string; content?: null | string; edited?: null | string; embeds?: null | ({ colour?: null | string; description?: null | string; icon_url?: null | string; image?: null | { height: number; size: "Large" | "Preview"; url: string; width: number }; original_url?: null | string; site_name?: null | string; special?: null | { type: "None" } | { type: "GIF" } | { id: string; timestamp?: null | string; type: "YouTube" } | { content_type: "Channel"; id: string; type: "Lightspeed" } | { content_type: "Channel" | "Video" | "Clip"; id: string; type: "Twitch" } | { content_type: string; id: string; type: "Spotify" } | { type: "Soundcloud" } | { content_type: "Album" | "Track"; id: string; type: "Bandcamp" } | { id: string; type: "Streamable" }; title?: null | string; type: "Website"; url?: null | string; video?: null | { height: number; url: string; width: number } } | { height: number; size: "Large" | "Preview"; type: "Image"; url: string; width: number } | { height: number; type: "Video"; url: string; width: number } | { colour?: null | string; description?: null | string; icon_url?: null | string; media?: null | { _id: string; content_type: string; deleted?: null | boolean; filename: string; message_id?: null | string; metadata: { type: "File" } | { type: "Text" } | { height: number; type: "Image"; width: number } | { height: number; type: "Video"; width: number } | { type: "Audio" }; object_id?: null | string; reported?: null | boolean; server_id?: null | string; size: number; tag: string; user_id?: null | string }; title?: null | string; type: "Text"; url?: null | string } | { type: "None" })[]; interactions?: { reactions?: null | string[]; restrict_reactions?: boolean }; masquerade?: null | { avatar?: null | string; colour?: null | string; name?: null | string }; mentions?: null | string[]; nonce?: null | string; reactions?: {}; replies?: null | string[]; system?: null | { content: string; type: "text" } | { by: string; id: string; type: "user_added" } | { by: string; id: string; type: "user_remove" } | { id: string; type: "user_joined" } | { id: string; type: "user_left" } | { id: string; type: "user_kicked" } | { id: string; type: "user_banned" } | { by: string; name: string; type: "channel_renamed" } | { by: string; type: "channel_description_changed" } | { by: string; type: "channel_icon_changed" } | { from: string; to: string; type: "channel_ownership_changed" } }
  
  Message Data
  - _id: string
    
    description
    
    Unique Id
  - Optional attachments?: null | { _id: string; content_type: string; deleted?: null | boolean; filename: string; message_id?: null | string; metadata: { type: "File" } | { type: "Text" } | { height: number; type: "Image"; width: number } | { height: number; type: "Video"; width: number } | { type: "Audio" }; object_id?: null | string; reported?: null | boolean; server_id?: null | string; size: number; tag: string; user_id?: null | string }[]
    
    description
    
    Array of attachments
  - author: string
    
    description
    
    Id of the user that sent this message
  - channel: string
    
    description
    
    Id of the channel this message was sent in
  - Optional content?: null | string
    
    description
    
    Message content
  - Optional edited?: null | string
    
    description
    
    Time at which this message was last edited
  - Optional embeds?: null | ({ colour?: null | string; description?: null | string; icon_url?: null | string; image?: null | { height: number; size: "Large" | "Preview"; url: string; width: number }; original_url?: null | string; site_name?: null | string; special?: null | { type: "None" } | { type: "GIF" } | { id: string; timestamp?: null | string; type: "YouTube" } | { content_type: "Channel"; id: string; type: "Lightspeed" } | { content_type: "Channel" | "Video" | "Clip"; id: string; type: "Twitch" } | { content_type: string; id: string; type: "Spotify" } | { type: "Soundcloud" } | { content_type: "Album" | "Track"; id: string; type: "Bandcamp" } | { id: string; type: "Streamable" }; title?: null | string; type: "Website"; url?: null | string; video?: null | { height: number; url: string; width: number } } | { height: number; size: "Large" | "Preview"; type: "Image"; url: string; width: number } | { height: number; type: "Video"; url: string; width: number } | { colour?: null | string; description?: null | string; icon_url?: null | string; media?: null | { _id: string; content_type: string; deleted?: null | boolean; filename: string; message_id?: null | string; metadata: { type: "File" } | { type: "Text" } | { height: number; type: "Image"; width: number } | { height: number; type: "Video"; width: number } | { type: "Audio" }; object_id?: null | string; reported?: null | boolean; server_id?: null | string; size: number; tag: string; user_id?: null | string }; title?: null | string; type: "Text"; url?: null | string } | { type: "None" })[]
    
    description
    
    Attached embeds to this message
  - Optional interactions?: { reactions?: null | string[]; restrict_reactions?: boolean }
    
    description
    
    Information about how this message should be interacted with
    - Optional reactions?: null | string[]
      
      description
      
      Reactions which should always appear and be distinct
    - Optional restrict_reactions?: boolean
      
      description
      
      Whether reactions should be restricted to the given list
      
      Can only be set to true if reactions list is of at least length 1
  - Optional masquerade?: null | { avatar?: null | string; colour?: null | string; name?: null | string }
    
    description
    
    Name and / or avatar overrides for this message
  - Optional mentions?: null | string[]
    
    description
    
    Array of user ids mentioned in this message
  - Optional nonce?: null | string
    
    description
    
    Unique value generated by client sending this message
  - Optional reactions?: {}
    
    description
    
    Hashmap of emoji IDs to array of user IDs
    - [key: string]: string[]
  - Optional replies?: null | string[]
    
    description
    
    Array of message ids this message is replying to
  - Optional system?: null | { content: string; type: "text" } | { by: string; id: string; type: "user_added" } | { by: string; id: string; type: "user_remove" } | { id: string; type: "user_joined" } | { id: string; type: "user_left" } | { id: string; type: "user_kicked" } | { id: string; type: "user_banned" } | { by: string; name: string; type: "channel_renamed" } | { by: string; type: "channel_description_changed" } | { by: string; type: "channel_icon_changed" } | { from: string; to: string; type: "channel_ownership_changed" }
    
    description
    
    System message
- Optional emit: number | boolean
  
  Whether to emit creation event
Returns Message

Message

delete

delete(key: string): boolean

Inherited from default.delete
- Defined in node_modules/mobx/dist/types/observablemap.d.ts:50
Parameters
- key: string
Returns boolean

entries

entries(): IterableIterator<IMapEntry<string, Message>>

Inherited from default.entries
- Defined in node_modules/mobx/dist/types/observablemap.d.ts:58
Returns IterableIterator<IMapEntry<string, Message>>

forEach

forEach(callback: (value: Message, key: string, object: Map<string, Message>) => void, thisArg?: any): void

Inherited from default.forEach
- Defined in node_modules/mobx/dist/types/observablemap.d.ts:60
Parameters
- callback: (value: Message, key: string, object: Map<string, Message>) => void
  - - (value: Message, key: string, object: Map<string, Message>): void
    - Parameters
      - value: Message
      - key: string
      - object: Map<string, Message>
      Returns void
- Optional thisArg: any
Returns void

get

get(key: string): undefined | Message

Inherited from default.get
- Defined in node_modules/mobx/dist/types/observablemap.d.ts:54
Parameters
- key: string
Returns undefined | Message

has

has(key: string): boolean

Inherited from default.has
- Defined in node_modules/mobx/dist/types/observablemap.d.ts:48
Parameters
- key: string
Returns boolean

intercept_

intercept_(handler: IInterceptor<IMapWillChange<string, Message>>): Lambda

Inherited from default.intercept_
- Defined in node_modules/mobx/dist/types/observablemap.d.ts:75
Parameters
- handler: IInterceptor<IMapWillChange<string, Message>>
Returns Lambda

keys

keys(): IterableIterator<string>

Inherited from default.keys
- Defined in node_modules/mobx/dist/types/observablemap.d.ts:56
Returns IterableIterator<string>

merge

merge(other: any): ObservableMap<string, Message>

Inherited from default.merge
- Defined in node_modules/mobx/dist/types/observablemap.d.ts:62
Merge another object into this object, returns this.

Parameters
- other: any
Returns ObservableMap<string, Message>

observe_

observe_(listener: (changes: IMapDidChange<string, Message>) => void, fireImmediately?: boolean): Lambda

Inherited from default.observe_
- Defined in node_modules/mobx/dist/types/observablemap.d.ts:74
Observes this object. Triggers for the events 'add', 'update' and 'delete'. See: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object/observe for callback details

Parameters
- listener: (changes: IMapDidChange<string, Message>) => void
  - - (changes: IMapDidChange<string, Message>): void
    - Parameters
      - changes: IMapDidChange<string, Message>
      Returns void
- Optional fireImmediately: boolean
Returns Lambda

replace

replace(values: any): ObservableMap<string, Message>

Inherited from default.replace
- Defined in node_modules/mobx/dist/types/observablemap.d.ts:64
Parameters
- values: any
Returns ObservableMap<string, Message>

set

set(key: string, value: Message): default

Inherited from default.set
- Defined in node_modules/mobx/dist/types/observablemap.d.ts:49
Parameters
- key: string
- value: Message
Returns default

toJSON

toJSON(): [string, Message][]

Inherited from default.toJSON
- Defined in node_modules/mobx/dist/types/observablemap.d.ts:67
Returns [string, Message][]

toString

toString(): string

Inherited from default.toString
- Defined in node_modules/mobx/dist/types/observablemap.d.ts:66
Returns string

values

values(): IterableIterator<Message>

Inherited from default.values
- Defined in node_modules/mobx/dist/types/observablemap.d.ts:57
Returns IterableIterator<Message>

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

client: Client

Returns default

Properties

[$mobx]

Type declaration

changeListeners_

client

data_

dehancer

enhancer_

hasMap_

interceptors_

keysAtom_

name_

Accessors

[toStringTag]

Returns string

size

Returns number

Methods

$get

Parameters

id: string

_id: string

author: string

channel: string

Optional content?: null | string

Optional edited?: null | string

Optional interactions?: { reactions?: null | string[]; restrict_reactions?: boolean }

Optional reactions?: null | string[]

Optional restrict_reactions?: boolean

Optional masquerade?: null | { avatar?: null | string; colour?: null | string; name?: null | string }

Optional mentions?: null | string[]

Optional nonce?: null | string

Optional reactions?: {}

[key: string]: string[]

Optional replies?: null | string[]

Returns Message

[iterator]

Returns IterableIterator<IMapEntry<string, Message>>

clear

Returns void

createObj

Parameters

_id: string

author: string

channel: string

Optional content?: null | string

Optional edited?: null | string

Optional interactions?: { reactions?: null | string[]; restrict_reactions?: boolean }

Optional reactions?: null | string[]

Optional restrict_reactions?: boolean

Optional masquerade?: null | { avatar?: null | string; colour?: null | string; name?: null | string }

Optional mentions?: null | string[]

Optional nonce?: null | string

Optional reactions?: {}

[key: string]: string[]

Optional replies?: null | string[]

Optional emit: number | boolean

Returns Message

delete

Parameters

key: string

Returns boolean

entries

Returns IterableIterator<IMapEntry<string, Message>>

forEach

Parameters

callback: (value: Message, key: string, object: Map<string, Message>) => void

Parameters

value: Message