Class: Jabber::Presence

Create a new presence from a stanza

result:

    # File lib/xmpp4r/presence.rb, line 42
42:     def Presence.import(xmlstanza)
43:       Presence::new.import(xmlstanza)
44:     end

new(show=nil, status=nil, priority=nil)

Create presence stanza

show:	[String] Initial Availability Status
status:	[String] Initial status message
priority:	[Fixnum] Initial priority value

[Source]

    # File lib/xmpp4r/presence.rb, line 20
20:     def initialize(show=nil, status=nil, priority=nil)
21:       super("presence")
22:       set_show(show) if show
23:       set_status(status) if status
24:       set_priority(priority) if priority
25:     end

<=>(o)

Compare two presences using priority (with cmp_interest as fall-back).

[Source]

     # File lib/xmpp4r/presence.rb, line 220
220:     def <=>(o)
221:       if priority.to_i == o.priority.to_i
222:         cmp_interest(o)
223:       else
224:         priority.to_i <=> o.priority.to_i
225:       end
226:     end

cmp_interest(o)

[Source]

     # File lib/xmpp4r/presence.rb, line 238
238:     def cmp_interest(o)
239:       if type.nil?
240:         if o.type.nil?
241:           # both available.
242:           PRESENCE_STATUS[show] <=> PRESENCE_STATUS[o.show]
243:         else
244:           return -1
245:         end
246:       elsif o.type.nil?
247:         return 1
248:       else
249:         # both are non-nil. We consider this is equal.
250:         return 0
251:       end
252:     end

priority()

Get presence priority, or nil if absent

result:

[Integer]

[Source]

     # File lib/xmpp4r/presence.rb, line 186
186:     def priority
187:        e = first_element_text('priority')
188:       if e
189:         return e.to_i
190:       else
191:         return nil
192:       end
193:     end

priority=(val)

Set presence priority

val:	[Integer] Priority value between -128 and +127

*Warning:* negative values make you receive no subscription requests etc. (RFC3921 - 2.2.2.3.)

[Source]

     # File lib/xmpp4r/presence.rb, line 201
201:     def priority=(val)
202:       if val.nil?
203:         delete_element('priority')
204:       else
205:         replace_element_text('priority', val)
206:       end
207:     end

set_priority(val)

Set presence priority (chaining-friendly)

val:	[Integer] Priority value between -128 and +127

[Source]

     # File lib/xmpp4r/presence.rb, line 212
212:     def set_priority(val)
213:       self.priority = val
214:       self
215:     end

set_show(val)

Set Availability Status (chaining-friendly)

val:	[Symbol] or [Nil] See show for explanation

[Source]

     # File lib/xmpp4r/presence.rb, line 152
152:     def set_show(val)
153:       self.show = val
154:       self
155:     end

set_status(val)

Set status message (chaining-friendly)

val:	[String] or nil

[Source]

     # File lib/xmpp4r/presence.rb, line 178
178:     def set_status(val)
179:       self.status = val
180:       self
181:     end

set_type(val)

Set type of presence (chaining-friendly)

val:	[Symbol] See type for possible subscription types

[Source]

    # File lib/xmpp4r/presence.rb, line 91
91:     def set_type(val)
92:       self.type = val
93:       self
94:     end

show()

Get Availability Status (RFC3921 - 5.2)

result:

[Symbol] or [Nil] Valid values according to RFC3921:

nil (Available, no <show/> element)
:away
:chat (Free for chat)
:dnd (Do not disturb)
:xa (Extended away)

[Source]

     # File lib/xmpp4r/presence.rb, line 113
113:     def show
114:       e = first_element('show')
115:       text = e ? e.text : nil
116:       case text
117:         when 'away' then :away
118:         when 'chat' then :chat
119:         when 'dnd' then :dnd
120:         when 'xa' then :xa
121:         else nil
122:       end
123:     end

show=(val)

Set Availability Status

val:	[Symbol] or [Nil] See show for explanation

[Source]

     # File lib/xmpp4r/presence.rb, line 128
128:     def show=(val)
129:       xe = first_element('show')
130:       if xe.nil?
131:         xe = add_element('show')
132:       end
133:       case val
134:         when :away then text = 'away'
135:         when :chat then text = 'chat'
136:         when :dnd then text = 'dnd'
137:         when :xa then text = 'xa'
138:         when nil then text = nil
139:         else raise "Invalid value for show."
140:       end
141: 
142:       if text.nil?
143:         delete_element(xe)
144:       else
145:         xe.text = text
146:       end
147:     end

status()

Get status message

result:

[String] or nil

[Source]

     # File lib/xmpp4r/presence.rb, line 160
160:     def status
161:       first_element_text('status')
162:     end

status=(val)

Set status message

val:	[String] or nil

[Source]

     # File lib/xmpp4r/presence.rb, line 167
167:     def status=(val)
168:       if val.nil?
169:         delete_element('status')
170:       else
171:         replace_element_text('status', val)
172:       end
173:     end

type()

Get type of presence

result:

[Symbol] or [Nil] Possible values are:

:error
:probe (Servers send this to request presence information)
:subscribe (Subscription request)
:subscribed (Subscription approval)
:unavailable (User has gone offline)
:unsubscribe (Unsubscription request)
:unsubscribed (Unsubscription approval)
[nil] (available)

See RFC3921 - 2.2.1. for explanation.

[Source]

    # File lib/xmpp4r/presence.rb, line 59
59:     def type
60:       case super
61:         when 'error' then :error
62:         when 'probe' then :probe
63:         when 'subscribe' then :subscribe
64:         when 'subscribed' then :subscribed
65:         when 'unavailable' then :unavailable
66:         when 'unsubscribe' then :unsubscribe
67:         when 'unsubscribed' then :unsubscribed
68:         else nil
69:       end
70:     end

type=(val)

Set type of presence

val:	[Symbol] See type for possible subscription types

[Source]

    # File lib/xmpp4r/presence.rb, line 75
75:     def type=(val)
76:       case val
77:         when :error then super('error')
78:         when :probe then super('probe')
79:         when :subscribe then super('subscribe')
80:         when :subscribed then super('subscribed')
81:         when :unavailable then super('unavailable')
82:         when :unsubscribe then super('unsubscribe')
83:         when :unsubscribed then super('unsubscribed')
84:         else super(nil)
85:       end
86:     end

typed_add(element)

Add an element to the presence stanza

<x/> elements are converted to [X]

element:

[REXML::Element] to add

[Source]

    # File lib/xmpp4r/presence.rb, line 31
31:     def typed_add(element)
32:       if element.kind_of?(REXML::Element) && (element.name == 'x')
33:         super(X::import(element))
34:       else
35:         super(element)
36:       end
37:     end

x()

Get the first <x/> element of this stanza

result:

[REXML::Element] or nil

[Source]

     # File lib/xmpp4r/presence.rb, line 99
 99:     def x
100:       xe = nil
101:       each_element('x') { |e| xe = e }
102:       xe
103:     end

Methods

Included Modules

Constants

Public Class methods

Public Instance methods