User.md

CBS\SmarterU\DataTypes\User

A User in SmarterU.

Methods

Name	Description
getAddress1	Get the first line of the user's address.
getAddress2	Get the second line of the user's address.
getAllowFeedback	Get whether or not the user can provide feedback on online courses.
getAlternateEmail	Returns the User's alternate email address.
getAuthenticationType	Returns the User's authentication type.
getCity	Get the city of the user's address.
getCountry	Get the country of the user's address.
getCreatedDate	Get the date the User was created.
getCustomFields	Get the container for the custom fields in your account.
getDivision	Get the user's division.
getEmail	Get the user's email address.
getEmployeeId	Get the user's employee ID.
getFax	Get the user's fax number.
getGivenName	Get the given name of the user, also known as their first name.
getGroups	Get the container representing the Groups the User is a member of.
getHomeGroup	Get the name of the user's home group.
getId	Gets the user's ID.
getLanguage	Get the language the user's account uses.
getLearnerNotifications	Get whether or not the user should receive weekly reminders of their pending or outstanding courses in SmarterU.
getModifiedDate	Get the date the User was last modified.
getOldEmail	Get the old email address of the user.
getOldEmployeeId	Get the old employee ID of the user.
getOrganization	Get the name of the organization to assign to the user.
getPassword	Returns the password to assign to the user.
getPhoneAlternate	Get the user's alternate phone number.
getPhoneMobile	Get the user's mobile phone number.
getPhonePrimary	Get the user's primary phone number.
getPostalCode	Get the user's postal code.
getProvince	Get the province or state of the user's address.
getReceiveNotifications	Get whether or not the user will receive email notifications.
getRoles	Get the container for the learning plans assigned to the user.
getSendEmailTo	Returns where the user's email should be sent (Supervisor, Self, or Alternate).
getSendMailTo	Get the location where the user's physical mail should be sent.
getStatus	Return the status of the user.
getSupervisorNotifications	Get whether or not the user should receive weekly reports on the status of any users they are responsible for.
getSupervisors	Get the container for the user's supervisors.
getSurname	Returns the surname of the user, also known as their last name.
getTeams	Get the container for the teams to assign to the user.
getTimezone	Returns the user's timezone.
getTitle	Get the user's title.
getVenues	Get the container for assigning venues to the user.
getWages	Get the container for adding the user's wages.
getWebsite	Get the user's website.
setAddress1	Set the first line of the user's address.
setAddress2	Set the second line of the user's address.
setAllowFeedback	Set whether or not the user can provide feedback on online courses.
setAlternateEmail	Sets the user's alternate email address.
setAuthenticationType	Sets the user's authentication type.
setCity	Set the city of the user's address.
setCountry	Set the country of the user's address. Acceptable values are "Canada", "United States", or "International".
setCreatedDate	Set the date the User was created.
setCustomFields	Set the container for the custom fields in your account. The custom fields must already exist within your SmarterU account.
setDivision	Set the user's division.
setEmail	Set the user's email address.
setEmployeeId	Set the user's the employee ID.
setFax	Set the user's fax number.
setGivenName	Set the given name of the user, also known as their first name.
setGroups	Set the container representing the Groups the User is a member of.
setHomeGroup	Set the name of the user's home group.
setId	Sets the user's ID.
setLanguage	Set the language the user's account uses.
setLearnerNotifications	Set whether or not the user should receive weekly reminders of their pending or outstanding courses in SmarterU.
setModifiedDate	Set the date the User was last modified.
setOldEmail	Set the old email address of the user.
setOldEmployeeId	Set the old employee ID of the user.
setOrganization	Set the name of the organization to assign to the user. The organization must already exist within your SmarterU account.
setPassword	Sets the password to assign to the user
setPhoneAlternate	Set the user's alternate phone number.
setPhoneMobile	Set the user's mobile phone number.
setPhonePrimary	Set the user's primary phone number.
setPostalCode	Set the user's postal code.
setProvince	Set the province or state of the user's address.
setReceiveNotifications	Set whether or not the user will receive email notifications.
setRoles	Set the container for the learning plans assigned to the user. The learning plans must already exist within your SmarterU account.
setSendEmailTo	Sets where the user's email should be sent (Supervisor, Self, or Alternate).
setSendMailTo	Set the location where the user's physical mail should be sent.
setStatus	Set the status of the user.
setSupervisorNotifications	Set whether or not the user should receive weekly reports on the status of any users they are responsible for.
setSupervisors	Set the container for the user's supervisors. Each supervisor must already exist in SmarterU.
setSurname	Set the surname of the user, also known as their last name.
setTeams	Set the container for the teams to assign to the user. The team names provided must already exist in your SmarterU account.
setTimezone	Sets the user's timezone.
setTitle	Set the user's title.
setVenues	Set the container for assigning venues to the user.
setWages	Set the container for adding the user's wages.
setWebsite	Set the user's website.

User::getAddress1

Description

public getAddress1 (void)

Get the first line of the user's address.

Parameters

This function has no parameters.

Return Values

?string

the first line of the user's address

---

User::getAddress2

Description

public getAddress2 (void)

Get the second line of the user's address.

Parameters

This function has no parameters.

Return Values

?string

the second line of the user's address.

---

User::getAllowFeedback

Description

public getAllowFeedback (void)

Get whether or not the user can provide feedback on online courses.

Parameters

This function has no parameters.

Return Values

bool

true if and only if the user can provide feedback

---

User::getAlternateEmail

Description

public getAlternateEmail (void)

Returns the User's alternate email address.

Parameters

This function has no parameters.

Return Values

?string

The user's alternate email address.

---

User::getAuthenticationType

Description

public getAuthenticationType (void)

Returns the User's authentication type.

Parameters

This function has no parameters.

Return Values

?string

The User's authentication type.

---

User::getCity

Description

public getCity (void)

Get the city of the user's address.

Parameters

This function has no parameters.

Return Values

?string

the city of the user's address

---

User::getCountry

Description

public getCountry (void)

Get the country of the user's address.

Parameters

This function has no parameters.

Return Values

?string

the country of the user's address

---

User::getCreatedDate

Description

public getCreatedDate (void)

Get the date the User was created.

Parameters

This function has no parameters.

Return Values

?\DateTimeInterface

the date the User was created

---

User::getCustomFields

Description

public getCustomFields (void)

Get the container for the custom fields in your account.

Parameters

This function has no parameters.

Return Values

array

the custom fields

---

User::getDivision

Description

public getDivision (void)

Get the user's division.

Parameters

This function has no parameters.

Return Values

?string

the user's division

---

User::getEmail

Description

public getEmail (void)

Get the user's email address.

Parameters

This function has no parameters.

Return Values

?string

The user's email address.

---

User::getEmployeeId

Description

public getEmployeeId (void)

Get the user's employee ID.

Parameters

This function has no parameters.

Return Values

?string

The user's employee ID.

---

User::getFax

Description

public getFax (void)

Get the user's fax number.

Parameters

This function has no parameters.

Return Values

?string

the user's fax number

---

User::getGivenName

Description

public getGivenName (void)

Get the given name of the user, also known as their first name.

Parameters

This function has no parameters.

Return Values

?string

The given name of the user, also known as their first name.

---

User::getGroups

Description

public getGroups (void)

Get the container representing the Groups the User is a member of.

Parameters

This function has no parameters.

Return Values

array

the container for the User's groups

---

User::getHomeGroup

Description

public getHomeGroup (void)

Get the name of the user's home group.

Parameters

This function has no parameters.

Return Values

?string

the name of the user's home group

---

User::getId

Description

public getId (void)

Gets the user's ID.

Parameters

This function has no parameters.

Return Values

?string

the user's ID

---

User::getLanguage

Description

public getLanguage (void)

Get the language the user's account uses.

Parameters

This function has no parameters.

Return Values

?string

the language to use

---

User::getLearnerNotifications

Description

public getLearnerNotifications (void)

Get whether or not the user should receive weekly reminders of their pending or outstanding courses in SmarterU.

Parameters

This function has no parameters.

Return Values

?bool

True if and only if the user should receive weekly
reminders of their pending or outstanding courses in SmarterU.

---

User::getModifiedDate

Description

public getModifiedDate (void)

Get the date the User was last modified.

Parameters

This function has no parameters.

Return Values

?\DateTimeInterface

the date the User was last modified

---

User::getOldEmail

Description

public getOldEmail (void)

Get the old email address of the user.

Parameters

This function has no parameters.

Return Values

?string

the old email address

---

User::getOldEmployeeId

Description

public getOldEmployeeId (void)

Get the old employee ID of the user.

Parameters

This function has no parameters.

Return Values

?string

the old employee ID

---

User::getOrganization

Description

public getOrganization (void)

Get the name of the organization to assign to the user.

Parameters

This function has no parameters.

Return Values

?string

the name of the organization

---

User::getPassword

Description

public getPassword (void)

Returns the password to assign to the user.

Parameters

This function has no parameters.

Return Values

?string

Returns the password to assign to the user.

---

User::getPhoneAlternate

Description

public getPhoneAlternate (void)

Get the user's alternate phone number.

Parameters

This function has no parameters.

Return Values

?string

the user's alternate phone number

---

User::getPhoneMobile

Description

public getPhoneMobile (void)

Get the user's mobile phone number.

Parameters

This function has no parameters.

Return Values

?string

the user's mobile phone number

---

User::getPhonePrimary

Description

public getPhonePrimary (void)

Get the user's primary phone number.

Parameters

This function has no parameters.

Return Values

?string

the user's primary phone number

---

User::getPostalCode

Description

public getPostalCode (void)

Get the user's postal code.

Parameters

This function has no parameters.

Return Values

?string

the user's postal code

---

User::getProvince

Description

public getProvince (void)

Get the province or state of the user's address.

Parameters

This function has no parameters.

Return Values

?string

the province or state of the user's address

---

User::getReceiveNotifications

Description

public getReceiveNotifications (void)

Get whether or not the user will receive email notifications.

Parameters

This function has no parameters.

Return Values

bool

true if and only if the user will receive email notifications

---

User::getRoles

Description

public getRoles (void)

Get the container for the learning plans assigned to the user.

Parameters

This function has no parameters.

Return Values

array

the container for the learning plans to assign to the user

---

User::getSendEmailTo

Description

public getSendEmailTo (void)

Returns where the user's email should be sent (Supervisor, Self, or Alternate).

Parameters

This function has no parameters.

Return Values

?string

Returns where the user's email should be sent.

---

User::getSendMailTo

Description

public getSendMailTo (void)

Get the location where the user's physical mail should be sent.

Parameters

This function has no parameters.

Return Values

?string

the location where physical mail should be sent

---

User::getStatus

Description

public getStatus (void)

Return the status of the user.

Parameters

This function has no parameters.

Return Values

string

the status of the user

---

User::getSupervisorNotifications

Description

public getSupervisorNotifications (void)

Get whether or not the user should receive weekly reports on the status of any users they are responsible for.

Parameters

This function has no parameters.

Return Values

?bool

True if and only if the user should receive weekly reports
on the status of any users they are responsible for.

---

User::getSupervisors

Description

public getSupervisors (void)

Get the container for the user's supervisors.

Parameters

This function has no parameters.

Return Values

array

the container for the user's supervisors

---

User::getSurname

Description

public getSurname (void)

Returns the surname of the user, also known as their last name.

Parameters

This function has no parameters.

Return Values

?string

The surname of the user, also known as their last name.

---

User::getTeams

Description

public getTeams (void)

Get the container for the teams to assign to the user.

Parameters

This function has no parameters.

Return Values

array

the teams to assign to the user

---

User::getTimezone

Description

public getTimezone (void)

Returns the user's timezone.

Parameters

This function has no parameters.

Return Values

?string

Returns the user's timezone.

---

User::getTitle

Description

public getTitle (void)

Get the user's title.

Parameters

This function has no parameters.

Return Values

?string

the user's title

---

User::getVenues

Description

public getVenues (void)

Get the container for assigning venues to the user.

Parameters

This function has no parameters.

Return Values

?array

the container for the user's venues

---

User::getWages

Description

public getWages (void)

Get the container for adding the user's wages.

Parameters

This function has no parameters.

Return Values

?array

the container for the user's wages

---

User::getWebsite

Description

public getWebsite (void)

Get the user's website.

Parameters

This function has no parameters.

Return Values

?string

the URL of the user's website

---

User::setAddress1

Description

public setAddress1 (?string $address1)

Set the first line of the user's address.

Parameters

• (?string) $address1 : the first line of the user's address

Return Values

self

---

User::setAddress2

Description

public setAddress2 (?string $address2)

Set the second line of the user's address.

Parameters

• (?string) $address2 : the second line of the user's address

Return Values

self

---

User::setAllowFeedback

Description

public setAllowFeedback (bool $allowFeedback)

Set whether or not the user can provide feedback on online courses.

Parameters

• (bool) $allowFeedback : true if and only if the user can provide feedback

Return Values

self

---

User::setAlternateEmail

Description

public setAlternateEmail (?string $alternateEmail)

Sets the user's alternate email address.

Parameters

• (?string) $alternateEmail : The user's alternate email address.

Return Values

self

---

User::setAuthenticationType

Description

public setAuthenticationType (?string $authenticationType)

Sets the user's authentication type.

Parameters

• (?string) $authenticationType : The user's authentication type.

Return Values

self

---

User::setCity

Description

public setCity (?string $city)

Set the city of the user's address.

Parameters

• (?string) $city : the city of the user's address

Return Values

self

---

User::setCountry

Description

public setCountry (?string $country)

Set the country of the user's address. Acceptable values are "Canada", "United States", or "International".

Parameters

• (?string) $country : the country of the user's address

Return Values

self

---

User::setCreatedDate

Description

public setCreatedDate (\DateTimeInterface $createdDate)

Set the date the User was created.

Parameters

• (\DateTimeInterface) $createdDate : The date the User was created

Return Values

self

---

User::setCustomFields

Description

public setCustomFields (array $customFields)

Set the container for the custom fields in your account. The custom fields must already exist within your SmarterU account.

Parameters

• (array) $customFields : the custom fields in your account

Return Values

self

---

User::setDivision

Description

public setDivision (?string $division)

Set the user's division.

Parameters

• (?string) $division : the user's division

Return Values

self

---

User::setEmail

Description

public setEmail (?string $email)

Set the user's email address.

Parameters

• (?string) $email : The user's email address.

Return Values

self

---

User::setEmployeeId

Description

public setEmployeeId (?string $employeeId)

Set the user's the employee ID.

Parameters

• (?string) $employeeId : The user's employee ID.

Return Values

self

---

User::setFax

Description

public setFax (?string $fax)

Set the user's fax number.

Parameters

• (?string) $fax : the user's fax number

Return Values

self

---

User::setGivenName

Description

public setGivenName (?string $givenName)

Set the given name of the user, also known as their first name.

Parameters

• (?string) $givenName : The given name of the user, also known as their first name.

Return Values

self

---

User::setGroups

Description

public setGroups (array $groups)

Set the container representing the Groups the User is a member of.

Parameters

• (array) $groups : the container for the user's group assignments

Return Values

self

---

User::setHomeGroup

Description

public setHomeGroup (?string $homeGroup)

Set the name of the user's home group.

Parameters

• (?string) $homeGroup : the name of the user's home group

Return Values

self

---

User::setId

Description

public setId (string $id)

Sets the user's ID.

Parameters

• (string) $id : the user's ID

Return Values

self

---

User::setLanguage

Description

public setLanguage (?string $language)

Set the language the user's account uses.

Parameters

• (?string) $language : the language to use for this user

Return Values

self

---

User::setLearnerNotifications

Description

public setLearnerNotifications (?bool $learnerNotifications)

Set whether or not the user should receive weekly reminders of their pending or outstanding courses in SmarterU.

Parameters

• (?bool) $learnerNotifications : True if and only if the user should
  receive weekly reminders of their pending or outstanding courses
  in SmarterU.

Return Values

self

---

User::setModifiedDate

Description

public setModifiedDate (\DateTimeInterface $modifiedDate)

Set the date the User was last modified.

Parameters

• (\DateTimeInterface) $modifiedDate : The date the User was last modified

Return Values

self

---

User::setOldEmail

Description

public setOldEmail (?string $oldEmail)

Set the old email address of the user.

Parameters

• (?string) $oldEmail : the old email address

Return Values

self

---

User::setOldEmployeeId

Description

public setOldEmployeeId (?string $oldEmployeeId)

Set the old employee ID of the user.

Parameters

• (?string) $oldEmployeeId : the old employee ID

Return Values

self

---

User::setOrganization

Description

public setOrganization (?string $organization)

Set the name of the organization to assign to the user. The organization must already exist within your SmarterU account.

Parameters

• (?string) $organization : the name of the organization

Return Values

self

---

User::setPassword

Description

public setPassword (?string $password)

Sets the password to assign to the user

Parameters

• (?string) $password : The password to assign to the user

Return Values

self

---

User::setPhoneAlternate

Description

public setPhoneAlternate (?string $phoneAlternate)

Set the user's alternate phone number.

Parameters

• (?string) $phoneAlternate : the user's alternate phone number

Return Values

self

---

User::setPhoneMobile

Description

public setPhoneMobile (?string $phoneMobile)

Set the user's mobile phone number.

Parameters

• (?string) $phoneMobile : the user's mobile phone number

Return Values

self

---

User::setPhonePrimary

Description

public setPhonePrimary (?string $phonePrimary)

Set the user's primary phone number.

Parameters

• (?string) $phonePrimary : the user's primary phone number

Return Values

self

---

User::setPostalCode

Description

public setPostalCode (?string $postalCode)

Set the user's postal code.

Parameters

• (?string) $postalCode : the user's postal code

Return Values

self

---

User::setProvince

Description

public setProvince (?string $province)

Set the province or state of the user's address.

Parameters

• (?string) $province : the province or state of the user's address

Return Values

self

---

User::setReceiveNotifications

Description

public setReceiveNotifications (bool $receiveNotifications)

Set whether or not the user will receive email notifications.

Parameters

• (bool) $receiveNotifications : true if and only if the user will
  receive email notifications

Return Values

self

---

User::setRoles

Description

public setRoles (array $)

Set the container for the learning plans assigned to the user. The learning plans must already exist within your SmarterU account.

Parameters

• (array) $ : the container for the learning plans to assign to the user

Return Values

self

---

User::setSendEmailTo

Description

public setSendEmailTo (?string $sendEmailTo)

Sets where the user's email should be sent (Supervisor, Self, or Alternate).

Parameters

• (?string) $sendEmailTo : Sets where the user's email should be sent.

Return Values

self

---

User::setSendMailTo

Description

public setSendMailTo (?string $sendMailTo)

Set the location where the user's physical mail should be sent.

Parameters

• (?string) $sendMailTo : the location where physical mail should be sent

Return Values

self

---

User::setStatus

Description

public setStatus (string $status)

Set the status of the user.

Parameters

• (string) $status : the status of the user

Return Values

self

---

User::setSupervisorNotifications

Description

public setSupervisorNotifications (?bool $supervisorNotifications)

Set whether or not the user should receive weekly reports on the status of any users they are responsible for.

Parameters

• (?bool) $supervisorNotifications : True if and only if the user
  should receive weekly reports on the status of any users they are
  responsible for.

Return Values

self

---

User::setSupervisors

Description

public setSupervisors (array $supervisors)

Set the container for the user's supervisors. Each supervisor must already exist in SmarterU.

Parameters

• (array) $supervisors : the supervisors for this user

Return Values

self

---

User::setSurname

Description

public setSurname (?string $surname)

Set the surname of the user, also known as their last name.

Parameters

• (?string) $surname : The surname of the user, also known as their
  last name.

Return Values

self

---

User::setTeams

Description

public setTeams (array $)

Set the container for the teams to assign to the user. The team names provided must already exist in your SmarterU account.

Parameters

• (array) $ : teams the teams to assign to the user

Return Values

self

---

User::setTimezone

Description

public setTimezone (?string $timezone)

Sets the user's timezone.

Parameters

• (?string) $timezone : Sets the user's timezone.

Return Values

self

---

User::setTitle

Description

public setTitle (?string $title)

Set the user's title.

Parameters

• (?string) $title : the user's title

Return Values

self

---

User::setVenues

Description

public setVenues (array $venues)

Set the container for assigning venues to the user.

Parameters

• (array) $venues : the container for the user's venues

Return Values

self

---

User::setWages

Description

public setWages (array $wages)

Set the container for adding the user's wages.

Parameters

• (array) $wages : the container for the user's wages

Return Values

self

---

User::setWebsite

Description

public setWebsite (?string $website)

Set the user's website.

Parameters

• (?string) $website : the URL of the user's website

Return Values

self

---