Class Jabber::Command::IqCommand
In: lib/xmpp4r/command/iq/command.rb
Parent: Iq
Message Presence XMPPStanza Iq Singleton IdGenerator XMPPElement X IqQuery Error Connection Client Component Client Comparable JID RuntimeError AuthenticationFailure ErrorException NoNameXmlnsRegistered SOCKS5Error REXML::Element Stream SOCKS5Bytestreams SOCKS5BytestreamsTarget SOCKS5BytestreamsInitiator XMPPElement StreamHost IqSiFileRange IqSiFile StreamHostUsed IqSi XRosterItem RosterItem IqFeature XMUCUserItem XMUCUserInvite IqPubSub Items Item Event Feature Item Identity XDataField XDataReported XDataTitle XDataInstructions IqVcard SOCKS5BytestreamsServerStreamHost TCPSocket SOCKS5Socket IqQuery IqQueryBytestreams IqQueryVersion IqQueryRoster IqQueryMUCOwner IqQueryRPC IqQueryDiscoItems IqQueryDiscoInfo IBB IBBTarget IBBInitiator Responder SimpleResponder Iq IqCommand RosterXItem XRoster RosterX X XMUCUser XMUC XDelay XData XParent MUCClient SimpleMUCClient XMLRPC::ParserWriterChooseMixin Client Server XMLRPC::ParseContentType XMLRPC::BasicServer Base DigestMD5 Plain ServiceHelper NodeHelper FileSource CallbackList Callback Semaphore StreamParser SOCKS5BytestreamsPeer SOCKS5BytestreamsServer IBBQueueItem Responder Helper MUCBrowser NodeBrowser Helper Helper lib/xmpp4r/authenticationfailure.rb lib/xmpp4r/xmppstanza.rb lib/xmpp4r/callbacks.rb lib/xmpp4r/idgenerator.rb lib/xmpp4r/connection.rb lib/xmpp4r/iq.rb lib/xmpp4r/jid.rb lib/xmpp4r/errorexception.rb lib/xmpp4r/client.rb lib/xmpp4r/stream.rb lib/xmpp4r/semaphore.rb lib/xmpp4r/streamparser.rb lib/xmpp4r/x.rb lib/xmpp4r/error.rb lib/xmpp4r/component.rb lib/xmpp4r/query.rb lib/xmpp4r/xmppelement.rb lib/xmpp4r/message.rb lib/xmpp4r/presence.rb lib/xmpp4r/bytestreams/helper/ibb/initiator.rb lib/xmpp4r/bytestreams/iq/si.rb lib/xmpp4r/bytestreams/iq/bytestreams.rb lib/xmpp4r/bytestreams/helper/socks5bytestreams/base.rb lib/xmpp4r/bytestreams/helper/socks5bytestreams/server.rb lib/xmpp4r/bytestreams/helper/socks5bytestreams/target.rb lib/xmpp4r/bytestreams/helper/socks5bytestreams/socks5.rb lib/xmpp4r/bytestreams/helper/socks5bytestreams/initiator.rb lib/xmpp4r/bytestreams/helper/ibb/base.rb lib/xmpp4r/bytestreams/helper/ibb/target.rb Bytestreams XParent lib/xmpp4r/version/iq/version.rb lib/xmpp4r/version/helper/responder.rb lib/xmpp4r/version/helper/simpleresponder.rb Version lib/xmpp4r/command/iq/command.rb lib/xmpp4r/command/helper/responder.rb Command lib/xmpp4r/roster/helper/roster.rb lib/xmpp4r/roster/iq/roster.rb lib/xmpp4r/roster/x/roster.rb Roster lib/xmpp4r/feature_negotiation/iq/feature.rb FeatureNegotiation lib/xmpp4r/muc/x/muc.rb lib/xmpp4r/muc/helper/mucclient.rb lib/xmpp4r/muc/x/mucuseritem.rb lib/xmpp4r/muc/helper/mucbrowser.rb lib/xmpp4r/muc/x/mucuserinvite.rb lib/xmpp4r/muc/iq/mucowner.rb lib/xmpp4r/muc/helper/simplemucclient.rb MUC lib/xmpp4r/rpc/helper/server.rb lib/xmpp4r/rpc/helper/client.rb lib/xmpp4r/rpc/iq/rpc.rb RPC lib/xmpp4r/sasl.rb SASL lib/xmpp4r/delay/x/delay.rb Delay lib/xmpp4r/pubsub/helper/servicehelper.rb lib/xmpp4r/pubsub/stanzas/item.rb lib/xmpp4r/pubsub/helper/nodehelper.rb lib/xmpp4r/pubsub/iq/pubsub.rb lib/xmpp4r/pubsub/stanzas/event.rb lib/xmpp4r/pubsub/helper/nodebrowser.rb lib/xmpp4r/pubsub/stanzas/items.rb PubSub lib/xmpp4r/httpbinding/client.rb HTTPBinding lib/xmpp4r/bytestreams/helper/filetransfer.rb TransferSource FileTransfer lib/xmpp4r/discovery/iq/discoinfo.rb lib/xmpp4r/discovery/iq/discoitems.rb Discovery lib/xmpp4r/dataforms/x/data.rb Dataforms lib/xmpp4r/vcard/helper/vcard.rb lib/xmpp4r/vcard/iq/vcard.rb Vcard Jabber dot/m_79_0.png

Class for handling ad-hoc commands (JEP 0050)

A command is uniquely identified by its node attribute.

Methods

action   action=   actions   new   node   node=   sessionid   sessionid=   set_action   set_node   set_sessionid   set_status   status   status=  

Public Class methods

[Source]

    # File lib/xmpp4r/command/iq/command.rb, line 15
15:       def initialize(node=nil, action=nil)
16:         super()
17:         set_node(node)
18:         set_action(action)
19:       end

Public Instance methods

Get the action of the Command stanza

The following Symbols are allowed:

  • :execute
  • :cancel
  • :prev
  • :next
  • :complete
return:[Symbol] or nil

[Source]

    # File lib/xmpp4r/command/iq/command.rb, line 75
75:       def action
76:         case attributes['action']
77:           when 'execute' then :execute
78:           when 'cancel' then :cancel
79:           when 'prev' then :prev
80:           when 'next' then :next
81:           when 'complete' then :complete
82:           else nil
83:         end
84:       end

Set the action of the Command stanza (see IqCommand#action for details)

v:[Symbol] or nil

[Source]

    # File lib/xmpp4r/command/iq/command.rb, line 89
89:       def action=(v)
90:         attributes['action'] = case v
91:           when :execute then 'execute'
92:           when :cancel then 'cancel'
93:           when :prev then 'prev'
94:           when :next then 'next'
95:           when :complete then 'complete'
96:           else nil
97:         end
98:       end

Get the actions allowed

return:[REXML::Element] or nil

[Source]

     # File lib/xmpp4r/command/iq/command.rb, line 148
148:       def actions
149:         first_element('actions')
150:       end

Get the node of the Command stanza

result:[String] or nil

[Source]

    # File lib/xmpp4r/command/iq/command.rb, line 24
24:       def node
25:         attributes['node']
26:       end

Set the node of the Command stanza

v:[String] or nil

[Source]

    # File lib/xmpp4r/command/iq/command.rb, line 31
31:       def node=(v)
32:         attributes['node'] = v
33:       end

Get the sessionid of the Command stanza

result:[String] or nil

[Source]

    # File lib/xmpp4r/command/iq/command.rb, line 46
46:       def sessionid
47:         attributes['sessionid']
48:       end

Set the sessionid of the Command stanza

v:[String] or nil

[Source]

    # File lib/xmpp4r/command/iq/command.rb, line 53
53:       def sessionid=(v)
54:         attributes['sessionid'] = v
55:       end

Set the action of the Command stanza (chaining-friendly)

v:[Symbol] or nil

[Source]

     # File lib/xmpp4r/command/iq/command.rb, line 103
103:       def set_action(v)
104:         self.action = v
105:         self
106:       end

Set the node of the Command stanza (chaining-friendly)

v:[String] or nil

[Source]

    # File lib/xmpp4r/command/iq/command.rb, line 38
38:       def set_node(v)
39:         self.node = v
40:         self
41:       end

Set the sessionid of the Command stanza (chaining-friendly)

v:[String] or nil

[Source]

    # File lib/xmpp4r/command/iq/command.rb, line 60
60:       def set_sessionid(v)
61:         self.sessionid = v
62:         self
63:       end

Set the status of the Command stanza (chaining-friendly)

v:[Symbol] or nil

[Source]

     # File lib/xmpp4r/command/iq/command.rb, line 140
140:       def set_status(v)
141:         self.status = v
142:         self
143:       end

Get the status of the Command stanza

The following Symbols are allowed:

  • :executing
  • :completed
  • :canceled
return:[Symbol] or nil

[Source]

     # File lib/xmpp4r/command/iq/command.rb, line 116
116:       def status
117:         case attributes['status']
118:           when 'executing' then :executing
119:           when 'completed' then :completed
120:           when 'canceled' then :canceled
121:           else nil
122:         end
123:       end

Set the status of the Command stanza (see IqCommand#status for details)

v:[Symbol] or nil

[Source]

     # File lib/xmpp4r/command/iq/command.rb, line 128
128:       def status=(v)
129:         attributes['status'] = case v
130:           when :executing then 'executing'
131:           when :completed then 'completed'
132:           when :canceled then 'canceled'
133:           else nil
134:         end
135:       end

[Validate]