From 62f22d0bc55d275f66d64561ea6f8a155880770a Mon Sep 17 00:00:00 2001 From: Jongkyu Koo Date: Fri, 14 Jul 2017 16:00:51 +0900 Subject: [PATCH] Add documentation for ContactsViews Change-Id: Ic5d6aead0c0a9a0abea3e21834037fae786c1e53 Signed-off-by: Jongkyu Koo --- .../Tizen.Pims.Contacts/ContactsViews.cs | 168 ++++++++++++++++----- 1 file changed, 129 insertions(+), 39 deletions(-) diff --git a/src/Tizen.Pims.Contacts/Tizen.Pims.Contacts/ContactsViews.cs b/src/Tizen.Pims.Contacts/Tizen.Pims.Contacts/ContactsViews.cs index ea30499..82ed5fe 100644 --- a/src/Tizen.Pims.Contacts/Tizen.Pims.Contacts/ContactsViews.cs +++ b/src/Tizen.Pims.Contacts/Tizen.Pims.Contacts/ContactsViews.cs @@ -23,11 +23,14 @@ namespace Tizen.Pims.Contacts /// This class provides information about views with properties. /// /// - /// A view is a class which describes properties of a record. A record can have basic properties of five types: integer, string, boolean, long, double. + /// Views are provided to access and handle entities. A view is a structure, which has property elements. + /// A view is almost the same as a database "VIEW", which limits access and guarantees performance. + /// A "record" represents a single row of the views. + /// A record can have basic properties of five types: integer, string, boolean, long, double. /// public static class ContactsViews { - private const uint PropertyAddressbook = 0x00100000; + private const uint PropertyAddressBook = 0x00100000; private const uint PropertyGroup = 0x00200000; private const uint PropertyPerson = 0x00300000; private const uint PropertyData = 0x00600000; @@ -69,10 +72,10 @@ namespace Tizen.Pims.Contacts private enum PropertyIds : uint { /* addressbook */ - AddressbookId = (PropertyAddressbook | DataTypeInt | ReadOnly), - AddressbookAccountId = (PropertyAddressbook | DataTypeInt) + 1, - AddressbookName = (PropertyAddressbook | DataTypeString) + 2, - AddressbookMode = (PropertyAddressbook | DataTypeInt) + 3, + AddressbookId = (PropertyAddressBook | DataTypeInt | ReadOnly), + AddressbookAccountId = (PropertyAddressBook | DataTypeInt) + 1, + AddressbookName = (PropertyAddressBook | DataTypeString) + 2, + AddressbookMode = (PropertyAddressBook | DataTypeInt) + 3, /* group */ GroupId = (PropertyGroup | DataTypeInt | ReadOnly), @@ -96,7 +99,7 @@ namespace Tizen.Pims.Contacts PersonFavoritePriority = (PropertyPerson | DataTypeDouble | ReadOnly) + 7, PersonLinkCount = (PropertyPerson | DataTypeInt | ReadOnly) + 8, PersonAddressbookIds = (PropertyPerson | DataTypeString | ReadOnly) + 9, - PersonHasPhonenumber = (PropertyPerson | DataTypeBool | ReadOnly) + 10, + PersonHasPhoneNumber = (PropertyPerson | DataTypeBool | ReadOnly) + 10, PersonHasEmail = (PropertyPerson | DataTypeBool | ReadOnly) + 11, PersonDisplayNameIndex = (PropertyPerson | DataTypeString | ReadOnly) + 12, PersonStatus = (PropertyPerson | DataTypeString | ReadOnly) + 13, @@ -118,7 +121,7 @@ namespace Tizen.Pims.Contacts ContactImage = (PropertyContact | DataTypeRecord) + 5, ContactThumbnail = (PropertyContact | DataTypeString | ReadOnly) + 6, ContactIsFavorite = (PropertyContact | DataTypeBool) + 7, - ContactHasPhonenumber = (PropertyContact | DataTypeBool | ReadOnly) + 8, + ContactHasPhoneNumber = (PropertyContact | DataTypeBool | ReadOnly) + 8, ContactHasEmail = (PropertyContact | DataTypeBool | ReadOnly) + 9, ContactPersonId = (PropertyContact | DataTypeInt) + 10, ContactUid = (PropertyContact | DataTypeString) + 11, @@ -392,6 +395,9 @@ namespace Tizen.Pims.Contacts internal const uint AverageSizeOfRecord = 120; /* average size of person record */ + /// + /// Describes properies of a Address book record. + /// public static class Addressbook { /// @@ -431,6 +437,9 @@ namespace Tizen.Pims.Contacts } } + /// + /// Describes properies of a Group record. + /// public static class Group { /// @@ -475,6 +484,9 @@ namespace Tizen.Pims.Contacts public const uint MessageAlert = (uint)PropertyIds.GroupMessageAlert; } + /// + /// Describes properies of a Person record. + /// public static class Person { /// @@ -536,7 +548,7 @@ namespace Tizen.Pims.Contacts /// /// The person has phone number or not /// - public const uint HasPhonenumber = (uint)PropertyIds.PersonHasPhonenumber; + public const uint HasPhoneNumber = (uint)PropertyIds.PersonHasPhoneNumber; /// /// The person has email or not /// @@ -551,6 +563,9 @@ namespace Tizen.Pims.Contacts public const uint SnippetString = (uint)PropertyIds.PersonSnippetString; } + /// + /// Describes properies of a Contact record. + /// public static class Contact { /// @@ -588,7 +603,7 @@ namespace Tizen.Pims.Contacts /// /// The contact has phone number or not /// - public const uint HasPhonenumber = (uint)PropertyIds.ContactHasPhonenumber; + public const uint HasPhoneNumber = (uint)PropertyIds.ContactHasPhoneNumber; /// /// The contact has email or not /// @@ -751,6 +766,9 @@ namespace Tizen.Pims.Contacts } } + /// + /// Describes properies of a Simple contact record. + /// public static class SimpleContact { /// @@ -788,7 +806,7 @@ namespace Tizen.Pims.Contacts /// /// The contact has phone number or not /// - public const uint HasPhonenumber = (uint)PropertyIds.ContactHasPhonenumber; + public const uint HasPhoneNumber = (uint)PropertyIds.ContactHasPhoneNumber; /// /// The contact has email or not /// @@ -815,6 +833,9 @@ namespace Tizen.Pims.Contacts public const uint ChangedTime = (uint)PropertyIds.ContactChangedTime; } + /// + /// Describes properies of a My profile record. + /// public static class MyProfile { /// @@ -907,6 +928,9 @@ namespace Tizen.Pims.Contacts public const uint Sip = (uint)PropertyIds.MyProfileSip; } + /// + /// Describes properies of a Name record. + /// public static class Name { /// @@ -955,6 +979,9 @@ namespace Tizen.Pims.Contacts public const uint PhoneticLast = (uint)PropertyIds.NamePhoneticLast; } + /// + /// Describes properies of a Number record. + /// public static class Number { /// @@ -998,6 +1025,9 @@ namespace Tizen.Pims.Contacts /// public const uint NumberFilter = (uint)PropertyIds.NumberNumberFilter; + /// + /// Enumeration for number type. + /// public enum Types { /// @@ -1079,6 +1109,9 @@ namespace Tizen.Pims.Contacts } } + /// + /// Describes properies of a Email record. + /// public static class Email { /// @@ -1110,6 +1143,9 @@ namespace Tizen.Pims.Contacts /// public const uint Address = (uint)PropertyIds.EmailEmail; + /// + /// Enumeration for Contact email type. + /// public enum Types { /// @@ -1135,6 +1171,9 @@ namespace Tizen.Pims.Contacts } } + /// + /// Describes properies of a Address record. + /// public static class Address { /// @@ -1230,6 +1269,9 @@ namespace Tizen.Pims.Contacts } } + /// + /// Describes properies of a Note record. + /// public static class Note { /// @@ -1250,6 +1292,9 @@ namespace Tizen.Pims.Contacts public const uint Contents = (uint)PropertyIds.NoteNote; } + /// + /// Describes properies of a Url record. + /// public static class Url { /// @@ -1301,6 +1346,9 @@ namespace Tizen.Pims.Contacts } } + /// + /// Describes properies of a Event record. + /// public static class Event { /// @@ -1371,6 +1419,9 @@ namespace Tizen.Pims.Contacts } } + /// + /// Describes properies of a Relationship record. + /// public static class Relationship { /// @@ -1470,6 +1521,9 @@ namespace Tizen.Pims.Contacts } } + /// + /// Describes properies of a Image record. + /// public static class Image { /// @@ -1517,6 +1571,9 @@ namespace Tizen.Pims.Contacts } } + /// + /// Describes properies of a Company record. + /// public static class Company { /// @@ -1587,6 +1644,9 @@ namespace Tizen.Pims.Contacts } } + /// + /// Describes properies of a Nickname record. + /// public static class Nickname { /// @@ -1607,6 +1667,9 @@ namespace Tizen.Pims.Contacts public const uint Name = (uint)PropertyIds.NicknameName; } + /// + /// Describes properies of a Messenger record. + /// public static class Messenger { /// @@ -1690,6 +1753,9 @@ namespace Tizen.Pims.Contacts } } + /// + /// Describes properies of a Profile record. + /// public static class Profile { /// @@ -1742,6 +1808,9 @@ namespace Tizen.Pims.Contacts public const uint ExtraData = (uint)PropertyIds.ProfileExtraData; } + /// + /// Describes properies of a Sip record. + /// public static class Sip { /// @@ -1769,6 +1838,9 @@ namespace Tizen.Pims.Contacts /// public const uint Label = (uint)PropertyIds.SipLabel; + /// + /// Enumeration for Contact SIP type. + /// public enum Types { /// @@ -1790,6 +1862,9 @@ namespace Tizen.Pims.Contacts } } + /// + /// Describes properies of a Extension record. + /// public static class Extension { /// @@ -1854,6 +1929,9 @@ namespace Tizen.Pims.Contacts public const uint Data12 = (uint)PropertyIds.ExtensionData12; } + /// + /// Describes properies of a Group relation record. + /// public static class GroupRelation { /// @@ -1878,6 +1956,9 @@ namespace Tizen.Pims.Contacts public const uint Name = (uint)PropertyIds.GroupRelationGroupName; } + /// + /// Describes properies of a Speed dial record. + /// public static class SpeedDial { /// @@ -1930,6 +2011,9 @@ namespace Tizen.Pims.Contacts public const uint NumberFilter = (uint)PropertyIds.SpeedDialNumberFilter; } + /// + /// Describes properies of a Phone log record. + /// public static class PhoneLog { /// @@ -1981,6 +2065,9 @@ namespace Tizen.Pims.Contacts /// public const uint SimSlotNo = (uint)PropertyIds.PhonelogSIMSlotNo; + /// + /// Enumeration for Phone log type. + /// public enum Types { /// @@ -2072,7 +2159,7 @@ namespace Tizen.Pims.Contacts } /// - /// + /// Describes properies of a Contact updated information record. /// /// Read only view public static class ContactUpdatedInfo @@ -2090,7 +2177,7 @@ namespace Tizen.Pims.Contacts /// public const uint AddressbookId = (uint)PropertyIds.UpdateInfoAddressbookId; /// - /// Contact updated type, refer to the ContactsViews.ChangeTypes + /// Contact change type, refer to the ContactsViews.ChangeTypes /// public const uint Type = (uint)PropertyIds.UpdateInfoType; /// @@ -2104,7 +2191,7 @@ namespace Tizen.Pims.Contacts } /// - /// + /// Describes properies of a My profile updated information record. /// /// Read only view public static class MyProfileUpdatedInfo @@ -2118,7 +2205,7 @@ namespace Tizen.Pims.Contacts /// public const uint AddressbookId = (uint)PropertyIds.UpdateInfoAddressbookId; /// - /// Changed update type, refer to the ContactsViews.ChangeTypes + /// MyProfile change type, refer to the ContactsViews.ChangeTypes /// public const uint LastChangedType = (uint)PropertyIds.UpdateInfoLastChangedType; /// @@ -2128,7 +2215,7 @@ namespace Tizen.Pims.Contacts } /// - /// + /// Describes properies of a Group updated information record. /// /// Read only view public static class GroupUpdatedInfo @@ -2146,7 +2233,7 @@ namespace Tizen.Pims.Contacts /// public const uint AddressbookId = (uint)PropertyIds.UpdateInfoAddressbookId; /// - /// Changed update type, refer to the ContactsViews.ChangeTypes + /// Group change type, refer to the ContactsViews.ChangeTypes /// public const uint Type = (uint)PropertyIds.UpdateInfoType; /// @@ -2156,7 +2243,7 @@ namespace Tizen.Pims.Contacts } /// - /// + /// Describes properies of a Group Member updated information record. /// /// Read only view public static class GroupMemberUpdatedInfo @@ -2180,7 +2267,7 @@ namespace Tizen.Pims.Contacts } /// - /// + /// Describes properies of a Relation updated information record. /// /// Read only view public static class GroupRelationUpdatedInfo @@ -2202,7 +2289,7 @@ namespace Tizen.Pims.Contacts /// public const uint AddressbookId = (uint)PropertyIds.AddressbookId; /// - /// Changed update type, refer to the ContactsViews.ChangeTypes + /// Group relation change type, refer to the ContactsViews.ChangeTypes /// public const uint Type = (uint)PropertyIds.UpdateInfoType; /// @@ -2212,7 +2299,7 @@ namespace Tizen.Pims.Contacts } /// - /// + /// Describes properies of a Person & Contact record. /// /// Read only view public static class PersonContact @@ -2276,7 +2363,7 @@ namespace Tizen.Pims.Contacts /// /// The person has phone number or not /// - public const uint HasPhonenumber = (uint)PropertyIds.PersonHasPhonenumber; + public const uint HasPhoneNumber = (uint)PropertyIds.PersonHasPhoneNumber; /// /// The person has email or not /// @@ -2304,7 +2391,7 @@ namespace Tizen.Pims.Contacts }; /// - /// + /// Describes properies of a Person & Number record. /// /// Read only view public static class PersonNumber @@ -2352,7 +2439,7 @@ namespace Tizen.Pims.Contacts /// /// The person has phone number or not /// - public const uint HasPhonenumber = (uint)PropertyIds.PersonHasPhonenumber; + public const uint HasPhoneNumber = (uint)PropertyIds.PersonHasPhoneNumber; /// /// The person has email or not /// @@ -2400,7 +2487,7 @@ namespace Tizen.Pims.Contacts }; /// - /// + /// Describes properies of a Person & Email record. /// /// Read only view public static class PersonEmail @@ -2448,7 +2535,7 @@ namespace Tizen.Pims.Contacts /// /// The person has phone number or not /// - public const uint HasPhonenumber = (uint)PropertyIds.PersonHasPhonenumber; + public const uint HasPhoneNumber = (uint)PropertyIds.PersonHasPhoneNumber; /// /// The person has email or not /// @@ -2484,7 +2571,7 @@ namespace Tizen.Pims.Contacts }; /// - /// + /// Describes properies of a Person & Group Relation record. /// /// Read only view public static class PersonGroupRelation @@ -2536,7 +2623,7 @@ namespace Tizen.Pims.Contacts /// /// The person has phone number or not /// - public const uint HasPhonenumber = (uint)PropertyIds.PersonHasPhonenumber; + public const uint HasPhoneNumber = (uint)PropertyIds.PersonHasPhoneNumber; /// /// The person has email or not /// @@ -2580,7 +2667,7 @@ namespace Tizen.Pims.Contacts }; /// - /// + /// Describes properies of a Person & Group Assigned record. /// /// Read only view public static class PersonGroupAssigned @@ -2632,7 +2719,7 @@ namespace Tizen.Pims.Contacts /// /// The person has phone number or not /// - public const uint HasPhonenumber = (uint)PropertyIds.PersonHasPhonenumber; + public const uint HasPhoneNumber = (uint)PropertyIds.PersonHasPhoneNumber; /// /// The person has email or not /// @@ -2672,7 +2759,7 @@ namespace Tizen.Pims.Contacts }; /// - /// + /// Describes properies of a Person & Group Not Assigned record. /// /// Read only view public static class PersonGroupNotAssigned @@ -2724,7 +2811,7 @@ namespace Tizen.Pims.Contacts /// /// The person has phone number or not /// - public const uint HasPhonenumber = (uint)PropertyIds.PersonHasPhonenumber; + public const uint HasPhoneNumber = (uint)PropertyIds.PersonHasPhoneNumber; /// /// The person has email or not /// @@ -2760,7 +2847,7 @@ namespace Tizen.Pims.Contacts }; /// - /// + /// Describes properies of a Person & Phone Log record. /// /// Read only view public static class PersonPhonelog @@ -2828,7 +2915,7 @@ namespace Tizen.Pims.Contacts }; /// - /// + /// Describes properies of a Person Usage record. /// /// Read only view public static class PersonUsage @@ -2876,7 +2963,7 @@ namespace Tizen.Pims.Contacts /// /// The person has phone number or not /// - public const uint HasPhonenumber = (uint)PropertyIds.PersonHasPhonenumber; + public const uint HasPhoneNumber = (uint)PropertyIds.PersonHasPhoneNumber; /// /// The person has email or not /// @@ -2890,6 +2977,9 @@ namespace Tizen.Pims.Contacts /// public const uint TimesUsed = (uint)PropertyIds.PersonTimesUsed; + /// + /// Enumeration for Person usage type. + /// public enum Types { /// @@ -2940,7 +3030,7 @@ namespace Tizen.Pims.Contacts }; /// - /// + /// Describes properies of a Contact & Number record. /// /// Read only view public static class ContactNumber @@ -3012,7 +3102,7 @@ namespace Tizen.Pims.Contacts }; /// - /// + /// Describes properies of a Contact & Email record. /// /// Read only view public static class ContactEmail @@ -3072,7 +3162,7 @@ namespace Tizen.Pims.Contacts }; /// - /// + /// Describes properies of a Contact & Group Relation record. /// /// Read only view public static class ContactGroupRelation @@ -3120,7 +3210,7 @@ namespace Tizen.Pims.Contacts }; /// - /// + /// Describes properies of a Phone Log Statistics record. /// /// Read only view public static class PhonelogStatistics -- 2.7.4