Class: Rubirai::ImageMessage

Inherits:

Message

• Object
• Message
• Rubirai::ImageMessage

Defined in:

lib/rubirai/messages/message.rb

Overview

The image message type. Only one out of the three fields is needed to form the message.

Instance Attribute Summary

• #image_id ⇒ String^? readonly

  The image id from mirai.

• #path ⇒ String^? readonly

  The local path of the image.

• #url ⇒ String^? readonly

  The url of the image.

Attributes inherited from Message

#bot, #type

Class Method Summary

• .from(**kwargs) ⇒ Rubirai::ImageMessage

  Form an ImageMessage.

Methods inherited from Message

all_types, check_type, #to_h, to_message

Instance Attribute Details

#image_id ⇒ String^? (readonly)

Returns the image id from mirai.

Returns:

• (String, nil) —

  the image id from mirai

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

set_message :Image, :image_id, :url, :path

#path ⇒ String^? (readonly)

Returns the local path of the image.

Returns:

• (String, nil) —

  the local path of the image

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

set_message :Image, :image_id, :url, :path

#url ⇒ String^? (readonly)

Returns the url of the image.

Returns:

• (String, nil) —

  the url of the image

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

set_message :Image, :image_id, :url, :path

Class Method Details

.from(**kwargs) ⇒ Rubirai::ImageMessage

Form an Rubirai::ImageMessage. Only needs to give one of the three arguments.

Options Hash (**kwargs):

• :image_id (String) —

  the image id

• :url (String) —

  the url of the image

• :path (String) —

  the local path of the image

Returns:

• (Rubirai::ImageMessage) —

  the message object

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

set_message :Image, :image_id, :url, :path