Class: Discorb::Gateway::MessagePinEvent

Inherits:

GatewayEvent

• Object
• GatewayEvent
• Discorb::Gateway::MessagePinEvent

Defined in:

lib/discorb/gateway_events.rb

Overview

Represents a message pin event.

Instance Attribute Summary

• #message -> Discorb::Message readonly

  The message that was pinned.

• #pinned? -> Boolean readonly

  Whether the message was pinned.

• #type -> :pinned, :unpinned readonly

  The type of event.

• #unpinned? -> Boolean readonly

  Whether the message was unpinned.

Instance Method Summary

• #initialize(client, data, message) -> MessagePinEvent constructor

  A new instance of MessagePinEvent.

Methods inherited from GatewayEvent

#inspect

Constructor Details

#initialize(client, data, message) -> MessagePinEvent

Returns a new instance of MessagePinEvent.

# File 'lib/discorb/gateway_events.rb', line 534

def initialize(client, data, message)
  @client = client
  @data = data
  @message = message
  @type =
    if message.nil?
      :unknown
    elsif @message.pinned?
      :pinned
    else
      :unpinned
    end
end

Instance Attribute Details

#message -> Discorb::Message (readonly)

Returns The message that was pinned.

Returns:

• (Discorb::Message) —

  The message that was pinned.

# File 'lib/discorb/gateway_events.rb', line 525

def message
  @message
end

#pinned? -> Boolean (readonly)

Returns Whether the message was pinned.

Returns:

• (Boolean) —

  Whether the message was pinned.

# File 'lib/discorb/gateway_events.rb', line 534

def initialize(client, data, message)
  @client = client
  @data = data
  @message = message
  @type =
    if message.nil?
      :unknown
    elsif @message.pinned?
      :pinned
    else
      :unpinned
    end
end

#type -> :pinned, :unpinned (readonly)

Returns The type of event.

Returns:

• (:pinned, :unpinned) —

  The type of event.

# File 'lib/discorb/gateway_events.rb', line 527

def type
  @type
end

#unpinned? -> Boolean (readonly)

Returns Whether the message was unpinned.

Returns:

• (Boolean) —

  Whether the message was unpinned.

# File 'lib/discorb/gateway_events.rb', line 534

def initialize(client, data, message)
  @client = client
  @data = data
  @message = message
  @type =
    if message.nil?
      :unknown
    elsif @message.pinned?
      :pinned
    else
      :unpinned
    end
end