/* * * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * */ var argscheck = require('cordova/argscheck'), exec = require('cordova/exec'), ContactError = require('./ContactError'), utils = require('cordova/utils'), convertUtils = require('./convertUtils'); /** * Contains information about a single contact. * @constructor * @param {DOMString} id unique identifier * @param {DOMString} displayName * @param {ContactName} name * @param {DOMString} nickname * @param {Array.<ContactField>} phoneNumbers array of phone numbers * @param {Array.<ContactField>} emails array of email addresses * @param {Array.<ContactAddress>} addresses array of addresses * @param {Array.<ContactField>} ims instant messaging user ids * @param {Array.<ContactOrganization>} organizations * @param {DOMString} birthday contact's birthday * @param {DOMString} note user notes about contact * @param {Array.<ContactField>} photos * @param {Array.<ContactField>} categories * @param {Array.<ContactField>} urls contact's web sites */ var Contact = function (id, displayName, name, nickname, phoneNumbers, emails, addresses, ims, organizations, birthday, note, photos, categories, urls) { this.id = id || null; this.rawId = null; this.displayName = displayName || null; this.name = name || null; // ContactName this.nickname = nickname || null; this.phoneNumbers = phoneNumbers || null; // ContactField[] this.emails = emails || null; // ContactField[] this.addresses = addresses || null; // ContactAddress[] this.ims = ims || null; // ContactField[] this.organizations = organizations || null; // ContactOrganization[] this.birthday = birthday || null; this.note = note || null; this.photos = photos || null; // ContactField[] this.categories = categories || null; // ContactField[] this.urls = urls || null; // ContactField[] }; /** * Removes contact from device storage. * @param successCB success callback * @param errorCB error callback */ Contact.prototype.remove = function(successCB, errorCB) { argscheck.checkArgs('FF', 'Contact.remove', arguments); var fail = errorCB && function(code) { errorCB(new ContactError(code)); }; if (this.id === null) { fail(ContactError.UNKNOWN_ERROR); } else { exec(successCB, fail, "Contacts", "remove", [this.id]); } }; /** * Creates a deep copy of this Contact. * With the contact ID set to null. * @return copy of this Contact */ Contact.prototype.clone = function() { var clonedContact = utils.clone(this); clonedContact.id = null; clonedContact.rawId = null; function nullIds(arr) { if (arr) { for (var i = 0; i < arr.length; ++i) { arr[i].id = null; } } } // Loop through and clear out any id's in phones, emails, etc. nullIds(clonedContact.phoneNumbers); nullIds(clonedContact.emails); nullIds(clonedContact.addresses); nullIds(clonedContact.ims); nullIds(clonedContact.organizations); nullIds(clonedContact.categories); nullIds(clonedContact.photos); nullIds(clonedContact.urls); return clonedContact; }; /** * Persists contact to device storage. * @param successCB success callback * @param errorCB error callback */ Contact.prototype.save = function(successCB, errorCB) { argscheck.checkArgs('FFO', 'Contact.save', arguments); var fail = errorCB && function(code) { errorCB(new ContactError(code)); }; var success = function(result) { if (result) { if (successCB) { var fullContact = require('./contacts').create(result); successCB(convertUtils.toCordovaFormat(fullContact)); } } else { // no Entry object returned fail(ContactError.UNKNOWN_ERROR); } }; var dupContact = convertUtils.toNativeFormat(utils.clone(this)); exec(success, fail, "Contacts", "save", [dupContact]); }; module.exports = Contact;