forked from sintaxi/phonegap
/
cordova_contacts_contacts.md.html
1698 lines (1454 loc) · 72.1 KB
/
cordova_contacts_contacts.md.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<!DOCTYPE html>
<!--
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.
--><html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="viewport" content="initial-scale=1.0, maximum-scale=1.0, user-scalable=no, width=device-width">
<meta name="generator" content="joDoc">
<title>Apache Cordova API Documentation</title>
<link rel="stylesheet" type="text/css" href="index.css">
<link rel="stylesheet" type="text/css" href="mobile.css" media="only screen and (max-device-width: 1024px)">
<link rel="stylesheet" type="text/css" href="prettify/prettify.css">
</head>
<body>
<div id="header">
<h1><a href="index.html">Apache <strong>Cordova</strong> Documentation</a></h1>
<small>
<select><optgroup label="English" value="en">
<option value="edge">edge</option>
<option selected value="1.8.0rc1">1.8.0rc1</option>
<option value="1.7.0rc1">1.7.0rc1</option>
<option value="1.7.0">1.7.0</option>
<option value="1.6.1">1.6.1</option>
<option value="1.6.0rc1">1.6.0rc1</option>
<option value="1.6.0">1.6.0</option>
<option value="1.5.0rc1">1.5.0rc1</option>
<option value="1.5.0">1.5.0</option>
<option value="1.4.1">1.4.1</option>
<option value="1.4.0rc1">1.4.0rc1</option>
<option value="1.4.0">1.4.0</option>
<option value="1.3.0">1.3.0</option>
<option value="1.2.0">1.2.0</option>
<option value="1.1.0">1.1.0</option>
<option value="1.0.0rc3">1.0.0rc3</option>
<option value="1.0.0rc2">1.0.0rc2</option>
<option value="1.0.0rc1">1.0.0rc1</option>
<option value="1.0.0">1.0.0</option>
<option value="0.9.6">0.9.6</option>
<option value="0.9.5.1">0.9.5.1</option>
<option value="0.9.5">0.9.5</option>
<option value="0.9.4">0.9.4</option>
<option value="0.9.3">0.9.3</option>
<option value="0.9.2">0.9.2</option>
</optgroup>
<optgroup label="Español" value="es"><option value="1.0.0">1.0.0</option></optgroup>
<optgroup label="Français" value="fr">
<option value="1.3.0">1.3.0</option>
<option value="1.2.0">1.2.0</option>
<option value="1.1.0">1.1.0</option>
</optgroup>
<optgroup label="Japanese" value="jp"><option value="0.9.5">0.9.5</option></optgroup></select></small>
</div>
<div id="subheader">
<h1>Contacts</h1>
<small><select><option value="Contacts">Contacts</option>
<option value="Contacts_methods"> - Methods</option>
<option value="Contacts_arguments"> - Arguments</option>
<option value="Contacts_objects"> - Objects</option>
<option value="Contacts_permissions"> - Permissions</option>
<option value="contacts.create">contacts.create</option>
<option value="contacts.create_description"> - Description</option>
<option value="contacts.create_supported_platforms"> - Supported Platforms</option>
<option value="contacts.create_quick_example"> - Quick Example</option>
<option value="contacts.create_full_example"> - Full Example</option>
<option value="contacts.find">contacts.find</option>
<option value="contacts.find_description"> - Description</option>
<option value="contacts.find_parameters"> - Parameters</option>
<option value="contacts.find_supported_platforms"> - Supported Platforms</option>
<option value="contacts.find_quick_example"> - Quick Example</option>
<option value="contacts.find_full_example"> - Full Example</option>
<option value="Contact">Contact</option>
<option value="Contact_properties"> - Properties</option>
<option value="Contact_methods"> - Methods</option>
<option value="Contact_details"> - Details</option>
<option value="Contact_supported_platforms"> - Supported Platforms</option>
<option value="Contact_save_quick_example"> - Save Quick Example</option>
<option value="Contact_clone_quick_example"> - Clone Quick Example</option>
<option value="Contact_remove_quick_example"> - Remove Quick Example</option>
<option value="Contact_full_example"> - Full Example</option>
<option value="Contact_android_2_x_quirks"> - Android 2.X Quirks</option>
<option value="Contact_android_1_x_quirks"> - Android 1.X Quirks</option>
<option value="Contact_blackberry_webworks_os_5_0_and_higher_quirks"> - BlackBerry WebWorks (OS 5.0 and higher) Quirks</option>
<option value="Contact_ios_quirks"> - iOS Quirks</option>
<option value="Contact_bada_quirks"> - Bada Quirks</option>
<option value="ContactAddress">ContactAddress</option>
<option value="ContactAddress_properties"> - Properties</option>
<option value="ContactAddress_details"> - Details</option>
<option value="ContactAddress_supported_platforms"> - Supported Platforms</option>
<option value="ContactAddress_quick_example"> - Quick Example</option>
<option value="ContactAddress_full_example"> - Full Example</option>
<option value="ContactAddress_android_2_x_quirks"> - Android 2.X Quirks</option>
<option value="ContactAddress_android_1_x_quirks"> - Android 1.X Quirks</option>
<option value="ContactAddress_blackberry_webworks_os_5_0_and_higher_quirks"> - BlackBerry WebWorks (OS 5.0 and higher) Quirks</option>
<option value="ContactAddress_ios_quirks"> - iOS Quirks</option>
<option value="ContactAddress_bada_quirks"> - Bada Quirks</option>
<option value="ContactField">ContactField</option>
<option value="ContactField_properties"> - Properties</option>
<option value="ContactField_details"> - Details</option>
<option value="ContactField_supported_platforms"> - Supported Platforms</option>
<option value="ContactField_quick_example"> - Quick Example</option>
<option value="ContactField_full_example"> - Full Example</option>
<option value="ContactField_android_quirks"> - Android Quirks</option>
<option value="ContactField_blackberry_webworks_os_5_0_and_higher_quirks"> - BlackBerry WebWorks (OS 5.0 and higher) Quirks</option>
<option value="ContactField_ios_quirks"> - iOS Quirks</option>
<option value="ContactField_bada_quirks"> - Bada Quirks</option>
<option value="ContactFindOptions">ContactFindOptions</option>
<option value="ContactFindOptions_properties"> - Properties</option>
<option value="ContactFindOptions_supported_platforms"> - Supported Platforms</option>
<option value="ContactFindOptions_quick_example"> - Quick Example</option>
<option value="ContactFindOptions_full_example"> - Full Example</option>
<option value="ContactFindOptions_bada_quirks"> - Bada Quirks</option>
<option value="ContactName">ContactName</option>
<option value="ContactName_properties"> - Properties</option>
<option value="ContactName_details"> - Details</option>
<option value="ContactName_supported_platforms"> - Supported Platforms</option>
<option value="ContactName_quick_example"> - Quick Example</option>
<option value="ContactName_full_example"> - Full Example</option>
<option value="ContactName_android_quirks"> - Android Quirks</option>
<option value="ContactName_blackberry_webworks_os_5_0_and_higher_quirks"> - BlackBerry WebWorks (OS 5.0 and higher) Quirks</option>
<option value="ContactName_ios_quirks"> - iOS Quirks</option>
<option value="ContactName_bada_quirks"> - Bada Quirks</option>
<option value="ContactOrganization">ContactOrganization</option>
<option value="ContactOrganization_properties"> - Properties</option>
<option value="ContactOrganization_details"> - Details</option>
<option value="ContactOrganization_supported_platforms"> - Supported Platforms</option>
<option value="ContactOrganization_quick_example"> - Quick Example</option>
<option value="ContactOrganization_full_example"> - Full Example</option>
<option value="ContactOrganization_android_2_x_quirks"> - Android 2.X Quirks</option>
<option value="ContactOrganization_android_1_x_quirks"> - Android 1.X Quirks</option>
<option value="ContactOrganization_blackberry_webworks_os_5_0_and_higher_quirks"> - BlackBerry WebWorks (OS 5.0 and higher) Quirks</option>
<option value="ContactOrganization_ios_quirks"> - iOS Quirks</option>
<option value="ContactOrganization_bada_2_0_quirks"> - Bada 2.0 Quirks</option>
<option value="ContactError">ContactError</option>
<option value="ContactError_properties"> - Properties</option>
<option value="ContactError_constants"> - Constants</option>
<option value="ContactError_description"> - Description</option>
<option value="contactSuccess">contactSuccess</option>
<option value="contactSuccess_parameters"> - Parameters</option>
<option value="contactSuccess_example"> - Example</option>
<option value="contactError">contactError</option>
<option value="contactFields">contactFields</option>
<option value="contactFindOptions">contactFindOptions</option>
<option value="contactFindOptions_options"> - Options</option></select></small>
</div>
<div id="sidebar">
<div class="vertical_divider"></div>
<h1>API Reference</h1>
<ul>
<li><a href="cordova_accelerometer_accelerometer.md.html#Accelerometer">Accelerometer</a></li>
<li><a href="cordova_camera_camera.md.html#Camera">Camera</a></li>
<li><a href="cordova_media_capture_capture.md.html#Capture">Capture</a></li>
<li><a href="cordova_compass_compass.md.html#Compass">Compass</a></li>
<li><a href="cordova_connection_connection.md.html#Connection">Connection</a></li>
<li><a href="cordova_contacts_contacts.md.html#Contacts">Contacts</a></li>
<li><a href="cordova_device_device.md.html#Device">Device</a></li>
<li><a href="cordova_events_events.md.html#Events">Events</a></li>
<li><a href="cordova_file_file.md.html#File">File</a></li>
<li><a href="cordova_geolocation_geolocation.md.html#Geolocation">Geolocation</a></li>
<li><a href="cordova_media_media.md.html#Media">Media</a></li>
<li><a href="cordova_notification_notification.md.html#Notification">Notification</a></li>
<li><a href="cordova_storage_storage.md.html#Storage">Storage</a></li>
</ul>
<h1>Guides</h1>
<ul>
<li><a href="guide_getting-started_index.md.html#Getting%20Started%20Guides">Getting Started Guides</a></li>
<li><a href="guide_upgrading_index.md.html#Upgrading%20Guides">Upgrading Guides</a></li>
<li><a href="guide_whitelist_index.md.html#Domain%20Whitelist%20Guide">Domain Whitelist Guide</a></li>
<li><a href="_index.html">Keyword Index</a></li>
</ul>
</div>
<div id="scrollable">
<div id="content">
<h1><a name="Contacts">Contacts</a></h1>
<blockquote>
<p>The <code>contacts</code> object provides access to the device contacts database.</p>
</blockquote>
<h2>
<a name="Contacts_methods">Methods</a>
</h2>
<ul>
<li><a href="cordova_contacts_contacts.md.html#contacts.create">contacts.create</a></li>
<li><a href="cordova_contacts_contacts.md.html#contacts.find">contacts.find</a></li>
</ul>
<h2>
<a name="Contacts_arguments">Arguments</a>
</h2>
<ul>
<li><a href="cordova_contacts_contacts.md.html#contactFields">contactFields</a></li>
<li><a href="cordova_contacts_contacts.md.html#contactSuccess">contactSuccess</a></li>
<li><a href="cordova_contacts_contacts.md.html#contactError">contactError</a></li>
<li><a href="cordova_contacts_contacts.md.html#contactFindOptions">contactFindOptions</a></li>
</ul>
<h2>
<a name="Contacts_objects">Objects</a>
</h2>
<ul>
<li><a href="cordova_contacts_contacts.md.html#Contact">Contact</a></li>
<li><a href="cordova_contacts_contacts.md.html#ContactName">ContactName</a></li>
<li><a href="cordova_contacts_contacts.md.html#ContactField">ContactField</a></li>
<li><a href="cordova_contacts_contacts.md.html#ContactAddress">ContactAddress</a></li>
<li><a href="cordova_contacts_contacts.md.html#ContactOrganization">ContactOrganization</a></li>
<li><a href="cordova_contacts_contacts.md.html#ContactFindOptions">ContactFindOptions</a></li>
<li><a href="cordova_contacts_contacts.md.html#ContactError">ContactError</a></li>
</ul>
<h2>
<a name="Contacts_permissions">Permissions</a>
</h2>
<h3>Android</h3>
<h4>app/res/xml/plugins.xml</h4>
<pre class="prettyprint"><code><plugin name="<a href="cordova_contacts_contacts.md.html#Contacts">Contacts</a>" value="org.apache.cordova.ContactManager"/>
</code></pre>
<h4>app/AndroidManifest.xml</h4>
<pre class="prettyprint"><code><uses-permission android:name="android.permission.GET_ACCOUNTS" />
<uses-permission android:name="android.permission.READ_CONTACTS" />
<uses-permission android:name="android.permission.WRITE_CONTACTS" />
</code></pre>
<h3>Bada</h3>
<h4>manifest.xml</h4>
<pre class="prettyprint"><code><Privilege>
<Name>ADDRESSBOOK</Name>
</Privilege>
</code></pre>
<h3>BlackBerry WebWorks</h3>
<h4>www/plugins.xml</h4>
<pre class="prettyprint"><code><plugin name="<a href="cordova_contacts_contacts.md.html#Contact">Contact</a>" value="org.apache.cordova.pim.<a href="cordova_contacts_contacts.md.html#Contact">Contact</a>"/>
</code></pre>
<h4>www/config.xml</h4>
<p><feature id="blackberry.find" required="true" version="1.0.0.0"></feature><feature id="blackberry.identity" required="true" version="1.0.0.0"></feature><feature id="blackberry.pim.Address" required="true" version="1.0.0.0"></feature><feature id="blackberry.pim.<a href=" cordova_contacts_contacts>Contact" required="true" version="1.0.0.0" /></feature></p>
<h3>iOS</h3>
<h4>App/Supporting Files/Cordova.plist</h4>
<pre class="prettyprint"><code><key>Plugins</key>
<dict>
<key><a href="cordova_contacts_contacts.md.html#Contacts">Contacts</a></key>
<string>CDVContacts</string>
</dict>
</code></pre>
<h3>webOS</h3>
<pre class="prettyprint"><code>@TODO
</code></pre>
<h3>Windows Phone</h3>
<h4>Properties/WPAppManifest.xml</h4>
<pre class="prettyprint"><code><Capabilities>
<Capability Name="ID_CAP_CONTACTS"/>
</Capabilities>
</code></pre>
<p>Reference: <a class="external" href="http://msdn.microsoft.com/en-us/library/ff769509%28v=vs.92%29.aspx">Application Manifest for Windows Phone</a></p>
<hr>
<h1><a name="contacts.create">contacts.create</a></h1>
<p>Returns a new <a href="cordova_contacts_contacts.md.html#Contact">Contact</a> object.</p>
<pre class="prettyprint"><code>var contact = navigator.<a href="cordova_contacts_contacts.md.html#contacts.create">contacts.create</a>(properties);
</code></pre>
<h2>
<a name="contacts.create_description">Description</a>
</h2>
<p><a href="cordova_contacts_contacts.md.html#contacts.create">contacts.create</a> is a synchronous function that returns a new <code><a href="cordova_contacts_contacts.md.html#Contact">Contact</a></code> object.</p>
<p>This method does not persist the <a href="cordova_contacts_contacts.md.html#Contact">Contact</a> object to the device contacts database. To persist the <a href="cordova_contacts_contacts.md.html#Contact">Contact</a> object to the device, invoke the <code><a href="cordova_contacts_contacts.md.html#Contact">Contact</a>.save</code> method.</p>
<h2>
<a name="contacts.create_supported_platforms">Supported Platforms</a>
</h2>
<ul>
<li>Android</li>
<li>BlackBerry WebWorks (OS 5.0 and higher)</li>
<li>iOS</li>
<li>Bada 1.2 & 2.0</li>
</ul>
<h2>
<a name="contacts.create_quick_example">Quick Example</a>
</h2>
<pre class="prettyprint"><code>var myContact = navigator.<a href="cordova_contacts_contacts.md.html#contacts.create">contacts.create</a>({"displayName": "Test User"});
</code></pre>
<h2>
<a name="contacts.create_full_example">Full Example</a>
</h2>
<pre class="prettyprint"><code><!DOCTYPE html>
<html>
<head>
<title><a href="cordova_contacts_contacts.md.html#Contact">Contact</a> Example</title>
<script type="text/javascript" charset="utf-8" src="cordova-1.8.0.js"></script>
<script type="text/javascript" charset="utf-8">
// Wait for Cordova to load
//
document.addEventListener("<a href="cordova_events_events.md.html#deviceready">deviceready</a>", onDeviceReady, false);
// Cordova is ready
//
function onDeviceReady() {
var myContact = navigator.<a href="cordova_contacts_contacts.md.html#contacts.create">contacts.create</a>({"displayName": "Test User"});
myContact.note = "This contact has a note.";
console.log("The contact, " + myContact.displayName + ", note: " + myContact.note);
}
</script>
</head>
<body>
<h1>Example</h1>
<p>Create <a href="cordova_contacts_contacts.md.html#Contact">Contact</a></p>
</body>
</html>
</code></pre>
<hr>
<h1><a name="contacts.find">contacts.find</a></h1>
<p>Queries the device contacts database and returns one or more <code><a href="cordova_contacts_contacts.md.html#Contact">Contact</a></code> objects, each containing the fields specified.</p>
<pre class="prettyprint"><code>navigator.<a href="cordova_contacts_contacts.md.html#contacts.find">contacts.find</a>(<a href="cordova_contacts_contacts.md.html#contactFields">contactFields</a>, <a href="cordova_contacts_contacts.md.html#contactSuccess">contactSuccess</a>, <a href="cordova_contacts_contacts.md.html#contactError">contactError</a>, <a href="cordova_contacts_contacts.md.html#contactFindOptions">contactFindOptions</a>);
</code></pre>
<h2>
<a name="contacts.find_description">Description</a>
</h2>
<p><a href="cordova_contacts_contacts.md.html#contacts.find">contacts.find</a> is an asynchronous function that queries the device contacts database and returns an array of <code><a href="cordova_contacts_contacts.md.html#Contact">Contact</a></code> objects. The resulting objects are passed to the <code><a href="cordova_contacts_contacts.md.html#contactSuccess">contactSuccess</a></code> callback function specified by the <strong><a href="cordova_contacts_contacts.md.html#contactSuccess">contactSuccess</a></strong> parameter. </p>
<p>Users must specify the contact fields to be used as a search qualifier in the <strong><a href="cordova_contacts_contacts.md.html#contactFields">contactFields</a></strong> parameter. Only the fields specified in the <strong><a href="cordova_contacts_contacts.md.html#contactFields">contactFields</a></strong> parameter will be returned as properties of the <code><a href="cordova_contacts_contacts.md.html#Contact">Contact</a></code> objects that are passed to the <strong><a href="cordova_contacts_contacts.md.html#contactSuccess">contactSuccess</a></strong> callback function. A zero-length <strong><a href="cordova_contacts_contacts.md.html#contactFields">contactFields</a></strong> parameter will result in an array of <code><a href="cordova_contacts_contacts.md.html#Contact">Contact</a></code> objects with only the <code>id</code> property populated. A <strong><a href="cordova_contacts_contacts.md.html#contactFields">contactFields</a></strong> value of ["*"] will return all contact fields. </p>
<p>The <strong><a href="cordova_contacts_contacts.md.html#contactFindOptions">contactFindOptions</a>.filter</strong> string can be used as a search filter when querying the contacts database. If provided, a case-insensitive, partial value match is applied to each field specified in the <strong><a href="cordova_contacts_contacts.md.html#contactFields">contactFields</a></strong> parameter. If a match is found in a comparison with <em>any</em> of the specified fields, the contact is returned.</p>
<h2>
<a name="contacts.find_parameters">Parameters</a>
</h2>
<ul>
<li>
<strong><a href="cordova_contacts_contacts.md.html#contactFields">contactFields</a>:</strong> <a href="cordova_contacts_contacts.md.html#Contact">Contact</a> fields to be used as search qualifier. Only these fields will have values in the resulting <code><a href="cordova_contacts_contacts.md.html#Contact">Contact</a></code> objects. <em>(DOMString[])</em> [Required]</li>
<li>
<strong><a href="cordova_contacts_contacts.md.html#contactSuccess">contactSuccess</a>:</strong> Success callback function that is invoked with the contacts returned from the contacts database. [Required]</li>
<li>
<strong><a href="cordova_contacts_contacts.md.html#contactError">contactError</a>:</strong> Error callback function. Invoked when error occurs. [Optional]</li>
<li>
<strong><a href="cordova_contacts_contacts.md.html#contactFindOptions">contactFindOptions</a>:</strong> Search options to filter contacts. [Optional]</li>
</ul>
<h2>
<a name="contacts.find_supported_platforms">Supported Platforms</a>
</h2>
<ul>
<li>Android</li>
<li>BlackBerry WebWorks (OS 5.0 and higher)</li>
<li>iOS</li>
<li>Bada 1.2 & 2.0</li>
</ul>
<h2>
<a name="contacts.find_quick_example">Quick Example</a>
</h2>
<pre class="prettyprint"><code>function onSuccess(contacts) {
alert('Found ' + contacts.length + ' contacts.');
};
function onError(<a href="cordova_contacts_contacts.md.html#contactError">contactError</a>) {
alert('onError!');
};
// find all contacts with 'Bob' in any name field
var options = new <a href="cordova_contacts_contacts.md.html#ContactFindOptions">ContactFindOptions</a>();
options.filter="Bob";
var fields = ["displayName", "name"];
navigator.<a href="cordova_contacts_contacts.md.html#contacts.find">contacts.find</a>(fields, onSuccess, onError, options);
</code></pre>
<h2>
<a name="contacts.find_full_example">Full Example</a>
</h2>
<pre class="prettyprint"><code><!DOCTYPE html>
<html>
<head>
<title><a href="cordova_contacts_contacts.md.html#Contact">Contact</a> Example</title>
<script type="text/javascript" charset="utf-8" src="cordova-1.8.0.js"></script>
<script type="text/javascript" charset="utf-8">
// Wait for Cordova to load
//
document.addEventListener("<a href="cordova_events_events.md.html#deviceready">deviceready</a>", onDeviceReady, false);
// Cordova is ready
//
function onDeviceReady() {
// find all contacts with 'Bob' in any name field
var options = new <a href="cordova_contacts_contacts.md.html#ContactFindOptions">ContactFindOptions</a>();
options.filter="Bob";
var fields = ["displayName", "name"];
navigator.<a href="cordova_contacts_contacts.md.html#contacts.find">contacts.find</a>(fields, onSuccess, onError, options);
}
// onSuccess: Get a snapshot of the current contacts
//
function onSuccess(contacts) {
for (var i=0; i<contacts.length; i++) {
console.log("Display Name = " + contacts[i].displayName);
}
}
// onError: Failed to get the contacts
//
function onError(<a href="cordova_contacts_contacts.md.html#contactError">contactError</a>) {
alert('onError!');
}
</script>
</head>
<body>
<h1>Example</h1>
<p>Find <a href="cordova_contacts_contacts.md.html#Contacts">Contacts</a></p>
</body>
</html>
</code></pre>
<hr>
<h1><a name="Contact">Contact</a></h1>
<p>Contains properties that describe a contact, such as a user's personal or business contact.</p>
<h2>
<a name="Contact_properties">Properties</a>
</h2>
<ul>
<li>
<strong>id:</strong> A globally unique identifier. <em>(DOMString)</em>
</li>
<li>
<strong>displayName:</strong> The name of this <a href="cordova_contacts_contacts.md.html#Contact">Contact</a>, suitable for display to end-users. <em>(DOMString)</em>
</li>
<li>
<strong>name:</strong> An object containing all components of a persons name. <em>(<a href="cordova_contacts_contacts.md.html#ContactName">ContactName</a>)</em>
</li>
<li>
<strong>nickname:</strong> A casual name to address the contact by. <em>(DOMString)</em>
</li>
<li>
<strong>phoneNumbers:</strong> An array of all the contact's phone numbers. <em>(<a href="cordova_contacts_contacts.md.html#ContactField">ContactField</a>[])</em>
</li>
<li>
<strong>emails:</strong> An array of all the contact's email addresses. <em>(<a href="cordova_contacts_contacts.md.html#ContactField">ContactField</a>[])</em>
</li>
<li>
<strong>addresses:</strong> An array of all the contact's addresses. <em>(<a href="cordova_contacts_contacts.md.html#ContactAddress">ContactAddress</a>[])</em>
</li>
<li>
<strong>ims:</strong> An array of all the contact's IM addresses. <em>(<a href="cordova_contacts_contacts.md.html#ContactField">ContactField</a>[])</em>
</li>
<li>
<strong>organizations:</strong> An array of all the contact's organizations. <em>(<a href="cordova_contacts_contacts.md.html#ContactOrganization">ContactOrganization</a>[])</em>
</li>
<li>
<strong>birthday:</strong> The birthday of the contact. <em>(Date)</em>
</li>
<li>
<strong>note:</strong> A note about the contact. <em>(DOMString)</em>
</li>
<li>
<strong>photos:</strong> An array of the contact's photos. <em>(<a href="cordova_contacts_contacts.md.html#ContactField">ContactField</a>[])</em>
</li>
<li>
<strong>categories:</strong> An array of all the contacts user defined categories. <em>(<a href="cordova_contacts_contacts.md.html#ContactField">ContactField</a>[])</em>
</li>
<li>
<strong>urls:</strong> An array of web pages associated to the contact. <em>(<a href="cordova_contacts_contacts.md.html#ContactField">ContactField</a>[])</em>
</li>
</ul>
<h2>
<a name="Contact_methods">Methods</a>
</h2>
<ul>
<li>
<strong>clone</strong>: Returns a new <a href="cordova_contacts_contacts.md.html#Contact">Contact</a> object that is a deep copy of the calling object, with the id property set to <code>null</code>. </li>
<li>
<strong>remove</strong>: Removes the contact from the device contacts database. An error callback is called with a <code><a href="cordova_contacts_contacts.md.html#ContactError">ContactError</a></code> object if the removal is unsuccessful.</li>
<li>
<strong>save</strong>: Saves a new contact to the device contacts database, or updates an existing contact if a contact with the same <strong>id</strong> already exists.</li>
</ul>
<h2>
<a name="Contact_details">Details</a>
</h2>
<p>The <code><a href="cordova_contacts_contacts.md.html#Contact">Contact</a></code> object represents a user contact. <a href="cordova_contacts_contacts.md.html#Contacts">Contacts</a> can be created, saved to, or removed from the device contacts database. <a href="cordova_contacts_contacts.md.html#Contacts">Contacts</a> can also be retrieved (individually or in bulk) from the database by invoking the <code><a href="cordova_contacts_contacts.md.html#contacts.find">contacts.find</a></code> method.</p>
<p><em>Note: Not all of the above contact fields are supported on every <a href="#device%20platform">device platform</a>. Please check each platform's Quirks section for information about which fields are supported.</em></p>
<h2>
<a name="Contact_supported_platforms">Supported Platforms</a>
</h2>
<ul>
<li>Android</li>
<li>BlackBerry WebWorks (OS 5.0 and higher)</li>
<li>iOS</li>
<li>Bada 1.2 & 2.0</li>
</ul>
<h2>
<a name="Contact_save_quick_example">Save Quick Example</a>
</h2>
<pre class="prettyprint"><code>function onSuccess(contact) {
alert("Save Success");
};
function onError(<a href="cordova_contacts_contacts.md.html#contactError">contactError</a>) {
alert("Error = " + <a href="cordova_contacts_contacts.md.html#contactError">contactError</a>.code);
};
// create a new contact object
var contact = navigator.<a href="cordova_contacts_contacts.md.html#contacts.create">contacts.create</a>();
contact.displayName = "Plumber";
contact.nickname = "Plumber"; //specify both to support all devices
// populate some fields
var name = new <a href="cordova_contacts_contacts.md.html#ContactName">ContactName</a>();
name.givenName = "Jane";
name.familyName = "Doe";
contact.name = name;
// save to device
contact.save(onSuccess,onError);
</code></pre>
<h2>
<a name="Contact_clone_quick_example">Clone Quick Example</a>
</h2>
<pre class="prettyprint"><code>// clone the contact object
var clone = contact.clone();
clone.name.givenName = "John";
console.log("Original contact name = " + contact.name.givenName);
console.log("Cloned contact name = " + clone.name.givenName);
</code></pre>
<h2>
<a name="Contact_remove_quick_example">Remove Quick Example</a>
</h2>
<pre class="prettyprint"><code>function onSuccess() {
alert("Removal Success");
};
function onError(<a href="cordova_contacts_contacts.md.html#contactError">contactError</a>) {
alert("Error = " + <a href="cordova_contacts_contacts.md.html#contactError">contactError</a>.code);
};
// remove the contact from the device
contact.remove(onSuccess,onError);
</code></pre>
<h2>
<a name="Contact_full_example">Full Example</a>
</h2>
<pre class="prettyprint"><code><!DOCTYPE html>
<html>
<head>
<title><a href="cordova_contacts_contacts.md.html#Contact">Contact</a> Example</title>
<script type="text/javascript" charset="utf-8" src="cordova-1.8.0.js"></script>
<script type="text/javascript" charset="utf-8">
// Wait for Cordova to load
//
document.addEventListener("<a href="cordova_events_events.md.html#deviceready">deviceready</a>", onDeviceReady, false);
// Cordova is ready
//
function onDeviceReady() {
// create
var contact = navigator.<a href="cordova_contacts_contacts.md.html#contacts.create">contacts.create</a>();
contact.displayName = "Plumber";
contact.nickname = "Plumber"; //specify both to support all devices
var name = new <a href="cordova_contacts_contacts.md.html#ContactName">ContactName</a>();
name.givenName = "Jane";
name.familyName = "Doe";
contact.name = name;
// save
contact.save(onSaveSuccess,onSaveError);
// clone
var clone = contact.clone();
clone.name.givenName = "John";
console.log("Original contact name = " + contact.name.givenName);
console.log("Cloned contact name = " + clone.name.givenName);
// remove
contact.remove(onRemoveSuccess,onRemoveError);
}
// onSaveSuccess: Get a snapshot of the current contacts
//
function onSaveSuccess(contact) {
alert("Save Success");
}
// onSaveError: Failed to get the contacts
//
function onSaveError(<a href="cordova_contacts_contacts.md.html#contactError">contactError</a>) {
alert("Error = " + <a href="cordova_contacts_contacts.md.html#contactError">contactError</a>.code);
}
// onRemoveSuccess: Get a snapshot of the current contacts
//
function onRemoveSuccess(contacts) {
alert("Removal Success");
}
// onRemoveError: Failed to get the contacts
//
function onRemoveError(<a href="cordova_contacts_contacts.md.html#contactError">contactError</a>) {
alert("Error = " + <a href="cordova_contacts_contacts.md.html#contactError">contactError</a>.code);
}
</script>
</head>
<body>
<h1>Example</h1>
<p>Find <a href="cordova_contacts_contacts.md.html#Contacts">Contacts</a></p>
</body>
</html>
</code></pre>
<h2>
<a name="Contact_android_2_x_quirks">Android 2.X Quirks</a>
</h2>
<ul>
<li>
<strong>categories:</strong> This property is not support by Android 2.X devices, and will always be returned as <code>null</code>.</li>
</ul>
<h2>
<a name="Contact_android_1_x_quirks">Android 1.X Quirks</a>
</h2>
<ul>
<li>
<strong>name:</strong> This property is not support by Android 1.X devices, and will always be returned as <code>null</code>.</li>
<li>
<strong>nickname:</strong> This property is not support by Android 1.X devices, and will always be returned as <code>null</code>.</li>
<li>
<strong>birthday:</strong> This property is not support by Android 1.X devices, and will always be returned as <code>null</code>.</li>
<li>
<strong>photos:</strong> This property is not support by Android 1.X devices, and will always be returned as <code>null</code>.</li>
<li>
<strong>categories:</strong> This property is not support by Android 1.X devices, and will always be returned as <code>null</code>.</li>
<li>
<strong>urls:</strong> This property is not support by Android 1.X devices, and will always be returned as <code>null</code>.</li>
</ul>
<h2>
<a name="Contact_blackberry_webworks_os_5_0_and_higher_quirks">BlackBerry WebWorks (OS 5.0 and higher) Quirks</a>
</h2>
<ul>
<li>
<strong>id:</strong> Supported. Assigned by device when contact is saved.</li>
<li>
<strong>displayName:</strong> Supported. Stored in BlackBerry <strong>user1</strong> field.</li>
<li>
<strong>nickname:</strong> This property is not supported, and will always be returned as <code>null</code>. </li>
<li>
<strong>phoneNumbers:</strong> Partially supported. Phone numbers will be stored in BlackBerry fields <strong>homePhone1</strong> and <strong>homePhone2</strong> if <em>type</em> is 'home', <strong>workPhone1</strong> and <strong>workPhone2</strong> if <em>type</em> is 'work', <strong>mobilePhone</strong> if <em>type</em> is 'mobile', <strong>faxPhone</strong> if <em>type</em> is 'fax', <strong>pagerPhone</strong> if <em>type</em> is 'pager', and <strong>otherPhone</strong> if <em>type</em> is none of the above.</li>
<li>
<strong>emails:</strong> Partially supported. The first three email addresses will be stored in the BlackBerry <strong>email1</strong>, <strong>email2</strong>, and <strong>email3</strong> fields, respectively.</li>
<li>
<strong>addresses:</strong> Partially supported. The first and second addresses will be stored in the BlackBerry <strong>homeAddress</strong> and <strong>workAddress</strong> fields, respectively.</li>
<li>
<strong>ims:</strong> This property is not supported, and will always be returned as <code>null</code>. </li>
<li>
<strong>organizations:</strong> Partially supported. The <strong>name</strong> and <strong>title</strong> of the first organization are stored in the BlackBerry <strong>company</strong> and <strong>title</strong> fields, respectively.</li>
<li>
<strong>photos:</strong> - Partially supported. A single thumbnail-sized photo is supported. To set a contact's photo, pass in a either a Base64 encoded image, or a URL pointing to the image. The image will be scaled down before saving to the BlackBerry contacts database. The contact photo is returned as a Base64 encoded image.</li>
<li>
<strong>categories:</strong> Partially supported. Only 'Business' and 'Personal' categories are supported. </li>
<li>
<strong>urls:</strong> Partially supported. The first url is stored in BlackBerry <strong>webpage</strong> field.</li>
</ul>
<h2>
<a name="Contact_ios_quirks">iOS Quirks</a>
</h2>
<ul>
<li>
<strong>displayName:</strong> This property is not supported by iOS and will be returned as <code>null</code> unless there is no <a href="cordova_contacts_contacts.md.html#ContactName">ContactName</a> specified. If there is no <a href="cordova_contacts_contacts.md.html#ContactName">ContactName</a>, then composite name, <strong>nickame</strong> or "" is returned for <strong>displayName</strong>, respectively. </li>
<li>
<strong>birthday:</strong> For input, this property must be provided as a JavaScript Date object. It is returned as a JavaScript Date object.</li>
<li>
<strong>photos:</strong> Returned Photo is stored in the application's temporary directory and a <a href="cordova_file_file.md.html#File">File</a> URL to photo is returned. Contents of temporary folder is deleted when application exits. </li>
<li>
<strong>categories:</strong> This property is not currently supported and will always be returned as <code>null</code>.</li>
</ul>
<h2>
<a name="Contact_bada_quirks">Bada Quirks</a>
</h2>
<ul>
<li>
<strong>displayName:</strong> This property is not supported</li>
<li>
<strong>birthday:</strong> This property is not supported</li>
<li>
<strong>photos:</strong> This property should be a list with one URL to a photo</li>
<li>
<strong>categories:</strong> This property is not supported</li>
<li>
<strong>ims:</strong> This property is not supported</li>
</ul>
<hr>
<h1><a name="ContactAddress">ContactAddress</a></h1>
<p>Contains address properties for a <code><a href="cordova_contacts_contacts.md.html#Contact">Contact</a></code> object.</p>
<h2>
<a name="ContactAddress_properties">Properties</a>
</h2>
<ul>
<li>
<strong>pref:</strong> Set to <code>true</code> if this <code><a href="cordova_contacts_contacts.md.html#ContactAddress">ContactAddress</a></code> contains the user's preferred value. <em>(boolean)</em>
</li>
<li>
<strong>type:</strong> A string that tells you what type of field this is (example: 'home'). _(DOMString)</li>
<li>
<strong>formatted:</strong> The full address formatted for display. <em>(DOMString)</em>
</li>
<li>
<strong>streetAddress:</strong> The full street address. <em>(DOMString)</em>
</li>
<li>
<strong>locality:</strong> The city or locality. <em>(DOMString)</em>
</li>
<li>
<strong>region:</strong> The state or region. <em>(DOMString)</em>
</li>
<li>
<strong>postalCode:</strong> The zip code or postal code. <em>(DOMString)</em>
</li>
<li>
<strong>country:</strong> The country name. <em>(DOMString)</em>
</li>
</ul>
<h2>
<a name="ContactAddress_details">Details</a>
</h2>
<p>The <code><a href="cordova_contacts_contacts.md.html#ContactAddress">ContactAddress</a></code> object stores the properties of a single address of a contact. A <code><a href="cordova_contacts_contacts.md.html#Contact">Contact</a></code> object can have one or more addresses in a <code><a href="cordova_contacts_contacts.md.html#ContactAddress">ContactAddress</a>[]</code> array. </p>
<h2>
<a name="ContactAddress_supported_platforms">Supported Platforms</a>
</h2>
<ul>
<li>Android</li>
<li>BlackBerry WebWorks (OS 5.0 and higher)</li>
<li>iOS</li>
<li>Bada 1.2 & 2.0</li>
</ul>
<h2>
<a name="ContactAddress_quick_example">Quick Example</a>
</h2>
<pre class="prettyprint"><code>// display the address information for all contacts
function onSuccess(contacts) {
for (var i=0; i<contacts.length; i++) {
for (var j=0; j<contacts[i].addresses.length; j++) {
alert("Pref: " + contacts[i].addresses[j].pref + "\n" +
"Type: " + contacts[i].addresses[j].type + "\n" +
"Formatted: " + contacts[i].addresses[j].formatted + "\n" +
"Street Address: " + contacts[i].addresses[j].streetAddress + "\n" +
"Locality: " + contacts[i].addresses[j].locality + "\n" +
"Region: " + contacts[i].addresses[j].region + "\n" +
"Postal Code: " + contacts[i].addresses[j].postalCode + "\n" +
"Country: " + contacts[i].addresses[j].country);
}
}
};
function onError(<a href="cordova_contacts_contacts.md.html#contactError">contactError</a>) {
alert('onError!');
};
// find all contacts
var options = new <a href="cordova_contacts_contacts.md.html#ContactFindOptions">ContactFindOptions</a>();
options.filter="";
var filter = ["displayName","addresses"];
navigator.<a href="cordova_contacts_contacts.md.html#contacts.find">contacts.find</a>(filter, onSuccess, onError, options);
</code></pre>
<h2>
<a name="ContactAddress_full_example">Full Example</a>
</h2>
<pre class="prettyprint"><code><!DOCTYPE html>
<html>
<head>
<title><a href="cordova_contacts_contacts.md.html#Contact">Contact</a> Example</title>
<script type="text/javascript" charset="utf-8" src="cordova-1.8.0.js"></script>
<script type="text/javascript" charset="utf-8">
// Wait for Cordova to load
//
document.addEventListener("<a href="cordova_events_events.md.html#deviceready">deviceready</a>", onDeviceReady, false);
// Cordova is ready
//
function onDeviceReady() {
// find all contacts
var options = new <a href="cordova_contacts_contacts.md.html#ContactFindOptions">ContactFindOptions</a>();
options.filter="";
var filter = ["displayName","addresses"];
navigator.<a href="cordova_contacts_contacts.md.html#contacts.find">contacts.find</a>(filter, onSuccess, onError, options);
}
// onSuccess: Get a snapshot of the current contacts
//
function onSuccess(contacts) {
// display the address information for all contacts
for (var i=0; i<contacts.length; i++) {
for (var j=0; j<contacts[i].addresses.length; j++) {
alert("Pref: " + contacts[i].addresses[j].pref + "\n" +
"Type: " + contacts[i].addresses[j].type + "\n" +
"Formatted: " + contacts[i].addresses[j].formatted + "\n" +
"Street Address: " + contacts[i].addresses[j].streetAddress + "\n" +
"Locality: " + contacts[i].addresses[j].locality + "\n" +
"Region: " + contacts[i].addresses[j].region + "\n" +
"Postal Code: " + contacts[i].addresses[j].postalCode + "\n" +
"Country: " + contacts[i].addresses[j].country);
}
}
};
// onError: Failed to get the contacts
//
function onError(<a href="cordova_contacts_contacts.md.html#contactError">contactError</a>) {
alert('onError!');
}
</script>
</head>
<body>
<h1>Example</h1>
<p>Find <a href="cordova_contacts_contacts.md.html#Contacts">Contacts</a></p>
</body>
</html>
</code></pre>
<h2>
<a name="ContactAddress_android_2_x_quirks">Android 2.X Quirks</a>
</h2>
<ul>
<li>
<strong>pref:</strong> This property is not supported by Android 2.X devices and will always return <code>false</code>.</li>
</ul>
<h2>
<a name="ContactAddress_android_1_x_quirks">Android 1.X Quirks</a>
</h2>
<ul>
<li>
<strong>pref:</strong> This property is not supported by Android 1.X devices and will always return <code>false</code>.</li>
<li>
<strong>type:</strong> This property is not supported by Android 1.X devices and will always return <code>null</code>.</li>
<li>
<strong>streetAddress:</strong> This property is not support by Android 1.X devices, and will always return <code>null</code>.</li>
<li>
<strong>locality:</strong> This property is not support by Android 1.X devices, and will always return <code>null</code>.</li>
<li>
<strong>region:</strong> This property is not support by Android 1.X devices, and will always return <code>null</code>.</li>
<li>
<strong>postalCode:</strong> This property is not support by Android 1.X devices, and will always return <code>null</code>.</li>
<li>
<strong>country:</strong> This property is not support by Android 1.X devices, and will always return <code>null</code>.</li>
</ul>
<h2>
<a name="ContactAddress_blackberry_webworks_os_5_0_and_higher_quirks">BlackBerry WebWorks (OS 5.0 and higher) Quirks</a>
</h2>
<ul>
<li>
<strong>pref:</strong> This property is not supported on Blackberry devices and will always return <code>false</code>.</li>
<li>
<strong>type:</strong> Partially supported. Only one each of "Work" and "Home" type addresses can be stored per contact. </li>
<li>
<strong>formatted:</strong> Partially supported. Will return concatenation of all BlackBerry address fields.</li>
<li>
<strong>streetAddress:</strong> Supported. Will return concatenation of BlackBerry <strong>address1</strong> and <strong>address2</strong> address fields. </li>
<li>
<strong>locality:</strong> Supported. Stored in BlackBerry <strong>city</strong> address field.</li>
<li>
<strong>region:</strong> Supported. Stored in BlackBerry <strong>stateProvince</strong> address field.</li>
<li>
<strong>postalCode:</strong> Supported. Stored in BlackBerry <strong>zipPostal</strong> address field.</li>
<li>
<strong>country:</strong> Supported.</li>
</ul>
<h2>
<a name="ContactAddress_ios_quirks">iOS Quirks</a>
</h2>
<ul>
<li>
<strong>pref:</strong> This property is not supported on iOS devices and will always return <code>false</code>.</li>
<li>
<strong>formatted:</strong> Not currently supported.</li>
</ul>
<h2>
<a name="ContactAddress_bada_quirks">Bada Quirks</a>
</h2>
<ul>
<li>
<strong>formatted:</strong> This property is not supported</li>
<li>
<strong>type:</strong> Has to be one of the following: WORK, HOME</li>
</ul>
<hr>
<h1><a name="ContactField">ContactField</a></h1>
<p>Supports generic fields in a <code><a href="cordova_contacts_contacts.md.html#Contact">Contact</a></code> object. Some properties that are stored as <code><a href="cordova_contacts_contacts.md.html#ContactField">ContactField</a></code> objects include email addresses, phone numbers, and urls.</p>
<h2>
<a name="ContactField_properties">Properties</a>
</h2>
<ul>
<li>
<strong>type:</strong> A string that tells you what type of field this is (example: 'home'). <em>(DOMString)</em>
</li>
<li>
<strong>value:</strong> The value of the field (such as a phone number or email address). <em>(DOMString)</em>
</li>
<li>
<strong>pref:</strong> Set to <code>true</code> if this <code><a href="cordova_contacts_contacts.md.html#ContactField">ContactField</a></code> contains the user's preferred value. <em>(boolean)</em>
</li>
</ul>
<h2>
<a name="ContactField_details">Details</a>
</h2>
<p>The <code><a href="cordova_contacts_contacts.md.html#ContactField">ContactField</a></code> object is a reusable component that is used to support contact fields in a generic fashion. Each <code><a href="cordova_contacts_contacts.md.html#ContactField">ContactField</a></code> object contains a value property, a type property, and a pref property. A <code><a href="cordova_contacts_contacts.md.html#Contact">Contact</a></code> object stores several properties in <code><a href="cordova_contacts_contacts.md.html#ContactField">ContactField</a>[]</code> arrays, such as phone numbers and email addresses.</p>
<p>In most instances, there are no pre-determined values for the <strong>type</strong> attribute of a <code><a href="cordova_contacts_contacts.md.html#ContactField">ContactField</a></code> object. For example, a phone number can have <strong>type</strong> values of 'home', 'work', 'mobile', 'iPhone', or any other value that is supported by the contact database on a particular <a href="#device%20platform">device platform</a>. However, in the case of the <code><a href="cordova_contacts_contacts.md.html#Contact">Contact</a></code> <strong>photos</strong> field, Cordova makes use of the <strong>type</strong> field to indicate the format of the returned image. Cordova will return <strong>type: 'url'</strong> when the <strong>value</strong> attribute contains a URL to the photo image, or <strong>type: 'base64'</strong> when the returned <strong>value</strong> attribute contains a Base64 encoded image string.</p>