Class Emoji

Hierarchy

BaseObject<API.Emoji>
- Emoji

Index

Constructors

Properties

Accessors

_id animated createdAt creator creatorID id imageURL name nsfw parent parentID source uniqueName

Methods

delete fetchCreator fireUpdate offUpdate onUpdate toString update

Constructors

constructor

new Emoji(client: Client, data: {
    _id: string;
    animated?: boolean;
    creator_id: string;
    name: string;
    nsfw?: boolean;
    parent: {
        id: string;
        type: "Server";
    } | {
        type: "Detached";
    };
}): Emoji
Parameters
- client: Client
- data: {
      _id: string;
      animated?: boolean;
      creator_id: string;
      name: string;
      nsfw?: boolean;
      parent: {
          id: string;
          type: "Server";
      } | {
          type: "Detached";
      };
  }
  - _id: string
    
    Description
    Unique Id
  - Optional animated?: boolean
    
    Description
    Whether the emoji is animated
  - creator_id: string
    
    Description
    Uploader user id
  - name: string
    
    Description
    Emoji name
  - Optional nsfw?: boolean
    
    Description
    Whether the emoji is marked as nsfw
  - parent: {
        id: string;
        type: "Server";
    } | {
        type: "Detached";
    }
    
    Description
    What owns this emoji
Returns Emoji
Overrides BaseObject.constructor
- Defined in core/src/objects/Emoji.ts:8

Properties

client

client: Client

deleted

deleted: boolean = false

Accessors

`Protected` _id

get _id(): ""
Returns ""
Inherited from BaseObject._id
- Defined in core/src/objects/BaseObject.ts:10

animated

get animated(): boolean
Returns boolean
- Defined in core/src/objects/Emoji.ts:15

createdAt

get createdAt(): number
Returns number
Inherited from BaseObject.createdAt
- Defined in core/src/objects/BaseObject.ts:19

creator

get creator(): User
Returns User
- Defined in core/src/objects/Emoji.ts:24

creatorID

get creatorID(): string
Returns string
- Defined in core/src/objects/Emoji.ts:21

id

get id(): string
Returns string
Inherited from BaseObject.id
- Defined in core/src/objects/BaseObject.ts:16

imageURL

get imageURL(): string
The image URL for this emoji.

Returns string
- Defined in core/src/objects/Emoji.ts:31

name

get name(): string
Returns string
- Defined in core/src/objects/Emoji.ts:12

nsfw

get nsfw(): boolean
Returns boolean
- Defined in core/src/objects/Emoji.ts:18

parent

get parent(): Server
Returns Server
- Defined in core/src/objects/Emoji.ts:40

parentID

get parentID(): string
Returns string
- Defined in core/src/objects/Emoji.ts:37

source

get source(): APIType
Original API object.

Returns APIType
Inherited from BaseObject.source
- Defined in core/src/objects/BaseObject.ts:7

uniqueName

get uniqueName(): string
Returns string
- Defined in core/src/objects/Emoji.ts:44

Methods

delete

delete(): Promise<void>
Delete this emoji.

Returns Promise<void>
- Defined in core/src/objects/Emoji.ts:52

fetchCreator

fetchCreator(fetchNew?: boolean): Promise<User>
Parameters
- fetchNew: boolean = false
Returns Promise<User>
- Defined in core/src/objects/Emoji.ts:27

fireUpdate

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

offUpdate

offUpdate(callback: MiniEmitterCallback<any>): Emoji
Stops listening for Map updates.

Returns
this, useful for chaining.
Parameters
- callback: MiniEmitterCallback<any>
  
  The callback to stop listening for updates on.
Returns Emoji
Inherited from BaseObject.offUpdate
- Defined in core/src/utils/MiniEmitter.ts:24

onUpdate

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

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

toString

toString(): string
Returns
The emoji formatted for markdown. :id:

Returns string
Overrides BaseObject.toString
- Defined in core/src/objects/Emoji.ts:58

update

update(data?: Partial<{
    _id: string;
    animated?: boolean;
    creator_id: string;
    name: string;
    nsfw?: boolean;
    parent: {
        id: string;
        type: "Server";
    } | {
        type: "Detached";
    };
}>): Emoji
Update this object with new API data.
Parameters
- data: Partial<{
      _id: string;
      animated?: boolean;
      creator_id: string;
      name: string;
      nsfw?: boolean;
      parent: {
          id: string;
          type: "Server";
      } | {
          type: "Detached";
      };
  }> = {}
Returns Emoji
Inherited from BaseObject.update
- Defined in core/src/objects/BaseObject.ts:24