Contact

Version 1.9 - Updated on 02/14/2017

Contents

Introduction

public interface Contact extends Item

Contact Item - stores the data for each Contact item from the list.

getId

String getId()

  • Returns: Unique identifier for the contact

getFirstName

String getFirstName()

  • Returns: First name

getMiddleName

String getMiddleName()

  • Returns: Middle Name

getLastName

String getLastName()

  • Returns: Last Name

getNickName

String getNickName()

  • Returns: Nick Name

getNamePrefix

String getNamePrefix()

  • Returns: Name Prefix

getNameSuffix

String getNameSuffix()

  • Returns: Name Suffix

getBirthday

String getBirthday()

  • Returns: Birth date

isInCaseOfEmergency

boolean isInCaseOfEmergency()

  • Returns: true if contact is saved as emergency contact, false otherwise

isFavorite

boolean isFavorite()

  • Returns: true if contact is saved as favorite, false otherwise

getNote

String getNote()

  • Returns: Notes saved for this contact

getSource

String getSource()

  • Returns: Source where the contact was synced from

getVersion

String getVersion()

  • Returns: Version number

getProfession

String getProfession()

  • Returns: Profession

getAnniversary

String getAnniversary()

  • Returns: Anniversary information

getSpouse

String getSpouse()

  • Returns: Spouse information

getChildren

String getChildren()

  • Returns: Children information

getJobTitle

String getJobTitle()

  • Returns: Job title

getOrgName

String getOrgName()

  • Returns: Org name

getOrgUnit

String getOrgUnit()

  • Returns: Org unit

getAssistant

String getAssistant()

  • Returns: Assistant information

getGender

String getGender()

  • Returns: Gender

getRelationship

String getRelationship()

  • Returns: Relationship info

getMaritalStatus

String getMaritalStatus()

  • Returns: Marital Status

getTimezone

int getTimezone()

  • Returns: Time zone

getCreationDate

String getCreationDate()

  • Returns: Creation date

getModifiedDate

String getModifiedDate()

  • Returns: Modified date

getAddressList

ItemList<Address> getAddressList()

getPhoneList

ItemList<Phone> getPhoneList()

getEmailList

ItemList<Email> getEmailList()

getiMList

ItemList<IM> getiMList()

  • Returns: ItemList populated with IM as list items.

getWebPageList

ItemList<WebPage> getWebPageList()

Builder

class Builder

Class used to create a request to create or update a Contact.

Builder

public Builder ()

Constructor used to initialize an empty Contact builder object.

Builder

public Builder (Contact contact)

Constructor used to initialize Contact builder with pre-populated Contact values.

  • Parameters: contact — Contact object as obtained from getContacts methods.

setFirstName

public void setFirstName(String firstName)

Sets the first name.

  • Parameters: firstName — first name

setMiddleName

public void setMiddleName(String middleName)

Sets the middle name.

  • Parameters: middleName — middle name

setLastName

public void setLastName(String lastName)

Sets the last name.

  • Parameters: lastName — last name

setNickName

public void setNickName(String nickName)

Sets the nickname.

  • Parameters: nickName — nickname

setNamePrefix

public void setNamePrefix(String namePrefix)

Sets the name prefix.

  • Parameters: namePrefix — name prefix

setNameSuffix

public void setNameSuffix(String nameSuffix)

Sets the name suffix.

  • Parameters: nameSuffix — name suffix

setBirthday

public void setBirthday(String birthday)

Sets the birthday of the contact in format YYYY-MM-DD.

  • Parameters: birthday — birthday of the contact.

setInCaseOfEmergency

public void setInCaseOfEmergency(boolean inCaseOfEmergency)

Determines if the contact is an emergency contact. Maximum 3 contacts can be defined as emergency contacts.

  • Parameters: inCaseOfEmergency — set to true if the contact is an emergency contact, false otherwise.

setFavorite

public void setFavorite(boolean favorite)

Adds the contact to favorites.

  • Parameters: favorite — Set to true if the contact is added to favorites, false otherwise.

setNote

public void setNote(String note)

Adds a note for the contact.

  • Parameters: note — note for the contact

setSource

public void setSource(String source)

Sets the source of the contact.

  • Parameters: source — Source of the contact

setProfession

public void setProfession(String profession)

Sets the profession of the contact.

  • Parameters: profession — Profession of the contact

setAnniversary

public void setAnniversary(String anniversary)

Sets the anniversary for the contact in the format YYYY-MM-DD.

  • Parameters: anniversary — Anniversary

setSpouse

public void setSpouse(String spouse)

Sets the spouse for the contact.

  • Parameters: spouse — spouse of the contact

setChildren

public void setChildren(String children)

Sets the children of the contact.

  • Parameters: children — Children of the contact

setJobTitle

public void setJobTitle(String jobTitle)

Sets the job title of the contact.

  • Parameters: jobTitle — job title

setOrgName

public void setOrgName(String orgName)

Sets the organization name of the contact.

  • Parameters: orgName — Organization name

setOrgUnit

public void setOrgUnit(String orgUnit)

Sets the organization unit of the contact.

  • Parameters: orgUnit — Organization unit

setAssistant

public void setAssistant(String assistant)

Sets the assistant’s name.

  • Parameters: assistant — assistant’s name

setGender

public void setGender(String gender)

Sets the gender of the contact.

  • Parameters: gender — gender

setRelationship

public void setRelationship(String relationship)

Sets the relationship status of the contact.

  • Parameters: relationship — relationship status

setMaritalStatus

public void setMaritalStatus(String maritalStatus)

Sets the marital status of the contact.

  • Parameters: maritalStatus — Marital status

addAddress

public void addAddress(Address.Builder addressBuilder)

Adds address information for the contact. Call this method multiple times to add multiple values for address information.

  • Parameters: addressBuilderAddress.Builder object with address information

addAddress

public void addAddress(Address address)

Adds address information for the contact from pre-populated Address object. Call this method multiple times to add multiple address information.

  • Parameters: addressAddress object with pre-populated address information

setAddressList

public void setAddressList (ArrayList<Address.Builder> addressList)

Sets the address list for the contact.

  • Parameters: addressList — ArrayList of Address.Builder with Address information

clearAddressList

public void clearAddressList ()

Deletes all the items from the address list.

addPhone

public void addPhone(Phone.Builder phoneBuilder)

Adds phone information for the contact. Call this method multiple times to add multiple values of the phone information.

  • Parameters: phoneBuilderPhone.Builder object with phone information

addPhone

public void addPhone(Phone phone)

Adds phone information for the contact from pre-populated Phone object. Call this method multiple times to add multiple values of the phone information.

  • Parameters: phonePhone object with Phone information

setPhoneList

public void setPhoneList (ArrayList<Phone.Builder> phoneList)

Sets the phone list for the contact.

  • Parameters: phoneList — ArrayList of Phone.Builder with phone information

clearPhoneList

public void clearPhoneList ()

Deletes all items from the phone list.

addEmail

public void addEmail(Email.Builder emailBuilder)

Adds email information for the contact. Call this method multiple times to add multiple values of the email information.

  • Parameters: emailBuilderEmail.Builder object with email information

addEmail

public void addEmail(Email email)

Adds email information for the contact from pre-populated Email object. Call this method multiple times to add multiple values of the email information.

  • Parameters: emailEmail object with pre-populated email information

setEmailList

public void setEmailList (ArrayList<Email.Builder> emailList)

Sets the email list for the contact.

clearEmailList

public void clearEmailList ()

Deletes all items from the email list.

addIM

public void addIM(IM.Builder imBuilder)

Adds IM information for the contact. Call this method multiple times to add multiple values of the IM information.

  • Parameters: imBuilderIM.Builder with IM information

addIM

public void addIM(IM im)

Adds IM information for the contact from pre-populated IM object. Call this method multiple times to add multiple values of the IM information.

  • Parameters: imIM object with pre-populated IM information

setIMList

public void setIMList (ArrayList<IM.Builder> imList)

Sets IM list for the contact.

  • Parameters: imList — ArrayList of [IM.BuilderIM with IM information

clearIMList

public void clearIMList ()

Deletes all items from the IM list.

Copyright © 2015-2017, Verizon and/or its Licensors. All rights reserved.