Class: Rubirai::MusicShareMessage

Inherits:

Message

• Object
• Message
• Rubirai::MusicShareMessage

Defined in:

lib/rubirai/messages/message.rb

Overview

The music share card message

Instance Attribute Summary

• #brief ⇒ String^? readonly

  The brief message (optional).

• #jump_url ⇒ String readonly

  The jump url.

• #kind ⇒ String readonly

  The kind of music provider.

• #music_url ⇒ String readonly

  The music's url.

• #picture_url ⇒ String readonly

  The picture's url.

• #summary ⇒ String readonly

  The music card summary.

• #title ⇒ String readonly

  The music card title.

Attributes inherited from Message

#bot, #type

Class Method Summary

• .all_kinds ⇒ Array<String>

  List all kinds of music providers.

Methods inherited from Message

all_types, check_type, #to_h, to_message

Instance Attribute Details

#brief ⇒ String^? (readonly)

Returns the brief message (optional).

Returns:

• (String, nil) —

  the brief message (optional)

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

set_message :MusicShare, :kind, :title, :summary, :jump_url, :picture_url, :music_url, :brief do |hash|
  raise(RubiraiError, 'non valid music type') unless all_kinds.include? hash['kind']
end

#jump_url ⇒ String (readonly)

Returns the jump url.

Returns:

• (String) —

  the jump url

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

set_message :MusicShare, :kind, :title, :summary, :jump_url, :picture_url, :music_url, :brief do |hash|
  raise(RubiraiError, 'non valid music type') unless all_kinds.include? hash['kind']
end

#kind ⇒ String (readonly)

Returns the kind of music provider.

Returns:

• (String) —

  the kind of music provider

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

set_message :MusicShare, :kind, :title, :summary, :jump_url, :picture_url, :music_url, :brief do |hash|
  raise(RubiraiError, 'non valid music type') unless all_kinds.include? hash['kind']
end

#music_url ⇒ String (readonly)

Returns the music's url.

Returns:

• (String) —

  the music's url

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

set_message :MusicShare, :kind, :title, :summary, :jump_url, :picture_url, :music_url, :brief do |hash|
  raise(RubiraiError, 'non valid music type') unless all_kinds.include? hash['kind']
end

#picture_url ⇒ String (readonly)

Returns the picture's url.

Returns:

• (String) —

  the picture's url

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

set_message :MusicShare, :kind, :title, :summary, :jump_url, :picture_url, :music_url, :brief do |hash|
  raise(RubiraiError, 'non valid music type') unless all_kinds.include? hash['kind']
end

#summary ⇒ String (readonly)

Returns the music card summary.

Returns:

• (String) —

  the music card summary

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

set_message :MusicShare, :kind, :title, :summary, :jump_url, :picture_url, :music_url, :brief do |hash|
  raise(RubiraiError, 'non valid music type') unless all_kinds.include? hash['kind']
end

#title ⇒ String (readonly)

Returns the music card title.

Returns:

• (String) —

  the music card title

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

set_message :MusicShare, :kind, :title, :summary, :jump_url, :picture_url, :music_url, :brief do |hash|
  raise(RubiraiError, 'non valid music type') unless all_kinds.include? hash['kind']
end

Class Method Details

.all_kinds ⇒ Array<String>

List all kinds of music providers

Returns:

• (Array<String>) —

  kinds

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

def self.all_kinds
  %w[NeteaseCloudMusic QQMusic MiguMusic]
end