Class: RubyCord::Sticker

Inherits:
DiscordModel show all
Defined in:
lib/rubycord/sticker.rb

Overview

Represents a sticker.

Direct Known Subclasses

GuildSticker

Defined Under Namespace

Classes: GuildSticker, Pack

Instance Attribute Summary collapse

Method Summary

Methods inherited from DiscordModel

#==, #eql?, #inspect

Instance Attribute Details

#available ⇒ Boolean (readonly) Also known as: available?

Returns Whether the sticker is available.

Returns:

  • (Boolean) —

    Whether the sticker is available.



30
31
32
 
# File 'lib/rubycord/sticker.rb', line 30

def available
  @available
end

#description ⇒ String (readonly)

Returns The URL of the sticker.

Returns:

  • (String) —

    The URL of the sticker.



20
21
22
 
# File 'lib/rubycord/sticker.rb', line 20

def description
  @description
end

#format ⇒ :png, ... (readonly)

Returns The format of the sticker.

Returns:

  • (:png, :apng, :lottie) —

    The format of the sticker.



18
19
20
 
# File 'lib/rubycord/sticker.rb', line 18

def format
  @format
end

#guild_id ⇒ RubyCord::Snowflake (readonly)

Returns The ID of the guild the sticker is in.

Returns:



26
27
28
 
# File 'lib/rubycord/sticker.rb', line 26

def guild_id
  @guild_id
end

#id ⇒ RubyCord::Snowflake (readonly)

Returns The ID of the sticker.

Returns:



10
11
12
 
# File 'lib/rubycord/sticker.rb', line 10

def id
  @id
end

#name ⇒ String (readonly)

Returns The name of the sticker.

Returns:

  • (String) —

    The name of the sticker.



12
13
14
 
# File 'lib/rubycord/sticker.rb', line 12

def name
  @name
end

#pack_id ⇒ RubyCord::Snowflake (readonly)

Returns The ID of the sticker pack.

Returns:



22
23
24
 
# File 'lib/rubycord/sticker.rb', line 22

def pack_id
  @pack_id
end

#sort_value ⇒ Integer (readonly)

Returns The sort value of the sticker.

Returns:

  • (Integer) —

    The sort value of the sticker.



24
25
26
 
# File 'lib/rubycord/sticker.rb', line 24

def sort_value
  @sort_value
end

#tags ⇒ Array<String> (readonly)

Returns The tags of the sticker.

Returns:

  • (Array<String>) —

    The tags of the sticker.



14
15
16
 
# File 'lib/rubycord/sticker.rb', line 14

def tags
  @tags
end

#type ⇒ :official, :guild (readonly)

Returns The type of sticker.

Returns:

  • (:official, :guild) —

    The type of sticker.



16
17
18
 
# File 'lib/rubycord/sticker.rb', line 16

def type
  @type
end

#user ⇒ RubyCord::User (readonly)

Returns The user who created the sticker.

Returns:



28
29
30
 
# File 'lib/rubycord/sticker.rb', line 28

def user
  @user
end