SevenTVEmote

SevenTVEmote

new SevenTVEmote(channel, id, data)

Description:

  • A 7TV emote.

Source:
Parameters:
Name Type Description
channel Channel

Channel this emote belongs to.
id string

ID of the emote.
data data

The raw emote data.

Extends

Members

code :string

Description:

  • The code or name of the emote.

Source:
Overrides:

The code or name of the emote.

Type:
  • string

ownerName :string|null

Description:

  • The name of the emote owner. Might be null for global emotes.

Source:

The name of the emote owner. Might be null for global emotes.

Type:
  • string | null

sizes :Array.<string>

Description:

  • Available image sizes.

Source:

Available image sizes.

Type:
  • Array.<string>

imageType :string

Description:

  • The image type of the emote.

Source:

The image type of the emote.

Type:
  • string

animated :boolean

Description:

  • If the emote is animated.

Source:

If the emote is animated.

Type:
  • boolean

zeroWidth :boolean

Description:

  • If emote can be zero-width (overlaying).

Source:

If emote can be zero-width (overlaying).

Type:
  • boolean

nsfw :boolean

Description:

  • If emote is NSFW (or Twitch disallowed, just in case). Do note that this flag isn't always applied to what looks NSFW.

Source:

If emote is NSFW (or Twitch disallowed, just in case). Do note that this flag isn't always applied to what looks NSFW.

Type:
  • boolean

fetcher :EmoteFetcher

Description:
Source:
Overrides:

The EmoteFetcher being used.

Type:

channel :Channel

Description:

  • The Channel this emote belongs to. Only accurate and constant on Twitch emotes. For other types of emotes, use the ownerName property.

Source:
Overrides:

The Channel this emote belongs to. Only accurate and constant on Twitch emotes. For other types of emotes, use the ownerName property.

Type:

id :string

Description:

  • The ID of this emote.

Source:
Overrides:

The ID of this emote.

Type:
  • string

type :'twitch'|'bttv'|'ffz'|'7tv'|null

Description:

  • The type/platform of this emote.

Source:
Overrides:

The type/platform of this emote.

Type:
  • 'twitch' | 'bttv' | 'ffz' | '7tv' | null

Methods

Description:

  • Gets the image link of the emote.

Source:
Parameters:
Name Type Attributes Description
options object <optional>

Options for the link.

Properties
Name Type Attributes Default Description
size number <optional>
 0

Size (scale) for the emote.
forceStatic boolean <optional>

Whether to force the emote to be static (non-animated). Defaults to the fetcher's forceStatic or false.
Returns:
  • The URL to the emote.
Type
string

toObject() → {object}

Description:

  • Override of the override for toObject. Will result in an Object representation of a SevenTVEmote.

Source:
Overrides:
Returns:
Type
object

(static) fromObject(emoteObjectopt, channelopt) → {SevenTVEmote}

Description:
Source:
Parameters:
Name Type Attributes Description
emoteObject object <optional>

Object representation of this emote
channel Channel <optional>

Channel this emote belongs to.
Returns:
Type
SevenTVEmote