Class: Jabber::Dataforms::XDataField

     # File lib/xmpp4r/dataforms/x/data.rb, line 108
108:       def initialize(var=nil, type=nil)
109:         super('field')
110:         self.var = var
111:         self.type = type
112:       end

label()

[Source]

     # File lib/xmpp4r/dataforms/x/data.rb, line 114
114:       def label
115:         attributes['label']
116:       end

label=(s)

[Source]

     # File lib/xmpp4r/dataforms/x/data.rb, line 118
118:       def label=(s)
119:         attributes['label'] = s
120:       end

options()

Get the options (in a Data Form with type=‘form’)

[Source]

     # File lib/xmpp4r/dataforms/x/data.rb, line 217
217:       def options
218:         res = {}
219:         each_element('option') { |e|
220:           value = nil
221:           e.each_element('value') { |ve| value = ve.text }
222:           res[value] = e.attributes['label']
223:         }
224:         res
225:       end

options=(hsh)

Set the options

[Source]

     # File lib/xmpp4r/dataforms/x/data.rb, line 229
229:       def options=(hsh)
230:         delete_elements('option')
231:         hsh.each { |value,label|
232:           o = add(REXML::Element.new('option'))
233:           o.attributes['label'] = label
234:           o.add(REXML::Element.new('value')).text = value
235:         }
236:       end

required=(r)

Set if this field is required

r:	[true] or [false]

[Source]

     # File lib/xmpp4r/dataforms/x/data.rb, line 189
189:       def required=(r)
190:         delete_elements('required')
191:         if r
192:           add REXML::Element.new('required')
193:         end
194:       end

required?()

Is this field required (has the <required/> child)?

[Source]

     # File lib/xmpp4r/dataforms/x/data.rb, line 180
180:       def required?
181:         res = false
182:         each_element('required') { res = true }
183:         res
184:       end

type()

Type of this field

result:

* :boolean

:fixed
:hidden
:jid_multi
:jid_single
:list_multi
:list_single
:text_multi
:text_private
:text_single
nil

[Source]

     # File lib/xmpp4r/dataforms/x/data.rb, line 144
144:       def type
145:         case attributes['type']
146:           when 'boolean' then :boolean
147:           when 'fixed' then :fixed
148:           when 'hidden' then :hidden
149:           when 'jid-multi' then :jid_multi
150:           when 'jid-single' then :jid_single
151:           when 'list-multi' then :list_multi
152:           when 'list-single' then :list_single
153:           when 'text-multi' then :text_multi
154:           when 'text-private' then :text_private
155:           when 'text-single' then :text_single
156:           else nil
157:         end
158:       end

type=(t)

Set the type of this field (see type)

[Source]

     # File lib/xmpp4r/dataforms/x/data.rb, line 162
162:       def type=(t)
163:         case t
164:           when :boolean then attributes['type'] = 'boolean'
165:           when :fixed then attributes['type'] = 'fixed'
166:           when :hidden then attributes['type'] = 'hidden'
167:           when :jid_multi then attributes['type'] = 'jid-multi'
168:           when :jid_single then attributes['type'] = 'jid-single'
169:           when :list_multi then attributes['type'] = 'list-multi'
170:           when :list_single then attributes['type'] = 'list-single'
171:           when :text_multi then attributes['type'] = 'text-multi'
172:           when :text_private then attributes['type'] = 'text-private'
173:           when :text_single then attributes['type'] = 'text-single'
174:           else attributes['type'] = nil
175:         end
176:       end

values()

Get the values (in a Data Form with type=‘submit’)

[Source]

     # File lib/xmpp4r/dataforms/x/data.rb, line 198
198:       def values
199:         res = []
200:         each_element('value') { |e|
201:           res << e.text
202:         }
203:         res
204:       end

values=(ary)

Set the values

[Source]

     # File lib/xmpp4r/dataforms/x/data.rb, line 208
208:       def values=(ary)
209:         delete_elements('value')
210:         ary.each { |v|
211:           add(REXML::Element.new('value')).text = v
212:         }
213:       end

var()

[Source]

     # File lib/xmpp4r/dataforms/x/data.rb, line 122
122:       def var
123:         attributes['var']
124:       end

var=(s)

[Source]

     # File lib/xmpp4r/dataforms/x/data.rb, line 126
126:       def var=(s)
127:         attributes['var'] = s
128:       end

Methods

Public Class methods

Public Instance methods