Module: Discordrb::ServerAttributes

Included in:

Light::UltraLightServer, Server

Defined in:

lib/discordrb/data.rb

Overview

Basic attributes a server should have

Instance Attribute Summary

• #icon_id ⇒ String readonly

  The hexadecimal ID used to identify this server's icon.

• #name ⇒ String readonly

  This server's name.

Instance Method Summary

• #icon_url ⇒ String

  Utility function to get the URL for the icon image.

Instance Attribute Details

#icon_id ⇒ String (readonly)

Returns the hexadecimal ID used to identify this server's icon.

Returns:

• (String) —

  the hexadecimal ID used to identify this server's icon.

# File 'lib/discordrb/data.rb', line 1903

def icon_id
  @icon_id
end

#name ⇒ String (readonly)

Returns this server's name.

Returns:

• (String) —

  this server's name.

# File 'lib/discordrb/data.rb', line 1900

def name
  @name
end

Instance Method Details

#icon_url ⇒ String

Utility function to get the URL for the icon image

Returns:

• (String) —

  the URL to the icon image

# File 'lib/discordrb/data.rb', line 1907

def icon_url
  return nil unless @icon_id
  API.icon_url(@id, @icon_id)
end