Class Jabber::Helpers::RosterItem
In: lib/xmpp4r/helpers/roster.rb
Parent: Jabber::RosterItem
X XDelay XMuc XRoster XMucUser REXML::Element XRosterItem IqQuery XMLStanza IqVcard DiscoIdentity XMucUserItem DiscoItem Error RosterItem DiscoFeature IqQueryRoster IqQueryVersion IqQueryDiscoItems IqQueryDiscoInfo Message Presence Iq Singleton IdGenerator Connection Client Component Comparable JID RuntimeError ErrorException AuthenticationFailure RosterItem Stream StreamParser Roster Vcard Version lib/xmpp4r/authenticationfailure.rb lib/xmpp4r/iq/query/roster.rb lib/xmpp4r/idgenerator.rb lib/xmpp4r/iq/query/version.rb lib/xmpp4r/connection.rb lib/xmpp4r/x/mucuseritem.rb lib/xmpp4r/x/roster.rb lib/xmpp4r/iq.rb lib/xmpp4r/jid.rb lib/xmpp4r/iq/query.rb lib/xmpp4r/xmlstanza.rb lib/xmpp4r/x/delay.rb lib/xmpp4r/errorexception.rb lib/xmpp4r/client.rb lib/xmpp4r/stream.rb lib/xmpp4r/x/muc.rb lib/xmpp4r/streamparser.rb lib/xmpp4r/x.rb lib/xmpp4r/iq/vcard.rb lib/xmpp4r/iq/query/discoinfo.rb lib/xmpp4r/error.rb lib/xmpp4r/component.rb lib/xmpp4r/message.rb lib/xmpp4r/iq/query/discoitems.rb lib/xmpp4r/presence.rb lib/xmpp4r/helpers/roster.rb lib/xmpp4r/helpers/vcard.rb lib/xmpp4r/helpers/version.rb Helpers Jabber Module: Jabber

These are extensions to RosterItem to carry presence information. This information is not stored in XML!

Methods

add_presence   each_presence   import   new   online?   presence   send   subscribe   unsubscribe  

Attributes

presences  [R]  Tracked (online) presences of this RosterItem

Public Class methods

new(stream)

Initialize an empty RosterItem

[Source]

     # File lib/xmpp4r/helpers/roster.rb, line 276
276:       def initialize(stream)
277:         super()
278:         @stream = stream
279:         @presences = []
280:       end

Public Instance methods

add_presence(newpres)

Add presence (unless type is :unavailable)

This overwrites previous stanzas with the same destination JID to keep track of resources. Presence stanzas with type == :unavailable will be deleted as this indicates that this resource has gone offline.

[Source]

     # File lib/xmpp4r/helpers/roster.rb, line 342
342:       def add_presence(newpres)
343:         # Delete old presences with the same JID
344:         @presences.delete_if do |pres|
345:           pres.from == newpres.from
346:         end
347:         # Add new presence
348:         unless newpres.type == :unavailable
349:           @presences.push(newpres)
350:         end
351:       end
each_presence() {|pres| ...}

Iterate through all received <presence/> stanzas

[Source]

     # File lib/xmpp4r/helpers/roster.rb, line 316
316:       def each_presence(&block)
317:         @presences.each { |pres|
318:           yield(pres)
319:         }
320:       end
import(xe)

Import another element, also import presences if xe is a RosterItem

return:[RosterItem] self

[Source]

     # File lib/xmpp4r/helpers/roster.rb, line 286
286:       def import(xe)
287:         super
288:         if xe.kind_of?(RosterItem)
289:           xe.each_presence { |pres|
290:             add_presence(Presence.new.import(pres))
291:           }
292:         end
293:         self
294:       end
online?()

Is any presence of this person on-line?

(Or is there any presence? Unavailable presences are deleted.)

[Source]

     # File lib/xmpp4r/helpers/roster.rb, line 310
310:       def online?
311:         @presences.size > 0
312:       end
presence(jid)

Get specific presence

jid:[JID] Full JID

[Source]

     # File lib/xmpp4r/helpers/roster.rb, line 325
325:       def presence(jid)
326:         @presences.each do |pres|
327:           if pres.from == jid
328:             return(pres)
329:           end
330:         end
331:         nil
332:       end
send()

Send the updated RosterItem to the server, i.e. if you modified iname, groups, …

[Source]

     # File lib/xmpp4r/helpers/roster.rb, line 299
299:       def send
300:         request = Iq.new_rosterset
301:         request.query.add(self)
302:         @stream.send(request)
303:       end
subscribe()

Send subscription request to the user

The block given to Jabber::Helpers::Roster#add_update_callback will be called, carrying the RosterItem with ask="subscribe"

[Source]

     # File lib/xmpp4r/helpers/roster.rb, line 358
358:       def subscribe
359:         pres = Presence.new.set_type(:subscribe).set_to(jid)
360:         @stream.send(pres)
361:       end
unsubscribe()

Send unsubscription request to the user

[Source]

     # File lib/xmpp4r/helpers/roster.rb, line 365
365:       def unsubscribe
366:         pres = Presence.new.set_type(:unsubscribe).set_to(jid)
367:         @stream.send(pres)
368:       end

[Validate]