GedcomX FS JS Class: User

new User( [json])

FamilySearch user.

Parameters:

Name	Type	Argument	Description
`json`	Object	<optional>

Extends

ExtensibleData

Methods

addField(field)

Add a field

Parameters:

Name	Type	Description
`field`	Field

Inherited From:

ExtensibleData#addField

Returns:

this

Type: ExtensibleData

addLink(link)

Add a link

Parameters:

Name	Type	Description
`link`	Link

Inherited From:

ExtensibleData#addLink

Returns:

this

Type: ExtensibleData

getAlternateEmail()

Get the alternateEmail

Returns:

alternateEmail

Type: String

getBirthDate()

Get the birthDate

Returns:

birthDate

Type: String

getContactName()

Get the contactName

Returns:

contactName

Type: String

getCountry()

Get the country

Returns:

country

Type: String

getDisplayName()

Get the displayName

Returns:

displayName

Type: String

getEmail()

Get the email

Returns:

Type: String

getFamilyName()

Get the familyName

Returns:

familyName

Type: String

getFields()

Get the fields

Inherited From:

ExtensibleData#getFields

Returns:

Type: Array.<Field>

getFullName()

Get the fullName

Returns:

fullName

Type: String

getGender()

Get the gender

Returns:

gender

Type: String

getGivenName()

Get the givenName

Returns:

givenName

Type: String

getHelperAccessPin()

Get the helperAccessPin

Returns:

helperAccessPin

Type: String

getId()

Get the object's id.

Inherited From:

ExtensibleData#getId

Returns:

Type: String

getLink(rel)

Get a link

Parameters:

Name	Type	Description
`rel`	String

Inherited From:

ExtensibleData#getLink

Returns:

Type: Link

getLinks()

Get the links

Inherited From:

ExtensibleData#getLinks

Returns:

Type: Array.<Link>

getMailingAddress()

Get the mailingAddress

Returns:

mailingAddress

Type: String

getMobilePhoneNumber()

Get the mobilePhoneNumber

Returns:

mobilePhoneNumber

Type: String

getPersonId()

Get the personId

Returns:

personId

Type: String

getPhoneNumber()

Get the phoneNumber

Returns:

phoneNumber

Type: String

getPreferredLanguage()

Get the preferredLanguage

Returns:

preferredLanguage

Type: String

getTreeUserId()

Get the treeUserId

Returns:

treeUserId

Type: String

init(json)

Initialize from JSON

Parameters:

Name	Type	Description
`json`	Object

Overrides:

ExtensibleData#init

Returns:

User this

<static> isInstance(obj)

Check whether the given object is an instance of this class.

Parameters:

Name	Type	Description
`obj`	Object

Returns:

Type: Boolean

setAlternateEmail(alternateEmail)

Set the alternateEmail

Parameters:

Name	Type	Description
`alternateEmail`	String

Returns:

this

Type: User

setBirthDate(birthDate)

Set the birthDate

Parameters:

Name	Type	Description
`birthDate`	String

Returns:

this

Type: User

setContactName(contactName)

Set the contactName

Parameters:

Name	Type	Description
`contactName`	String

Returns:

this

Type: User

setCountry(country)

Set the country

Parameters:

Name	Type	Description
`country`	String

Returns:

this

Type: User

setDisplayName(displayName)

Set the displayName

Parameters:

Name	Type	Description
`displayName`	String

Returns:

this

Type: User

setEmail(email)

Set the email

Parameters:

Name	Type	Description
`email`	String

Returns:

this

Type: User

setFamilyName(familyName)

Set the familyName

Parameters:

Name	Type	Description
`familyName`	String

Returns:

this

Type: User

setFields(fields)

Set the fields

Parameters:

Name	Type	Description
`fields`	Array.<Field>

Inherited From:

ExtensibleData#setFields

Returns:

this

Type: ExtensibleData

setFullName(fullName)

Set the fullName

Parameters:

Name	Type	Description
`fullName`	String

Returns:

this

Type: User

setGender(gender)

Set the gender

Parameters:

Name	Type	Description
`gender`	String

Returns:

this

Type: User

setGivenName(givenName)

Set the givenName

Parameters:

Name	Type	Description
`givenName`	String

Returns:

this

Type: User

setHelperAccessPin(helperAccessPin)

Set the helperAccessPin

Parameters:

Name	Type	Description
`helperAccessPin`	String

Returns:

this

Type: User

setId(id)

Set the object's id.

Parameters:

Name	Type	Description
`id`	String

Inherited From:

ExtensibleData#setId

Returns:

This object, for chaining.

Type: ExtensibleData

setLinks(links)

Set the links

Parameters:

Name	Type	Description
`links`	Links

Inherited From:

ExtensibleData#setLinks

Returns:

this

Type: ExtensibleData

setMailingAddress(mailingAddress)

Set the mailingAddress

Parameters:

Name	Type	Description
`mailingAddress`	String

Returns:

this

Type: User

setMobilePhoneNumber(mobilePhoneNumber)

Set the mobilePhoneNumber

Parameters:

Name	Type	Description
`mobilePhoneNumber`	String

Returns:

this

Type: User

setPersonId(personId)

Set the personId

Parameters:

Name	Type	Description
`personId`	String

Returns:

this

Type: User

setPhoneNumber(phoneNumber)

Set the phoneNumber

Parameters:

Name	Type	Description
`phoneNumber`	String

Returns:

this

Type: User

setPreferredLanguage(preferredLanguage)

Set the preferredLanguage

Parameters:

Name	Type	Description
`preferredLanguage`	String

Returns:

this

Type: User

setTreeUserId(treeUserId)

Set the treeUserId

Parameters:

Name	Type	Description
`treeUserId`	String

Returns:

this

Type: User

toJSON()

Export the object as JSON

Overrides:

ExtensibleData#toJSON

Returns:

JSON object

Type: Object