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
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
|
//
// Copyright (c) 2012 Samsung Electronics Co., Ltd.
//
// Licensed 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.
//
/**
* @file FSclAddressbookManager.h
* @brief This is the header file for the %AddressbookManager class.
*
* This header file contains the declarations of the %AddressbookManager class.
*/
#ifndef _FSCL_ADDRESSBOOK_MANAGER_H_
#define _FSCL_ADDRESSBOOK_MANAGER_H_
#include <unique_ptr.h>
#include <FBaseTypes.h>
#include <FBaseObject.h>
#include <FBaseString.h>
#include <FBaseByteBuffer.h>
#include <FSclTypes.h>
namespace Tizen { namespace Base
{
namespace Collection
{
class IList;
template<class Type1> class IListT;
}
}}
namespace Tizen { namespace Social
{
class Category;
class Contact;
class Person;
class UserProfile;
class Addressbook;
class AddressbookFilter;
class IAddressbookEventListener;
class IAddressbookChangeEventListener;
/**
* @class AddressbookManager
* @brief This class manages addressbooks and contacts in the device storage.
*
* @since 2.0
*
* @final This class is not intended for extension.
*
* The %AddressbookManager class provides methods for managing addressbooks and contacts in the device storage.
*/
class _OSP_EXPORT_ AddressbookManager
: public Tizen::Base::Object
{
public:
/**
* Creates an addressbook with the specified account ID and name. @n
* The accountId must specify a valid account and only one addressbook can be created per account. @n
* The name of the addressbook must be specified and the name must be unique among existing addressbooks on the device.
*
* @since 2.0
* @privlevel public
* @privilege %http://tizen.org/privilege/contact.write
*
* @return An addressbook instance
* @param[in] accountId The account ID
* @param[in] name The addressbook name
* @exception E_SUCCESS The method is successful.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. @b Since: @b 2.1
* @exception E_INVALID_ARG Either of the following conditions has occurred:
* - The specified @c accountId is invalid.
* - The specified @c name is an empty string.
* @exception E_OBJ_ALREADY_EXIST The addressbook with the specified @c accountId or @c name already exists.
* @exception E_STORAGE_FULL The storage is insufficient.
* @exception E_SYSTEM The method cannot proceed due to a severe system error.
* @remarks The specific error code can be accessed using the GetLastResult() method.
*/
Addressbook* CreateAddressbookN(AccountId accountId, const Tizen::Base::String& name);
/**
* Deletes an addressbook. @n
* If the addressbook has been deleted successfully,
* the contacts and categories that belong to the addressbook are also deleted.
*
* @since 2.0
* @privlevel public
* @privilege %http://tizen.org/privilege/contact.write
*
* @return An error code
* @param[in] addressbookId The addressbook ID
* @exception E_SUCCESS The method is successful.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. @b Since: @b 2.1
* @exception E_INVALID_ARG Either of the following conditions has occurred:
* - The specified @c addressbookId is invalid.
* - The addressbook specified by the @c addressbookId is a default addressbook.
* @exception E_OBJ_NOT_FOUND The specified @c addressbookId does not exist.
* @exception E_SYSTEM The method cannot proceed due to a severe system error.
*/
result DeleteAddressbook(AddressbookId addressbookId);
/**
* Gets the addressbooks associated with the specified account ID.
*
* @since 2.0
* @privlevel public
* @privilege %http://tizen.org/privilege/contact.read
*
* @return The list of addressbooks, @n
* else an empty list if there is no addressbook, or @c null if an exception occurs (@ref Addressbook list)
* @param[in] accountId The account ID
* @exception E_SUCCESS The method is successful.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. @b Since: @b 2.1
* @exception E_INVALID_ARG The specified @c accountId is invalid.
* @exception E_SYSTEM The method cannot proceed due to a severe system error.
* @remarks The specific error code can be accessed using the GetLastResult() method.
*/
Tizen::Base::Collection::IList* GetAddressbooksByAccountN(AccountId accountId) const;
/**
* Gets the list of addressbooks.
*
* @since 2.0
* @privlevel public
* @privilege %http://tizen.org/privilege/contact.read
*
* @return The list of addressbooks, @n
* else an empty list if there is no addressbook, or @c null if an exception occurs (@ref Addressbook list)
* @exception E_SUCCESS The method is successful.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. @b Since: @b 2.1
* @exception E_SYSTEM The method cannot proceed due to a severe system error.
* @remarks The specific error code can be accessed using the GetLastResult() method.
*/
Tizen::Base::Collection::IList* GetAllAddressbooksN(void) const;
/**
* Gets an instance of the addressbook specified by the addressbook ID.
*
* @since 2.0
* @privlevel public
* @privilege %http://tizen.org/privilege/contact.read
*
* @return An addressbook instance
* @param[in] addressbookId The addressbook ID
* @exception E_SUCCESS The method is successful.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. @b Since: @b 2.1
* @exception E_INVALID_ARG The specified @c addressbookId is invalid.
* @exception E_OBJ_NOT_FOUND The specified @c addressbookId does not exist.
* @exception E_SYSTEM The method cannot proceed due to a severe system error.
* @remarks The specific error code can be accessed using the GetLastResult() method.
*/
Addressbook* GetAddressbookN(AddressbookId addressbookId = DEFAULT_ADDRESSBOOK_ID) const;
/**
* Sets an addressbook change event listener. @n
* The listener is called when a contact or a category has been changed.
* To reset the event listener, @c null must be passed.
*
* @brief <i> [Deprecated] </i>
* @deprecated This method and IAddressbookEventListener are deprecated. Instead of using this method, use SetAddressbookChangeEventListener()
* and IAddressbookChangeEventListener.
*
* @since 2.0
* @privlevel public
* @privilege %http://tizen.org/privilege/contact.read
*
* @return An error code
* @param[in] pListener The event listener
* @exception E_SUCCESS The method is successful.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. @b Since: @b 2.1
* @exception E_SYSTEM The method cannot proceed due to a severe system error.
*/
result SetEventListener(IAddressbookEventListener* pListener);
/**
* Sets an addressbook change event listener. @n
* The listener is called when a contact or a category has been changed.
* To reset the event listener, @c null must be passed.
*
* @since 2.1
* @privlevel public
* @privilege %http://tizen.org/privilege/contact.read
*
* @return An error code
* @param[in] pListener The event listener
* @exception E_SUCCESS The method is successful.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method.
* @exception E_SYSTEM The method cannot proceed due to a severe system error
*/
result SetAddressbookChangeEventListener(IAddressbookChangeEventListener* pListener);
/**
* Adds a contact to the specified addressbook. @n
* At least one property of the contact must have been set. @n
* If the contact has been added successfully, a contact ID is assigned to it.
*
* @since 2.0
* @privlevel public
* @privilege %http://tizen.org/privilege/contact.write
*
* @return An error code
* @param[in,out] contact The contact to add
* @param[in] addressbookId The addressbook ID
* @exception E_SUCCESS The method is successful.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. @b Since: @b 2.1
* @exception E_INVALID_ARG Either of the following conditions has occurred:
* - The contact ID is not #INVALID_RECORD_ID.
* - The properties of the specified @c contact have not been set.
* - The specified @c addressbookId is invalid.
* @exception E_OBJ_NOT_FOUND The specified addressbook is not found.
* @exception E_STORAGE_FULL The storage is insufficient.
* @exception E_SYSTEM The method cannot proceed due to a severe system error.
* @remarks The #CONTACT_PROPERTY_ID_DISPLAY_NAME and #CONTACT_PROPERTY_ID_LAST_REVISION
* properties cannot be set. @n #CONTACT_PROPERTY_ID_DISPLAY_NAME is automatically generated from the first name and
* the last name. And #CONTACT_PROPERTY_ID_LAST_REVISION is automatically updated with the last update time.
*/
result AddContact(Contact& contact, AddressbookId addressbookId);
/**
* Removes a contact.
*
* @since 2.0
* @privlevel public
* @privilege %http://tizen.org/privilege/contact.write
*
* @return An error code
* @param[in] contactId The contact ID
* @exception E_SUCCESS The method is successful.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. @b Since: @b 2.1
* @exception E_INVALID_ARG The specified @c contactId is invalid.
* @exception E_OBJ_NOT_FOUND The specified @c contactId does not exist.
* @exception E_SYSTEM The method cannot proceed due to a severe system error.
*/
result RemoveContact(RecordId contactId);
/**
* Updates the specified contact. @n
* At least one property of the contact must have been set.
*
* @since 2.0
* @privlevel public
* @privilege %http://tizen.org/privilege/contact.write
*
* @return An error code
* @param[in] contact The contact to update
* @exception E_SUCCESS The method is successful.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. @b Since: @b 2.1
* @exception E_OBJ_NOT_FOUND The specified @c contact does not exist in this address book.
* @exception E_INVALID_ARG Either of the following conditions has occurred:
* - The specified @c contact is invalid.
* - The properties of the specified @c contact have not been set.
* @exception E_STORAGE_FULL The storage is insufficient.
* @exception E_SYSTEM The method cannot proceed due to a severe system error.
*/
result UpdateContact(const Contact& contact);
/**
* Adds a category to the specified addressbook. @n
* The name of the category must have been set. @n
* If the category has been added successfully, a category ID is assigned to it.
*
* @since 2.0
* @privlevel public
* @privilege %http://tizen.org/privilege/contact.write
*
* @return An error code
* @param[in,out] category The category to add
* @param[in] addressbookId The addressbook ID
* @exception E_SUCCESS The method is successful.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. @b Since: @b 2.1
* @exception E_INVALID_ARG Either of the following conditions has occurred:
* - The name of the category has not been set.
* - One of the member contacts is invalid.
* - The category ID of the specified @c category is not #INVALID_RECORD_ID.
* - The specified @c addressbookId is invalid.
* @exception E_STORAGE_FULL The storage is insufficient.
* @exception E_SYSTEM The method cannot proceed due to a severe system error.
*/
result AddCategory(Category& category, AddressbookId addressbookId);
/**
* Removes a category.
*
* @since 2.0
* @privlevel public
* @privilege %http://tizen.org/privilege/contact.write
*
* @return An error code
* @param[in] categoryId The category ID
* @exception E_SUCCESS The method is successful.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. @b Since: @b 2.1
* @exception E_INVALID_ARG Either of the following conditions has occurred:
* - The specified @c categoryId is invalid.
* - The category specified by the @c categoryId is a default category.
* @exception E_OBJ_NOT_FOUND The specified @c categoryId does not exist in this address book.
* @exception E_SYSTEM The method cannot proceed due to a severe system error.
* @see Category::IsDefault()
*/
result RemoveCategory(RecordId categoryId);
/**
* Updates a category.
*
* @since 2.0
* @privlevel public
* @privilege %http://tizen.org/privilege/contact.write
*
* @return An error code
* @param[in] category The category to update
* @exception E_SUCCESS The method is successful.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. @b Since: @b 2.1
* @exception E_OBJ_NOT_FOUND The specified @c category does not exist in this address book.
* @exception E_INVALID_ARG Either of the following conditions has occurred:
* - The specified @c category is invalid.
* - One of the contact members is invalid.
* @exception E_STORAGE_FULL The storage is insufficient.
* @exception E_SYSTEM The method cannot proceed due to a severe system error.
*/
result UpdateCategory(const Category& category);
/**
* Gets all the contacts on the device. @n
* The contacts are ordered by display name.
*
* @since 2.0
* @privlevel public
* @privilege %http://tizen.org/privilege/contact.read
*
* @return The list of contacts on the device, @n
* else an empty list if there is no contact, or @c null if an exception occurs (@ref Contact list)
* @exception E_SUCCESS The method is successful.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. @b Since: @b 2.1
* @exception E_SYSTEM The method cannot proceed due to a severe system error.
* @remarks
* - The specific error code can be accessed using the GetLastResult() method.
* - There is a high probability for an occurrence of an out-of-memory exception.
* If possible, check whether the exception is @c E_OUT_OF_MEMORY or not. @n
* For more information on how to handle the out-of-memory exception, refer
* <a href="../org.tizen.native.appprogramming/html/basics_tizen_programming/exception_check.htm">here</a>.
*/
Tizen::Base::Collection::IList* GetAllContactsN(void) const;
/**
* Gets the member contacts of the specified category. @n
* If the specified @c categoryId is ::INVALID_RECORD_ID, this method returns the list of contacts that are not a member of any category.
* The contacts are ordered by display name.
*
* @since 2.0
* @privlevel public
* @privilege %http://tizen.org/privilege/contact.read
*
* @return The list of contacts that are members of the specified category, @n
* else an empty list if there is no contact, or @c null if an exception occurs (@ref Contact list)
* @param[in] categoryId The category ID
* @exception E_SUCCESS The method is successful.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. @b Since: @b 2.1
* @exception E_INVALID_ARG The specified @c categoryId is less than ::INVALID_RECORD_ID.
* @exception E_SYSTEM The method cannot proceed due to a severe system error.
* @remarks
* - The specific error code can be accessed using the GetLastResult() method.
* - There is a high probability for an occurrence of an out-of-memory exception.
* If possible, check whether the exception is @c E_OUT_OF_MEMORY or not. @n
* For more information on how to handle the out-of-memory exception, refer
* <a href="../org.tizen.native.appprogramming/html/basics_tizen_programming/exception_check.htm">here</a>.
*/
Tizen::Base::Collection::IList* GetContactsByCategoryN(RecordId categoryId) const;
/**
* Gets the contacts linked to the person specified by the person ID.
*
* @since 2.0
* @privlevel public
* @privilege %http://tizen.org/privilege/contact.read
*
* @return The list of contacts that are linked to this person, @n
* else @c null if an exception occurs (@ref Contact list)
* @param[in] personId The person ID
* @exception E_SUCCESS The method is successful.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. @b Since: @b 2.1
* @exception E_INVALID_ARG The specified @c personId is invalid.
* @exception E_SYSTEM The method cannot proceed due to a severe system error.
* @remarks The specific error code can be accessed using the GetLastResult() method.
*/
Tizen::Base::Collection::IList* GetContactsByPersonN(PersonId personId) const;
/**
* Gets the categories whose member is the person specified by the person ID. @n
* A person is a member of a category if a contact linked to it is a member of the category.
* The categories are ordered by name.
*
* @since 2.0
* @privlevel public
* @privilege %http://tizen.org/privilege/contact.read
*
* @return The list of categories that has the specified person as a member, @n
* else an empty list if there is no category, or @c null if an exception occurs (@ref Category list)
* @param[in] personId The person ID
* @exception E_SUCCESS The method is successful.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. @b Since: @b 2.1
* @exception E_INVALID_ARG The specified @c personId is invalid.
* @exception E_SYSTEM The method cannot proceed due to a severe system error.
* @remarks The specific error code can be accessed using the GetLastResult() method.
*/
Tizen::Base::Collection::IList* GetCategoriesByPersonN(PersonId personId) const;
/**
* Gets the contact with the specified contact ID.
*
* @since 2.0
* @privlevel public
* @privilege %http://tizen.org/privilege/contact.read
*
* @return The matched contact, @n
* else @c null if no contact matches the specified contact ID
* @param[in] contactId The contact ID
* @exception E_SUCCESS The method is successful.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. @b Since: @b 2.1
* @exception E_INVALID_ARG The specified @c contactId is invalid.
* @exception E_OBJ_NOT_FOUND The specified @c contactId is not found.
* @exception E_SYSTEM The method cannot proceed due to a severe system error.
* @remarks The specific error code can be accessed using the GetLastResult() method.
*/
Contact* GetContactN(RecordId contactId) const;
/**
* Gets the number of contacts in all the addressbooks.
*
* @since 2.0
* @privlevel public
* @privilege %http://tizen.org/privilege/contact.read
*
* @return The number of contacts in the address book, @n
* else @c -1 if an error occurs
* @exception E_SUCCESS The method is successful.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. @b Since: @b 2.1
* @exception E_SYSTEM The method cannot proceed due to a severe system error.
* @remarks The specific error code can be accessed using the GetLastResult() method.
*/
int GetContactCount(void) const;
/**
* Adds the specified contact to the specified category.
*
* @since 2.0
* @privlevel public
* @privilege %http://tizen.org/privilege/contact.write
*
* @return An error code
* @param [in] categoryId The category ID
* @param [in] contactId The contact ID
* @exception E_SUCCESS The method is successful.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. @b Since: @b 2.1
* @exception E_INVALID_ARG Either of the following conditions has occurred:
* - The specified contact or category does not exist.
* - The specified contact and category are not in the same addressbook.
* @exception E_SYSTEM The method cannot proceed due to a severe system error.
* @remarks If the contact is already a member of the category, this method does nothing.
*/
result AddMemberToCategory(RecordId categoryId, RecordId contactId);
/**
* Removes the specified contact from the specified category.
*
* @since 2.0
* @privlevel public
* @privilege %http://tizen.org/privilege/contact.write
*
* @return An error code
* @param [in] categoryId The category ID
* @param [in] contactId The contact ID
* @exception E_SUCCESS The method is successful.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. @b Since: @b 2.1
* @exception E_INVALID_ARG The specified contact or category does not exist.
* @exception E_SYSTEM The method cannot proceed due to a severe system error.
* @remarks If the contact is not a member of the category, this method does nothing.
*/
result RemoveMemberFromCategory(RecordId categoryId, RecordId contactId);
/**
* Gets all the categories on the device. @n
* The categories are ordered by name.
*
* @since 2.0
* @privlevel public
* @privilege %http://tizen.org/privilege/contact.read
*
* @return The list of categories on the device, @n
* else an empty list if there is no category, or @c null if an exception occurs (@ref Category list)
* @exception E_SUCCESS The method is successful.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. @b Since: @b 2.1
* @exception E_SYSTEM The method cannot proceed due to a severe system error.
* @remarks The specific error code can be accessed using the GetLastResult() method.
*/
Tizen::Base::Collection::IList* GetAllCategoriesN(void) const;
/**
* Gets all the categories whose member is the specified contact. @n
* The categories are ordered by name.
*
* @since 2.0
* @privlevel public
* @privilege %http://tizen.org/privilege/contact.read
*
* @return The list of categories that has the specified contact as a member, @n
* else an empty list if there is no category, or @c null if an exception occurs (@ref Category list)
* @param[in] contactId The contact ID
* @exception E_SUCCESS The method is successful.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. @b Since: @b 2.1
* @exception E_INVALID_ARG The specified @c contactId is invalid.
* @exception E_SYSTEM The method cannot proceed due to a severe system error.
* @remarks The specific error code can be accessed using the GetLastResult() method.
*/
Tizen::Base::Collection::IList* GetCategoriesByContactN(RecordId contactId) const;
/**
* Gets the number of categories on the device.
*
* @since 2.0
* @privlevel public
* @privilege %http://tizen.org/privilege/contact.read
*
* @return The number of categories on the device, @n
* else @c -1 if an error occurs
* @exception E_SUCCESS The method is successful.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. @b Since: @b 2.1
* @exception E_SYSTEM The method cannot proceed due to a severe system error.
* @remarks The specific error code can be accessed using the GetLastResult() method.
*/
int GetCategoryCount(void) const;
/**
* Gets the category with the specified category ID.
*
* @since 2.0
* @privlevel public
* @privilege %http://tizen.org/privilege/contact.read
*
* @return The matched category, @n
* else @c null if no category matches the specified category ID
* @param[in] categoryId The category ID
* @exception E_SUCCESS The method is successful.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. @b Since: @b 2.1
* @exception E_INVALID_ARG The specified @c categoryId is invalid.
* @exception E_OBJ_NOT_FOUND The specified record is not found.
* @exception E_SYSTEM The method cannot proceed due to a severe system error.
* @remarks The specific error code can be accessed using the GetLastResult() method.
*/
Category* GetCategoryN(RecordId categoryId) const;
/**
* Searches the contacts whose email address contains the specified @c email string. @n
* The search operation is performed with a case insensitive key (param: @c email). @n
* The contacts are ordered by display name.
*
* @since 2.0
* @privlevel public
* @privilege %http://tizen.org/privilege/contact.read
*
* @return The list of all matched contacts, @n
* else an empty list if there is no matched contact, or @c null if an exception occurs (@ref Contact list)
* @param[in] email The substring of the email to search
* @exception E_SUCCESS The method is successful.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. @b Since: @b 2.1
* @exception E_INVALID_ARG The specified @c email is an empty string.
* @exception E_SYSTEM The method cannot proceed due to a severe system error.
* @remarks
* - The specific error code can be accessed using the GetLastResult() method.
* - There is a high probability for an occurrence of an out-of-memory exception.
* If possible, check whether the exception is @c E_OUT_OF_MEMORY or not. @n
* For more information on how to handle the out-of-memory exception, refer
* <a href="../org.tizen.native.appprogramming/html/basics_tizen_programming/exception_check.htm">here</a>.
*/
Tizen::Base::Collection::IList* SearchContactsByEmailN(const Tizen::Base::String& email) const;
/**
* Searches the contacts that have the specified @c name as a substring of their display name. @n
* The display name is a concatenation of the first name, space, and the last name. @n
* The search operation is performed with a case insensitive key (param: @c name). @n
* The contacts are ordered by display name.
*
* @since 2.0
* @privlevel public
* @privilege %http://tizen.org/privilege/contact.read
*
* @return The list of all matched contacts, @n
* else an empty list if there is no matched contact, or @c null if an exception occurs (@ref Contact list)
* @param[in] name The substring of the name to search
* @exception E_SUCCESS The method is successful.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. @b Since: @b 2.1
* @exception E_INVALID_ARG The specified @c name is an empty string.
* @exception E_SYSTEM The method cannot proceed due to a severe system error.
* @remarks
* - The specific error code can be accessed using the GetLastResult() method.
* - There is a high probability for an occurrence of an out-of-memory exception.
* If possible, check whether the exception is @c E_OUT_OF_MEMORY or not. @n
* For more information on how to handle the out-of-memory exception, refer
* <a href="../org.tizen.native.appprogramming/html/basics_tizen_programming/exception_check.htm">here</a>.
*/
Tizen::Base::Collection::IList* SearchContactsByNameN(const Tizen::Base::String& name) const;
/**
* Searches the contacts that have the specified @c phoneNumber string as a substring of one of their phone numbers. @n
* This method returns the contacts whose phone number match the value of the specified @c phoneNumber. @n
* The search operation is performed with a case insensitive key (param: @c phoneNumber). @n
* The contacts are ordered by display name.
*
* @since 2.0
* @privlevel public
* @privilege %http://tizen.org/privilege/contact.read
*
* @return The list of all matched contacts, @n
* else an empty list if there is no contact, or @c null if an exception occurs (@ref Contact list)
* @param[in] phoneNumber The substring of the phone number to search
* @exception E_SUCCESS The method is successful.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. @b Since: @b 2.1
* @exception E_INVALID_ARG The specified @c phoneNumber is an empty string.
* @exception E_SYSTEM The method cannot proceed due to a severe system error.
* @remarks
* - The specific error code can be accessed using the GetLastResult() method.
* - There is a high probability for an occurrence of an out-of-memory exception.
* If possible, check whether the exception is @c E_OUT_OF_MEMORY or not. @n
* For more information on how to handle the out-of-memory exception, refer
* <a href="../org.tizen.native.appprogramming/html/basics_tizen_programming/exception_check.htm">here</a>.
*/
Tizen::Base::Collection::IList* SearchContactsByPhoneNumberN(const Tizen::Base::String& phoneNumber) const;
/**
* Gets the latest change version.
*
* @since 2.0
* @privlevel public
* @privilege %http://tizen.org/privilege/contact.read
*
* @return The latest change version, @n
* else @c -1 if an exception occurs
* @exception E_SUCCESS The method is successful.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. @b Since: @b 2.1
* @exception E_SYSTEM The method cannot proceed due to a severe system error.
* @remarks The specific error code can be accessed using the GetLastResult() method.
* @see GetChangedContactsAfterN()
* @see GetChangedCategoriesAfterN()
*/
int GetLatestVersion(void) const;
/**
* Gets the change information of the contacts that have been changed after the specified change version.
*
* @brief <i> [Deprecated] </i>
* @deprecated This method is deprecated.
*
* @since 2.0
* @privlevel public
* @privilege %http://tizen.org/privilege/contact.read
*
* @return The list of contact change information, @n
* else an empty list if there is no changed contact, or @c null if an exception occurs (@ref ContactChangeInfo list)
* @param[in] version The change version
* @param[out] latestVersion The latest change version among the changed contacts
* @exception E_SUCCESS The method is successful.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. @b Since: @b 2.1
* @exception E_INVALID_ARG The specified @c version is invalid.
* @exception E_SYSTEM The method cannot proceed due to a severe system error.
* @remarks The specific error code can be accessed using the GetLastResult() method.
* @see GetLatestVersion()
* @see ContactChangeInfo
*
* The following example demonstrates how to use the %GetChangedContactsAfterN() method.
* @code
* void
* MyApplication::PrintChangedContacts(void)
* {
* IList* pChangedContacts = __pAddressbookManager->GetChangedContactsAfterN(__version, __version);
*
* IEnumerator* pEnum = pChangedContacts->GetEnumeratorN();
* while (pEnum->MoveNext() == E_SUCCESS)
* {
* ContactChangeInfo* pInfo = static_cast<ContactChangeInfo*>(pEnum->GetCurrent());
*
* AppLog("Contact changed: type(%d), id(%d), version(%d)", pInfo->GetChangeType(), pInfo->GetContctId(), pInfo->GetVersion());
* }
* delete pEnum;
* pChangedContacts->RemoveAll(true);
* delete pChangedContacts;
* }
* @endcode
*/
Tizen::Base::Collection::IList* GetChangedContactsAfterN(int version, int& latestVersion) const;
/**
* Gets the change information of the categories that have been changed after the specified change version.
*
* @brief <i> [Deprecated] </i>
* @deprecated This method is deprecated.
*
* @since 2.0
* @privlevel public
* @privilege %http://tizen.org/privilege/contact.read
*
* @return The list of category change information, @n
* else an empty list if there is no changed category, or @c null if an exception occurs (@ref CategoryChangeInfo list)
* @param[in] version The change version
* @param[out] latestVersion The latest change version among the changed categories
* @exception E_SUCCESS The method is successful.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. @b Since: @b 2.1
* @exception E_INVALID_ARG The specified @c version is invalid.
* @exception E_SYSTEM The method cannot proceed due to a severe system error.
* @remarks The specific error code can be accessed using the GetLastResult() method.
* @see GetLatestVersion()
* @see CategoryChangeInfo
*
* The following example demonstrates how to use the %GetChangedCategoriesAfterN() method.
* @code
* void
* MyApplication::PrintChangedCategories(void)
* {
* IList* pChangedCategories = __pAddressbookManager->GetChangedCategoriesAfterN(__version, __version);
*
* IEnumerator* pEnum = pChangedCategories->GetEnumeratorN();
* while (pEnum->MoveNext() == E_SUCCESS)
* {
* CategoryChangeInfo* pInfo = static_cast<CategoryChangeInfo*>(pEnum->GetCurrent());
*
* AppLog("Category changed: type(%d), id(%d), version(%d)", pInfo->GetChangeType(), pInfo->GetCategoryId(), pInfo->GetVersion());
* }
* delete pEnum;
* pChangedCategories->RemoveAll(true);
* delete pChangedCategories;
* }
* @endcode
*/
Tizen::Base::Collection::IList* GetChangedCategoriesAfterN(int version, int& latestVersion) const;
/**
* Gets the person with the specified person ID.
*
* @since 2.0
* @privlevel public
* @privilege %http://tizen.org/privilege/contact.read
*
* @return The matched person, @n
* else @c null if an exception occurs
* @param[in] personId The person ID
* @exception E_SUCCESS The method is successful.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. @b Since: @b 2.1
* @exception E_INVALID_ARG The specified @c personId is invalid.
* @exception E_OBJ_NOT_FOUND The specified @c personId is not found.
* @exception E_SYSTEM The method cannot proceed due to a severe system error.
* @remarks The specific error code can be accessed using the GetLastResult() method.
*/
Person* GetPersonN(PersonId personId) const;
/**
* Removes a person. @n
* All the contacts linked to the person are removed, too.
*
* @since 2.0
* @privlevel public
* @privilege %http://tizen.org/privilege/contact.write
*
* @return An error code
* @param[in] personId The person ID
* @exception E_SUCCESS The method is successful.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. @b Since: @b 2.1
* @exception E_INVALID_ARG The specified @c personId is invalid.
* @exception E_OBJ_NOT_FOUND The specified person does not exist.
* @exception E_SYSTEM The method cannot be proceed due to a severe system error.
*/
result RemovePerson(PersonId personId);
/**
* Gets all persons on the device. @n
* The persons are ordered by display name.
*
* @since 2.0
* @privlevel public
* @privilege %http://tizen.org/privilege/contact.read
*
* @return The list of all persons on the device, @n
* else an empty list if there is no person, or @c null if an exception occurs (@ref Person list)
* @exception E_SUCCESS The method is successful.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. @b Since: @b 2.1
* @exception E_SYSTEM The method cannot be proceed due to a severe system error.
* @remarks
* - The specific error code can be accessed using the GetLastResult() method.
* - There is a high probability for an occurrence of an out-of-memory exception.
* If possible, check whether the exception is @c E_OUT_OF_MEMORY or not. @n
* For more information on how to handle the out-of-memory exception, refer
* <a href="../org.tizen.native.appprogramming/html/basics_tizen_programming/exception_check.htm">here</a>.
*/
Tizen::Base::Collection::IList* GetAllPersonsN(void) const;
/**
* Gets the persons that are members of the specified category where a person is a member of a category if a contact linked to it is a member of the category. @n
* If the specified @c categoryId is ::INVALID_RECORD_ID, this method returns the persons that are not members of any category. @n
* The persons are ordered by display name.
*
* @since 2.0
* @privlevel public
* @privilege %http://tizen.org/privilege/contact.read
*
* @return The list of persons that are members of the specified category, @n
* else an empty list if there is no person, or @c null if an exception occurs (@ref Person list)
* @param[in] categoryId The category ID
* @exception E_SUCCESS The method is successful.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. @b Since: @b 2.1
* @exception E_INVALID_ARG The specified @c categoryId is invalid.
* @exception E_OBJ_NOT_FOUND The specified category does not exist.
* @exception E_SYSTEM The method cannot proceed due to a severe system error.
* @remarks
* - The specific error code can be accessed using the GetLastResult() method.
* - There is a high probability for an occurrence of an out-of-memory exception.
* If possible, check whether the exception is @c E_OUT_OF_MEMORY or not. @n
* For more information on how to handle the out-of-memory exception, refer
* <a href="../org.tizen.native.appprogramming/html/basics_tizen_programming/exception_check.htm">here</a>.
*/
Tizen::Base::Collection::IList* GetPersonsByCategoryN(RecordId categoryId) const;
/**
* Gets the list of favorite persons. @n
* The persons are ordered by display name.
*
* @since 2.0
* @privlevel public
* @privilege %http://tizen.org/privilege/contact.read
*
* @return The list of favorite persons, @n
* else an empty list if there is no favorite person, or @c null if an exception occurs (@ref Person list)
* @exception E_SUCCESS The method is successful.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. @b Since: @b 2.1
* @exception E_SYSTEM The method cannot proceed due to a severe system error.
* @remarks
* - The specific error code can be accessed using the GetLastResult() method.
* - There is a high probability for an occurrence of an out-of-memory exception.
* If possible, check whether the exception is @c E_OUT_OF_MEMORY or not. @n
* For more information on how to handle the out-of-memory exception, refer
* <a href="../org.tizen.native.appprogramming/html/basics_tizen_programming/exception_check.htm">here</a>.
* @see SetPersonAsFavorite()
*/
Tizen::Base::Collection::IList* GetFavoritePersonsN(void) const;
/**
* Searches the persons that contain the specified @c keyword string in its properties. @n
* The search operation is performed with a case insensitive key (param: @c keyword). @n
* The persons are ordered by display name.
*
* @since 2.0
* @privlevel public
* @privilege %http://tizen.org/privilege/contact.read
*
* @return The list of all matched persons, @n
* else an empty list if there is no matched person, or @c null if an exception occurs (@ref Person list)
* @param[in] keyword The key to search
* @exception E_SUCCESS The method is successful.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. @b Since: @b 2.1
* @exception E_INVALID_ARG The specified @c keyword is an empty string.
* @exception E_SYSTEM The method cannot proceed due to a severe system error.
* @remarks
* - The specific error code can be accessed using the GetLastResult() method.
* - There is a high probability for an occurrence of an out-of-memory exception.
* If possible, check whether the exception is @c E_OUT_OF_MEMORY or not. @n
* For more information on how to handle the out-of-memory exception, refer
* <a href="../org.tizen.native.appprogramming/html/basics_tizen_programming/exception_check.htm">here</a>.
*/
Tizen::Base::Collection::IList* SearchPersonsN(const Tizen::Base::String& keyword) const;
/**
* Sets whether the specified person is a favorite or not.
*
* @since 2.0
* @privlevel public
* @privilege %http://tizen.org/privilege/contact.write
*
* @return An error code
* @param[in] personId The person ID
* @param[in] isFavorite Set to @c true to set the specified person as a favorite, @n
* else @c false to set the specified person as a non-favorite
* @exception E_SUCCESS The method is successful.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. @b Since: @b 2.1
* @exception E_INVALID_ARG The specified @c personId is invalid.
* @exception E_OBJ_NOT_FOUND The specified person does not exist.
* @exception E_SYSTEM The method cannot proceed due to a severe system error.
* @see GetFavoritePersonsN()
* @see Person::IsFavorite()
*/
result SetPersonAsFavorite(PersonId personId, bool isFavorite = true);
/**
* Merges the source person with the target person. @n
* The following are done during merging:
* - Unlinks the contacts linked to the source person.
* - Links the unlinked contacts to the target person.
* - Removes the source person.
* - Updates information of the target person.
*
* The %MergePersons() method does nothing if the source or target person does not exist.
*
* @since 2.0
* @privlevel public
* @privilege %http://tizen.org/privilege/contact.write
*
* @return An error code
* @param[in] sourcePersonId The source person ID
* @param[in] targetPersonId The target person ID
* @exception E_SUCCESS The method is successful.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. @b Since: @b 2.1
* @exception E_INVALID_ARG The specified @c sourcePersonId or @c targetPersonId is invalid.
* @exception E_SYSTEM The method cannot proceed due to a severe system error.
*/
result MergePersons(PersonId sourcePersonId, PersonId targetPersonId);
/**
* Unlinks the specified contact from the specified person. @n
* The following are done during unlinking:
* - Unlinks the contact specified by @c contactId.
* - Creates a new person.
* - Links the unlinked contact to the new person.
* - Updates information of a person.
*
* It is not allowed to unlink a contact if it is the only one contact linked to a person.
* The %UnlinkContact() method does nothing if the contact has not been linked to the person or does not exist.
*
* @since 2.0
* @privlevel public
* @privilege %http://tizen.org/privilege/contact.write
*
* @return An error code
* @param[in] personId The ID of the person that the contact is unlinked from
* @param[in] contactId The contact to unlink
* @param[out] newPersonId The ID of the new person
* @exception E_SUCCESS The method is successful.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. @b Since: @b 2.1
* @exception E_INVALID_ARG The specified @c personId or @c contactId is invalid.
* @exception E_SYSTEM The method cannot proceed due to a severe system error.
*/
result UnlinkContact(PersonId personId, RecordId contactId, PersonId& newPersonId);
/**
* Searches items of the addressbook with the filter. @n
* The filter specifies the item type and condition for searching.
* The searched results are ordered by the @c propertyToSort and @c sortOrder.
* If the @c offset is M and the @c maxCount are N, then the first M items are omitted from the result set returned by the searching operation and the next N items are returned.
*
* @since 2.0
* @privlevel public
* @privilege %http://tizen.org/privilege/contact.read
*
* @return The list of searched results (The list of Addressbook, Person, Contact, Category, PhoneNumberContact, EmailContact), @n
* else an empty list if there is no searched result, or @c null if an exception occurs
* @param[in] filter The filter that specifies the search condition @n If the filter is empty, all items that are specified by the type of this filter are searched.
* @param[in] propertyToSort The property for sorting @n The searched results are ordered by the values of this property.
* @param[in] sortOrder The order for sorting
* @param[in] offset The offset of the searched results @n If this value is @c 0, it is ignored.
* @param[in] maxCount The maximum count of the searched results @n If this value is @c 0, it is ignored.
* @exception E_SUCCESS The method is successful.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. @b Since: @b 2.1
* @exception E_INVALID_ARG Either of the following conditions has occurred:
* - The specified @c offset or @c maxCount is less than @c 0.
* - The specified @c propertyToSort is not an element of the enumerator that corresponds to the type of the @c filter.
* @exception E_SYSTEM The method cannot proceed due to a severe system error.
* @remarks
* - The specific error code can be accessed using the GetLastResult() method.
* - There is a high probability for an occurrence of an out-of-memory exception.
* If possible, check whether the exception is @c E_OUT_OF_MEMORY or not. @n
* For more information on how to handle the out-of-memory exception, refer
* <a href="../org.tizen.native.appprogramming/html/basics_tizen_programming/exception_check.htm">here</a>.
* @see AddressbookFilterProperty
* @see PersonFilterProperty
* @see ContactFilterProperty
* @see CategoryFilterProperty
* @see PhoneContactFilterProperty
* @see EmailContactFilterProperty
*/
Tizen::Base::Collection::IList* SearchN(const AddressbookFilter& filter,
unsigned long propertyToSort = 0, Tizen::Base::SortOrder sortOrder = Tizen::Base::SORT_ORDER_NONE, int offset = 0, int maxCount = 0);
/**
* Gets the matched item count of the search results with the filter. @n
* The filter specifies the item type and condition for searching.
*
* @since 2.0
* @privlevel public
* @privilege %http://tizen.org/privilege/contact.read
*
* @return The count of the searched results
* @param[in] filter The filter that specifies the search condition @n If the filter is empty, all items that are specified by the type of this filter are searched.
* @exception E_SUCCESS The method is successful.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. @b Since: @b 2.1
* @exception E_SYSTEM The method cannot proceed due to a severe system error.
* @remarks The specific error code can be accessed using the GetLastResult() method.
* @see AddressbookFilterProperty
* @see PersonFilterProperty
* @see ContactFilterProperty
* @see CategoryFilterProperty
* @see PhoneContactFilterProperty
* @see EmailContactFilterProperty
*/
int GetMatchedItemCount(const AddressbookFilter& filter);
/**
* Parses contacts from the specified vCard file. @n
* The %ParseContactsFromVcardN() method supports vCard formation 2.1 and 3.0.
*
* @since 2.0
*
* @return The list of contacts, @n
* else an empty list if there is no contact, or @c null if an exception occurs (@ref Contact list)
* @param[in] vcardPath The file path of a vCard file
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified @c vcardPath is invalid.
* @exception E_ILLEGAL_ACCESS The access is denied due to insufficient permission.
* @exception E_FILE_NOT_FOUND The specified file cannot be found.
* @exception E_SYSTEM The method cannot proceed due to a severe system error.
* @remarks The specific error code can be accessed using the GetLastResult() method.
*/
Tizen::Base::Collection::IList* ParseContactsFromVcardN(const Tizen::Base::String& vcardPath);
/**
* Exports a person to the specified vCard 3.0 file.
*
* @since 2.0
* @privlevel public
* @privilege %http://tizen.org/privilege/contact.read
*
* @return An error code
* @param[in] person The person to export
* @param[in] vcardPath The file path of a vCard file
* @exception E_SUCCESS The method is successful.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. @b Since: @b 2.1
* @exception E_INVALID_ARG The specified @c person is invalid.
* @exception E_ILLEGAL_ACCESS The access is denied due to insufficient permission.
* @exception E_FILE_ALREADY_EXIST The specified file already exists.
* @exception E_STORAGE_FULL The storage is insufficient.
* @exception E_SYSTEM The method cannot proceed due to a severe system error.
*/
result ExportPersonToVcard(const Person& person, const Tizen::Base::String& vcardPath);
/**
* Exports a person list to the specified vCard 3.0 file.
*
* @since 2.0
* @privlevel public
* @privilege %http://tizen.org/privilege/contact.read
*
* @return An error code
* @param[in] personList The person list to export @n The list should contain the Person instances.
* @param[in] vcardPath The file path of a vCard file
* @exception E_SUCCESS The method is successful.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. @b Since: @b 2.1
* @exception E_INVALID_ARG Either of the following conditions has occurred:
* - The specified @c personList is invalid.
* - The specified @c vcardPath is invalid.
* @exception E_ILLEGAL_ACCESS The access is denied due to insufficient permission.
* @exception E_FILE_ALREADY_EXIST The specified file already exists.
* @exception E_STORAGE_FULL The storage is insufficient.
* @exception E_SYSTEM The method cannot proceed due to a severe system error.
*/
result ExportPersonsToVcard(const Tizen::Base::Collection::IList& personList, const Tizen::Base::String& vcardPath);
/**
* Exports a contact to the specified vCard 3.0 file.
*
* @since 2.0
*
* @return An error code
* @param[in] contact The contact to export
* @param[in] vcardPath The file path of a vCard file
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified @c contact is invalid.
* @exception E_ILLEGAL_ACCESS The access is denied due to insufficient permission.
* @exception E_FILE_ALREADY_EXIST The specified file already exists.
* @exception E_STORAGE_FULL The storage is insufficient.
* @exception E_SYSTEM The method cannot proceed due to a severe system error.
*/
result ExportContactToVcard(const Contact& contact, const Tizen::Base::String& vcardPath);
/**
* Exports a contact list to the specified vCard 3.0 file.
*
* @since 2.0
*
* @return An error code
* @param[in] contactList The contact list to export @n The list should contain Contact instances.
* @param[in] vcardPath The file path of a vCard file
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG Either of the following conditions has occurred:
* - The specified @c contactList is invalid.
* - The specified @c vcardPath is invalid.
* @exception E_ILLEGAL_ACCESS The access is denied due to insufficient permission.
* @exception E_FILE_ALREADY_EXIST The specified file already exists.
* @exception E_STORAGE_FULL The storage is insufficient.
* @exception E_SYSTEM The method cannot proceed due to a severe system error.
*/
result ExportContactsToVcard(const Tizen::Base::Collection::IList& contactList, const Tizen::Base::String& vcardPath);
/**
* Exports a contact to a vCard format stream.
*
* @since 2.1
*
* @return The exported vcard stream, @n
* else @c null if an exception occurs
* @param[in] contact The contact to export
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified @c contact is invalid.
* @exception E_SYSTEM The method cannot proceed due to a severe system error.
* @remarks The specific error code can be accessed using the GetLastResult() method.
* @see ExportContactToVcard()
*/
Tizen::Base::ByteBuffer* ExportContactToVcardStreamN(const Contact& contact);
/**
* Exports a contact list to a vCard format stream.
*
* @since 2.1
*
* @return The exported vcard stream, @n
* else @c null if an exception occurs
* @param[in] contactList The contact list to export @n The list should contain the Contact instances
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified @c contactList contains an invalid contact.
* @exception E_SYSTEM The method cannot proceed due to a severe system error.
* @remarks The specific error code can be accessed using the GetLastResult() method.
* @see ExportContactsToVcard()
*/
Tizen::Base::ByteBuffer* ExportContactsToVcardStreamN(const Tizen::Base::Collection::IList& contactList);
/**
* Exports a person to a vCard format stream.
*
* @since 2.1
* @privlevel public
* @privilege %http://tizen.org/privilege/contact.read
*
* @return The exported vcard stream, @n
* else @c null if an exception occurs
* @param[in] person The person to export
* @exception E_SUCCESS The method is successful.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method.
* @exception E_INVALID_ARG The specified @c person is invalid.
* @exception E_SYSTEM The method cannot proceed due to a severe system error.
* @remarks The specific error code can be accessed using the GetLastResult() method.
* @see ExportPersonToVcard()
*/
Tizen::Base::ByteBuffer* ExportPersonToVcardStreamN(const Person& person);
/**
* Exports a person list to a vCard format stream.
*
* @since 2.1
* @privlevel public
* @privilege %http://tizen.org/privilege/contact.read
*
* @return The exported vcard stream, @n
* else @c null if an exception occurs
* @param[in] personList The person list to export @n The list should contain the Person instances.
* @exception E_SUCCESS The method is successful.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method.
* @exception E_INVALID_ARG The specified @c personList contains invalid person.
* @exception E_SYSTEM The method cannot proceed due to a severe system error.
* @remarks The specific error code can be accessed using the GetLastResult() method.
* @see ExportPersonsToVcard()
*/
Tizen::Base::ByteBuffer* ExportPersonsToVcardStreamN(const Tizen::Base::Collection::IList& personList);
/**
* Parses contacts from the specified vCard stream. @n
* The %ParseVcardStreamN() method supports vCard formation 2.1 and 3.0.
*
* @since 2.1
*
* @return The list of contacts, @n
* else an empty list if there is no contact, or @c null if an exception occurs (@ref Contact list)
* @param[in] vcardStream The vCard stream
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified @c vcardStream is invalid.
* @exception E_SYSTEM The method cannot proceed due to a severe system error.
* @remarks The specific error code can be accessed using the GetLastResult() method.
* @see ParseContactsFromVcardN()
*/
Tizen::Base::Collection::IList* ParseVcardStreamN(const Tizen::Base::ByteBuffer& vcardStream);
/**
* Exports a user profile to a vCard format stream.
*
* @since 2.1
*
* @return The exported vCard stream, @n
* else @c null if an exception occurs
* @param[in] userProfile The user profile to export
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified @c userProfile is invalid.
* @exception E_SYSTEM The method cannot proceed due to a severe system error.
* @remarks The specific error code can be accessed using the GetLastResult() method.
*/
Tizen::Base::ByteBuffer* ExportUserProfileToVcardStreamN(const UserProfile& userProfile);
/**
* Exports a user profile list to a vCard format stream.
*
* @since 2.1
*
* @return The exported vCard stream, @n
* else @c null if an exception occurs
* @param[in] userProfileList The user profile list to export @n The list should contain the UserProfile instances
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified @c userProfile is invalid.
* @exception E_SYSTEM The method cannot proceed due to a severe system error.
* @remarks The specific error code can be accessed using the GetLastResult() method.
*/
Tizen::Base::ByteBuffer* ExportUserProfilesToVcardStreamN(const Tizen::Base::Collection::IList& userProfileList);
/**
* Exports a user profile to the specified vCard 3.0 file.
*
* @since 2.1
*
* @return An error code
* @param[in] userProfile The user profile to export
* @param[in] vcardPath The file path of a vCard file
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified @c userProfile is invalid.
* @exception E_ILLEGAL_ACCESS The access is denied due to insufficient permission.
* @exception E_FILE_ALREADY_EXIST The specified file already exists.
* @exception E_STORAGE_FULL The storage is insufficient.
* @exception E_SYSTEM The method cannot proceed due to a severe system error.
*/
result ExportUserProfileToVcard(const UserProfile& userProfile, const Tizen::Base::String& vcardPath);
/**
* Exports a user profile list to the specified vCard 3.0 file.
*
* @since 2.1
*
* @return An error code
* @param[in] userProfileList The user profile list to export @n The list should contain the UserProfile instances
* @param[in] vcardPath The file path of a vCard file
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG Either of the following conditions has occurred:
* - The specified @c userProfileList is invalid.
* - The specified @c vcardPath is invalid.
* @exception E_ILLEGAL_ACCESS The access is denied due to insufficient permission.
* @exception E_FILE_ALREADY_EXIST The specified file already exists.
* @exception E_STORAGE_FULL The storage is insufficient.
* @exception E_SYSTEM The method cannot proceed due to a severe system error.
*/
result ExportUserProfilesToVcard(const Tizen::Base::Collection::IList& userProfileList, const Tizen::Base::String& vcardPath);
/**
* Gets all the user profiles on the device.
*
* @since 2.1
* @privlevel public
* @privilege %http://tizen.org/privilege/userprofile.read
*
* @return The list of all the user profiles on the device, @n
* else an empty list if there is no user profile, or @c null if an exception occurs (@ref UserProfile list)
* @exception E_SUCCESS The method is successful.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method.
* @exception E_SYSTEM The method cannot be proceed due to a severe system error.
* @remarks The specific error code can be accessed using the GetLastResult() method.
*/
Tizen::Base::Collection::IList* GetAllUserProfilesN(void) const;
/**
* Gets a user profile of the address book specified by the address book ID.
*
* @since 2.1
* @privlevel public
* @privilege %http://tizen.org/privilege/userprofile.read
*
* @return The matched user profile, @n
* else @c null if an exception occurs
* @param[in] addressbookId The addressbook ID
* @exception E_SUCCESS The method is successful.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method.
* @exception E_INVALID_ARG The specified @c addressbookId is invalid.
* @exception E_OBJ_NOT_FOUND The specified addressbook is not found.
* @exception E_SYSTEM The method cannot proceed due to a severe system error.
* @remarks The specific error code can be accessed using the GetLastResult() method.
*/
UserProfile* GetUserProfileN(AddressbookId addressbookId) const;
/**
* Gets an %AddressbookManager instance.
*
* @since 2.0
*
* @return A pointer to the %AddressbookManager instance, @n
* else @c null if it fails
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @remarks The specific error code can be accessed using the GetLastResult() method.
*/
static AddressbookManager* GetInstance(void);
private:
//
// This default constructor is intentionally declared as private to implement the Singleton semantic.
//
// @since 2.0
//
AddressbookManager(void);
//
// This destructor is intentionally declared as private to implement the Singleton semantic.
//
// @since 2.0
//
virtual ~AddressbookManager(void);
//
// This function is only for internal usage.
//
// @since 2.0
//
// @return An error code
//
result Construct(void);
//
// The implementation of this copy constructor is intentionally blank and declared as private to prohibit copying of objects.
//
// @since 2.0
//
AddressbookManager(const AddressbookManager& rhs);
//
// The implementation of this copy assignment operator is intentionally blank and declared as private to prohibit copying of objects.
//
// @since 2.0
//
AddressbookManager& operator =(const AddressbookManager& rhs);
static void InitAddressbookManager(void);
static void DestroyAddressbookManager(void);
private:
static AddressbookManager* __pInstance;
friend struct std::default_delete< AddressbookManager >;
friend class _AddressbookManagerImpl;
class _AddressbookManagerImpl* __pAddressbookManagerImpl;
}; // AddressbookManager
}} // Tizen::Social
#endif //_FSCL_ADDRESSBOOK_MANAGER_H_
|