Contactos

Con este plugin tendremos acceso a los contactos y a todas sus propiedades:

org.apache.cordova.contacs

Instalación

cordova plugin add org.apache.cordova.contacts

navigator.contacts

Métodos

  • navigator.contacts.create
  • navigator.contacts.find

Objetos

  • Contact
  • ContactName
  • ContactField
  • ContactAddress
  • ContactOrganization
  • ContactFindOptions
  • ContactError

 

Métodos

navigator.contacts.create

El método navigator.contacts.create es síncrono, y devuelve el objeto de un nuevo Contact.

Este método no almacena el objeto en la base de datos de contactos del dispositivo, por lo que se necesita invocar al método Contact.save.

Plataformas soportadas

  • Android
  • BlackBerry 10
  • Firefox OS
  • iOS
  • Windows Phone 7 and 8
  • Windows 8 ( Nota: Los contactos en Windows 8 serán abiertos desde la aplicación de contactos del propio sistema operativo, pero únicamente en modo lectura, por lo que los cambios realizados en la aplicación no serán guardados ) .

Ejemplo

var myContact = navigator.contacts.create({"displayName": "Test User"});

navigator.contacts.find

El método navigator.contacts.find se ejecuta asíncronamente, listando los contactos del dispositivo y devolviendo un array de objetos Contact. Los objetos resultantes son pasados por la función de llamada contactSuccess especificada por el parámetro contactSuccess.

El parámetro contactFields especifica los campos utilizados para la búsqueda, y solo aquellos resultados devueltos por la función contactSuccess. Si la longitud es 0, se lanza un error ContactError.INVALID_ARGUMENT_ERROR. Un objeto con más de 0 devuelve todos los campos de los contactos.

Parámetros

  • contactFields: Campos utilizados como parámetro de búsqueda. El objeto Contact resultante solo contiene los valores de estos campos. (DOMString[]) [Requerido]
  • contactSuccess: Función de respuesta correcta invocada con un array de objetos Contact desde la base de datos. [Required]
  • contactError: función de respuesta errónea, invocada cuando ocurre un error. [Opcional]
  • contactFindOptions: Busca las opciones de filtrado. [Opcional]

Plataformas soportadas

  • Android
  • BlackBerry 10
  • Firefox OS
  • iOS
  • Windows Phone 7 and 8
  • Windows 8 ( solo lectura )

Objetos

Contact

El objeto contact representa al contacto del usuario. Los contactos pueden ser creados, guardados o borrados desde la base de datos del dispositivo. Únicamente pueden ser devueltos desde el método  navigator.contacts.find.

Propiedades

  • id: Identificador globar único. (DOMString)
  • displayName: El nombre de este contacto, será el que se visione finalmente. (DOMString)
  • name: Un objeto que contiene todos los componentes del nombre de la persona. (ContactName)
  • nickname: Un nombre casual. (DOMString)
  • phoneNumbers: Un array de los números telefónicos del contacto. (ContactField[])
  • emails: Un array de todas las direcciones email del contacto. (ContactField[])
  • addresses: Un array de todas las direcciones del contacto. (ContactAddress[])
  • ims: Un array de todas las direcciones IM del contacto. (ContactField[])
  • organizations: Un array de todas las organizaciones del contacto. (ContactOrganization[])
  • birthday: Cumpleaños del contacto. (Date)
  • note: Una nota sobre el contacto. (DOMString)
  • photos: Un array de las fotos del contacto. (ContactField[])
  • categories:Un array de todas las categorías definidas por el usuario asociadas con el contacto. (ContactField[])
  • urls: Un array de las páginas webs asociadas al contacto. (ContactField[])

Métodos

  • clone: Devuelve un nuevo objeto Contact que es una copia idéntica de la llamada al objeto, con la id establecida a null.
  • remove: Borra al contacto de la base de datos del dispositivo.
  • save: Guarda un nuevo contacto en el dispositivo, o lo actualiza en el caso de que se encuentre un contacto con el mismo id.

Plataformas soportadas

  • Amazon Fire OS
  • Android
  • BlackBerry 10
  • Firefox OS
  • iOS
  • Windows Phone 7 & 8

ContactAddress

El objeto ContactAddress almacena las propiedades de una dirección. Un objeto Contact podría contener más de una dirección en un array ContactAddress[].

Propiedades

  • pref: Pone a true si el contenido de  ContactAddress tiene el valor preferido. (boolean)
  • type: Una cadena indicando de que tipo es el campo, home por ejemplo. (DOMString)
  • formatted: La dirección completa formateada. (DOMString)
  • streetAddress: La dirección completa de la calle. (DOMString)
  • locality: La ciudad o localidad. (DOMString)
  • region: El estado o región. (DOMString)
  • postalCode: El código postal. (DOMString)
  • country: Nombre del país. (DOMString)

Plataformas soportadas

  • Amazon Fire OS
  • Android
  • BlackBerry 10
  • Firefox OS
  • iOS
  • Windows Phone 7 & 8
  • Windows 8

ContactError

El objeto ContactError se devuelve al usuario cuando lanza la función de llamada contactError al ocurrir algún error.

Propiedades

  • code: Uno de los errores predefinidos listados a continuación.

Constantes

  • ContactError.UNKNOWN_ERROR
  • ContactError.INVALID_ARGUMENT_ERROR
  • ContactError.TIMEOUT_ERROR
  • ContactError.PENDING_OPERATION_ERROR
  • ContactError.IO_ERROR
  • ContactError.NOT_SUPPORTED_ERROR
  • ContactError.PERMISSION_DENIED_ERROR

ContactField

El objeto ContactField es un componente reutilizable que representa generalmente los campos del contacto. Cada objeto ContactField contiene una propiedad value, type, y pref. Un objeto Contact guarda varias propiedades en arrais ContactField[], así como números telefónicos y correos electrónicos.

Propiedades

  • type: Una cadena que india que tipo de campos es. (DOMString)
  • value: El valor del campo , así como teléfono o email. (DOMString)
  • pref: Pone a true si este ContactField contiene el valor preferido del usuario. (boolean)

Plataformas soportadas

  • Amazon Fire OS
  • Android
  • BlackBerry 10
  • Firefox OS
  • iOS
  • Windows Phone 7 & 8
  • Windows 8

ContactName

Contiene diferentes tipos de información sobre el nombre del objeto  Contact.

Propiedades

  • formatted: Nombre completo del contacto (DOMString)
  • familyName: Nombre de familia del contacto (DOMString)
  • givenName: El nombre dado del contacto (DOMString)
  • middleName: El nombre medio del contacto (DOMString)
  • honorificPrefix: El prefijo del contacto (D. o Da.) (DOMString)
  • honorificSuffix: El sufijo del contacto (Esq.) (DOMString)

Plataformas soportadas

  • Amazon Fire OS
  • Android 2.X
  • BlackBerry 10
  • Firefox OS
  • iOS
  • Windows Phone 7 & 8
  • Windows 8

ContactOrganization

El objeto ContactOrganization almacena las propiedades de la organización del contacto. Un objeto Contact almacena uno o varios objetos ContactOrganization en un array.

Propiedades

  • pref: Pone a true si este ContactField contiene el valor preferido del usuario. (boolean)
  • type: Una cadena que india que tipo de campos es. (DOMString)
  • name: Nombre de la organización. (DOMString)
  • department: Para qué departamento trabaja el contacto. (DOMString)
  • title: Puesto del contacto. (DOMString)

Plataformas soportadas

  • Android
  • BlackBerry 10
  • Firefox OS
  • iOS
  • Windows Phone 7 y 8