Class: Xrc::Messages::Base

Inherits:
Object
  • Object
show all
Defined in:
lib/xrc/messages/base.rb

Direct Known Subclasses

Invite, Message, Null, Subject

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(element) ⇒ Base

Returns a new instance of Base.

Parameters:

  • element (REXML::Element) —

    A message element



8
9
10
 
# File 'lib/xrc/messages/base.rb', line 8

def initialize(element)
  @element = element
end

Instance Attribute Details

#element ⇒ REXML::Element (readonly)

Returns Raw element object.

Returns:

  • (REXML::Element) —

    Raw element object



5
6
7
 
# File 'lib/xrc/messages/base.rb', line 5

def element
  @element
end

Instance Method Details

#delayed? ⇒ true, false

Note:

See XEP-0203 for more details about Delayed Delivery

Returns True if given message includes delay element.

Returns:

  • (true, false) —

    True if given message includes delay element



38
39
40
 
# File 'lib/xrc/messages/base.rb', line 38

def delayed?
  !!@element.elements["delay"]
end

#from ⇒ String

Returns a JID of message sender

Examples:

message.from #=> "[email protected]"

Returns:

  • (String) 


16
17
18
 
# File 'lib/xrc/messages/base.rb', line 16

def from
  @element.attribute("from").to_s
end

#to ⇒ String

Returns a JID of message address

Examples:

message.to #=> "[email protected]"

Returns:

  • (String) 


24
25
26
 
# File 'lib/xrc/messages/base.rb', line 24

def to
  @element.attribute("to").to_s
end

#type ⇒ String

Returns the type of the message

Examples:

message.type #=> "groupchat"

Returns:

  • (String) 


32
33
34
 
# File 'lib/xrc/messages/base.rb', line 32

def type
  @element.attribute("type").to_s
end