Class: Rubirai::VoiceMessage

Inherits:

Message

• Object
• Message
• Rubirai::VoiceMessage

Defined in:

lib/rubirai/messages/message.rb

Overview

The voice message type

Instance Attribute Summary

• #path ⇒ String^? readonly

  The local path of the voice.

• #url ⇒ String^? readonly

  The url of the voice.

• #voice_id ⇒ String^? readonly

  The voice id from mirai.

Attributes inherited from Message

#bot, #type

Class Method Summary

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

  Form a VoiceMessage.

Methods inherited from Message

all_types, check_type, #to_h, to_message

Instance Attribute Details

#path ⇒ String^? (readonly)

Returns the local path of the voice.

Returns:

• (String, nil) —

  the local path of the voice

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

set_message :Voice, :voice_id, :url, :path

#url ⇒ String^? (readonly)

Returns the url of the voice.

Returns:

• (String, nil) —

  the url of the voice

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

set_message :Voice, :voice_id, :url, :path

#voice_id ⇒ String^? (readonly)

Returns the voice id from mirai.

Returns:

• (String, nil) —

  the voice id from mirai

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

set_message :Voice, :voice_id, :url, :path

Class Method Details

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

Form a Rubirai::VoiceMessage. Only needs to give one of the three arguments.

Options Hash (**kwargs):

• :voice_id (String) —

  the voice id

• :url (String) —

  the url of the voice

• :path (String) —

  the local path of the voice

Returns:

• (Rubirai::VoiceMessage) —

  the message object

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

set_message :Voice, :voice_id, :url, :path