Class: Discordrb::PrimaryServer

Inherits:
Object
  • Object
show all
Defined in:
lib/discordrb/data/primary_server.rb

Overview

A server tag that a user has chosen to display on their profile.

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#badge_id ⇒ String (readonly)

Returns the ID of the server tag's badge. can be used to generate a badge URL.

See Also:



19
20
21
 
# File 'lib/discordrb/data/primary_server.rb', line 19

def badge_id
  @badge_id
end

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



10
11
12
 
# File 'lib/discordrb/data/primary_server.rb', line 10

def enabled
  @enabled
end

#name ⇒ String (readonly) Also known as: text 



14
15
16
 
# File 'lib/discordrb/data/primary_server.rb', line 14

def name
  @name
end

#server_id ⇒ Integer (readonly) 



7
8
9
 
# File 'lib/discordrb/data/primary_server.rb', line 7

def server_id
  @server_id
end

Instance Method Details

#==(other) ⇒ true, false Also known as: eql?

Comparison based off of server ID.



52
53
54
55
56
 
# File 'lib/discordrb/data/primary_server.rb', line 52

def ==(other)
  return false unless other.is_a?(PrimaryServer)

  Discordrb.id_compare?(other.server_id, @server_id)
end

#badge_url(format = 'webp') ⇒ String

Utility method to get a server tag's badge URL.



46
47
48
 
# File 'lib/discordrb/data/primary_server.rb', line 46

def badge_url(format = 'webp')
  API.server_tag_badge_url(@server_id, @badge_id, format)
end

#server ⇒ Server

Get the server associated with this primary server.

Raises:



33
34
35
 
# File 'lib/discordrb/data/primary_server.rb', line 33

def server
  @bot.server(@server_id)
end

#server_preview ⇒ ServerPreview?

Get the server preview associated with this primary server.



39
40
41
 
# File 'lib/discordrb/data/primary_server.rb', line 39

def server_preview
  @bot.server_preview(@server_id)
end