Class: Discorb::Channel Abstract

Inherits:
DiscordModel show all
Defined in:
lib/discorb/channel/base.rb

Overview

This class is abstract.

Represents a channel of Discord.

Direct Known Subclasses

DMChannel, GuildChannel, ThreadChannel

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from DiscordModel

#eql?

Instance Attribute Details

#id ⇒ Discorb::Snowflake (readonly)

Returns The ID of the channel.

Returns:



10
11
12
 
# File 'lib/discorb/channel/base.rb', line 10

def id
  @id
end

#name ⇒ String (readonly)

Returns The name of the channel.

Returns:

  • (String) —

    The name of the channel.



12
13
14
 
# File 'lib/discorb/channel/base.rb', line 12

def name
  @name
end

Instance Method Details

#==(other) ⇒ Boolean

Checks if the channel is other channel.

Parameters:

Returns:

  • (Boolean) —

    True if the channel is other channel.



38
39
40
41
42
 
# File 'lib/discorb/channel/base.rb', line 38

def ==(other)
  return false unless other.respond_to?(:id)

  @id == other.id
end

#inspect ⇒ Object 



44
45
46
 
# File 'lib/discorb/channel/base.rb', line 44

def inspect
  "#<#{self.class} \"##{@name}\" id=#{@id}>"
end

#type ⇒ Object 



84
85
86
 
# File 'lib/discorb/channel/base.rb', line 84

def type
  self.class.channel_type
end