Class: Discordrb::Events::ChannelCreateEvent

Inherits:

Event

• Object
• Event
• Discordrb::Events::ChannelCreateEvent

Defined in:

lib/discordrb/events/channels.rb

Overview

Raised when a channel is created

Direct Known Subclasses

ChannelUpdateEvent

Instance Attribute Summary

• #channel ⇒ Channel readonly

  The channel in question.

• #id ⇒ Integer readonly

  The channel’s unique ID.

• #name ⇒ String readonly

  The channel’s name.

• #position ⇒ Integer readonly

  The position of the channel in the channels list.

• #server ⇒ Server readonly

  The server the channel belongs to.

• #topic ⇒ String readonly

  The channel’s topic.

• #type ⇒ Integer readonly

  The channel’s type (0: text, 1: private, 2: voice, 3: group).

Attributes inherited from Event

#bot

Instance Method Summary

• #initialize(data, bot) ⇒ ChannelCreateEvent constructor

  A new instance of ChannelCreateEvent.

Constructor Details

#initialize(data, bot) ⇒ ChannelCreateEvent

Returns a new instance of ChannelCreateEvent.

# File 'lib/discordrb/events/channels.rb', line 32

def initialize(data, bot)
  @bot = bot
  @channel = data.is_a?(Discordrb::Channel) ? data : bot.channel(data['id'].to_i)
end

Instance Attribute Details

#channel ⇒ Channel (readonly)

Returns the channel in question.

Returns:

• (Channel) —

  the channel in question.

# File 'lib/discordrb/events/channels.rb', line 10

def channel
  @channel
end

#id ⇒ Integer (readonly)

Returns the channel’s unique ID.

Returns:

• (Integer) —

  the channel’s unique ID.

See Also:

• Channel#id

# File 'lib/discordrb/events/channels.rb', line 30

delegate :name, :server, :type, :owner_id, :recipients, :topic, :user_limit, :position, :permission_overwrites, to: :channel

#name ⇒ String (readonly)

Returns the channel’s name.

Returns:

• (String) —

  the channel’s name

See Also:

• Channel#name

# File 'lib/discordrb/events/channels.rb', line 30

delegate :name, :server, :type, :owner_id, :recipients, :topic, :user_limit, :position, :permission_overwrites, to: :channel

#position ⇒ Integer (readonly)

Returns the position of the channel in the channels list.

Returns:

• (Integer) —

  the position of the channel in the channels list.

See Also:

• Channel#position

# File 'lib/discordrb/events/channels.rb', line 30

delegate :name, :server, :type, :owner_id, :recipients, :topic, :user_limit, :position, :permission_overwrites, to: :channel

#server ⇒ Server (readonly)

Returns the server the channel belongs to.

Returns:

• (Server) —

  the server the channel belongs to.

See Also:

• Channel#server

# File 'lib/discordrb/events/channels.rb', line 30

delegate :name, :server, :type, :owner_id, :recipients, :topic, :user_limit, :position, :permission_overwrites, to: :channel

#topic ⇒ String (readonly)

Returns the channel’s topic.

Returns:

• (String) —

  the channel’s topic.

See Also:

• Channel#topic

# File 'lib/discordrb/events/channels.rb', line 30

delegate :name, :server, :type, :owner_id, :recipients, :topic, :user_limit, :position, :permission_overwrites, to: :channel

#type ⇒ Integer (readonly)

Returns the channel’s type (0: text, 1: private, 2: voice, 3: group).

Returns:

• (Integer) —

  the channel’s type (0: text, 1: private, 2: voice, 3: group).

See Also:

• Channel#type

# File 'lib/discordrb/events/channels.rb', line 30

delegate :name, :server, :type, :owner_id, :recipients, :topic, :user_limit, :position, :permission_overwrites, to: :channel