Ce plugin définit un global navigator.contacts objet, ce qui permet d'accéder à la base de données de contacts de dispositif.
Bien que l‘objet est attaché à la portée globale navigator , il n’est pas disponible jusqu'après la deviceready événement.
document.addEventListener (« deviceready », onDeviceReady, false) ;
function onDeviceReady() {console.log(navigator.contacts);}
Avertissement: collecte et utilisation des données de contact soulève des questions importantes de la vie privée. Politique de confidentialité de votre application doit examiner comment l‘application utilise les données de contact et si il est partagé avec d’autres parties. Information de contact est considéré comme sensible parce qu‘il révèle les gens avec lesquels une personne communique. Par conséquent, en plus de la politique de confidentialité de l’application, vous devez envisager fortement fournissant un avis juste-à-temps, avant que l‘application accède ou utilise des données de contact, si le système d’exploitation de périphérique ne fait donc pas déjà. Cet avis doit fournir les mêmes renseignements susmentionnées, ainsi que d‘obtenir l’autorisation de l‘utilisateur (par exemple, en présentant des choix OK et Non merci). Notez que certains marchés app peuvent exiger l’application de fournir un avis juste-à-temps et obtenir la permission de l‘utilisateur avant d’accéder à des données de contact. Une expérience utilisateur claire et facile à comprendre qui entourent l‘utilisation de données permettent d’éviter la confusion des utilisateurs de contact et une utilisation jugée abusive des données de contact. Pour plus d'informations, consultez le Guide de la vie privée.
Pour cela, cordova 5.0 + (v1.0.0 stable actuelle)
cordova plugin add cordova-plugin-contacts
Anciennes versions de cordova peuvent toujours installer via l'id déconseillée (v0.2.16 rassis)
cordova plugin add org.apache.cordova.contacts
Il est également possible d‘installer directement via l’url de repo (instable)
cordova plugin add https://github.com/apache/cordova-plugin-contacts.git
Créez www/manifest.webapp comme décrit dans Les Docs manifeste. Ajouter permisions pertinentes. Il est également nécessaire de changer le type d‘application Web de « privilégiés » - Docs manifeste. Avertissement: toutes les applications privilégiées appliquer Contenu politique de sécurité qui interdit à un script inline. Initialiser votre application d’une autre manière.
« type »: "le privilège", "autorisations": {« contacts »: {« accès »: "readwrite", "description": "décrire pourquoi il est nécessaire pour obtenir cette permission"}}
Avant Windows 10 : Tout contact retourné par les méthodes find et pickContact est en lecture seule, afin que votre application ne puisse les modifier. findméthode disponible uniquement sur les appareils Windows Phone 8.1.
Windows 10 et plus : Contacts peuvent être enregistrées et seront enregistrées dans le stockage local application contacts. Contacts peuvent également être supprimés.
Windows 8 Contacts sont en lecture seule. Via les Contacts d‘API Cordova ne sont pas queryable/consultables, vous devez en informer l’utilisateur de choisir un contact comme un appel à contacts.pickContact qui va ouvrir l‘application « People » où l’utilisateur doit choisir un contact. Les contacts retournés sont en lecture seule, afin que votre application ne puisse les modifier.
La navigator.contacts.create méthode est synchrone et retourne un nouveau Contact objet.
Cette méthode ne conserve pas l‘objet de Contact dans la base de données des contacts périphériques, dont vous avez besoin d’appeler le Contact.save méthode.
myContact var = navigator.contacts.create ({« displayName »: « Test User »}) ;
La navigator.contacts.find méthode s‘exécute de façon asynchrone, l’interrogation de la base de données de contacts de dispositif et retourne un tableau de Contact objets. Les objets résultants sont passés à la contactSuccess la fonction de rappel spécifiée par le paramètre contactSuccess .
Le paramètre contactFields spécifie les champs à utiliser comme un qualificateur de recherche. Un paramètre de longueur nulle contactFields n'est pas valide et se traduit par ContactError.INVALID_ARGUMENT_ERROR . Une valeur de contactFields de "*" recherche dans les champs de tout contact.
La chaîne contactFindOptions.filter peut servir comme un filtre de recherche lors de l‘interrogation de la base de données de contacts. Si fourni, un non-respect de la casse, correspondance de valeur partielle est appliquée à chaque champ spécifié dans le paramètre contactFields . S’il y a une correspondance pour n'importe quel des champs spécifiés, le contact est retourné. Utilisation contactFindOptions.desiredFields paramètre de contrôle qui contacter propriétés doit être retourné au retour.
contactFields: communiquer avec les champs à utiliser comme un qualificateur de recherche. (DOMString[]) [Required]
contactSuccess: fonction de rappel de succès avec le tableau d'objets Contact appelée retournée par la base de données. [Required]
contactError: fonction de rappel d‘erreur, appelée lorsqu’une erreur se produit. [Facultatif]
contactFindOptions: recherche d'options pour filtrer navigator.contacts. [Optional]
Clés incluent :
filtre: la chaîne de recherche utilisée pour trouver navigator.contacts. (DOMString) (Par défaut :"")
multiples: détermine si l'opération find retourne plusieurs navigator.contacts. (Booléen) (Par défaut :false)
Contact objet dispose seulement des valeurs de ces champs. (DOMString[]) [Optional]function onSuccess(contacts) {alert (« Found » + contacts.length + « contacts. »);} ;
function onError(contactError) {alert('onError!');} ;
trouver tous les contacts avec « Bob » dans toute option de var de champ nom = new ContactFindOptions() ;
options.Filter = « Bob » ;
options.multiple = true ;
options.desiredFields = [navigator.contacts.fieldType.id] ;
champs var = [navigator.contacts.fieldType.displayName, navigator.contacts.fieldType.name] ;
Navigator.contacts.Find (champs, onSuccess, onError, options) ;
__contactFields__n‘est pas prise en charge et sera ignorée. findméthode toujours tenter de faire correspondre le nom, adresse e-mail ou numéro de téléphone d’un contact.La navigator.contacts.pickContact méthode lance le sélecteur de Contact pour sélectionner un contact unique. L'objet qui en résulte est passé à la contactSuccess la fonction de rappel spécifiée par le paramètre contactSuccess .
contactSuccess: fonction de rappel de succès appelée avec l'objet de Contact unique. [Obligatoire]
contactError: fonction de rappel d‘erreur, appelée lorsqu’une erreur se produit. [Facultatif]
navigator.contacts.pickContact(function(contact) {console.log ("le contact suivant a été retenu:" + JSON.stringify(contact)) ;
}, function(err) {console.log ("Error:" + err) ;
});
Le Contact objet représente le contact de l'utilisateur. Contacts peuvent être créés, conservés ou supprimés de la base de données de contacts de dispositif. Contacts peuvent également être récupérées (individuellement ou en vrac) de la base de données en appelant le navigator.contacts.find méthode.
NOTE: tous les champs de contact susmentionnés ne sont pris en charge sur chaque plate-forme de périphérique. S'il vous plaît vérifier la section bizarreries de chaque plate-forme pour plus de détails.
ID: un identificateur global unique. (DOMString)
displayName: le nom de ce Contact, approprié pour l‘affichage à l’utilisateur final. (DOMString)
nom: un objet contenant tous les composants d'un nom de personnes. (ContactName)
Pseudo: un nom occasionnel permettant de régler le contact. (DOMString)
phoneNumbers: un tableau des numéros de téléphone du contact. (ContactField[])
courriels: un tableau d'adresses de courriel du contact. (ContactField[])
adresses: un tableau d'adresses tous les contacts. (ContactAddress[])
IMS: un tableau d'adresses IM tout le contact. (ContactField[])
organisations: un tableau des organisations de tout le contact. (ContactOrganization[])
anniversaire: l'anniversaire du contact. (Date)
Remarque: une remarque sur le contact. (DOMString)
photos: un tableau de photos du contact. (ContactField[])
catégories: un tableau de toutes les catégories définies par l'utilisateur attribuée au contact. (ContactField[])
URL: un tableau des pages web attribuée au contact. (ContactField[])
Clone: retourne un nouveau Contact objet qui est une copie complète de l'objet appelant, avec le id propriété la valeurnull.
supprimer: supprime le contact de la base de données de contacts de dispositif, sinon exécute un rappel d'erreur avec un ContactError objet.
Enregistrer: enregistre un nouveau contact dans la base de données de contacts de périphérique, ou met à jour un contact existant, si un contact avec le même id existe déjà.
function onSuccess(contact) {alert ("sauver succès");} ;
function onError(contactError) {alert ("erreur =" + contactError.code);} ;
créer un objet contact contact var = navigator.contacts.create() ;
contact.displayName = « Plombier » ;
contact.Nickname = « Plombier » ; spécifier à la fois pour prendre en charge tous les périphériques / / renseigner certains champs var nom = new ContactName() ;
name.givenName = « Jane » ;
name.familyName = « Doe » ;
contact.name = nom ;
enregistrer dans contact.save(onSuccess,onError) de l'appareil ;
Clone clone objet contact var = contact.clone() ;
clone.name.givenName = « John » ;
Console.log ("contact Original nom =" + contact.name.givenName) ;
Console.log ("nom de contact clonés =" + clone.name.givenName) ;
fonction onSuccess() {alert ("succès");} ;
function onError(contactError) {alert ("erreur =" + contactError.code);} ;
supprimer le contact de l'appareil contact.remove(onSuccess,onError) ;
null.catégories: partiellement pris en charge. Champs pref et type sont de retournull
IMS: non pris en charge
photos: ne pas pris en charge
displayName: ne pas possible sur iOS, retour null à moins qu‘il n’y a aucun ContactName spécifié, auquel cas, il renvoie le nom composite, Pseudo ou "" , respectivement.
anniversaire: doit être entré comme un JavaScript Date objet, de la même façon qu'il soit retourné.
photos: retourne une URL de fichier de l‘image, qui est stocké dans le répertoire temporaire de l’application. Contenu du répertoire temporaire est supprimés lorsque l'application se ferme.
catégories: cette propriété n'est actuellement pas supportée, retournull.
displayName: lorsque vous créez un contact, la valeur fournie pour le paramètre de nom d‘affichage est différent de l’affichage nom Récupérée lors de la recherche du contact.
URL: lorsque vous créez un contact, les utilisateurs peuvent entrer et enregistrer plus d'une adresse web, mais seulement un est disponible lors de la recherche du contact.
phoneNumbers: l‘option de pref n’est pas pris en charge. Le type n‘est pas pris en charge lors d’une opération de trouver . Seul phoneNumber est autorisé pour chaque type.
courriels: l‘option de pref n’est pas pris en charge. Accueil et personnels références même courriel entrée. Une seule participation est autorisée pour chaque type.
adresses: prend en charge seulement travail et accueil/personal type. La maison et personnels de type référence la même entrée d'adresse. Une seule participation est autorisée pour chaque type.
organisations: seul est autorisé et ne supporte pas les attributs pref, typeet Département .
Remarque: ne pas pris en charge, retournull.
IMS: ne pas pris en charge, retournull.
anniversaires: ne pas pris en charge, retournull.
catégories: ne pas pris en charge, retournull.
remove: méthode n'est pas prise en charge
photos: retourne une URL de fichier de l‘image, qui est stocké dans le répertoire temporaire de l’application.
anniversaires: ne pas pris en charge, retournull.
catégories: ne pas pris en charge, retournull.
remove: méthode est uniquement pris en charge dans Windows 10 ou supérieur.
Le ContactAddress objet Stocke les propriétés d‘une seule adresse d’un contact. A Contact objet peut inclure plusieurs adresses dans un ContactAddress[] tableau.
pref: la valeur true si ce ContactAddress contient la valeur de préférence de l'utilisateur. (booléen)
type: une chaîne qui indique quel type de terrain c'est le cas, maison par exemple. (DOMString)
mise en forme: l‘adresse complète au format pour l’affichage. (DOMString)
adresse: l'adresse complète. (DOMString)
localité: la ville ou la localité. (DOMString)
région: l'État ou la région. (DOMString)
Code postal: le code zip ou code postal. (DOMString)
pays: le nom du pays. (DOMString)
Affichez les informations d'adresse pour tous les contacts fonctionnent onSuccess(contacts) {pour (var j'ai = 0; j'ai < contacts.length; i ++) {pour (var j = 0; j < contacts[i].addresses.length; j ++) {alert ("Pref:" + contacts[i].addresses[j].pref + « \n » + "Type:" + contacts[i].addresses[j].type + « \n » + "au format:" + contacts[i].addresses[j].formatted + « \n » + "adresse de rue: "+ contacts[i].addresses[j].streetAddress +"\n"+" localité: "+ contacts[i].addresses[j].locality +"\n"+" région: "+ contacts[i].addresses[j].region +"\n"+" Code Postal: "+ contacts[i].addresses[j].postalCode +"\n"+" pays: "+ contacts[i].addresses[j].country) ;
}
}
};
function onError(contactError) {alert('onError!');} ;
trouver tous les contacts options var = new ContactFindOptions() ;
options.Filter = "" ;
filtre var = ["name", « adresses »] ;
Navigator.contacts.Find (filtre, onSuccess, onError, options) ;
false sur les appareils Android 2.X.pref: non pris en charge sur les appareils BlackBerry, retourfalse.
type: partiellement pris en charge. Seule chaque de travail et tapez les adresses de la maison peut être stockée par contact.
au format: partiellement pris en charge. Retourne la concaténation de tous les champs d'adresse BlackBerry.
streetAddress: prise en charge. Retourne la concaténation de BlackBerry address1 et address2 champs d'adresse.
localité: prise en charge. Stockée dans le champ d'adresse BlackBerry ville .
région: pris en charge. Stockée dans le champ d'adresse BlackBerry stateProvince .
Code postal: prise en charge. Stockée dans le champ d'adresse BlackBerry zipPostal .
pays: prise en charge.
pref: non pris en charge sur les appareils iOS, retourfalse.
au format: actuellement ne pas pris en charge.
Le ContactError objet est retourné à l‘utilisateur via le contactError fonction de rappel lorsqu’une erreur survient.
ContactError.UNKNOWN_ERROR (code 0)ContactError.INVALID_ARGUMENT_ERROR (code 1)ContactError.TIMEOUT_ERROR (code 2)ContactError.PENDING_OPERATION_ERROR (code 3)ContactError.IO_ERROR (code 4)ContactError.NOT_SUPPORTED_ERROR (code 5)ContactError.PERMISSION_DENIED_ERROR (code 20)Le ContactField objet est un composant réutilisable que représente contacter champs génériquement. Chaque ContactField objet contient un value , type , et pref propriété. A Contact objet stocke plusieurs propriétés dans ContactField[] tableaux, tels que téléphone numéros et adresses e-mail.
Dans la plupart des cas, il n‘y a pas de valeurs prédéterminées pour une ContactField l’attribut type de l‘objet. Par exemple, un numéro de téléphone peut spécifier des valeurs de type de la maison, travail, mobile, iPhoneou toute autre valeur qui est pris en charge par la base de contacts de la plate-forme un périphérique particulier. Toutefois, pour les Contact photos champ, le champ type indique le format de l’image retournée : url lorsque l‘attribut value contient une URL vers l’image photo ou base64 lorsque la valeur contient une chaîne codée en base64 image.
type: une chaîne qui indique quel type de terrain c'est le cas, maison par exemple. (DOMString)
valeur: la valeur du champ, comme un téléphone numéro ou adresse e-mail. (DOMString)
pref: la valeur true si ce ContactField contient la valeur de préférence de l'utilisateur. (booléen)
créer un nouveau contact contact var = navigator.contacts.create() ;
stocker des numéros de téléphone de contact en ContactField [] var phoneNumbers = [] ;
phoneNumbers[0] = new ContactField (« travail », ' 212-555-1234', false) ;
phoneNumbers[1] = new ContactField (« mobile », ' 917-555-5432', true) ; phoneNumbers[2] numéro préféré = new ContactField (« home », ' 203-555-7890', false) ;
contact.phoneNumbers = phoneNumbers ;
enregistrer le contact contact.save() ;
false.type: partiellement pris en charge. Utilisé pour les numéros de téléphone.
valeur: prise en charge.
pref: ne pas pris en charge, retourfalse.
false.false.false.Contient différents types d‘informations sur un Contact nom de l’objet.
mise en forme: le nom complet du contact. (DOMString)
familyName: nom de famille du contact. (DOMString)
givenName: prénom du contact. (DOMString)
middleName: deuxième prénom du contact. (DOMString)
honorificPrefix: préfixe du contact (exemple M. ou Mme) (DOMString)
honorificSuffix: suffixe du contact (exemple Esq.). (DOMString)
function onSuccess(contacts) {pour (var j'ai = 0; j'ai < contacts.length; i ++) {alert ("Formatted:" + contacts[i].name.formatted + « \n » + "patronyme:" + contacts[i].name.familyName + « \n » + "Prénom:" + contacts[i].name.givenName + « \n » + "Prénom:" + contacts[i].name.middleName + « \n » + "suffixe:" + contacts[i].name.honorificSuffix + « \n » + "préfixe:" + contacts[i].name.honorificSuffix) ;
}
};
function onError(contactError) {alert('onError!');} ;
options de var = new ContactFindOptions() ;
options.Filter = "" ;
filtre = ["name", « nom »] ;
Navigator.contacts.Find (filtre, onSuccess, onError, options) ;
honorificPrefix , givenName , middleName , familyName , ethonorificSuffix.au format: partiellement pris en charge. Retourne la concaténation de champs firstName et lastName de BlackBerry.
familyName: prise en charge. Stockée dans le champ lastName BlackBerry.
givenName: prise en charge. Stockée dans le champ firstName BlackBerry.
middleName: ne pas pris en charge, retournull.
honorificPrefix: ne pas pris en charge, retournull.
honorificSuffix: ne pas pris en charge, retournull.
honorificPrefix , givenName , middleName , familyName , ethonorificSuffix.au format: c'est le seul nom de propriété et est identique à displayName , etnickname
familyName: non pris en charge
givenName: non pris en charge
middleName: non pris en charge
honorificPrefix: non pris en charge
honorificSuffix: non pris en charge
displayNameLe ContactOrganization objet Stocke des propriétés un contact de l'organisation. A Contact objet contient un ou plusieurs ContactOrganization des objets dans un tableau.
pref: la valeur true si ce ContactOrganization contient la valeur de préférence de l'utilisateur. (booléen)
type: une chaîne qui indique quel type de terrain c'est le cas, maison par exemple. _(DOMString)
nom: le nom de l'organisation. (DOMString)
Département: le département et le contrat de travaille pour. (DOMString)
titre: titre du contact auprès de l'organisation. (DOMString)
function onSuccess(contacts) {pour (var j'ai = 0; j'ai < contacts.length; i ++) {pour (var j = 0; j < contacts[i].organizations.length; j ++) {alert ("Pref:" + contacts[i].organizations[j].pref + « \n » + "Type:" + contacts[i].organizations[j].type + « \n » + "nom:" + contacts[i].organizations[j].name + « \n » + "Département:" + contacts[i].organizations[j].department + « \n » + "Title: "+ contacts[i].organizations[j].title) ;
}
}
};
function onError(contactError) {alert('onError!');} ;
options de var = new ContactFindOptions() ;
options.Filter = "" ;
filtre = ["displayName", « organisations »] ;
Navigator.contacts.Find (filtre, onSuccess, onError, options) ;
false.pref: ne pas pris en charge par les appareils BlackBerry, retourfalse.
type: ne pas pris en charge par les appareils BlackBerry, retournull.
nom: partiellement pris en charge. Le premier nom de l'organisme est stocké dans le champ company de BlackBerry.
Département: ne pas pris en charge, retournull.
titre: partiellement pris en charge. Le premier titre de l'organisation est stocké dans le champ de jobTitle BlackBerry.
pref: non pris en charge
type: non pris en charge
Département: non pris en charge
Les champs nom et titre stocké dans org et jobTitle.
pref: non pris en charge sur les appareils iOS, retourfalse.
type: non pris en charge sur les appareils iOS, retournull.
nom: partiellement pris en charge. Le premier nom de l'organisme est stocké dans le champ de kABPersonOrganizationProperty iOS.
Département: partiellement pris en charge. Le premier nom de département est stocké dans le champ de kABPersonDepartmentProperty iOS.
titre: partiellement pris en charge. Le premier titre est stocké dans le champ de kABPersonJobTitleProperty iOS.
pref: ne pas pris en charge, retourfalse.
type: ne pas pris en charge, retournull.