Class Jabber::Message
In: lib/xmpp4r/message.rb
Parent: XMPPStanza

The Message class manages the <message/> stanzas, which is used for all messaging communication.

Methods

body   body=   new   set_body   set_subject   set_thread   set_type   subject   subject=   thread   thread=   type   type=  

Included Modules

XParent

Public Class methods

Create a new message

>to:a JID or a String object to send the message to.
>body:the message‘s body

[Source]

    # File lib/xmpp4r/message.rb, line 23
23:     def initialize(to = nil, body = nil)
24:       super()
25:       if not to.nil?
26:         set_to(to)
27:       end
28:       if !body.nil?
29:         add_element(REXML::Element::new("body").add_text(body))
30:       end
31:     end

Public Instance methods

Returns the message‘s body, or nil. This is the message‘s plain-text content.

[Source]

    # File lib/xmpp4r/message.rb, line 79
79:     def body
80:       first_element_text('body')
81:     end

Sets the message‘s body

b:[String] body to set

[Source]

    # File lib/xmpp4r/message.rb, line 87
87:     def body=(b)
88:       replace_element_text('body', b)
89:     end

Sets the message‘s body

b:[String] body to set
return:[REXML::Element] self for chaining

[Source]

    # File lib/xmpp4r/message.rb, line 96
96:     def set_body(b)
97:       self.body = b
98:       self
99:     end

sets the message‘s subject

s:[String] subject to set
return:[REXML::Element] self for chaining

[Source]

     # File lib/xmpp4r/message.rb, line 114
114:     def set_subject(s)
115:       self.subject = s
116:       self
117:     end

gets the message‘s thread (chaining-friendly) Please note that this are not [Thread] but a [String]-Identifier to track conversations

s:[String] thread to set

[Source]

     # File lib/xmpp4r/message.rb, line 137
137:     def set_thread(s)
138:       self.thread = s
139:       self
140:     end

Set the type of the Message stanza (chaining-friendly)

v:[Symbol] or nil

[Source]

    # File lib/xmpp4r/message.rb, line 71
71:     def set_type(v)
72:       self.type = v
73:       self
74:     end

Returns the message‘s subject, or nil

[Source]

     # File lib/xmpp4r/message.rb, line 121
121:     def subject
122:       first_element_text('subject')
123:     end

sets the message‘s subject

s:[String] subject to set

[Source]

     # File lib/xmpp4r/message.rb, line 105
105:     def subject=(s)
106:       replace_element_text('subject', s)
107:     end

Returns the message‘s thread, or nil

[Source]

     # File lib/xmpp4r/message.rb, line 144
144:     def thread
145:       first_element_text('thread')
146:     end

sets the message‘s thread

s:[String] thread to set

[Source]

     # File lib/xmpp4r/message.rb, line 128
128:     def thread=(s)
129:       delete_elements('thread')
130:       replace_element_text('thread', s) unless s.nil?
131:     end

Get the type of the Message stanza

The following Symbols are allowed:

  • :chat
  • :error
  • :groupchat
  • :headline
  • :normal
result:[Symbol] or nil

[Source]

    # File lib/xmpp4r/message.rb, line 43
43:     def type
44:       case super
45:         when 'chat' then :chat
46:         when 'error' then :error
47:         when 'groupchat' then :groupchat
48:         when 'headline' then :headline
49:         when 'normal' then :normal
50:         else nil
51:       end
52:     end

Set the type of the Message stanza (see Message#type for details)

v:[Symbol] or nil

[Source]

    # File lib/xmpp4r/message.rb, line 57
57:     def type=(v)
58:       case v
59:         when :chat then super('chat')
60:         when :error then super('error')
61:         when :groupchat then super('groupchat')
62:         when :headline then super('headline')
63:         when :normal then super('normal')
64:         else super(nil)
65:       end
66:     end

[Validate]