Contacts

Contacts

Version 1.6 - Updated on 03/23/2017

Contents

contacts(requestObject)

Retrieves a user’s contacts stroed in the cloud

  • Parameters:
    • requestObject — callbacks and parameters
    • requestObject.count — items to include in a paginated response. Default is 200.
    • requestObject.sort — the sort order for a folder response. Syntax is: {field}+{asc or desc}. Valid values are:
      • album
      • artist
      • captureDate
      • compilation
      • contentType
      • creationDate
      • extension
      • favorite
      • genre
      • height
      • modificationDate
      • name
      • priority
      • size
      • source
      • tags
      • timelineDate
      • title
      • type
      • versionCreated
    • requestObject.page — the pages to be returned in the response. Default is 1.
    • requestObject.query — the value of a field that is stored in contacts which can be used to search for a specific contact or set of contacts. Supported fields are:
      • address
      • email
      • ID
      • IM
      • name
      • tel
      • field-tag.type such as address or home
      • address.type.subfield such as address.home.street
    • requestObject.success — Success callback function. Returns the response in the first argument.
    • requestObject.failure — Failure callback function. Returns the response in the first argument.
  • Returns: None. This method is asynchronous. Clients should use callback methods.

NOTE: This SDK returns a maximum of 200 contacts in a successful response.

deleteContact(requestObject)

Deletes specified contact.

  • Parameters:
    • requestObject — callbacks and parameters.
    • requestObject.id — ID of the contact that to be deleted
    • requestObject.success — Success callback function. Returns the response in the first argument.
    • requestObject.failure — Failure callback function. Returns the response in the first argument.
  • Returns: — None. This method is asynchronous. Clients should use callback methods.

createContact(requestObject)

Creates a new contact.

  • Parameters:
    • requestObject — callbacks and parameters.
    • requestObject.firstname — first name of the contact
    • requestObject.lastname — last name of the contact
    • requestObject.middlename — middle name of the contact
    • requestObject.nameprefix — name prefix of the contact
    • requestObject.birthday — birthday of the contact
    • requestObject.anniversary — anniversary of the contact
    • requestObject.spouse — contact’s spouse
    • requestObject.children — contact’s children
    • requestObject.orgname — the name of the contact’s organization
    • requestObject.jobtitle — job title of the contact
    • requestObject.profession — contact’s profession
    • requestObject.assistant — contact’s assistant
    • requestObject.gender — contact’s gender
    • requestObject.relationship — the relationship with the contact
    • requestObject.maritalstatus — marital status of the contact
    • requestObject.source — source of the contact
    • requestObject.note — note for the contact
    • requestObject.incaseofemergency — set if this contact is to be called in case of emergency
    • requestObject.favorite — set if this contact is a favorite
    • requestObject.tel — array of telephone objects
    • requestObject.email — array of email objects
    • requestObject.address — array of address objects
    • requestObject.im — array of IM objects
    • requestObject.success — Success callback function. Returns the response in the first argument.
    • requestObject.failure — Failure callback function. Returns the response in the first argument.
  • Returns: None. This method is asynchronous. Clients should use callback methods.

updateContact(requestObject)

Updates a specified contact.

  • Parameters:
    • requestObject — callbacks and parameters.
    • requestObject.id — ID of the contact
    • requestObject.version — version of the contact to be updated
    • requestObject.firstname — first name of the contact
    • requestObject.lastname — last name of the contact
    • requestObject.middlename — middle name of the contact
    • requestObject.nameprefix — name prefix of the contact
    • requestObject.birthday — birthday of the contact
    • requestObject.anniversary — anniversary of the contact
    • requestObject.spouse — contact’s spouse
    • requestObject.children — of the contact
    • requestObject.orgname — contact’s children
    • requestObject.jobtitle — job title of the contact
    • requestObject.profession — contact’s profession
    • requestObject.assistant — contact’s assistant
    • requestObject.gender — contact’s gender
    • requestObject.relationship — relationship with the contact
    • requestObject.maritalstatus — contact’s marital status
    • requestObject.source — source of the contact
    • requestObject.note — note for the contact
    • requestObject.incaseofemergency — set if this contact is to be called in case of emergency
    • requestObject.favorite — set if this contact is a favorite
    • requestObject.tel — array of telephone objects
    • requestObject.email — array of email objects
    • requestObject.address — array of address objects
    • requestObject.im — array of im objects
    • requestObject.success — Success callback function. Returns the response in the first argument.
    • requestObject.failure — Failure callback function. Returns the response in the first argument.
  • Returns: None. This method is asynchronous. Clients should use callback methods.

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