Class Jabber::Bytestreams::IqSiFile
In: lib/xmpp4r/bytestreams/iq/si.rb
Parent: REXML::Element
XMLStanza Message Presence Iq REXML::Element X IqQuery Error StreamHost IqSiFileRange IqSiFile StreamHostUsed IqSi IqFeature XRosterItem RosterItem XMUCUserItem XMUCUserInvite XDataField XDataReported XDataTitle XDataInstructions Feature Identity Item IqVcard Singleton IdGenerator Connection Client Component Comparable JID RuntimeError AuthenticationFailure ErrorException SOCKS5Error Stream SOCKS5Bytestreams SOCKS5BytestreamsTarget SOCKS5BytestreamsInitiator SOCKS5BytestreamsServerStreamHost TCPSocket SOCKS5Socket IqQuery IqQueryBytestreams IqQueryVersion IqQueryRoster IqQueryDiscoItems IqQueryDiscoInfo IBB IBBTarget IBBInitiator Responder SimpleResponder X XRoster XMUCUser XMUC XDelay XData MUCClient SimpleMUCClient Base DigestMD5 Plain FileSource StreamParser SOCKS5BytestreamsPeer SOCKS5BytestreamsServer IBBQueueItem Helper MUCBrowser Helper Helper lib/xmpp4r/authenticationfailure.rb lib/xmpp4r/idgenerator.rb lib/xmpp4r/connection.rb lib/xmpp4r/iq.rb lib/xmpp4r/jid.rb lib/xmpp4r/xmlstanza.rb lib/xmpp4r/errorexception.rb lib/xmpp4r/stream.rb lib/xmpp4r/client.rb lib/xmpp4r/x.rb lib/xmpp4r/streamparser.rb lib/xmpp4r/error.rb lib/xmpp4r/component.rb lib/xmpp4r/query.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/target.rb lib/xmpp4r/bytestreams/helper/socks5bytestreams/server.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 lib/xmpp4r/version/iq/version.rb lib/xmpp4r/version/helper/responder.rb lib/xmpp4r/version/helper/simpleresponder.rb Version lib/xmpp4r/feature_negotiation/iq/feature.rb FeatureNegotiation lib/xmpp4r/roster/helper/roster.rb lib/xmpp4r/roster/iq/roster.rb lib/xmpp4r/roster/x/roster.rb Roster 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/helper/simplemucclient.rb MUC lib/xmpp4r/sasl.rb SASL lib/xmpp4r/bytestreams/helper/filetransfer.rb TransferSource FileTransfer lib/xmpp4r/delay/x/delay.rb Delay lib/xmpp4r/dataforms/x/data.rb Dataforms lib/xmpp4r/discovery/iq/discoinfo.rb lib/xmpp4r/discovery/iq/discoitems.rb Discovery lib/xmpp4r/vcard/helper/vcard.rb lib/xmpp4r/vcard/iq/vcard.rb Vcard Jabber Module: Jabber

File-transfer meta-information, may appear as <file/> in IqSi

Methods

date   date=   description   description=   fname   fname=   hash   hash=   new   range   size   size=   typed_add  

Public Class methods

new(fname=nil, size=nil)

[Source]

    # File lib/xmpp4r/bytestreams/iq/si.rb, line 92
92:       def initialize(fname=nil, size=nil)
93:         super 'file'
94:         add_namespace IqSi::PROFILE_FILETRANSFER
95:         self.fname = fname
96:         self.size = size
97:       end

Public Instance methods

date()

Get file date

result:[Time] or nil

[Source]

     # File lib/xmpp4r/bytestreams/iq/si.rb, line 134
134:       def date
135:         begin
136:           Time.xmlschema(attributes['date'])
137:         rescue ArgumentError
138:           nil
139:         end
140:       end
date=(d)

Set file date

d:[Time] or nil

[Source]

     # File lib/xmpp4r/bytestreams/iq/si.rb, line 145
145:       def date=(d)
146:         attributes['date'] = (d ? d.xmlschema : nil)
147:       end
description()

File description

[Source]

     # File lib/xmpp4r/bytestreams/iq/si.rb, line 164
164:       def description
165:         first_element_text('desc')
166:       end
description=(s)

Set file description

[Source]

     # File lib/xmpp4r/bytestreams/iq/si.rb, line 170
170:       def description=(s)
171:         replace_element_text('desc', s)
172:       end
fname()

Get filename (attribute ‘name’)

[Source]

     # File lib/xmpp4r/bytestreams/iq/si.rb, line 109
109:       def fname
110:         attributes['name']
111:       end
fname=(s)

Set filename (attribute ‘name’)

[Source]

     # File lib/xmpp4r/bytestreams/iq/si.rb, line 115
115:       def fname=(s)
116:         attributes['name'] = s
117:       end
hash()

Get MD5 hash

[Source]

     # File lib/xmpp4r/bytestreams/iq/si.rb, line 121
121:       def hash
122:         attributes['hash']
123:       end
hash=(s)

Set MD5 hash

[Source]

     # File lib/xmpp4r/bytestreams/iq/si.rb, line 127
127:       def hash=(s)
128:         attributes['hash'] = s
129:       end
range()

<range/> child

A file-transfer offer may contain this with no attributes set, indicating the ability to do ranged transfers.

result:[IqSiFileRange]

[Source]

     # File lib/xmpp4r/bytestreams/iq/si.rb, line 181
181:       def range
182:         first_element('range')
183:       end
size()

File size in bytes

result:[Fixnum]

[Source]

     # File lib/xmpp4r/bytestreams/iq/si.rb, line 152
152:       def size
153:         (attributes['size'] =~ /^\d+$/) ? attributes['size'].to_i : nil
154:       end
size=(s)

Set file size

[Source]

     # File lib/xmpp4r/bytestreams/iq/si.rb, line 158
158:       def size=(s)
159:         attributes['size'] = s ? s.to_s : nil
160:       end
typed_add(element)

[Source]

     # File lib/xmpp4r/bytestreams/iq/si.rb, line 99
 99:       def typed_add(element)
100:         if element.kind_of?(REXML::Element) and element.name == 'range'
101:           super IqSiFileRange.new.import(element)
102:         else
103:           super element
104:         end
105:       end

[Validate]