Class: HealthVault::WCData::Methods::UpdateApplication::Info

Inherits:
ComplexType
  • Object
show all
Defined in:
lib/wc_data/generated/methods/update_application/info.rb

Instance Attribute Summary

Attributes inherited from ComplexType

#tag_name

Instance Method Summary collapse

Methods inherited from ComplexType

#add_new_to_children, #element, #method_missing, #optional_elements, #parse_element, #query_elements, #required_elements, #to_s, #valid?

Constructor Details

#initialize ⇒ Info

Returns a new instance of Info.



282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
 
# File 'lib/wc_data/generated/methods/update_application/info.rb', line 282

def initialize
  super
  self.tag_name = 'info'

  
  @children['id'] = {:name => 'id', :class => HealthVault::WCData::Types::Guid, :value => nil, :min => 1, :max => 1, :order => 1, :place => :element, :choice => 0 }
    
  @children['id'][:value] = HealthVault::WCData::Types::Guid.new
    
  

  
  @children['name'] = {:name => 'name', :class => HealthVault::WCData::Types::String255, :value => nil, :min => 0, :max => 1, :order => 2, :place => :element, :choice => 0 }
    
  

  
  @children['public-keys'] = {:name => 'public-keys', :class => HealthVault::WCData::Application::PublicKeys, :value => nil, :min => 0, :max => 1, :order => 3, :place => :element, :choice => 0 }
    
  

  
  @children['person-online-base-auth'] = {:name => 'person-online-base-auth', :class => HealthVault::WCData::Auth::AuthXml, :value => nil, :min => 0, :max => 1, :order => 4, :place => :element, :choice => 0 }
    
  

  
  @children['person-offline-base-auth'] = {:name => 'person-offline-base-auth', :class => HealthVault::WCData::Auth::AuthXml, :value => nil, :min => 0, :max => 1, :order => 5, :place => :element, :choice => 0 }
    
  

  
  @children['methods'] = {:name => 'methods', :class => HealthVault::WCData::Types::Stringnz, :value => nil, :min => 0, :max => 1, :order => 6, :place => :element, :choice => 0 }
    
  

  
  @children['action-url'] = {:name => 'action-url', :class => HealthVault::WCData::Types::Stringnz, :value => nil, :min => 0, :max => 1, :order => 7, :place => :element, :choice => 0 }
    
  

  
  @children['description'] = {:name => 'description', :class => HealthVault::WCData::Types::Stringnz, :value => nil, :min => 0, :max => 1, :order => 8, :place => :element, :choice => 0 }
    
  

  
  @children['auth-reason'] = {:name => 'auth-reason', :class => HealthVault::WCData::Types::Stringnz, :value => nil, :min => 0, :max => 1, :order => 9, :place => :element, :choice => 0 }
    
  

  
  @children['domain-name'] = {:name => 'domain-name', :class => HealthVault::WCData::Types::String255, :value => nil, :min => 0, :max => 1, :order => 10, :place => :element, :choice => 0 }
    
  

  
  @children['large-logo'] = {:name => 'large-logo', :class => HealthVault::WCData::Application::AppLargeLogoInfo, :value => nil, :min => 0, :max => 1, :order => 11, :place => :element, :choice => 0 }
    
  

  
  @children['small-logo'] = {:name => 'small-logo', :class => HealthVault::WCData::Application::AppSmallLogoInfo, :value => nil, :min => 0, :max => 1, :order => 12, :place => :element, :choice => 0 }
    
  

  
  @children['persistent-tokens'] = {:name => 'persistent-tokens', :class => HealthVault::WCData::Application::AppPersistentTokens, :value => nil, :min => 0, :max => 1, :order => 13, :place => :element, :choice => 0 }
    
  

  
  @children['app-type'] = {:name => 'app-type', :class => HealthVault::WCData::Types::Stringnz, :value => nil, :min => 0, :max => 1, :order => 14, :place => :element, :choice => 0 }
    
  

  
  @children['privacy-statement'] = {:name => 'privacy-statement', :class => HealthVault::WCData::Application::StatementInfo, :value => nil, :min => 0, :max => 1, :order => 15, :place => :element, :choice => 0 }
    
  

  
  @children['terms-of-use'] = {:name => 'terms-of-use', :class => HealthVault::WCData::Application::StatementInfo, :value => nil, :min => 0, :max => 1, :order => 16, :place => :element, :choice => 0 }
    
  

  
  @children['app-auth-required'] = {:name => 'app-auth-required', :class => String, :value => nil, :min => 0, :max => 1, :order => 17, :place => :element, :choice => 0 }
    
  

  
  @children['is-published'] = {:name => 'is-published', :class => String, :value => nil, :min => 0, :max => 1, :order => 18, :place => :element, :choice => 0 }
    
  

end

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class HealthVault::WCData::ComplexType

Instance Method Details

#action_url ⇒ Object

returns: a HealthVault::WCData::Types::Stringnz



115
116
117
 
# File 'lib/wc_data/generated/methods/update_application/info.rb', line 115

def action_url
  return @children['action-url'][:value]
end

#action_url=(value) ⇒ Object

remarks: Since an application must have both a privacy statement and a terms of use statement, the application configuration must have one of the following: 1. An action url. 2. Both the privacy statement and terms of use (see the “privacy-statement” and “terms-of-use” parameters). If the above condition is not met, an INVALID_XML error will be returned. value is a HealthVault::WCData::Types::Stringnz



110
111
112
 
# File 'lib/wc_data/generated/methods/update_application/info.rb', line 110

def action_url=(value)
  @children['action-url'][:value] = value
end

#app_auth_required ⇒ Object

returns: a String



261
262
263
 
# File 'lib/wc_data/generated/methods/update_application/info.rb', line 261

def app_auth_required
  return @children['app-auth-required'][:value]
end

#app_auth_required=(value) ⇒ Object

remarks: For example, if the application charged a subscription fee for its use, this parameter would need to be true so that the application can verify that the user has in fact paid for the usage before logging him/her in. Currently not supported. value is a String



256
257
258
 
# File 'lib/wc_data/generated/methods/update_application/info.rb', line 256

def app_auth_required=(value)
  @children['app-auth-required'][:value] = value
end

#app_type ⇒ Object

returns: a HealthVault::WCData::Types::Stringnz



218
219
220
 
# File 'lib/wc_data/generated/methods/update_application/info.rb', line 218

def app_type
  return @children['app-type'][:value]
end

#app_type=(value) ⇒ Object

remarks: Currently not used by HealthVault. value is a HealthVault::WCData::Types::Stringnz



213
214
215
 
# File 'lib/wc_data/generated/methods/update_application/info.rb', line 213

def app_type=(value)
  @children['app-type'][:value] = value
end

#auth_reason ⇒ Object

returns: a HealthVault::WCData::Types::Stringnz



143
144
145
 
# File 'lib/wc_data/generated/methods/update_application/info.rb', line 143

def auth_reason
  return @children['auth-reason'][:value]
end

#auth_reason=(value) ⇒ Object

value is a HealthVault::WCData::Types::Stringnz



138
139
140
 
# File 'lib/wc_data/generated/methods/update_application/info.rb', line 138

def auth_reason=(value)
  @children['auth-reason'][:value] = value
end

#description ⇒ Object

returns: a HealthVault::WCData::Types::Stringnz



129
130
131
 
# File 'lib/wc_data/generated/methods/update_application/info.rb', line 129

def description
  return @children['description'][:value]
end

#description=(value) ⇒ Object

value is a HealthVault::WCData::Types::Stringnz



124
125
126
 
# File 'lib/wc_data/generated/methods/update_application/info.rb', line 124

def description=(value)
  @children['description'][:value] = value
end

#domain_name ⇒ Object

returns: a HealthVault::WCData::Types::String255



158
159
160
 
# File 'lib/wc_data/generated/methods/update_application/info.rb', line 158

def domain_name
  return @children['domain-name'][:value]
end

#domain_name=(value) ⇒ Object

remarks: For example, if the domain name supplied was ‘myapp.com’, the application would call SendInsecureMessageFromApplication with a mailbox-name ‘mailbox’, and the recipient would receive an email from [email protected]. Currently not supported. The list of methods that the application is given access to by default does not contain any of the methods for sending email. value is a HealthVault::WCData::Types::String255



153
154
155
 
# File 'lib/wc_data/generated/methods/update_application/info.rb', line 153

def domain_name=(value)
  @children['domain-name'][:value] = value
end

#id ⇒ Object

returns: a HealthVault::WCData::Types::Guid



26
27
28
 
# File 'lib/wc_data/generated/methods/update_application/info.rb', line 26

def id
  return @children['id'][:value]
end

#id=(value) ⇒ Object

value is a HealthVault::WCData::Types::Guid



21
22
23
 
# File 'lib/wc_data/generated/methods/update_application/info.rb', line 21

def id=(value)
  @children['id'][:value] = value
end

#is_published ⇒ Object

returns: a String



276
277
278
 
# File 'lib/wc_data/generated/methods/update_application/info.rb', line 276

def is_published
  return @children['is-published'][:value]
end

#is_published=(value) ⇒ Object

remarks: Currently not supported. value is a String



271
272
273
 
# File 'lib/wc_data/generated/methods/update_application/info.rb', line 271

def is_published=(value)
  @children['is-published'][:value] = value
end

#large_logo ⇒ Object

returns: a HealthVault::WCData::Application::AppLargeLogoInfo



173
174
175
 
# File 'lib/wc_data/generated/methods/update_application/info.rb', line 173

def 
  return @children['large-logo'][:value]
end

#large_logo=(value) ⇒ Object

remarks: The large logo can be up to 160kb in size. value is a HealthVault::WCData::Application::AppLargeLogoInfo



168
169
170
 
# File 'lib/wc_data/generated/methods/update_application/info.rb', line 168

def large_logo=(value)
  @children['large-logo'][:value] = value
end

#methods ⇒ Object

returns: a HealthVault::WCData::Types::Stringnz



100
101
102
 
# File 'lib/wc_data/generated/methods/update_application/info.rb', line 100

def methods
  return @children['methods'][:value]
end

#methods=(value) ⇒ Object

remarks: Currently not supported. The application can only use the methods it was given access to when added. value is a HealthVault::WCData::Types::Stringnz



95
96
97
 
# File 'lib/wc_data/generated/methods/update_application/info.rb', line 95

def methods=(value)
  @children['methods'][:value] = value
end

#name ⇒ Object

returns: a HealthVault::WCData::Types::String255



40
41
42
 
# File 'lib/wc_data/generated/methods/update_application/info.rb', line 40

def name
  return @children['name'][:value]
end

#name=(value) ⇒ Object

value is a HealthVault::WCData::Types::String255



35
36
37
 
# File 'lib/wc_data/generated/methods/update_application/info.rb', line 35

def name=(value)
  @children['name'][:value] = value
end

#persistent_tokens ⇒ Object

returns: a HealthVault::WCData::Application::AppPersistentTokens



203
204
205
 
# File 'lib/wc_data/generated/methods/update_application/info.rb', line 203

def persistent_tokens
  return @children['persistent-tokens'][:value]
end

#persistent_tokens=(value) ⇒ Object

remarks: A persistent token is an encrypted identifier for the user and application. It can be used to enable the “Keep me signed in on this computer” feature in HealthVault. value is a HealthVault::WCData::Application::AppPersistentTokens



198
199
200
 
# File 'lib/wc_data/generated/methods/update_application/info.rb', line 198

def persistent_tokens=(value)
  @children['persistent-tokens'][:value] = value
end

#person_offline_base_auth ⇒ Object

returns: a HealthVault::WCData::Auth::AuthXml



85
86
87
 
# File 'lib/wc_data/generated/methods/update_application/info.rb', line 85

def person_offline_base_auth
  return @children['person-offline-base-auth'][:value]
end

#person_offline_base_auth=(value) ⇒ Object

remarks: This set of authorization rules must be a subset of the calling application’s authorization rule set. If not, an INVALID_APPAUTH error will be returned. value is a HealthVault::WCData::Auth::AuthXml



80
81
82
 
# File 'lib/wc_data/generated/methods/update_application/info.rb', line 80

def person_offline_base_auth=(value)
  @children['person-offline-base-auth'][:value] = value
end

#person_online_base_auth ⇒ Object

returns: a HealthVault::WCData::Auth::AuthXml



70
71
72
 
# File 'lib/wc_data/generated/methods/update_application/info.rb', line 70

def person_online_base_auth
  return @children['person-online-base-auth'][:value]
end

#person_online_base_auth=(value) ⇒ Object

remarks: This set of authorization rules must be a subset of the calling application’s authorization rule set. If not, an INVALID_APPAUTH error will be returned. value is a HealthVault::WCData::Auth::AuthXml



65
66
67
 
# File 'lib/wc_data/generated/methods/update_application/info.rb', line 65

def person_online_base_auth=(value)
  @children['person-online-base-auth'][:value] = value
end

#privacy_statement ⇒ Object

returns: a HealthVault::WCData::Application::StatementInfo



232
233
234
 
# File 'lib/wc_data/generated/methods/update_application/info.rb', line 232

def privacy_statement
  return @children['privacy-statement'][:value]
end

#privacy_statement=(value) ⇒ Object

value is a HealthVault::WCData::Application::StatementInfo



227
228
229
 
# File 'lib/wc_data/generated/methods/update_application/info.rb', line 227

def privacy_statement=(value)
  @children['privacy-statement'][:value] = value
end

#public_keys ⇒ Object

returns: a HealthVault::WCData::Application::PublicKeys



55
56
57
 
# File 'lib/wc_data/generated/methods/update_application/info.rb', line 55

def public_keys
  return @children['public-keys'][:value]
end

#public_keys=(value) ⇒ Object

remarks: This value should be the hexadecimal representation of the entire X509 certificate, excluding the private key. The easiest way to get this value is to take the binary value of a .cer file as a hexadecimal. It is extremely important that the private key that cooresponds to this public key should be secured both physically and electronically so that other applications cannot identify themselves the application being added. value is a HealthVault::WCData::Application::PublicKeys



50
51
52
 
# File 'lib/wc_data/generated/methods/update_application/info.rb', line 50

def public_keys=(value)
  @children['public-keys'][:value] = value
end

#small_logo ⇒ Object

returns: a HealthVault::WCData::Application::AppSmallLogoInfo



188
189
190
 
# File 'lib/wc_data/generated/methods/update_application/info.rb', line 188

def 
  return @children['small-logo'][:value]
end

#small_logo=(value) ⇒ Object

remarks: The small logo can be up to 40kb in size. value is a HealthVault::WCData::Application::AppSmallLogoInfo



183
184
185
 
# File 'lib/wc_data/generated/methods/update_application/info.rb', line 183

def small_logo=(value)
  @children['small-logo'][:value] = value
end

#terms_of_use ⇒ Object

returns: a HealthVault::WCData::Application::StatementInfo



246
247
248
 
# File 'lib/wc_data/generated/methods/update_application/info.rb', line 246

def terms_of_use
  return @children['terms-of-use'][:value]
end

#terms_of_use=(value) ⇒ Object

value is a HealthVault::WCData::Application::StatementInfo



241
242
243
 
# File 'lib/wc_data/generated/methods/update_application/info.rb', line 241

def terms_of_use=(value)
  @children['terms-of-use'][:value] = value
end