Class: Rubirai::AtMessage

Inherits:

Message

• Object
• Message
• Rubirai::AtMessage

Defined in:

lib/rubirai/messages/message.rb

Overview

The At message type

Instance Attribute Summary

• #display ⇒ String readonly

  The displayed name (not used when sending).

• #target ⇒ Integer readonly

  The target group user's id.

Attributes inherited from Message

#bot, #type

Instance Method Summary

• #from(**kwargs) ⇒ AtMessage

  Form an AtMessage.

Methods inherited from Message

all_types, check_type, #to_h, to_message

Instance Attribute Details

#display ⇒ String (readonly)

Returns the displayed name (not used when sending).

Returns:

• (String) —

  the displayed name (not used when sending)

# File 'lib/rubirai/messages/message.rb', line 280

set_message :At, :target, :display

#target ⇒ Integer (readonly)

Returns the target group user's id.

Returns:

• (Integer) —

  the target group user's id

# File 'lib/rubirai/messages/message.rb', line 280

set_message :At, :target, :display

Instance Method Details

#from(**kwargs) ⇒ AtMessage

Form an Rubirai::AtMessage. The display option has no effect when sending at messages.

Options Hash (**kwargs):

• :target (Integer) —

  the target id

Returns:

• (AtMessage) —

  the message object

# File 'lib/rubirai/messages/message.rb', line 280

set_message :At, :target, :display