Class: LUSI::API::Person::UserContact

Inherits:

Object

• Object
• LUSI::API::Person::UserContact

Defined in:

lib/lusi_api/person/student.rb

Instance Attribute Summary

• #contact_name ⇒ String^?

  The name of the contact.

• #contact_type ⇒ String^?

  The type of contact (‘Staff’ | ‘Student’).

• #email_address ⇒ String^?

  The email address of the contact.

• #identity ⇒ String^?

  The identity code of the contact.

Instance Method Summary

• #initialize(xml = nil, lookup = nil, identity: nil, contact_type: nil, contact_name: nil, email_address: nil) ⇒ void constructor

  Initialises a new UserContact instance.

• #to_s ⇒ String

  Returns a string representation of the instance.

Constructor Details

#initialize(xml = nil, lookup = nil, identity: nil, contact_type: nil, contact_name: nil, email_address: nil) ⇒ void

Initialises a new UserContact instance

# File 'lib/lusi_api/person/student.rb', line 206

def initialize(xml = nil, lookup = nil, identity: nil, contact_type: nil, contact_name: nil, email_address: nil)
  @identity = LUSI::API::Core::XML.xml_content_at(xml, 'xmlns:Identity', identity)
  @contact_type = LUSI::API::Core::XML.xml_content_at(xml, 'xmlns:ContactType', contact_type)
  @contact_name = LUSI::API::Core::XML.xml_content_at(xml, 'xmlns:ContactName', contact_name)
  @email_address = LUSI::API::Core::XML.xml_content_at(xml, 'xmlns:EmailAddress', email_address)
end

Instance Attribute Details

#contact_name ⇒ String^?

# File 'lib/lusi_api/person/student.rb', line 194

def contact_name
  @contact_name
end

#contact_type ⇒ String^?

# File 'lib/lusi_api/person/student.rb', line 190

def contact_type
  @contact_type
end

#email_address ⇒ String^?

# File 'lib/lusi_api/person/student.rb', line 198

def email_address
  @email_address
end

#identity ⇒ String^?

# File 'lib/lusi_api/person/student.rb', line 186

def identity
  @identity
end

Instance Method Details

#to_s ⇒ String

Returns a string representation of the instance

# File 'lib/lusi_api/person/student.rb', line 215

def to_s
  email = @email_address ? " <#{@email_address}>" : ''
  "#{@contact_name}#{@email}"
end