From 8ddd74163e778da37cbb0bf3344a1e0f46b145ae Mon Sep 17 00:00:00 2001 From: =?utf8?q?=E2=80=9CEditor?= Date: Thu, 21 Dec 2017 17:23:07 +0530 Subject: [PATCH] Review Pims.Calendar, Pims.Contacts API cs files PS2: Feedback implementation Change-Id: I5e77234b3aabd0cbcd13fea25c884e030b31b200 --- .../Tizen.Pims.Calendar/CalendarDatabase.cs | 278 ++-- .../Tizen.Pims.Calendar/CalendarFilter.cs | 174 +-- .../Tizen.Pims.Calendar/CalendarList.cs | 38 +- .../Tizen.Pims.Calendar/CalendarManager.cs | 22 +- .../Tizen.Pims.Calendar/CalendarQuery.cs | 48 +- .../Tizen.Pims.Calendar/CalendarRecord.cs | 100 +- .../Tizen.Pims.Calendar/CalendarReminder.cs | 12 +- .../Tizen.Pims.Calendar/CalendarStructs.cs | 42 +- .../Tizen.Pims.Calendar/CalendarTypes.cs | 174 +-- .../Tizen.Pims.Calendar/CalendarVcalendar.cs | 40 +- .../Tizen.Pims.Calendar/CalendarViews.cs | 538 ++++---- .../Tizen.Pims.Calendar/DBChangedEventArgs.cs | 4 +- .../Tizen.Pims.Calendar/ReminderEventArgs.cs | 6 +- .../Interop/Interop.Activity.cs | 2 +- src/Tizen.Pims.Contacts/Interop/Interop.Group.cs | 4 +- .../Interop/Interop.Libraries.cs | 2 +- .../Interop/Interop.PhoneLog.cs | 2 +- src/Tizen.Pims.Contacts/Interop/Interop.Service.cs | 4 +- src/Tizen.Pims.Contacts/Interop/Interop.Setting.cs | 2 +- src/Tizen.Pims.Contacts/Interop/Interop.Sim.cs | 2 +- .../Tizen.Pims.Contacts/ContactsDatabase.cs | 428 +++--- .../Tizen.Pims.Contacts/ContactsFilter.cs | 172 +-- .../Tizen.Pims.Contacts/ContactsList.cs | 44 +- .../Tizen.Pims.Contacts/ContactsManager.cs | 48 +- .../Tizen.Pims.Contacts/ContactsQuery.cs | 48 +- .../Tizen.Pims.Contacts/ContactsRecord.cs | 90 +- .../Tizen.Pims.Contacts/ContactsVcard.cs | 44 +- .../Tizen.Pims.Contacts/ContactsViews.cs | 1370 ++++++++++---------- .../Tizen.Pims.Contacts/DBChangedEventArgs.cs | 4 +- .../DBStatusChangedEventArgs.cs | 2 +- .../NameDisplayOrderChangedEventArgs.cs | 4 +- .../NameSortingOrderChangedEventArgs.cs | 4 +- 32 files changed, 1876 insertions(+), 1876 deletions(-) diff --git a/src/Tizen.Pims.Calendar/Tizen.Pims.Calendar/CalendarDatabase.cs b/src/Tizen.Pims.Calendar/Tizen.Pims.Calendar/CalendarDatabase.cs index 45686aa..b57cb45 100644 --- a/src/Tizen.Pims.Calendar/Tizen.Pims.Calendar/CalendarDatabase.cs +++ b/src/Tizen.Pims.Calendar/Tizen.Pims.Calendar/CalendarDatabase.cs @@ -22,11 +22,11 @@ using System.Diagnostics.CodeAnalysis; namespace Tizen.Pims.Calendar { /// - /// CalendarDatabase provides methods to manage calendar information from/to the database. + /// The CalendarDatabase provides methods to manage calendar information from/to the database. /// /// - /// This class allows user to access/create/update/delete db operations for calendar information. - /// CalendarDatabase is created by CalendarManager. + /// This class allows user to access/create/update/delete database operations for the calendar information. + /// The CalendarDatabase is created by the CalendarManager. /// /// 4 public class CalendarDatabase @@ -61,14 +61,14 @@ namespace Tizen.Pims.Calendar } /// - /// Gets last successful changed calendar database version on the current connection. + /// Gets the last successful changed calendar database version on the current connection. /// /// 4 - /// The last successful changed calendar database version on the current connection + /// The last successful changed calendar database version on the current connection. /// http://tizen.org/privilege/calendar.read - /// Thrown when method failed due to invalid operation - /// Thrown when failed due to out of memory - /// Thrown when application does not have proper privileges + /// Thrown when the method failed due to an invalid operation. + /// Thrown when failed due to out of memory. + /// Thrown when the application does not have proper privileges. /// The last successful changed calendar database version on the current connection. [SuppressMessage("Microsoft.Performance", "CA1822:MarkMembersAsStatic")] public int LastChangeVersion @@ -89,15 +89,15 @@ namespace Tizen.Pims.Calendar /// Inserts a record into the calendar database. /// /// 4 - /// The record to be inserted - /// The ID of inserted record + /// The record to be inserted. + /// The ID of inserted record. /// http://tizen.org/privilege/calendar.write /// http://tizen.org/feature/calendar - /// Thrown when feature is not supported - /// Thrown when method failed due to invalid operation - /// Thrown when one of the arguments provided to a method is not valid - /// Thrown when failed due to out of memory - /// Thrown when application does not have proper privileges + /// Thrown when the feature is not supported. + /// Thrown when the method failed due to an invalid operation. + /// Thrown when one of the arguments provided to a method is not valid. + /// Thrown when failed due to out of memory. + /// Thrown when the application does not have proper privileges. [SuppressMessage("Microsoft.Performance", "CA1822:MarkMembersAsStatic")] public int Insert(CalendarRecord record) { @@ -115,18 +115,18 @@ namespace Tizen.Pims.Calendar /// Gets a record from the calendar database. /// /// 4 - /// The view URI of a record - /// The record ID + /// The view URI of a record. + /// The record ID. /// - /// The record associated with the record ID + /// The record associated with the record ID. /// /// http://tizen.org/privilege/calendar.read /// http://tizen.org/feature/calendar - /// Thrown when feature is not supported - /// Thrown when method failed due to invalid operation - /// Thrown when one of the arguments provided to a method is not valid - /// Thrown when failed due to out of memory - /// Thrown when application does not have proper privileges + /// Thrown when feature is not supported. + /// Thrown when the method failed due to an invalid operation. + /// Thrown when one of the arguments provided to a method is not valid. + /// Thrown when failed due to out of memory. + /// Thrown when the application does not have proper privileges. [SuppressMessage("Microsoft.Performance", "CA1822:MarkMembersAsStatic")] [SuppressMessage("Microsoft.Design", "CA1054:UriParametersShouldNotBeStrings")] public CalendarRecord Get(string viewUri, int recordId) @@ -150,14 +150,14 @@ namespace Tizen.Pims.Calendar /// Updates a record in the calendar database. /// /// 4 - /// The record to be updated + /// The record to be updated. /// http://tizen.org/privilege/calendar.write /// http://tizen.org/feature/calendar - /// Thrown when feature is not supported - /// Thrown when method failed due to invalid operation - /// Thrown when one of the arguments provided to a method is not valid - /// Thrown when failed due to out of memory - /// Thrown when application does not have proper privileges + /// Thrown when the feature is not supported. + /// Thrown when the method failed due to an invalid operation. + /// Thrown when one of the arguments provided to a method is not valid. + /// Thrown when failed due to out of memory. + /// Thrown when the application does not have proper privileges. [SuppressMessage("Microsoft.Performance", "CA1822:MarkMembersAsStatic")] public void Update(CalendarRecord record) { @@ -173,15 +173,15 @@ namespace Tizen.Pims.Calendar /// Deletes a record from the calendar database with related child records. /// /// 4 - /// The view URI of a record - /// The record ID to be deleted + /// The view URI of a record. + /// The record ID to be deleted. /// http://tizen.org/privilege/calendar.write /// http://tizen.org/feature/calendar - /// Thrown when feature is not supported - /// Thrown when method failed due to invalid operation - /// Thrown when one of the arguments provided to a method is not valid - /// Thrown when failed due to out of memory - /// Thrown when application does not have proper privileges + /// Thrown when the feature is not supported. + /// Thrown when the method failed due to an invalid operation. + /// Thrown when one of the arguments provided to a method is not valid. + /// Thrown when failed due to out of memory. + /// Thrown when the application does not have proper privileges. [SuppressMessage("Microsoft.Performance", "CA1822:MarkMembersAsStatic")] [SuppressMessage("Microsoft.Design", "CA1054:UriParametersShouldNotBeStrings")] public void Delete(string viewUri, int recordId) @@ -198,15 +198,15 @@ namespace Tizen.Pims.Calendar /// Replaces a record in the calendar database. /// /// 4 - /// The record to be replaced - /// the record id + /// The record to be replaced. + /// The record ID. /// http://tizen.org/privilege/calendar.write /// http://tizen.org/feature/calendar - /// Thrown when feature is not supported - /// Thrown when method failed due to invalid operation - /// Thrown when one of the arguments provided to a method is not valid - /// Thrown when failed due to out of memory - /// Thrown when application does not have proper privileges + /// Thrown when the feature is not supported. + /// Thrown when the method failed due to an invalid operation. + /// Thrown when one of the arguments provided to a method is not valid. + /// Thrown when failed due to out of memory. + /// Thrown when the application does not have proper privileges. [SuppressMessage("Microsoft.Performance", "CA1822:MarkMembersAsStatic")] public void Replace(CalendarRecord record, int id) { @@ -219,22 +219,22 @@ namespace Tizen.Pims.Calendar } /// - /// Retrieves all records as a list. + /// Retrieves all the records as a list. /// /// 4 - /// The view URI to get records from - /// The index from which results are received - /// The maximum number of results(value 0 is used for all records) + /// The view URI to get records from. + /// The index from which results are received. + /// The maximum number of results (value 0 is used for all the records). /// - /// The record list + /// The record list. /// /// http://tizen.org/privilege/calendar.read /// http://tizen.org/feature/calendar - /// Thrown when feature is not supported - /// Thrown when method failed due to invalid operation - /// Thrown when one of the arguments provided to a method is not valid - /// Thrown when failed due to out of memory - /// Thrown when application does not have proper privileges + /// Thrown when the feature is not supported. + /// Thrown when the method failed due to an invalid operation. + /// Thrown when one of the arguments provided to a method is not valid. + /// Thrown when failed due to out of memory. + /// Thrown when the application does not have proper privileges. [SuppressMessage("Microsoft.Performance", "CA1822:MarkMembersAsStatic")] [SuppressMessage("Microsoft.Design", "CA1054:UriParametersShouldNotBeStrings")] public CalendarList GetAll(string viewUri, int offset, int limit) @@ -250,21 +250,21 @@ namespace Tizen.Pims.Calendar } /// - /// Retrieves records using a query. + /// Retrieves the records using a query. /// /// 4 - /// The query used to filter results - /// The index from which results are received - /// The maximum number of results(value 0 is used for all records) + /// The query used to filter results. + /// The index from which results are received. + /// The maximum number of results (value 0 is used for all the records). /// - /// CalendarList + /// CalendarList. /// /// http://tizen.org/privilege/calendar.read /// http://tizen.org/feature/calendar - /// Thrown when feature is not supported - /// Thrown when method failed due to invalid operation - /// Thrown when failed due to out of memory - /// Thrown when application does not have proper privileges + /// Thrown when the feature is not supported. + /// Thrown when the method failed due to an invalid operation. + /// Thrown when failed due to out of memory. + /// Thrown when the application does not have proper privileges. [SuppressMessage("Microsoft.Performance", "CA1822:MarkMembersAsStatic")] public CalendarList GetRecordsWithQuery(CalendarQuery query, int offset, int limit) { @@ -282,17 +282,17 @@ namespace Tizen.Pims.Calendar /// Inserts multiple records into the calendar database as a batch operation. /// /// 4 - /// The record list + /// The record list. /// - /// The inserted record id array + /// The inserted record ID array. /// /// http://tizen.org/privilege/calendar.write /// http://tizen.org/feature/calendar - /// Thrown when feature is not supported - /// Thrown when method failed due to invalid operation - /// Thrown when one of the arguments provided to a method is not valid - /// Thrown when failed due to out of memory - /// Thrown when application does not have proper privileges + /// Thrown when the feature is not supported. + /// Thrown when the method failed due to an invalid operation. + /// Thrown when one of the arguments provided to a method is not valid. + /// Thrown when failed due to out of memory. + /// Thrown when the application does not have proper privileges. [SuppressMessage("Microsoft.Performance", "CA1822:MarkMembersAsStatic")] public int[] Insert(CalendarList list) { @@ -314,14 +314,14 @@ namespace Tizen.Pims.Calendar /// Updates multiple records into the calendar database as a batch operation. /// /// 4 - /// The record list + /// The record list. /// http://tizen.org/privilege/calendar.write /// http://tizen.org/feature/calendar - /// Thrown when feature is not supported - /// Thrown when method failed due to invalid operation - /// Thrown when one of the arguments provided to a method is not valid - /// Thrown when failed due to out of memory - /// Thrown when application does not have proper privileges + /// Thrown when the feature is not supported. + /// Thrown when the method failed due to an invalid operation. + /// Thrown when one of the arguments provided to a method is not valid. + /// Thrown when failed due to out of memory. + /// Thrown when the application does not have proper privileges. [SuppressMessage("Microsoft.Performance", "CA1822:MarkMembersAsStatic")] public void Update(CalendarList list) { @@ -334,18 +334,18 @@ namespace Tizen.Pims.Calendar } /// - /// Deletes multiple records with related child records from the calendar database as a batch operation. + /// Deletes multiple records with the related child records from the calendar database as a batch operation. /// /// 4 - /// The view URI of the records to delete - /// The record IDs to delete + /// The view URI of the records to delete. + /// The record IDs to delete. /// http://tizen.org/privilege/calendar.write /// http://tizen.org/feature/calendar - /// Thrown when feature is not supported - /// Thrown when method failed due to invalid operation - /// Thrown when one of the arguments provided to a method is not valid - /// Thrown when failed due to out of memory - /// Thrown when application does not have proper privileges + /// Thrown when the feature is not supported. + /// Thrown when the method failed due to an invalid operation. + /// Thrown when one of the arguments provided to a method is not valid. + /// Thrown when failed due to out of memory. + /// Thrown when the application does not have proper privileges. [SuppressMessage("Microsoft.Performance", "CA1822:MarkMembersAsStatic")] [SuppressMessage("Microsoft.Design", "CA1054:UriParametersShouldNotBeStrings")] public void Delete(string viewUri, int[] idArray) @@ -359,16 +359,16 @@ namespace Tizen.Pims.Calendar } /// - /// Deletes multiple records with related child records from the calendar database as a batch operation. + /// Deletes multiple records with the related child records from the calendar database as a batch operation. /// /// 4 - /// The record list + /// The record list. /// http://tizen.org/privilege/calendar.write /// http://tizen.org/feature/calendar - /// Thrown when feature is not supported - /// Thrown when method failed due to invalid operation - /// Thrown when failed due to out of memory - /// Thrown when application does not have proper privileges + /// Thrown when the feature is not supported. + /// Thrown when the method failed due to an invalid operation. + /// Thrown when failed due to out of memory. + /// Thrown when the application does not have proper privileges. public void Delete(CalendarList list) { CalendarRecord record = null; @@ -410,15 +410,15 @@ namespace Tizen.Pims.Calendar /// Replaces multiple records in the calendar database as a batch operation. /// /// 4 - /// The record list - /// The record IDs + /// The record list. + /// The record IDs. /// http://tizen.org/privilege/calendar.write /// http://tizen.org/feature/calendar - /// Thrown when feature is not supported - /// Thrown when method failed due to invalid operation - /// Thrown when one of the arguments provided to a method is not valid - /// Thrown when failed due to out of memory - /// Thrown when application does not have proper privileges + /// Thrown when the feature is not supported. + /// Thrown when the method failed due to an invalid operation. + /// Thrown when one of the arguments provided to a method is not valid. + /// Thrown when failed due to out of memory. + /// Thrown when the application does not have proper privileges. [SuppressMessage("Microsoft.Performance", "CA1822:MarkMembersAsStatic")] public void Replace(CalendarList list, int[] idArray) { @@ -431,23 +431,23 @@ namespace Tizen.Pims.Calendar } /// - /// Retrieves records with the given calendar database version. + /// Retrieves the records with the given calendar database version. /// /// 4 - /// The view URI to get records from - /// The calendar book ID to filter - /// The calendar database version - /// The current calendar database version + /// The view URI to get records from. + /// The calendar book ID to filter. + /// The calendar database version. + /// The current calendar database version. /// - /// The record list + /// The record list. /// /// http://tizen.org/privilege/calendar.read /// http://tizen.org/feature/calendar - /// Thrown when feature is not supported - /// Thrown when method failed due to invalid operation - /// Thrown when one of the arguments provided to a method is not valid - /// Thrown when failed due to out of memory - /// Thrown when application does not have proper privileges + /// Thrown when the feature is not supported. + /// Thrown when the method failed due to an invalid operation. + /// Thrown when one of the arguments provided to a method is not valid. + /// Thrown when failed due to out of memory. + /// Thrown when the application does not have proper privileges. [SuppressMessage("Microsoft.Performance", "CA1822:MarkMembersAsStatic")] [SuppressMessage("Microsoft.Design", "CA1054:UriParametersShouldNotBeStrings")] public CalendarList GetChangesByVersion(string viewUri, int BookId, int calendarDBVersion, out int currentDBVersion) @@ -466,9 +466,9 @@ namespace Tizen.Pims.Calendar /// Gets the record count of a specific view. /// /// 4 - /// The view URI to get records from + /// The view URI to get records from. /// - /// The count of records + /// The count of records. /// /// http://tizen.org/privilege/calendar.read [SuppressMessage("Microsoft.Design", "CA1822:MarkMembersAsStatic")] @@ -489,9 +489,9 @@ namespace Tizen.Pims.Calendar /// Gets the record count with a query. /// /// 4 - /// The query used for filtering the results + /// The query used for filtering the results. /// - /// The count of records + /// The count of records. /// /// http://tizen.org/privilege/calendar.read [SuppressMessage("Microsoft.Design", "CA1822:MarkMembersAsStatic")] @@ -511,15 +511,15 @@ namespace Tizen.Pims.Calendar /// Registers a callback function to be invoked when a record changes. /// /// 4 - /// The view URI of the record to subscribe for change notifications - /// The EventHandler to register + /// The view URI of the record to subscribe for change notifications. + /// The EventHandler to register. /// http://tizen.org/privilege/calendar.read /// http://tizen.org/feature/calendar - /// Thrown when feature is not supported - /// Thrown when method failed due to invalid operation - /// Thrown when one of the arguments provided to a method is not valid - /// Thrown when failed due to out of memory - /// Thrown when application does not have proper privileges + /// Thrown when the feature is not supported. + /// Thrown when the method failed due to an invalid operation. + /// Thrown when one of the arguments provided to a method is not valid. + /// Thrown when failed due to out of memory. + /// Thrown when the application does not have proper privileges. [SuppressMessage("Microsoft.Design", "CA1054:UriParametersShouldNotBeStrings")] public void AddDBChangedDelegate(string viewUri, EventHandler DBChanged) { @@ -552,14 +552,14 @@ namespace Tizen.Pims.Calendar /// Deregisters a callback function. /// /// 4 - /// The view URI of the record to subscribe for change notifications - /// The EventHandler to deregister + /// The view URI of the record to subscribe for change notifications. + /// The EventHandler to deregister. /// http://tizen.org/privilege/calendar.read /// http://tizen.org/feature/calendar - /// Thrown when feature is not supported - /// Thrown when method failed due to invalid operation - /// Thrown when failed due to out of memory - /// Thrown when application does not have proper privileges + /// Thrown when the feature is not supported. + /// Thrown when the method failed due to an invalid operation. + /// Thrown when failed due to out of memory. + /// Thrown when the application does not have proper privileges. [SuppressMessage("Microsoft.Design", "CA1054:UriParametersShouldNotBeStrings")] public void RemoveDBChangedDelegate(string viewUri, EventHandler DBChanged) { @@ -584,18 +584,18 @@ namespace Tizen.Pims.Calendar } /// - /// Link a record to another record. + /// Links a record to another record. /// /// 4 - /// The base record ID - /// The record ID to link to + /// The base record ID. + /// The record ID to link to. /// http://tizen.org/privilege/calendar.write /// http://tizen.org/feature/calendar - /// Thrown when feature is not supported - /// Thrown when method failed due to invalid operation - /// Thrown when one of the arguments provided to a method is not valid - /// Thrown when failed due to out of memory - /// Thrown when application does not have proper privileges + /// Thrown when the feature is not supported. + /// Thrown when the method failed due to an invalid operation. + /// Thrown when one of the arguments provided to a method is not valid. + /// Thrown when failed due to out of memory. + /// Thrown when the application does not have proper privileges. [SuppressMessage("Microsoft.Design", "CA1822:MarkMembersAsStatic")] public void LinkRecord(int baseId, int recordId) { @@ -609,17 +609,17 @@ namespace Tizen.Pims.Calendar } /// - /// Unlink a record from base record. + /// Unlinks a record from the base record. /// /// 4 - /// The record ID to unlink + /// The record ID to unlink. /// http://tizen.org/privilege/calendar.write /// http://tizen.org/feature/calendar - /// Thrown when feature is not supported - /// Thrown when method failed due to invalid operation - /// Thrown when one of the arguments provided to a method is not valid - /// Thrown when failed due to out of memory - /// Thrown when application does not have proper privileges + /// Thrown when the feature is not supported. + /// Thrown when the method failed due to an invalid operation. + /// Thrown when one of the arguments provided to a method is not valid. + /// Thrown when failed due to out of memory. + /// Thrown when the application does not have proper privileges. [SuppressMessage("Microsoft.Performance", "CA1822:MarkMembersAsStatic")] public void UnlinkRecord(int recordId) { diff --git a/src/Tizen.Pims.Calendar/Tizen.Pims.Calendar/CalendarFilter.cs b/src/Tizen.Pims.Calendar/Tizen.Pims.Calendar/CalendarFilter.cs index 76a65d4..54f0a17 100644 --- a/src/Tizen.Pims.Calendar/Tizen.Pims.Calendar/CalendarFilter.cs +++ b/src/Tizen.Pims.Calendar/Tizen.Pims.Calendar/CalendarFilter.cs @@ -32,13 +32,13 @@ namespace Tizen.Pims.Calendar /// /// 4 /// http://tizen.org/feature/calendar - /// The view URI of a filter - /// The property ID to add a condition - /// The match flag - /// The match value - /// Thrown when feature is not supported - /// Thrown when one of the arguments provided to a method is not valid - /// Thrown when failed due to out of memory + /// The view URI of a filter. + /// The property ID to add a condition. + /// The match flag. + /// The match value. + /// Thrown when the feature is not supported. + /// Thrown when one of the arguments provided to a method is not valid. + /// Thrown when failed due to out of memory. [SuppressMessage("Microsoft.Design", "CA1054:UriParametersShouldNotBeStrings")] public CalendarFilter(string viewUri, uint propertyId, StringMatchType matchType, string matchValue) { @@ -64,13 +64,13 @@ namespace Tizen.Pims.Calendar /// /// 4 /// http://tizen.org/feature/calendar - /// The view URI of a filter - /// The property ID to add a condition - /// The match flag - /// The match value - /// Thrown when feature is not supported - /// Thrown when one of the arguments provided to a method is not valid - /// Thrown when failed due to out of memory + /// The view URI of a filter. + /// The property ID to add a condition. + /// The match flag. + /// The match value. + /// Thrown when the feature is not supported. + /// Thrown when one of the arguments provided to a method is not valid. + /// Thrown when failed due to out of memory. [SuppressMessage("Microsoft.Design", "CA1054:UriParametersShouldNotBeStrings")] public CalendarFilter(string viewUri, uint propertyId, IntegerMatchType matchType, int matchValue) { @@ -92,17 +92,17 @@ namespace Tizen.Pims.Calendar } /// - /// Creates a filter with a condition for long type. + /// Creates a filter with a condition for a long type. /// /// 4 /// http://tizen.org/feature/calendar - /// The view URI of a filter - /// The property ID to add a condition - /// The match flag - /// The match value - /// Thrown when feature is not supported - /// Thrown when one of the arguments provided to a method is not valid - /// Thrown when failed due to out of memory + /// The view URI of a filter. + /// The property ID to add a condition. + /// The match flag. + /// The match value. + /// Thrown when the feature is not supported. + /// Thrown when one of the arguments provided to a method is not valid. + /// Thrown when failed due to out of memory. [SuppressMessage("Microsoft.Design", "CA1054:UriParametersShouldNotBeStrings")] public CalendarFilter(string viewUri, uint propertyId, IntegerMatchType matchType, long matchValue) { @@ -124,17 +124,17 @@ namespace Tizen.Pims.Calendar } /// - /// Creates a filter with a condition for double type. + /// Creates a filter with a condition for a double type. /// /// 4 /// http://tizen.org/feature/calendar - /// The view URI of a filter - /// The property ID to add a condition - /// The match flag - /// The match value - /// Thrown when feature is not supported - /// Thrown when one of the arguments provided to a method is not valid - /// Thrown when failed due to out of memory + /// The view URI of a filter. + /// The property ID to add a condition. + /// The match flag. + /// The match value. + /// Thrown when the feature is not supported. + /// Thrown when one of the arguments provided to a method is not valid. + /// Thrown when failed due to out of memory. [SuppressMessage("Microsoft.Design", "CA1054:UriParametersShouldNotBeStrings")] public CalendarFilter(string viewUri, uint propertyId, IntegerMatchType matchType, double matchValue) { @@ -156,17 +156,17 @@ namespace Tizen.Pims.Calendar } /// - /// Creates a filter with a condition for CalendarTime type. + /// Creates a filter with a condition for the CalendarTime type. /// /// 4 /// http://tizen.org/feature/calendar - /// The view URI of a filter - /// The property ID to add a condition - /// The match flag - /// The match value - /// Thrown when feature is not supported - /// Thrown when one of the arguments provided to a method is not valid - /// Thrown when failed due to out of memory + /// The view URI of a filter. + /// The property ID to add a condition. + /// The match flag. + /// The match value. + /// Thrown when the feature is not supported. + /// Thrown when one of the arguments provided to a method is not valid. + /// Thrown when failed due to out of memory. [SuppressMessage("Microsoft.Design", "CA1054:UriParametersShouldNotBeStrings")] public CalendarFilter(string viewUri, uint propertyId, IntegerMatchType matchType, CalendarTime matchValue) { @@ -189,7 +189,7 @@ namespace Tizen.Pims.Calendar } /// - /// Destroy filter. + /// Destroys the filter. /// ~CalendarFilter() { @@ -203,27 +203,27 @@ namespace Tizen.Pims.Calendar public enum StringMatchType { /// - /// Full string, case-sensitive + /// Full string, case-sensitive. /// Exactly, /// - /// Full string, case-insensitive + /// Full string, case-insensitive. /// FullString, /// - /// Sub string, case-insensitive + /// Sub-string, case-insensitive. /// Contains, /// - /// Start with, case-insensitive + /// Starts with, case-insensitive. /// StartsWith, /// - /// End with, case-insensitive + /// Ends with, case-insensitive. /// EndsWith, /// - /// IS NOT NUL + /// IS NOT NULL. /// Exists, } @@ -255,11 +255,11 @@ namespace Tizen.Pims.Calendar /// LessThanOrEqual, /// - /// <>, this flag can yield poor performance + /// <>, this flag can yield poor performance. /// NotEqual, /// - /// IS NULL + /// IS NULL. /// None, } @@ -271,11 +271,11 @@ namespace Tizen.Pims.Calendar public enum LogicalOperator { /// - /// AND + /// And. /// And, /// - /// OR + /// Or. /// Or, } @@ -284,9 +284,9 @@ namespace Tizen.Pims.Calendar private bool disposedValue = false; // To detect redundant calls /// - /// Dispose + /// Dispose. /// - /// true to release both managed and unmanaged resources; false to release only unmanaged resources. + /// true to release both managed and unmanaged resources, false to release only unmanaged resources. /// 4 protected virtual void Dispose(bool disposing) { @@ -304,8 +304,8 @@ namespace Tizen.Pims.Calendar } /// - /// Releases all resources used by the CalendarFilter. - /// It should be called after having finished using of the object. + /// Releases all the resources used by the CalendarFilter. + /// It should be called after having finished using the object. /// /// 4 public void Dispose() @@ -320,12 +320,12 @@ namespace Tizen.Pims.Calendar /// /// 4 /// http://tizen.org/feature/calendar - /// The operator type - /// The property ID to add a condition - /// The match flag - /// The match value - /// Thrown when feature is not supported - /// Thrown when one of the arguments provided to a method is not valid + /// The operator type. + /// The property ID to add a condition. + /// The match flag. + /// The match value. + /// Thrown when the feature is not supported. + /// Thrown when one of the arguments provided to a method is not valid. public void AddCondition(LogicalOperator logicalOperator, uint propertyId, StringMatchType matchType, string matchValue) { int error = Interop.Filter.AddOperator(_filterHandle, logicalOperator); @@ -348,12 +348,12 @@ namespace Tizen.Pims.Calendar /// /// 4 /// http://tizen.org/feature/calendar - /// The operator type - /// The property ID to add a condition - /// The match flag - /// The match value - /// Thrown when feature is not supported - /// Thrown when one of the arguments provided to a method is not valid + /// The operator type. + /// The property ID to add a condition. + /// The match flag. + /// The match value. + /// Thrown when the feature is not supported. + /// Thrown when one of the arguments provided to a method is not valid. public void AddCondition(LogicalOperator logicalOperator, uint propertyId, IntegerMatchType matchType, int matchValue) { int error = Interop.Filter.AddOperator(_filterHandle, logicalOperator); @@ -376,12 +376,12 @@ namespace Tizen.Pims.Calendar /// /// 4 /// http://tizen.org/feature/calendar - /// The operator type - /// The property ID to add a condition - /// The match flag - /// The match value - /// Thrown when feature is not supported - /// Thrown when one of the arguments provided to a method is not valid + /// The operator type. + /// The property ID to add a condition. + /// The match flag. + /// The match value. + /// Thrown when the feature is not supported. + /// Thrown when one of the arguments provided to a method is not valid. public void AddCondition(LogicalOperator logicalOperator, uint propertyId, IntegerMatchType matchType, long matchValue) { int error = Interop.Filter.AddOperator(_filterHandle, logicalOperator); @@ -404,12 +404,12 @@ namespace Tizen.Pims.Calendar /// /// 4 /// http://tizen.org/feature/calendar - /// The operator type - /// The property ID to add a condition - /// The match flag - /// The match value - /// Thrown when feature is not supported - /// Thrown when one of the arguments provided to a method is not valid + /// The operator type. + /// The property ID to add a condition. + /// The match flag. + /// The match value. + /// Thrown when the feature is not supported. + /// Thrown when one of the arguments provided to a method is not valid. public void AddCondition(LogicalOperator logicalOperator, uint propertyId, IntegerMatchType matchType, double matchValue) { int error = Interop.Filter.AddOperator(_filterHandle, logicalOperator); @@ -432,12 +432,12 @@ namespace Tizen.Pims.Calendar /// /// 4 /// http://tizen.org/feature/calendar - /// The operator type - /// The property ID to add a condition - /// The match flag - /// The match value - /// Thrown when feature is not supported - /// Thrown when one of the arguments provided to a method is not valid + /// The operator type. + /// The property ID to add a condition. + /// The match flag. + /// The match value. + /// Thrown when the feature is not supported. + /// Thrown when one of the arguments provided to a method is not valid. public void AddCondition(LogicalOperator logicalOperator, uint propertyId, IntegerMatchType matchType, CalendarTime matchValue) { int error = Interop.Filter.AddOperator(_filterHandle, logicalOperator); @@ -461,10 +461,10 @@ namespace Tizen.Pims.Calendar /// /// 4 /// http://tizen.org/feature/calendar - /// The operator type - /// The child filter - /// Thrown when feature is not supported - /// Thrown when one of the arguments provided to a method is not valid + /// The operator type. + /// The child filter. + /// Thrown when the feature is not supported. + /// Thrown when one of the arguments provided to a method is not valid. public void AddFilter(LogicalOperator logicalOperator, CalendarFilter filter) { int error = Interop.Filter.AddOperator(_filterHandle, logicalOperator); diff --git a/src/Tizen.Pims.Calendar/Tizen.Pims.Calendar/CalendarList.cs b/src/Tizen.Pims.Calendar/Tizen.Pims.Calendar/CalendarList.cs index cef13cb..c22e507 100644 --- a/src/Tizen.Pims.Calendar/Tizen.Pims.Calendar/CalendarList.cs +++ b/src/Tizen.Pims.Calendar/Tizen.Pims.Calendar/CalendarList.cs @@ -48,8 +48,8 @@ namespace Tizen.Pims.Calendar /// /// 4 /// http://tizen.org/feature/calendar - /// Thrown when feature is not supported - /// Thrown when failed due to out of memory + /// Thrown when the feature is not supported. + /// Thrown when failed due to out of memory. public CalendarList() { int error = Interop.List.Create(out _listHandle); @@ -65,7 +65,7 @@ namespace Tizen.Pims.Calendar /// The count of the calendar entity. /// /// 4 - /// The count of calendar entity. + /// The count of the calendar entity. public int Count { get @@ -85,7 +85,7 @@ namespace Tizen.Pims.Calendar } /// - /// Destroy CalendarList resource. + /// Destroys the CalendarList resource. /// ~CalendarList() { @@ -96,9 +96,9 @@ namespace Tizen.Pims.Calendar private bool disposedValue = false; // To detect redundant calls /// - /// Disposes of the resources (other than memory) used by the CalendarList. + /// Disposes off the resources (other than memory) used by the CalendarList. /// - /// true to release both managed and unmanaged resources; false to release only unmanaged resources. + /// true to release both managed and unmanaged resources, false to release only unmanaged resources. /// 4 protected virtual void Dispose(bool disposing) { @@ -118,7 +118,7 @@ namespace Tizen.Pims.Calendar /// /// Releases all resources used by the CalendarList. - /// It should be called after having finished using of the object. + /// It should be called after it has finished using the object. /// /// 4 public void Dispose() @@ -132,9 +132,9 @@ namespace Tizen.Pims.Calendar /// Adds a record to the calendar list. /// /// 4 - /// The record to be added + /// The record to be added. /// http://tizen.org/feature/calendar - /// Thrown when feature is not supported + /// Thrown when the feature is not supported. public void AddRecord(CalendarRecord record) { int error = Interop.List.Add(_listHandle, record._recordHandle); @@ -152,9 +152,9 @@ namespace Tizen.Pims.Calendar /// Removes a record from the calendar list. /// /// 4 - /// The record to be removed + /// The record to be removed. /// http://tizen.org/feature/calendar - /// Thrown when feature is not supported + /// Thrown when the feature is not supported. public void RemoveRecord(CalendarRecord record) { int error = Interop.List.Remove(_listHandle, record._recordHandle); @@ -173,10 +173,10 @@ namespace Tizen.Pims.Calendar /// /// 4 /// - /// calendar record + /// The calendar record. /// /// http://tizen.org/feature/calendar - /// Thrown when feature is not supported + /// Thrown when the feature is not supported. public CalendarRecord GetCurrentRecord() { IntPtr handle; @@ -194,10 +194,10 @@ namespace Tizen.Pims.Calendar /// /// 4 /// - /// if cursor is moved to the end, it returns false. + /// If the cursor is moved to the end, it returns false. /// /// http://tizen.org/feature/calendar - /// Thrown when feature is not supported + /// Thrown when the feature is not supported. public bool MovePrevious() { int error = Interop.List.Prev(_listHandle); @@ -222,10 +222,10 @@ namespace Tizen.Pims.Calendar /// /// 4 /// - /// if cursor is moved to the end, it returns false. + /// If the cursor is moved to the end, it returns false. /// /// http://tizen.org/feature/calendar - /// Thrown when feature is not supported + /// Thrown when the feature is not supported. public bool MoveNext() { int error = Interop.List.Next(_listHandle); @@ -250,7 +250,7 @@ namespace Tizen.Pims.Calendar /// /// 4 /// http://tizen.org/feature/calendar - /// Thrown when feature is not supported + /// Thrown when the feature is not supported. public void MoveFirst() { int error = Interop.List.First(_listHandle); @@ -266,7 +266,7 @@ namespace Tizen.Pims.Calendar /// /// 4 /// http://tizen.org/feature/calendar - /// Thrown when feature is not supported + /// Thrown when the feature is not supported. public void MoveLast() { int error = Interop.List.Last(_listHandle); diff --git a/src/Tizen.Pims.Calendar/Tizen.Pims.Calendar/CalendarManager.cs b/src/Tizen.Pims.Calendar/Tizen.Pims.Calendar/CalendarManager.cs index c9ff809..a6675b9 100644 --- a/src/Tizen.Pims.Calendar/Tizen.Pims.Calendar/CalendarManager.cs +++ b/src/Tizen.Pims.Calendar/Tizen.Pims.Calendar/CalendarManager.cs @@ -19,7 +19,7 @@ using System; namespace Tizen.Pims.Calendar { /// - /// A class for managing calendar information. It allows applications to use calendar service. + /// A class for managing the calendar information. It allows the applications to use the calendar service. /// /// 4 public class CalendarManager : IDisposable @@ -27,12 +27,12 @@ namespace Tizen.Pims.Calendar private CalendarDatabase _db = null; /// - /// Create a manager. + /// Creates a manager. /// /// 4 /// http://tizen.org/feature/calendar - /// Thrown when feature is not supported - /// Thrown when method failed due to invalid operation + /// Thrown when the feature is not supported. + /// Thrown when the method failed due to an invalid operation. public CalendarManager() { int error = Interop.Service.Connect(); @@ -45,7 +45,7 @@ namespace Tizen.Pims.Calendar } /// - /// Destroy CalendarManager resource. + /// Destroys the CalendarManager resource. /// ~CalendarManager() { @@ -53,13 +53,13 @@ namespace Tizen.Pims.Calendar } #region IDisposable Support - /// To detect redundant calls + /// To detect redundant calls. private bool disposedValue = false; /// /// Disposes of the resources (other than memory) used by the CalendarManager. /// - /// true to release both managed and unmanaged resources; false to release only unmanaged resources. + /// true to release both managed and unmanaged resources, false to release only unmanaged resources. /// 4 protected virtual void Dispose(bool disposing) { @@ -77,8 +77,8 @@ namespace Tizen.Pims.Calendar } /// - /// Releases all resources used by the CalendarManager. - /// It should be called after having finished using of the object. + /// Releases all the resources used by the CalendarManager. + /// It should be called after it has finished using the object. /// /// 4 public void Dispose() @@ -89,10 +89,10 @@ namespace Tizen.Pims.Calendar #endregion /// - /// Get database. + /// Gets the database. /// /// 4 - /// The database instance + /// The database instance. public CalendarDatabase Database { get diff --git a/src/Tizen.Pims.Calendar/Tizen.Pims.Calendar/CalendarQuery.cs b/src/Tizen.Pims.Calendar/Tizen.Pims.Calendar/CalendarQuery.cs index b713901..9c78be7 100644 --- a/src/Tizen.Pims.Calendar/Tizen.Pims.Calendar/CalendarQuery.cs +++ b/src/Tizen.Pims.Calendar/Tizen.Pims.Calendar/CalendarQuery.cs @@ -20,14 +20,14 @@ using System.Diagnostics.CodeAnalysis; namespace Tizen.Pims.Calendar { /// - /// A query is used to retrieve data which satisfies given criteria. + /// A query is used to retrieve the data, which satisfies the given criteria. /// /// 4 /// - /// A query is used to retrieve calendar data which satisfies a given criteria, + /// A query is used to retrieve the calendar data, which satisfies a given criteria, /// such as an integer property being greater than a given value, /// or a string property containing a given substring. - /// A query needs a filter which can set the conditions for the search. + /// A query needs a filter, which can set the conditions for the search. /// public class CalendarQuery:IDisposable { @@ -38,10 +38,10 @@ namespace Tizen.Pims.Calendar /// /// 4 /// http://tizen.org/feature/calendar - /// The view URI of a query - /// Thrown when feature is not supported - /// Thrown when one of the arguments provided to a method is not valid - /// Thrown when failed due to out of memory + /// The view URI of a query. + /// Thrown when the feature is not supported. + /// Thrown when one of the arguments provided to a method is not valid. + /// Thrown when failed due to out of memory. [SuppressMessage("Microsoft.Design", "CA1054:UriParametersShouldNotBeStrings")] public CalendarQuery(string viewUri) { @@ -59,7 +59,7 @@ namespace Tizen.Pims.Calendar } /// - /// Destructor + /// Destructor. /// ~CalendarQuery() { @@ -72,7 +72,7 @@ namespace Tizen.Pims.Calendar /// /// Disposes of the resources (other than memory) used by the CalendarQuery. /// - /// true to release both managed and unmanaged resources; false to release only unmanaged resources. + /// true to release both managed and unmanaged resources, false to release only unmanaged resources. /// 4 protected virtual void Dispose(bool disposing) { @@ -90,8 +90,8 @@ namespace Tizen.Pims.Calendar } /// - /// Releases all resources used by the CalendarQuery. - /// It should be called after having finished using of the object. + /// Releases all the resources used by the CalendarQuery. + /// It should be called after it has finished using the object. /// /// 4 public void Dispose() @@ -102,13 +102,13 @@ namespace Tizen.Pims.Calendar #endregion /// - /// Adds property IDs for projection. + /// Adds the property IDs for projection. /// /// 4 - /// The property ID array + /// The property ID array. /// http://tizen.org/feature/calendar - /// Thrown when feature is not supported - /// Thrown when one of the arguments provided to a method is not valid + /// Thrown when the feature is not supported. + /// Thrown when one of the arguments provided to a method is not valid. public void SetProjection(uint[] propertyIdArray) { if (propertyIdArray == null) @@ -128,9 +128,9 @@ namespace Tizen.Pims.Calendar /// Sets the "distinct" option for projection. /// /// 4 - /// If true it is set, otherwise if false it is unset + /// If true it is set, otherwise if false it is unset. /// http://tizen.org/feature/calendar - /// Thrown when feature is not supported + /// Thrown when the feature is not supported. public void SetDistinct(bool set) { int error = Interop.Query.SetDistinct(_queryHandle, set); @@ -145,10 +145,10 @@ namespace Tizen.Pims.Calendar /// Sets the filter for a query. /// /// 4 - /// The filter + /// The filter. /// http://tizen.org/feature/calendar - /// Thrown when feature is not supported - /// Thrown when one of the arguments provided to a method is not valid + /// Thrown when the feature is not supported. + /// Thrown when one of the arguments provided to a method is not valid. public void SetFilter(CalendarFilter filter) { int error = Interop.Query.SetFilter(_queryHandle, filter._filterHandle); @@ -163,11 +163,11 @@ namespace Tizen.Pims.Calendar /// Sets the sort mode for a query. /// /// 4 - /// The property ID to sort - /// If true it sorts in the ascending order, otherwise if false it sorts in the descending order + /// The property ID to sort. + /// If true it sorts in the ascending order, otherwise if false it sorts in the descending order. /// http://tizen.org/feature/calendar - /// Thrown when feature is not supported - /// Thrown when one of the arguments provided to a method is not valid + /// Thrown when the feature is not supported. + /// Thrown when one of the arguments provided to a method is not valid. public void SetSort(uint propertyId, bool isAscending) { int error = Interop.Query.SetSort(_queryHandle, propertyId, isAscending); diff --git a/src/Tizen.Pims.Calendar/Tizen.Pims.Calendar/CalendarRecord.cs b/src/Tizen.Pims.Calendar/Tizen.Pims.Calendar/CalendarRecord.cs index a97ab83..abb32fc 100644 --- a/src/Tizen.Pims.Calendar/Tizen.Pims.Calendar/CalendarRecord.cs +++ b/src/Tizen.Pims.Calendar/Tizen.Pims.Calendar/CalendarRecord.cs @@ -21,17 +21,17 @@ using System.Diagnostics.CodeAnalysis; namespace Tizen.Pims.Calendar { /// - /// A record represents an actual record in the database + /// A record represents an actual record in the database. /// /// 4 /// /// A record represents an actual record in the database, - /// but you can also consider it a piece of information, such as an alarm, attendee and extended. + /// but you can also consider it a piece of information, such as an alarm, attendee, and extended. /// A record can be a complex set of data, containing other data. /// For example, a calendar record contains the alarm property, which is a reference to an alarm record. /// An alarm record could belong to a event record, - /// and its alarm id property is set to the identifier of the corresponding event. - /// In this case, the alarm is the child record of the event and the event is the parent record. + /// and its alarm ID property is set to the identifier of the corresponding event. + /// In this case, the alarm is the child record of the event, and the event is the parent record. /// public class CalendarRecord : IDisposable { @@ -93,10 +93,10 @@ namespace Tizen.Pims.Calendar /// /// 4 /// http://tizen.org/feature/calendar - /// The view URI - /// Thrown when feature is not supported - /// Thrown when one of the arguments provided to a method is not valid - /// Thrown when failed due to out of memory + /// The view URI. + /// Thrown when the feature is not supported. + /// Thrown when one of the arguments provided to a method is not valid. + /// Thrown when failed due to out of memory. [SuppressMessage("Microsoft.Design", "CA1054:UriParametersShouldNotBeStrings")] public CalendarRecord(string viewUri) { @@ -112,7 +112,7 @@ namespace Tizen.Pims.Calendar } /// - /// Destructor + /// Destructor. /// ~CalendarRecord() { @@ -120,13 +120,13 @@ namespace Tizen.Pims.Calendar } #region IDisposable Support - /// To detect redundant calls + /// To detect redundant calls. internal bool _disposedValue = false; /// /// Disposes of the resources (other than memory) used by the CalendarRecord. /// - /// true to release both managed and unmanaged resources; false to release only unmanaged resources. + /// true to release both managed and unmanaged resources, false to release only unmanaged resources. /// 4 protected virtual void Dispose(bool disposing) { @@ -145,8 +145,8 @@ namespace Tizen.Pims.Calendar } /// - /// Releases all resources used by the CalendarRecord. - /// It should be called after having finished using of the object. + /// Releases all the resources used by the CalendarRecord. + /// It should be called after it has finished using the object. /// /// 4 public void Dispose() @@ -199,11 +199,11 @@ namespace Tizen.Pims.Calendar /// /// 4 /// - /// A cloned record + /// A cloned record. /// /// http://tizen.org/feature/calendar - /// Thrown when feature is not supported - /// Thrown when failed due to out of memory + /// Thrown when the feature is not supported. + /// Thrown when failed due to out of memory. public CalendarRecord Clone() { IntPtr _clonedRecordHandle; @@ -217,10 +217,10 @@ namespace Tizen.Pims.Calendar } /// - /// Get record URI. + /// Gets the record URI. /// /// 4 - /// The URI of the record + /// The URI of the record. [SuppressMessage("Microsoft.Design", "CA1056:UriPropertiesShouldNotBeStrings")] public string Uri { @@ -234,13 +234,13 @@ namespace Tizen.Pims.Calendar /// Gets a object from a record. /// /// 4 - /// The property ID + /// The property ID. /// - /// The value of the property corresponding to property id. + /// The value of the property corresponding to property ID. /// /// http://tizen.org/feature/calendar - /// Thrown when feature is not supported - /// Thrown when one of the arguments provided to a method is not valid + /// Thrown when the feature is not supported. + /// Thrown when one of the arguments provided to a method is not valid. public T Get(uint propertyId) { object parsedValue = null; @@ -312,11 +312,11 @@ namespace Tizen.Pims.Calendar /// Sets a value of the property to a record. /// /// 4 - /// The property ID - /// value + /// The property ID. + /// The value. /// http://tizen.org/feature/calendar - /// Thrown when feature is not supported - /// Thrown when one of the arguments provided to a method is not valid + /// Thrown when the feature is not supported. + /// Thrown when one of the arguments provided to a method is not valid. public void Set(uint propertyId, T value) { if (typeof(T) == typeof(string)) @@ -381,11 +381,11 @@ namespace Tizen.Pims.Calendar /// Adds a child record to the parent record. /// /// 4 - /// The property ID - /// The child record + /// The property ID. + /// The child record. /// http://tizen.org/feature/calendar - /// Thrown when feature is not supported - /// Thrown when one of the arguments provided to a method is not valid + /// Thrown when the feature is not supported. + /// Thrown when one of the arguments provided to a method is not valid. public void AddChildRecord(uint propertyId, CalendarRecord childRecord) { int error = Interop.Record.AddChildRecord(_recordHandle, propertyId, childRecord._recordHandle); @@ -401,11 +401,11 @@ namespace Tizen.Pims.Calendar /// Removes a child record from the parent record. /// /// 4 - /// The property ID - /// The child record + /// The property ID. + /// The child record. /// http://tizen.org/feature/calendar - /// Thrown when feature is not supported - /// Thrown when one of the arguments provided to a method is not valid + /// Thrown when the feature is not supported. + /// Thrown when one of the arguments provided to a method is not valid. public void RemoveChildRecord(uint propertyId, CalendarRecord childRecord) { int error = Interop.Record.RemoveChildRecord(_recordHandle, propertyId, childRecord._recordHandle); @@ -418,16 +418,16 @@ namespace Tizen.Pims.Calendar } /// - /// Gets a child record from the parent record + /// Gets a child record from the parent record. /// /// 4 - /// The property ID + /// The property ID. /// - /// The number of child records corresponding to property ID + /// The number of child records corresponding to property ID. /// /// http://tizen.org/feature/calendar - /// Thrown when feature is not supported - /// Thrown when one of the arguments provided to a method is not valid + /// Thrown when the feature is not supported. + /// Thrown when one of the arguments provided to a method is not valid. public int GetChildRecordCount(uint propertyId) { int count = 0; @@ -441,17 +441,17 @@ namespace Tizen.Pims.Calendar } /// - /// Gets a child record from the parent record + /// Gets a child record from the parent record. /// /// 4 - /// The property ID - /// The child record index + /// The property ID. + /// The child record index. /// - /// The record + /// The record. /// /// http://tizen.org/feature/calendar - /// Thrown when feature is not supported - /// Thrown when one of the arguments provided to a method is not valid + /// Thrown when the feature is not supported. + /// Thrown when one of the arguments provided to a method is not valid. public CalendarRecord GetChildRecord(uint propertyId, int index) { IntPtr handle; @@ -466,16 +466,16 @@ namespace Tizen.Pims.Calendar } /// - /// Clones a child record list corresponding to property ID + /// Clones a child record list corresponding to property ID. /// /// 4 - /// The property ID + /// The property ID. /// - /// the record list + /// The record list. /// /// http://tizen.org/feature/calendar - /// Thrown when feature is not supported - /// Thrown when one of the arguments provided to a method is not valid + /// Thrown when the feature is not supported. + /// Thrown when one of the arguments provided to a method is not valid. public CalendarList CloneChildRecordList(uint propertyId) { IntPtr listHandle; diff --git a/src/Tizen.Pims.Calendar/Tizen.Pims.Calendar/CalendarReminder.cs b/src/Tizen.Pims.Calendar/Tizen.Pims.Calendar/CalendarReminder.cs index e1804a8..008870a 100644 --- a/src/Tizen.Pims.Calendar/Tizen.Pims.Calendar/CalendarReminder.cs +++ b/src/Tizen.Pims.Calendar/Tizen.Pims.Calendar/CalendarReminder.cs @@ -19,11 +19,11 @@ using System; namespace Tizen.Pims.Calendar { /// - /// A class for reminder for event. + /// A class for the reminder for an event. /// /// 4 /// - /// The client who wants to be alerted at specific time should register MIME("application/x-tizen.calendar.reminder") type in manifest.xml file. + /// The client who wants to be alerted at a specific time should register MIME ("application/x-tizen.calendar.reminder") type in manifest.xml file. /// public class CalendarReminder:IDisposable { @@ -37,7 +37,7 @@ namespace Tizen.Pims.Calendar /// /// Disposes of the resources (other than memory) used by the CalendarReminder. /// - /// true to release both managed and unmanaged resources; false to release only unmanaged resources. + /// true to release both managed and unmanaged resources, false to release only unmanaged resources. /// 4 protected virtual void Dispose(bool disposing) { @@ -48,8 +48,8 @@ namespace Tizen.Pims.Calendar } /// - /// Releases all resources used by the CalendarReminder. - /// It should be called after having finished using of the object. + /// Releases all the resources used by the CalendarReminder. + /// It should be called after it has finished using the object. /// /// 4 public void Dispose() @@ -68,7 +68,7 @@ namespace Tizen.Pims.Calendar private static event EventHandler s_reminderAlerted; /// - /// Reminder event is triggered when the alarm is alerted. + /// The Reminder event is triggered when the alarm is alerted. /// /// 4 public static event EventHandler ReminderAlerted diff --git a/src/Tizen.Pims.Calendar/Tizen.Pims.Calendar/CalendarStructs.cs b/src/Tizen.Pims.Calendar/Tizen.Pims.Calendar/CalendarStructs.cs index 0ddbac9..d549bf2 100644 --- a/src/Tizen.Pims.Calendar/Tizen.Pims.Calendar/CalendarStructs.cs +++ b/src/Tizen.Pims.Calendar/Tizen.Pims.Calendar/CalendarStructs.cs @@ -19,7 +19,7 @@ using System; namespace Tizen.Pims.Calendar { /// - /// A class for time to set, get or calculate. + /// A class for the time to set, get, or calculate. /// /// 4 public class CalendarTime:IComparable @@ -34,22 +34,22 @@ namespace Tizen.Pims.Calendar public enum Type { /// - /// UTC time + /// UTC time. /// /// 4 Utc, /// - /// Local time + /// Local time. /// /// 4 Local } /// - /// Create UTC CalendarTime + /// Creates the UTC CalendarTime. /// /// 4 - /// UTC epoch time. 0 is 1971/01/01 + /// The UTC epoch time. 0 is 1971/01/01. public CalendarTime(long utcTime) { _type = (int)Type.Utc; @@ -58,15 +58,15 @@ namespace Tizen.Pims.Calendar } /// - /// Create Local CalendarTime + /// Creates the local CalendarTime /// /// 4 - /// year - /// month - /// day - /// hour - /// minute - /// second + /// The year. + /// The month. + /// The day. + /// The hour. + /// The minute. + /// The second. public CalendarTime(int year, int month, int day, int hour, int minute, int second) { _type = (int)Type.Local; @@ -74,30 +74,30 @@ namespace Tizen.Pims.Calendar } /// - /// Get UtcTime + /// Gets the UtcTime. /// /// 4 - /// The Utc time + /// The UTC time. public DateTime UtcTime { get; } /// - /// Get localTime + /// Gets the LocalTime /// /// 4 - /// The Localtime + /// The local time. public DateTime LocalTime { get; } /// - /// Compare CalendarTime + /// Compares the CalendarTime. /// /// 4 - /// The CalendarTime to be compared + /// The CalendarTime to be compared. /// /// A 32-bit signed integer that indicates the relative order of the objects being compared. /// @@ -116,10 +116,10 @@ namespace Tizen.Pims.Calendar } /// - /// Equals CalendarTime + /// Equals the CalendarTime. /// /// 4 - /// The CalendarTime to be compared + /// The CalendarTime to be compared. /// /// A 32-bit signed integer that indicates the relative order of the objects being compared. /// @@ -139,7 +139,7 @@ namespace Tizen.Pims.Calendar } /// - /// GetHashCode CalendarTime + /// The GetHashCode for the CalendarTime. /// /// 4 /// diff --git a/src/Tizen.Pims.Calendar/Tizen.Pims.Calendar/CalendarTypes.cs b/src/Tizen.Pims.Calendar/Tizen.Pims.Calendar/CalendarTypes.cs index d270021..e258340 100644 --- a/src/Tizen.Pims.Calendar/Tizen.Pims.Calendar/CalendarTypes.cs +++ b/src/Tizen.Pims.Calendar/Tizen.Pims.Calendar/CalendarTypes.cs @@ -17,74 +17,74 @@ namespace Tizen.Pims.Calendar { /// - /// This class provides enumerations about calendar information. + /// This class provides enumerations about the calendar information. /// /// 4 /// - /// Most enumerations are based on vcalendar, icalendar(ver 2.0) specification. + /// Most enumerations are based on vCalendar and iCalendar(ver 2.0) specification. /// https://www.ietf.org/rfc/rfc2445.txt /// public static class CalendarTypes { /// - /// Enumeration for Default book + /// Enumeration for the default books. /// /// 4 public enum DefaultBook { /// - /// Default event calendar book. + /// The default event calendar book. /// /// 4 Event, /// - /// Default Todo calendar book. + /// The default todo calendar book. /// /// 4 Todo, /// - /// Default Birthday calendar book. + /// The default birthday calendar book. /// /// 4 Birthday, } /// - /// Enumeration for Store type + /// Enumeration for the store types. /// /// 4 public enum StoreType { /// - /// Book type + /// Book type. /// /// 4 Book, /// - /// Event type + /// Event type. /// /// 4 Event, /// - /// Todo type + /// Todo type. /// /// 4 Todo, } /// - /// Enumeration for the book mode. + /// Enumeration for the book modes. /// /// 4 public enum BookMode { /// - /// All modules can read and write records of this calendar_book + /// All modules can read and write records of this calendar book. /// /// 4 Default, /// - /// All modules can only read records of this calendar book + /// All modules can only read records of this calendar book. /// /// 4 ReadOnly, @@ -97,55 +97,55 @@ namespace Tizen.Pims.Calendar public enum EventStatus { /// - /// No status + /// No status. /// /// 4 None = 0x01, /// - /// The event is tentative + /// The event is tentative. /// /// 4 Tentative = 0x02, /// - /// The event is confirmed + /// The event is confirmed. /// /// 4 Confirmed = 0x04, /// - /// The event is cancelled + /// The event is cancelled. /// /// 4 Cancelled = 0x08, } /// - /// Enumeration for for the status of a to-do. + /// Enumeration for the status of a to-do. /// /// 4 public enum TodoStatus { /// - /// No status + /// No status. /// /// 4 None = 0x0100, /// - /// Needs action status + /// Needs action status. /// /// 4 NeedAction = 0x0200, /// - /// Completed status + /// Completed status. /// /// 4 Completed = 0x0400, /// - /// Work in process status + /// Work in process status. /// /// 4 InProcess = 0x0800, /// - /// Cancelled status + /// Cancelled status. /// /// 4 Cancelled = 0x1000, @@ -158,22 +158,22 @@ namespace Tizen.Pims.Calendar public enum BusyStatus { /// - /// The free status + /// The free status. /// /// 4 Free, /// - /// The busy status + /// The busy status. /// /// 4 Busy, /// - /// The unavailable status + /// The unavailable status. /// /// 4 Unavailable, /// - /// The tentative status + /// The tentative status. /// /// 4 Tentative, @@ -186,17 +186,17 @@ namespace Tizen.Pims.Calendar public enum Sensitivity { /// - /// Public Sensitivity + /// Public sensitivity. /// /// 4 Public, /// - /// Private Sensitivity + /// Private sensitivity. /// /// 4 Private, /// - /// Confidential Sensitivity + /// Confidential sensitivity. /// /// 4 Confidential, @@ -209,50 +209,50 @@ namespace Tizen.Pims.Calendar public enum MeetingStatus { /// - /// No meeting + /// No meeting. /// /// 4 NoMeeting, /// - /// Meeting exists + /// Meeting exists. /// /// 4 Meeting, /// - /// Meeting received + /// Meeting received. /// /// 4 Received, /// - /// Meeting cancelled + /// Meeting canceled. /// /// 4 Cancelled, } /// - /// Enumeration for the calendar event item's priority + /// Enumeration for the calendar event item's priority. /// /// 4 public enum Priority { /// - /// No priority + /// No priority. /// /// 4 None = 0x01, /// - /// Low priority + /// Low priority. /// /// 4 High = 0x02, /// - /// Normal priority + /// Normal priority. /// /// 4 Normal = 0x04, /// - /// High priority + /// High priority. /// /// 4 Low = 0x08, @@ -265,73 +265,73 @@ namespace Tizen.Pims.Calendar public enum Recurrence { /// - /// No recurrence event + /// No recurrence event. /// /// 4 None, /// - /// An event occurs every day + /// An event occurs every day. /// /// 4 Daily, /// - /// An event occurs on the same day of every week. According to the week flag, the event will recur every day of the week + /// An event occurs on the same day of every week. According to the week flag, the event will recur every day of the week. /// /// 4 Weekly, /// - /// An event occurs on the same day of every month + /// An event occurs on the same day of every month. /// /// 4 Monthly, /// - /// An event occurs on the same day of every year + /// An event occurs on the same day of every year. /// /// 4 Yearly, } /// - /// Enumeration for the range type. + /// Enumeration for the range types. /// /// 4 public enum RangeType { /// - /// Range until + /// Range until. /// /// 4 Until, /// - /// Range count + /// Range count. /// /// 4 Count, /// - /// No range + /// No range. /// /// 4 None, } /// - /// Enumeration for the system type. + /// Enumeration for the system types. /// /// 4 public enum SystemType { /// - /// Locale's default calendar + /// Locale's default calendar. /// /// 4 Default, /// - /// Locale's default calendar + /// Locale's default calendar. /// /// 4 Gregorian, /// - /// East Asian lunisolar calendar + /// East Asian lunisolar calendar. /// /// 4 Lunisolar, @@ -344,32 +344,32 @@ namespace Tizen.Pims.Calendar public enum TickUnit { /// - /// No reminder set + /// No reminder set. /// /// 4 None = -1, /// - /// Specific in seconds + /// Specific in seconds. /// /// 4 Specific = 1, /// - /// Alarm time unit in minutes + /// Alarm time unit in minutes. /// /// 4 Minute = 60, /// - /// Alarm time unit in hours + /// Alarm time unit in hours. /// /// 4 Hour = 3600, /// - /// Alarm time unit in days + /// Alarm time unit in days. /// /// 4 Day = 86400, /// - /// Alarm time unit in weeks + /// Alarm time unit in weeks. /// /// 4 Week = 604800, @@ -382,98 +382,98 @@ namespace Tizen.Pims.Calendar public enum WeekDay { /// - /// Sunday + /// Sunday. /// /// 4 Sunday = 1, /// - /// Monday + /// Monday. /// /// 4 Monday, /// - /// Tuesday + /// Tuesday. /// /// 4 Tuesday, /// - /// Wednesday + /// Wednesday. /// /// 4 Wednesday, /// - /// Thursday + /// Thursday. /// /// 4 Thursday, /// - /// Friday + /// Friday. /// /// 4 Friday, /// - /// Saturday + /// Saturday. /// /// 4 Saturday, } /// - /// Enumeration to specify the type of calendar user specified by the property. + /// Enumeration to specify the type of calendar user, specified by the property. /// /// 4 public enum Cutype { /// - /// An individual + /// An individual. /// /// 4 Individual, /// - /// A group of individuals + /// A group of individuals. /// /// 4 Group, /// - /// A physical resource + /// A physical resource. /// /// 4 Resource, /// - /// A room resource + /// A room resource. /// /// 4 Room, /// - /// Otherwise not known + /// Otherwise not known. /// /// 4 Unknown, } /// - /// Enumeration for the attendee role. + /// Enumeration for the attendee roles. /// /// 4 public enum AttendeeRole { /// - /// Participation is required + /// Participation is required. /// /// 4 ReqParticipant, /// - /// Accepted status + /// Accepted status. /// /// 4 OptParticipant, /// - /// Non-Participant + /// Non-Participant. /// /// 4 NonParticipant, /// - /// Chairperson + /// Chairperson. /// /// 4 Chair, @@ -486,60 +486,60 @@ namespace Tizen.Pims.Calendar public enum AttendeeStatus { /// - /// Pending status + /// Pending status. /// /// 4 Pending, /// - /// Accepted status + /// Accepted status. /// /// 4 Accepted, /// - /// Declined status + /// Declined status. /// /// 4 Declined, /// - /// Tentative status + /// Tentative status. /// /// 4 Tentative, /// - /// Delegated status + /// Delegated status. /// /// 4 Delegated, /// - /// Completed status + /// Completed status. /// /// 4 Completed, /// - /// In process status + /// In process status. /// /// 4 InProcess, } /// - /// Enumeration for the alarm action. + /// Enumeration for the alarm actions. /// /// 4 public enum Action { /// - /// Audio action + /// Audio action. /// /// 4 Audio, /// - /// Display action + /// Display action. /// /// 4 Display, /// - /// Email action + /// Email action. /// /// 4 Email, diff --git a/src/Tizen.Pims.Calendar/Tizen.Pims.Calendar/CalendarVcalendar.cs b/src/Tizen.Pims.Calendar/Tizen.Pims.Calendar/CalendarVcalendar.cs index 272fa28..b6b5c57 100644 --- a/src/Tizen.Pims.Calendar/Tizen.Pims.Calendar/CalendarVcalendar.cs +++ b/src/Tizen.Pims.Calendar/Tizen.Pims.Calendar/CalendarVcalendar.cs @@ -19,31 +19,31 @@ using System; namespace Tizen.Pims.Calendar { /// - /// Parsing vcalendar file callback function. + /// Parsing the vCalendar file callback function. /// - /// The record - /// true to continue with the next iteration of the loop, otherwise false to break out of the loop + /// The record. + /// true to continue with the next iteration of the loop, otherwise false to break out of the loop. /// 4 public delegate bool ParseCallback(CalendarRecord record); /// - /// A class for parsing and composing vCalendar. + /// A class for parsing and composing the vCalendar. /// /// - /// It's based on the vCalendar v2.0 specification + /// It's based on the vCalendar v2.0 specification. /// /// 4 public static class CalendarVcalendar { /// - /// Retrieves a vcalendar stream from a calendar list. + /// Retrieves a vCalendar stream from a calendar list. /// - /// The calendar list + /// The calendar list. /// /// The composed stream. /// - /// Thrown when one of the arguments provided to a method is not valid - /// Thrown when failed due to out of memory + /// Thrown when one of the arguments provided to a method is not valid. + /// Thrown when failed due to out of memory. /// 4 public static string Compose(CalendarList list) { @@ -58,14 +58,14 @@ namespace Tizen.Pims.Calendar } /// - /// Retrieves all calendars from a vcalendar stream. + /// Retrieves all the calendars from a vCalendar stream. /// - /// The vcalendar stream + /// The vCalendar stream. /// - /// the record list + /// The record list. /// - /// Thrown when one of the arguments provided to a method is not valid - /// Thrown when failed due to out of memory + /// Thrown when one of the arguments provided to a method is not valid. + /// Thrown when failed due to out of memory. /// 4 public static CalendarList Parse(string stream) { @@ -81,13 +81,13 @@ namespace Tizen.Pims.Calendar } /// - /// Parse vcalendar file with ForEach + /// Parses the vCalendar file with ForEach. /// - /// The file path of the vCalendar stream file - /// he callback function to invoke - /// Thrown when method failed due to invalid operation - /// Thrown when one of the arguments provided to a method is not valid - /// Thrown when failed due to out of memory + /// The file path of the vCalendar stream file. + /// The callback function to invoke. + /// Thrown when the method failed due to an invalid operation. + /// Thrown when one of the arguments provided to a method is not valid. + /// Thrown when failed due to out of memory. /// 4 public static void ParseForEach(string path, ParseCallback callback) { diff --git a/src/Tizen.Pims.Calendar/Tizen.Pims.Calendar/CalendarViews.cs b/src/Tizen.Pims.Calendar/Tizen.Pims.Calendar/CalendarViews.cs index a26a4f0..5b34d72 100644 --- a/src/Tizen.Pims.Calendar/Tizen.Pims.Calendar/CalendarViews.cs +++ b/src/Tizen.Pims.Calendar/Tizen.Pims.Calendar/CalendarViews.cs @@ -334,202 +334,202 @@ namespace Tizen.Pims.Calendar } /// - /// Describes properties of a Book record. + /// Describes the properties of a Book record. /// /// 4 public static class Book { /// - /// Identifier of this calendar book view + /// Identifier of this calendar book view. /// /// 4 public const string Uri = "tizen.calendar_view.book"; /// - /// DB record ID of the calendar book + /// Database record ID of the calendar book. /// /// 4 public const uint Id = (uint)Property.Id.BookId; /// - /// Unique identifier + /// Unique identifier. /// /// 4 public const uint Uid = (uint)Property.Id.BookUid; /// - /// Calendar book name + /// Calendar book name. /// /// 4 public const uint Name = (uint)Property.Id.BookName; /// - /// Calendar book description + /// Calendar book description. /// /// 4 public const uint Description = (uint)Property.Id.BookDescription; /// - /// Calendar book color for UX + /// Calendar book color for UX. /// /// 4 public const uint Color = (uint)Property.Id.BookColor; /// - /// Location of the event + /// Location of the event. /// /// 4 public const uint Location = (uint)Property.Id.BookLocation; /// - /// Visibility of the calendar book for UX + /// Visibility of the calendar book for UX. /// /// 4 public const uint Visibility = (uint)Property.Id.BookVisibility; /// - /// Currently NOT Used + /// Currently not used. /// /// 4 public const uint SyncEvent = (uint)Property.Id.BookSyncEvent; /// - /// Account for this calendar + /// Account for this calendar. /// /// 4 public const uint AccountId = (uint)Property.Id.BookAccountId; /// - /// Type of calendar contents(refer to the CalendarTypes.StoreType) + /// Type of calendar contents (refer to the CalendarTypes.StoreType). /// /// 4 public const uint StoreType = (uint)Property.Id.BookStoreType; /// - /// Generic data for use by syncing + /// Generic data for use by syncing. /// /// 4 public const uint SyncData1 = (uint)Property.Id.BookSyncData1; /// - /// Generic data for use by syncing + /// Generic data for use by syncing. /// /// 4 public const uint SyncData2 = (uint)Property.Id.BookSyncData2; /// - /// Generic data for use by syncing + /// Generic data for use by syncing. /// /// 4 public const uint SyncData3 = (uint)Property.Id.BookSyncData3; /// - /// Generic data for use by syncing + /// Generic data for use by syncing. /// /// 4 public const uint SyncData4 = (uint)Property.Id.BookSyncData4; /// - /// Calendar book mode(refer to the CalendarTypes.BookMode) + /// Calendar book mode (refer to the CalendarTypes.BookMode). /// /// 4 public const uint Mode = (uint)Property.Id.BookMode; } /// - /// Describes properties of a Event record. + /// Describes the properties of a Event record. /// /// 4 [SuppressMessage("Microsoft.Naming", "CA1716:IdentifiersShouldNotMatchKeywords")] public static class Event { /// - /// Identifier of this event view + /// Identifier of this event view. /// /// 4 public const string Uri = "tizen.calendar_view.event"; /// - /// DB record ID of the event + /// Database record ID of the event. /// /// 4 public const uint Id = (uint)Property.Id.EventId; /// - /// ID of the calendar book to which the event belongs + /// ID of the calendar book to which the event belongs. /// /// 4 public const uint BookId = (uint)Property.Id.EventBookId; /// - /// The short description of the event + /// The short description of the event. /// /// 4 public const uint Summary = (uint)Property.Id.EventSummary; /// - /// The description of the event + /// The description of the event. /// /// 4 public const uint Description = (uint)Property.Id.EventDescription; /// - /// The location of the event + /// The location of the event. /// /// 4 public const uint Location = (uint)Property.Id.EventLocation; /// - /// The category of the event. For example APPOINTMENT, BIRTHDAY + /// The category of the event. For example, appointment, birthday. /// /// 4 public const uint Categories = (uint)Property.Id.EventCategories; /// - /// The exception list of the event. If this event has a recurrence rule, the instance of the exdate is removed. Format is "YYYYMMDD"(allday event) or "YYYYMMDDTHHMMSS". Multiple exceptions can be included with a comma + /// The exception list of the event. If this event has a recurrence rule, the instance of the exdate is removed. Format is "YYYYMMDD"(allday event) or "YYYYMMDDTHHMMSS". Multiple exceptions can be included with a comma. /// /// 4 public const uint Exdate = (uint)Property.Id.EventExdate; /// - /// The status of event(refer to the CalendarTypes.EventStatus). + /// The status of event (refer to the CalendarTypes.EventStatus). /// /// 4 public const uint EventStatus = (uint)Property.Id.EventEventStatus; /// - /// The priority of event(refer to the CalendarTypes.Priority). + /// The priority of event (refer to the CalendarTypes.Priority). /// /// 4 public const uint Priority = (uint)Property.Id.EventPriority; /// - /// The timezone_id of the event if it exists. + /// The timezone_id of the event, if it exists. /// /// 4 public const uint Timezone = (uint)Property.Id.EventTimezone; /// - /// The person_id of the event if the event is a birthday. Refer to the contacts-service + /// The person_id of the event if the event is a birthday. Refer to the contacts-service. /// /// 4 public const uint ContactId = (uint)Property.Id.EventContactId; /// - /// The busy status of event(refer to the CalendarTypes.BusyStatus). + /// The busy status of event (refer to the CalendarTypes.BusyStatus). /// /// 4 public const uint BusyStatus = (uint)Property.Id.EventBusyStatus; /// - /// The Sensitivity of event(refer to the CalendarTypes.Sensitivity). + /// The sensitivity of event (refer to the CalendarTypes.Sensitivity). /// /// 4 public const uint Sensitivity = (uint)Property.Id.EventSensitivity; /// - /// The unique ID of the event + /// The unique ID of the event. /// /// 4 public const uint Uid = (uint)Property.Id.EventUid; /// - /// The name of organizer of the event + /// The name of organizer of the event. /// /// 4 public const uint OrganizerName = (uint)Property.Id.EventOrganizerName; /// - /// The email address of the organizer of the event + /// The email address of the organizer of the event. /// /// 4 public const uint OrganizerEmail = (uint)Property.Id.EventOrganizerEmail; /// - /// The meeting status of event(refer to the CalendarTypes.MeetingStatus). + /// The meeting status of event (refer to the CalendarTypes.MeetingStatus). /// /// 4 public const uint MeetingStatus = (uint)Property.Id.EventMeetingStatus; /// - /// The ID of the original event if the event is an exception. + /// The ID of the original event, if the event is an exception. /// /// 4 public const uint OriginalEventId = (uint)Property.Id.EventOriginalEventId; /// - /// The latitude of the location of the event + /// The latitude of the location of the event. /// /// 4 public const uint Latitude = (uint)Property.Id.EventLatitude; /// - /// The longitude of the location of the event + /// The longitude of the location of the event. /// /// 4 public const uint Longitude = (uint)Property.Id.EventLongitude; @@ -539,27 +539,27 @@ namespace Tizen.Pims.Calendar /// 4 public const uint EmailId = (uint)Property.Id.EventEmailId; /// - /// The time when the event is created + /// The time when the event is created. /// /// 4 public const uint CreatedTime = (uint)Property.Id.EventCreatedTime; /// - /// The time when the event is updated + /// The time when the event is updated. /// /// 4 public const uint LastModifiedTime = (uint)Property.Id.EventLastModifiedTime; /// - /// Whether or not the event is deleted + /// Whether or not the event is deleted. /// /// 4 public const uint IsDeleted = (uint)Property.Id.EventIsDeleted; /// - /// The frequent type of event recurrence(refer to the CalendarTypes.Recurrence). + /// The frequent type of event recurrence (refer to the CalendarTypes.Recurrence). /// /// 4 public const uint Freq = (uint)Property.Id.EventFreq; /// - /// The range type of event recurrence(refer to the CalendarTypes.RangeType). + /// The range type of event recurrence (refer to the CalendarTypes.RangeType). /// /// 4 public const uint RangeType = (uint)Property.Id.EventRangeType; @@ -574,22 +574,22 @@ namespace Tizen.Pims.Calendar /// 4 public const uint Count = (uint)Property.Id.EventCount; /// - /// The interval of the event recurrence + /// The interval of the event recurrence. /// /// 4 public const uint Interval = (uint)Property.Id.EventInterval; /// - /// The second list of the event recurrence. The value can be from 0 to 59. The list is separated by comma + /// The second list of the event recurrence. The value can be from 0 to 59. The list is separated by commas. /// /// 4 public const uint Bysecond = (uint)Property.Id.EventBysecond; /// - /// The minute list of the event recurrence. The value can be from 0 to 59. The list is separated by commas + /// The minute list of the event recurrence. The value can be from 0 to 59. The list is separated by commas. /// /// 4 public const uint Byminute = (uint)Property.Id.EventByminute; /// - /// The hour list of the event recurrence. The value can be from 0 to 23. The list is separated by commas + /// The hour list of the event recurrence. The value can be from 0 to 23. The list is separated by commas. /// /// 4 public const uint Byhour = (uint)Property.Id.EventByhour; @@ -604,77 +604,77 @@ namespace Tizen.Pims.Calendar /// 4 public const uint Bymonthday = (uint)Property.Id.EventBymonthday; /// - /// The year day list of the event recurrence. The value can be from 1 to 366 and from -366 to -1. The list is separated by commas + /// The year day list of the event recurrence. The value can be from 1 to 366 and from -366 to -1. The list is separated by commas. /// /// 4 public const uint Byyearday = (uint)Property.Id.EventByyearday; /// - /// The week number list of the event recurrence. The value can be from 1 to 53 and from -53 to -1. The list is separated by commas + /// The week number list of the event recurrence. The value can be from 1 to 53 and from -53 to -1. The list is separated by commas. /// /// 4 public const uint Byweekno = (uint)Property.Id.EventByweekno; /// - /// The month list of the event recurrence. The value can be from 1 to 12. The list is separated by commas + /// The month list of the event recurrence. The value can be from 1 to 12. The list is separated by commas. /// /// 4 public const uint Bymonth = (uint)Property.Id.EventBymonth; /// - /// The position list of the event recurrence. The value can be from 1 to 366 and from -366 to -1. The list is separated by commas + /// The position list of the event recurrence. The value can be from 1 to 366 and from -366 to -1. The list is separated by commas. /// /// 4 public const uint Bysetpos = (uint)Property.Id.EventBysetpos; /// - /// The start day of the week(refer to the CalendarTypes.WeekDay). + /// The start day of the week (refer to the CalendarTypes.WeekDay). /// /// 4 public const uint Wkst = (uint)Property.Id.EventWkst; /// - /// RECURRENCE-ID of RFC #2445 + /// RECURRENCE-ID of RFC #2445. /// /// 4 public const uint RecurrenceId = (uint)Property.Id.EventRecurrenceId; /// - /// RDATE of RFC #2445 + /// RDATE of RFC #2445. /// /// 4 public const uint Rdate = (uint)Property.Id.EventRdate; /// - /// Whether or not the event has an attendee list + /// Whether or not the event has an attendee list. /// /// 4 public const uint HasAttendee = (uint)Property.Id.EventHasAttendee; /// - /// Whether or not the event has an alarm list + /// Whether or not the event has an alarm list. /// /// 4 public const uint HasAlarm = (uint)Property.Id.EventHasAlarm; /// - /// The sync data of the event. If developer need to save some information related to the event, they can use this property + /// The sync data of the event. If the developers need to save some information related to the event, they can use this property. /// /// 4 public const uint SyncData1 = (uint)Property.Id.EventSyncData1; /// - /// The sync data of the event. If developer need to save some information related to the event, they can use this property + /// The sync data of the event. If the developers need to save some information related to the event, they can use this property. /// /// 4 public const uint SyncData2 = (uint)Property.Id.EventSyncData2; /// - /// The sync data of the event. If developer need to save some information related to the event, they can use this property + /// The sync data of the event. If the developers need to save some information related to the event, they can use this property. /// /// 4 public const uint SyncData3 = (uint)Property.Id.EventSyncData3; /// - /// The sync data of the event. If developer need to save some information related to the event, they can use this property + /// The sync data of the event. If the developers need to save some information related to the event, they can use this property. /// /// 4 public const uint SyncData4 = (uint)Property.Id.EventSyncData4; /// - /// The start time of the event + /// The start time of the event. /// /// 4 public const uint Start = (uint)Property.Id.EventStart; /// - /// The end time of the event + /// The end time of the event. /// /// 4 public const uint End = (uint)Property.Id.EventEnd; @@ -689,22 +689,22 @@ namespace Tizen.Pims.Calendar /// 4 public const uint Attendee = (uint)Property.Id.EventAttendee; /// - /// The Calendar system type(refer to the CalendarTypes.SystemType). + /// The calendar system type (refer to the CalendarTypes.SystemType). /// /// 4 public const uint CalendarSystemType = (uint)Property.Id.EventCalendarSystemType; /// - /// The timezone of the start_time + /// The timezone of the start_time. /// /// 4 public const uint StartTzid = (uint)Property.Id.EventStartTzid; /// - /// The timezone of the end_time + /// The timezone of the end_time. /// /// 4 public const uint EndTzid = (uint)Property.Id.EventEndTzid; /// - /// The exception mod event list of the event + /// The exception mod event list of the event. /// /// 4 public const uint Exception = (uint)Property.Id.EventException; @@ -714,130 +714,130 @@ namespace Tizen.Pims.Calendar /// 4 public const uint Extended = (uint)Property.Id.EventExtended; /// - /// The event is an allday event or not + /// The event is an allday event or not. /// /// 4 public const uint IsAllday = (uint)Property.Id.EventIsAllday; /// - /// The linked event count + /// The linked event count. /// /// 4 public const uint LinkCount = (uint)Property.Id.EventLinkCount; /// - /// The event is an base linked event + /// The event is an base linked event. /// /// 4 public const uint LinkBaseId = (uint)Property.Id.EventLinkBaseId; } /// - /// Describes properties of a Todo record. + /// Describes the properties of a Todo record. /// /// 4 public static class Todo { /// - /// Identifier of this todo view + /// Identifier of this todo view. /// /// 4 public const string Uri = "tizen.calendar_view.todo"; /// - /// DB record ID of the todo + /// Database record ID of the todo. /// /// 4 public const uint Id = (uint)Property.Id.TodoId; /// - /// ID of the calendar book to which the todo belongs + /// ID of the calendar book to which the todo belongs to. /// /// 4 public const uint BookId = (uint)Property.Id.TodoBookId; /// - /// The short description of the todo + /// The short description of the todo. /// /// 4 public const uint Summary = (uint)Property.Id.TodoSummary; /// - /// The description of the todo + /// The description of the todo. /// /// 4 public const uint Description = (uint)Property.Id.TodoDescription; /// - /// The location of the todo + /// The location of the todo. /// /// 4 public const uint Location = (uint)Property.Id.TodoLocation; /// - /// The category of the todo. i.g. APPOINTMENT, BIRTHDAY + /// The category of the todo. For example, APPOINTMENT, BIRTHDAY. /// /// 4 public const uint Categories = (uint)Property.Id.TodoCategories; /// - /// The status of todo(refer to the CalendarTypes.TodoStatus). + /// The status of the todo (refer to the CalendarTypes.TodoStatus). /// /// 4 public const uint TodoStatus = (uint)Property.Id.TodoStatus; /// - /// The Priority of todo(refer to the CalendarTypes.Priority). + /// The priority of the todo (refer to the CalendarTypes.Priority). /// /// 4 public const uint Priority = (uint)Property.Id.TodoPriority; /// - /// The Sensitivity of todo(refer to the CalendarTypes.Sensitivity). + /// The sensitivity of the todo (refer to the CalendarTypes.Sensitivity). /// /// 4 public const uint Sensitivity = (uint)Property.Id.TodoSensitivity; /// - /// The unique ID of the todo + /// The unique ID of the todo. /// /// 4 public const uint Uid = (uint)Property.Id.TodoUid; /// - /// The latitude of the location of the todo + /// The latitude of the location of the todo. /// /// 4 public const uint Latitude = (uint)Property.Id.TodoLatitude; /// - /// The longitude of the location of the todo + /// The longitude of the location of the todo. /// /// 4 public const uint Longitude = (uint)Property.Id.TodoLongitude; /// - /// The progression of the todo. The value can be from 0 to 100 + /// The progression of the todo. The value can be from 0 to 100. /// /// 4 public const uint Progress = (uint)Property.Id.TodoProgress; /// - /// The time when the todo is create + /// The time when the todo is created. /// /// 4 public const uint CreatedTime = (uint)Property.Id.TodoCreatedTime; /// - /// The time when the todo is updated + /// The time when the todo is updated. /// /// 4 public const uint LastModifiedTime = (uint)Property.Id.TodoLastModifiedTime; /// - /// The time when the todo is completed + /// The time when the todo is completed. /// /// 4 public const uint CompletedTime = (uint)Property.Id.TodoCompletedTime; /// - /// Whether or not the todo is deleted + /// Whether or not the todo is deleted. /// /// 4 public const uint IsDeleted = (uint)Property.Id.TodoIsDeleted; /// - /// The frequent type of todo recurrence(refer to the CalendarTypes.Recurrence). + /// The frequent type of the todo recurrence (refer to the CalendarTypes.Recurrence). /// /// 4 public const uint Freq = (uint)Property.Id.TodoFreq; /// - /// The range type of todo recurrence(refer to the CalendarTypes.RangeType). + /// The range type of the todo recurrence (refer to the CalendarTypes.RangeType). /// /// 4 public const uint RangeType = (uint)Property.Id.TodoRangeType; /// - /// The end time of the todo recurrence. Only if this is used with RangeType.Until. + /// The end time of the todo recurrence. Only if this is used with RangeType.Until.. /// /// 4 public const uint Until = (uint)Property.Id.TodoUntil; @@ -847,92 +847,92 @@ namespace Tizen.Pims.Calendar /// 4 public const uint Count = (uint)Property.Id.TodoCount; /// - /// The interval of the todo recurrence + /// The interval of the todo recurrence. /// /// 4 public const uint Interval = (uint)Property.Id.TodoInterval; /// - /// The second list of the todo recurrence. The value can be from 0 to 59. The list is separated by commas + /// The second list of the todo recurrence. The value can be from 0 to 59. The list is separated by commas. /// /// 4 public const uint Bysecond = (uint)Property.Id.TodoBysecond; /// - /// The minute list of the todo recurrence. The value can be from 0 to 59. The list is separated by commas + /// The minute list of the todo recurrence. The value can be from 0 to 59. The list is separated by commas. /// /// 4 public const uint Byminute = (uint)Property.Id.TodoByminute; /// - /// The hour list of the todo recurrence. The value can be from 0 to 23. The list is separated by commas + /// The hour list of the todo recurrence. The value can be from 0 to 23. The list is separated by commas. /// /// 4 public const uint Byhour = (uint)Property.Id.TodoByhour; /// - /// The day list of the todo recurrence. The value can be SU, MO, TU, WE, TH, FR, SA. The list is separated by commas + /// The day list of the todo recurrence. The value can be SU, MO, TU, WE, TH, FR, SA. The list is separated by commas. /// /// 4 public const uint Byday = (uint)Property.Id.TodoByday; /// - /// The month day list of the todo recurrence. The value can be from 1 to 31 and from -31 to -1. The list is separated by commas + /// The month day list of the todo recurrence. The value can be from 1 to 31 and from -31 to -1. The list is separated by commas. /// /// 4 public const uint Bymonthday = (uint)Property.Id.TodoBymonthday; /// - /// The year day list of the todo recurrence. The value can be from 1 to 366 and from -366 to -1. The list is separated by commas + /// The year day list of the todo recurrence. The value can be from 1 to 366 and from -366 to -1. The list is separated by commas. /// /// 4 public const uint Byyearday = (uint)Property.Id.TodoByyearday; /// - /// The week number list of the todo recurrence. The value can be from 1 to 53 and from -53 to -1. The list is separated by commas + /// The week number list of the todo recurrence. The value can be from 1 to 53 and from -53 to -1. The list is separated by commas. /// /// 4 public const uint Byweekno = (uint)Property.Id.TodoByweekno; /// - /// The month list of the todo recurrence. The value can be from 1 to 12. The list is separated by commas + /// The month list of the todo recurrence. The value can be from 1 to 12. The list is separated by commas. /// /// 4 public const uint Bymonth = (uint)Property.Id.TodoBymonth; /// - /// The position list of the todo recurrence. The value can be from 1 to 366 and from -366 to -1. The list is separated by commas + /// The position list of the todo recurrence. The value can be from 1 to 366 and from -366 to -1. The list is separated by commas. /// /// 4 public const uint Bysetpos = (uint)Property.Id.TodoBysetpos; /// - /// The start day of the week(refer to the CalendarTypes.WeekDay). + /// The start day of the week (refer to the CalendarTypes.WeekDay). /// /// 4 public const uint Wkst = (uint)Property.Id.TodoWkst; /// - /// Whether or not the todo has an alarm list + /// Whether or not the todo has an alarm list. /// /// 4 public const uint HasAlarm = (uint)Property.Id.TodoHasAlarm; /// - /// The sync data of the todo. If developers need to save some information related to the todo, they can use this property + /// The sync data of the todo. If the developers need to save some information related to the todo, they can use this property. /// /// 4 public const uint SyncData1 = (uint)Property.Id.TodoSyncData1; /// - /// The sync data of the todo. If developers need to save some information related to the todo, they can use this property + /// The sync data of the todo. If the developers need to save some information related to the todo, they can use this property. /// /// 4 public const uint SyncData2 = (uint)Property.Id.TodoSyncData2; /// - /// The sync data of the todo. If developers need to save some information related to the todo, they can use this property + /// The sync data of the todo. If the developers need to save some information related to the todo, they can use this property. /// /// 4 public const uint SyncData3 = (uint)Property.Id.TodoSyncData3; /// - /// The sync data of the todo. If developers need to save some information related to the todo, they can use this property + /// The sync data of the todo. If the developers need to save some information related to the todo, they can use this property. /// /// 4 public const uint SyncData4 = (uint)Property.Id.TodoSyncData4; /// - /// The start time of the todo + /// The start time of the todo. /// /// 4 public const uint Start = (uint)Property.Id.TodoStart; /// - /// The due time of the todo + /// The due time of the todo. /// /// 4 public const uint Due = (uint)Property.Id.TodoDue; @@ -942,27 +942,27 @@ namespace Tizen.Pims.Calendar /// 4 public const uint Alarm = (uint)Property.Id.TodoAlarm; /// - /// The timezone of the start_time + /// The timezone of the start_time. /// /// 4 public const uint StartTzid = (uint)Property.Id.TodoStartTzid; /// - /// The timezone of the due_time + /// The timezone of the due_time. /// /// 4 public const uint DueTzid = (uint)Property.Id.TodoDueTzid; /// - /// The name of the organizer of the event + /// The name of the organizer of the event. /// /// 4 public const uint OrganizerName = (uint)Property.Id.TodoOrganizerName; /// - /// The email address of the organizer of the todo + /// The email address of the organizer of the todo. /// /// 4 public const uint OrganizerEmail = (uint)Property.Id.TodoOrganizerEmail; /// - /// Whether or not the todo has an attendee list + /// Whether or not the todo has an attendee list. /// /// 4 public const uint HasAttendee = (uint)Property.Id.TodoHasAttendee; @@ -977,741 +977,741 @@ namespace Tizen.Pims.Calendar /// 4 public const uint Extended = (uint)Property.Id.TodoExtended; /// - /// The todo is an allday event or not + /// The todo is an allday event or not. /// /// 4 public const uint IsAllday = (uint)Property.Id.TodoIsAllday; } /// - /// Describes properties of a Timezone record. + /// Describes the properties of a timezone record. /// /// 4 public static class Timezone { /// - /// Identifier of this timezone view + /// Identifier of this timezone view. /// /// 4 public const string Uri = "tizen.calendar_view.timezone"; /// - /// DB record ID of the timezone + /// Database record ID of the timezone. /// /// 4 public const uint Id = (uint)Property.Id.TimezoneId; /// - /// UTC offset which is in use when the onset of this time zone observance begins. Valid values are -720(-12:00) to 840(+14:00) + /// UTC offset, which is in use when the onset of this time zone observance begins. Valid values are -720(-12:00) to 840(+14:00). /// /// 4 public const uint TzOffsetFromGmt = (uint)Property.Id.TimezoneTzOffsetFromGmt; /// - /// Name of the Standard Time + /// Name of the standard time. /// /// 4 public const uint StandardName = (uint)Property.Id.TimezoneStandardName; /// - /// Starting month of the Standard Time. Month is 0-based. eg, 0 for January + /// Starting month of the standard time. Month is 0-based. For example, 0 for January. /// /// 4 public const uint StdStartMonth = (uint)Property.Id.TimezoneStdStartMonth; /// - /// Starting day-of-week-in-month of the Standard Time. Day is 1-based + /// Starting day-of-week-in-month of the standard time. Day is 1-based. /// /// 4 public const uint StdStartPositionOfWeek = (uint)Property.Id.TimezoneStdStartPositionOfWeek; /// - /// Starting day-of-week of the Standard Time. Valid values are 1(SUNDAY) to 7(SATURDAY) + /// Starting day-of-week of the standard time. Valid values are 1 (SUNDAY) to 7 (SATURDAY). /// /// 4 public const uint StdStartDay = (uint)Property.Id.TimezoneStdStartDay; /// - /// Starting hour of the Standard Time. Valid values are 0 to 23 + /// Starting hour of the standard time. Valid values are 0 to 23. /// /// 4 public const uint StdStartHour = (uint)Property.Id.TimezoneStdStartHour; /// - /// The number of minutes added during the Standard Time + /// The number of minutes added during the standard time. /// /// 4 public const uint StandardBias = (uint)Property.Id.TimezoneStandardBias; /// - /// Name of Daylight + /// Name of the Daylight. /// /// 4 public const uint DayLightName = (uint)Property.Id.TimezoneDayLightName; /// - /// Starting month of Daylight. Month is 0-based. eg, 0 for January + /// Starting month of the Daylight. Month is 0-based. For example, 0 for January. /// /// 4 public const uint DayLightStartMonth = (uint)Property.Id.TimezoneDayLightStartMonth; /// - /// Starting day-of-week-in-month of Daylight. Day is 1-based + /// Starting day-of-week-in-month of the Daylight. Day is 1-based. /// /// 4 public const uint DayLightStartPositionOfWeek = (uint)Property.Id.TimezoneDayLightStartPositionOfWeek; /// - /// Starting day-of-week of Daylight. Valid values are 1(SUNDAY) to 7(SATURDAY) + /// Starting day-of-week of the Daylight. Valid values are 1 (SUNDAY) to 7 (SATURDAY). /// /// 4 public const uint DayLightStartDay = (uint)Property.Id.TimezoneDayLightStartDay; /// - /// Starting hour of Daylight. Valid values are 0 to 23 + /// Starting hour of the Daylight. Valid values are 0 to 23. /// /// 4 public const uint DayLightStartHour = (uint)Property.Id.TimezoneDayLightStartHour; /// - /// The number of minutes added during Daylight Time + /// The number of minutes added during the Daylight time. /// /// 4 public const uint DayLightBias = (uint)Property.Id.TimezoneDayLightBias; /// - /// DB record ID of a related calendar book + /// Database record ID of a related calendar book. /// /// 4 public const uint CalendarId = (uint)Property.Id.TimezoneCalendarId; } /// - /// Describes properties of a Attendee record. + /// Describes the properties of an Attendee record. /// /// 4 public static class Attendee { /// - /// Identifier of this calendar attendee view + /// Identifier of this calendar attendee view. /// /// 4 public const string Uri = "tizen.calendar_view.attendee"; /// - /// The number of the attendee + /// The number of the attendee. /// /// 4 public const uint Number = (uint)Property.Id.AttendeeNumber; /// - /// The type of attendee(refer to the CalendarTypes.Cutype). + /// The type of attendee (refer to the CalendarTypes.Cutype). /// /// 4 public const uint Cutype = (uint)Property.Id.AttendeeCutype; /// - /// CtIndex + /// CtIndex. /// /// 4 public const uint CtIndex = (uint)Property.Id.AttendeeCtIndex; /// - /// Unique identifier + /// Unique identifier. /// /// 4 public const uint Uid = (uint)Property.Id.AttendeeUid; /// - /// Group + /// Group. /// /// 4 public const uint Group = (uint)Property.Id.AttendeeGroup; /// - /// The email address of the attendee + /// The email address of the attendee. /// /// 4 public const uint Email = (uint)Property.Id.AttendeeEmail; /// - /// Attendee role(refer to the CalendarTypes.AttendeeRole). + /// Attendee role (refer to the CalendarTypes.AttendeeRole). /// /// 4 public const uint Role = (uint)Property.Id.AttendeeRole; /// - /// Attendee status(refer to the CalendarTypes.AttendeeStatus). + /// Attendee status (refer to the CalendarTypes.AttendeeStatus). /// /// 4 public const uint Status = (uint)Property.Id.AttendeeStatus; /// - /// RSVP invitation reply (one of true, false) + /// RSVP invitation reply (one of true, false). /// /// 4 public const uint Rsvp = (uint)Property.Id.AttendeeRsvp; /// - /// Delegatee (DELEGATED-TO) + /// Delegatee (DELEGATED-TO). /// /// 4 public const uint DelegateeUri = (uint)Property.Id.AttendeeDelegateeUri; /// - /// Delegator (DELEGATED-FROM) + /// Delegator (DELEGATED-FROM). /// /// 4 public const uint DelegatorUri = (uint)Property.Id.AttendeeDelegatorUri; /// - /// Attendee name + /// Attendee name. /// /// 4 public const uint Name = (uint)Property.Id.AttendeeName; /// - /// Group that the attendee belongs to + /// Group that the attendee belongs to. /// /// 4 public const uint Member = (uint)Property.Id.AttendeeMember; /// - /// Event/TODO that the attendee belongs to + /// Event/TODO that the attendee belongs to. /// /// 4 public const uint ParentId = (uint)Property.Id.AttendeeParentId; } /// - /// Describes properties of a Alarm record. + /// Describes the properties of an Alarm record. /// /// 4 public static class Alarm { /// - /// Identifier of this calendar alarm view + /// Identifier of this calendar alarm view. /// /// 4 public const string Uri = "tizen.calendar_view.alarm"; /// - /// The number of unit before start time. This MUST be used with one of TickUnit. + /// The number of unit before start time. This must be used with one of TickUnit. /// /// 4 public const uint Tick = (uint)Property.Id.AlarmTick; /// - /// Reminder tick time unit(refer to the CalendarTypes.TickUnit). + /// Reminder tick time unit (refer to the CalendarTypes.TickUnit). /// /// 4 public const uint TickUnit = (uint)Property.Id.AlarmTickUnit; /// - /// Alarm description + /// Alarm description. /// /// 4 public const uint Description = (uint)Property.Id.AlarmDescription; /// - /// Event that the alarm belongs to + /// Event that the alarm belongs to. /// /// 4 public const uint ParentId = (uint)Property.Id.AlarmParentId; /// - /// Alarm summary + /// Alarm summary. /// /// 4 public const uint Summary = (uint)Property.Id.AlarmSummary; /// - /// Action of alarm(refer to the CalendarTypes.Action). + /// Action of alarm (refer to the CalendarTypes.Action). /// /// 4 public const uint Action = (uint)Property.Id.AlarmAction; /// - /// Alarm tone path + /// Alarm tone path. /// /// 4 public const uint Attach = (uint)Property.Id.AlarmAttach; /// - /// The alarm time + /// The alarm time. /// /// 4 public const uint AlarmTime = (uint)Property.Id.AlarmAlarm; } /// - /// Describes properties of a InstanceUtimeBook record. + /// Describes the properties of an InstanceUtimeBook record. /// /// 4 - /// Read only view + /// Read only view. public static class InstanceUtimeBook { /// - /// Identifier of this instance utime book + /// Identifier of this instance utime book. /// /// 4 public const string Uri = "tizen.calendar_view.instance_utime/book"; /// - /// Event id + /// Event ID. /// /// 4 public const uint EventId = (uint)Property.Id.InstanceUtimeBookEventId; /// - /// Start time + /// Start time. /// /// 4 public const uint Start = (uint)Property.Id.InstanceUtimeBookStart; /// - /// End time + /// End time. /// /// 4 public const uint End = (uint)Property.Id.InstanceUtimeBookEnd; /// - /// Summary + /// Summary. /// /// 4 public const uint Summary = (uint)Property.Id.InstanceUtimeBookSummary; /// - /// Location + /// Location. /// /// 4 public const uint Location = (uint)Property.Id.InstanceUtimeBookLocation; /// - /// Book id + /// Book ID. /// /// 4 public const uint BookId = (uint)Property.Id.InstanceUtimeBookBookId; /// - /// Description + /// Description. /// /// 4 public const uint Description = (uint)Property.Id.InstanceUtimeBookDescription; /// - /// BusyStatus + /// BusyStatus. /// /// 4 public const uint BusyStatus = (uint)Property.Id.InstanceUtimeBookBusyStatus; /// - /// EventStatus + /// EventStatus. /// /// 4 public const uint EventStatus = (uint)Property.Id.InstanceUtimeBookEventStatus; /// - /// Priority + /// Priority. /// /// 4 public const uint Priority = (uint)Property.Id.InstanceUtimeBookPriority; /// - /// Sensitivity + /// Sensitivity. /// /// 4 public const uint Sensitivity = (uint)Property.Id.InstanceUtimeBookSensitivity; /// - /// HasRrule + /// HasRrule. /// /// 4 public const uint HasRrule = (uint)Property.Id.InstanceUtimeBookHasRrule; /// - /// Latitude + /// Latitude. /// /// 4 public const uint Latitude = (uint)Property.Id.InstanceUtimeBookLatitude; /// - /// Longitude + /// Longitude. /// /// 4 public const uint Longitude = (uint)Property.Id.InstanceUtimeBookLongitude; /// - /// HasAlarm + /// HasAlarm. /// /// 4 public const uint HasAlarm = (uint)Property.Id.InstanceUtimeBookHasAlarm; /// - /// OriginalEventId + /// OriginalEventId. /// /// 4 public const uint OriginalEventId = (uint)Property.Id.InstanceUtimeBookOriginalEventId; /// - /// LastModifiedtime + /// LastModifiedtime. /// /// 4 public const uint LastModifiedtime = (uint)Property.Id.InstanceUtimeBookLastModifiedTime; /// - /// SyncData1 + /// SyncData1. /// /// 4 public const uint SyncData1 = (uint)Property.Id.InstanceUtimeBookSyncData1; } /// - /// Describes properties of a InstanceLocaltimeBook record. + /// Describes the properties of an InstanceLocaltimeBook record. /// /// 4 - /// Read only view + /// Read only view. public static class InstanceLocaltimeBook { /// - /// Uri + /// URI. /// /// 4 public const string Uri = "tizen.calendar_view.instance_localtime/book"; /// - /// EventId + /// EventId. /// /// 4 public const uint EventId = (uint)Property.Id.InstanceLocaltimeBookEventId; /// - /// Start + /// Start. /// /// 4 public const uint Start = (uint)Property.Id.InstanceLocaltimeBookStart; /// - /// End + /// End. /// /// 4 public const uint End = (uint)Property.Id.InstanceLocaltimeBookEnd; /// - /// Summary + /// Summary. /// /// 4 public const uint Summary = (uint)Property.Id.InstanceLocaltimeBookSummary; /// - /// Location + /// Location. /// /// 4 public const uint Location = (uint)Property.Id.InstanceLocaltimeBookLocation; /// - /// BookId + /// BookId. /// /// 4 public const uint BookId = (uint)Property.Id.InstanceLocaltimeBookBookId; /// - /// Description + /// Description. /// /// 4 public const uint Description = (uint)Property.Id.InstanceLocaltimeBookDescription; /// - /// BusyStatus + /// BusyStatus. /// /// 4 public const uint BusyStatus = (uint)Property.Id.InstanceLocaltimeBookBusyStatus; /// - /// EventStatus + /// EventStatus. /// /// 4 public const uint EventStatus = (uint)Property.Id.InstanceLocaltimeBookEventStatus; /// - /// Priority + /// Priority. /// /// 4 public const uint Priority = (uint)Property.Id.InstanceLocaltimeBookPriority; /// - /// Sensitivity + /// Sensitivity. /// /// 4 public const uint Sensitivity = (uint)Property.Id.InstanceLocaltimeBookSensitivity; /// - /// HasRrule + /// HasRrule. /// /// 4 public const uint HasRrule = (uint)Property.Id.InstanceLocaltimeBookHasRrule; /// - /// Latitude + /// Latitude. /// /// 4 public const uint Latitude = (uint)Property.Id.InstanceLocaltimeBookLatitude; /// - /// Longitude + /// Longitude. /// /// 4 public const uint Longitude = (uint)Property.Id.InstanceLocaltimeBookLongitude; /// - /// HasAlarm + /// HasAlarm. /// /// 4 public const uint HasAlarm = (uint)Property.Id.InstanceLocaltimeBookHasAlarm; /// - /// OriginalEventId + /// OriginalEventId. /// /// 4 public const uint OriginalEventId = (uint)Property.Id.InstanceLocaltimeBookOriginalEventId; /// - /// LastModifiedTime + /// LastModifiedTime. /// /// 4 public const uint LastModifiedTime = (uint)Property.Id.InstanceLocaltimeBookLastModifiedTime; /// - /// SyncData1 + /// SyncData1. /// /// 4 public const uint SyncData1 = (uint)Property.Id.InstanceLocaltimeBookSyncData1; /// - /// IsAllday + /// IsAllday. /// /// 4 public const uint IsAllday = (uint)Property.Id.InstanceLocaltimeBookIsAllday; } /// - /// Describes properties of a InstanceUtimeBookExtended record. + /// Describes the properties of an InstanceUtimeBookExtended record. /// /// 4 - /// Read only view + /// Read only view. public static class InstanceUtimeBookExtended { /// - /// Uri + /// URI. /// /// 4 public const string Uri = "tizen.calendar_view.extended/instance_utime/book"; /// - /// EventId + /// EventId. /// /// 4 public const uint EventId = (uint)Property.Id.InstanceUtimeBookExtendedEventId; /// - /// Start + /// Start. /// /// 4 public const uint Start = (uint)Property.Id.InstanceUtimeBookExtendedStart; /// - /// End + /// End. /// /// 4 public const uint End = (uint)Property.Id.InstanceUtimeBookExtendedEnd; /// - /// Summary + /// Summary. /// /// 4 public const uint Summary = (uint)Property.Id.InstanceUtimeBookExtendedSummary; /// - /// Location + /// Location. /// /// 4 public const uint Location = (uint)Property.Id.InstanceUtimeBookExtendedLocation; /// - /// BookId + /// BookId. /// /// 4 public const uint BookId = (uint)Property.Id.InstanceUtimeBookExtendedBookId; /// - /// Description + /// Description. /// /// 4 public const uint Description = (uint)Property.Id.InstanceUtimeBookExtendedDescription; /// - /// BusyStatus + /// BusyStatus. /// /// 4 public const uint BusyStatus = (uint)Property.Id.InstanceUtimeBookExtendedBusyStatus; /// - /// EventStatus + /// EventStatus. /// /// 4 public const uint EventStatus = (uint)Property.Id.InstanceUtimeBookExtendedEventStatus; /// - /// Priority + /// Priority. /// /// 4 public const uint Priority = (uint)Property.Id.InstanceUtimeBookExtendedPriority; /// - /// Sensitivity + /// Sensitivity. /// /// 4 public const uint Sensitivity = (uint)Property.Id.InstanceUtimeBookExtendedSensitivity; /// - /// HasRrule + /// HasRrule. /// /// 4 public const uint HasRrule = (uint)Property.Id.InstanceUtimeBookExtendedHasRrule; /// - /// Latitude + /// Latitude. /// /// 4 public const uint Latitude = (uint)Property.Id.InstanceUtimeBookExtendedLatitude; /// - /// Longitude + /// Longitude. /// /// 4 public const uint Longitude = (uint)Property.Id.InstanceUtimeBookExtendedLongitude; /// - /// HasAlarm + /// HasAlarm. /// /// 4 public const uint HasAlarm = (uint)Property.Id.InstanceUtimeBookExtendedHasAlarm; /// - /// OriginalEventId + /// OriginalEventId. /// /// 4 public const uint OriginalEventId = (uint)Property.Id.InstanceUtimeBookExtendedOriginalEventId; /// - /// LastModifiedTime + /// LastModifiedTime. /// /// 4 public const uint LastModifiedTime = (uint)Property.Id.InstanceUtimeBookExtendedLastModifiedTime; /// - /// SyncData1 + /// SyncData1. /// /// 4 public const uint SyncData1 = (uint)Property.Id.InstanceUtimeBookExtendedSyncData1; /// - /// OrganizerName + /// OrganizerName. /// /// 4 public const uint OrganizerName = (uint)Property.Id.InstanceUtimeBookExtendedOrganizerName; /// - /// Categories + /// Categories. /// /// 4 public const uint Categories = (uint)Property.Id.InstanceUtimeBookExtendedCategories; /// - /// HasAttendee + /// HasAttendee. /// /// 4 public const uint HasAttendee = (uint)Property.Id.InstanceUtimeBookExtendedHasAttendee; /// - /// SyncData2 + /// SyncData2. /// /// 4 public const uint SyncData2 = (uint)Property.Id.InstanceUtimeBookExtendedSyncData2; /// - /// SyncData3 + /// SyncData3. /// /// 4 public const uint SyncData3 = (uint)Property.Id.InstanceUtimeBookExtendedSyncData3; /// - /// SyncData4 + /// SyncData4. /// /// 4 public const uint SyncData4 = (uint)Property.Id.InstanceUtimeBookExtendedSyncData4; } /// - /// Describes properties of a InstanceLocaltimeBookExtended record. + /// Describes the properties of an InstanceLocaltimeBookExtended record. /// /// 4 - /// Read only view + /// Read only view. public static class InstanceLocaltimeBookExtended { /// - /// Uri + /// URI. /// /// 4 public const string Uri = "tizen.calendar_view.extended/instance_localtime/book"; /// - /// EventId + /// EventId. /// /// 4 public const uint EventId = (uint)Property.Id.InstanceLocaltimeBookExtendedEventId; /// - /// Start + /// Start. /// /// 4 public const uint Start = (uint)Property.Id.InstanceLocaltimeBookExtendedStart; /// - /// End + /// End. /// /// 4 public const uint End = (uint)Property.Id.InstanceLocaltimeBookExtendedEnd; /// - /// Summary + /// Summary. /// /// 4 public const uint Summary = (uint)Property.Id.InstanceLocaltimeBookExtendedSummary; /// - /// Location + /// Location. /// /// 4 public const uint Location = (uint)Property.Id.InstanceLocaltimeBookExtendedLocation; /// - /// BookId + /// BookId. /// /// 4 public const uint BookId = (uint)Property.Id.InstanceLocaltimeBookExtendedBookId; /// - /// Description + /// Description. /// /// 4 public const uint Description = (uint)Property.Id.InstanceLocaltimeBookExtendedDescription; /// - /// BusyStatus + /// BusyStatus. /// /// 4 public const uint BusyStatus = (uint)Property.Id.InstanceLocaltimeBookExtendedBusyStatus; /// - /// EventStatus + /// EventStatus. /// /// 4 public const uint EventStatus = (uint)Property.Id.InstanceLocaltimeBookExtendedEventStatus; /// - /// Priority + /// Priority. /// /// 4 public const uint Priority = (uint)Property.Id.InstanceLocaltimeBookExtendedPriority; /// - /// Sensitivity + /// Sensitivity. /// /// 4 public const uint Sensitivity = (uint)Property.Id.InstanceLocaltimeBookExtendedSensitivity; /// - /// HasRrule + /// HasRrule. /// /// 4 public const uint HasRrule = (uint)Property.Id.InstanceLocaltimeBookExtendedHasRrule; /// - /// Latitude + /// Latitude. /// /// 4 public const uint Latitude = (uint)Property.Id.InstanceLocaltimeBookExtendedLatitude; /// - /// Longitude + /// Longitude. /// /// 4 public const uint Longitude = (uint)Property.Id.InstanceLocaltimeBookExtendedLongitude; /// - /// HasAlarm + /// HasAlarm. /// /// 4 public const uint HasAlarm = (uint)Property.Id.InstanceLocaltimeBookExtendedHasAlarm; /// - /// OriginalEventId + /// OriginalEventId. /// /// 4 public const uint OriginalEventId = (uint)Property.Id.InstanceLocaltimeBookExtendedOriginalEventId; /// - /// LastModifiedTime + /// LastModifiedTime. /// /// 4 public const uint LastModifiedTime = (uint)Property.Id.InstanceLocaltimeBookExtendedLastModifiedTime; /// - /// SyncData1 + /// SyncData1. /// /// 4 public const uint SyncData1 = (uint)Property.Id.InstanceLocaltimeBookExtendedSyncData1; /// - /// OrganizerName + /// OrganizerName. /// /// 4 public const uint OrganizerName = (uint)Property.Id.InstanceLocaltimeBookExtendedOrganizerName; /// - /// Categories + /// Categories. /// /// 4 public const uint Categories = (uint)Property.Id.InstanceLocaltimeBookExtendedCategories; /// - /// HasAttendee + /// HasAttendee. /// /// 4 public const uint HasAttendee = (uint)Property.Id.InstanceLocaltimeBookExtendedHasAttendee; /// - /// SyncData2 + /// SyncData2. /// /// 4 public const uint SyncData2 = (uint)Property.Id.InstanceLocaltimeBookExtendedSyncData2; /// - /// SyncData3 + /// SyncData3. /// /// 4 public const uint SyncData3 = (uint)Property.Id.InstanceLocaltimeBookExtendedSyncData3; /// - /// SyncData4 + /// SyncData4. /// /// 4 public const uint SyncData4 = (uint)Property.Id.InstanceLocaltimeBookExtendedSyncData4; /// - /// IsAllday + /// IsAllday. /// /// 4 public const uint IsAllday = (uint)Property.Id.InstanceLocaltimeBookExtendedIsAllday; } /// - /// Describes properties of a UpdatedInfo record. + /// Describes the properties of an UpdatedInfo record. /// /// 4 - /// Read only view + /// Read only view. public static class UpdatedInfo { /// - /// Identifier of this updatedInfo view + /// Identifier of this UpdatedInfo view. /// /// 4 public const string Uri = "tizen.calendar_view.updated_info"; /// - /// Modified event(or todo) record ID + /// Modified event (or todo) record ID. /// /// 4 public const uint Id = (uint)Property.Id.UpdateInfoId; /// - /// Calendar book ID of the modified event(or todo) record + /// Calendar book ID of the modified event (or todo) record. /// /// 4 public const uint CalendarId = (uint)Property.Id.UpdateInfoCalendarId; @@ -1721,30 +1721,30 @@ namespace Tizen.Pims.Calendar /// 4 public const uint Type = (uint)Property.Id.UpdateInfoType; /// - /// Version after change + /// Version after change. /// /// 4 public const uint Version = (uint)Property.Id.UpdateInfoVersion; } /// - /// Describes properties of a Extended record. + /// Describes the properties of an Extended record. /// /// 4 public static class Extended { /// - /// Identifier of this extended_property view + /// Identifier of this extended_property view. /// /// 4 public const string Uri = "tizen.calendar_view.extended_property"; /// - /// DB record ID of the extended_property + /// Database record ID of the extended_property. /// /// 4 public const uint Id = (uint)Property.Id.ExtendedId; /// - /// Related record ID + /// Related record ID. /// /// 4 public const uint RecordId = (uint)Property.Id.ExtendedRecordId; @@ -1754,12 +1754,12 @@ namespace Tizen.Pims.Calendar /// 4 public const uint RecordType = (uint)Property.Id.ExtendedRecordType; /// - /// The key of the property + /// The key of the property. /// /// 4 public const uint Key = (uint)Property.Id.ExtendedKey; /// - /// The value of the property + /// The value of the property. /// /// 4 public const uint Value = (uint)Property.Id.ExtendedValue; diff --git a/src/Tizen.Pims.Calendar/Tizen.Pims.Calendar/DBChangedEventArgs.cs b/src/Tizen.Pims.Calendar/Tizen.Pims.Calendar/DBChangedEventArgs.cs index 69bee3e..57870ac 100644 --- a/src/Tizen.Pims.Calendar/Tizen.Pims.Calendar/DBChangedEventArgs.cs +++ b/src/Tizen.Pims.Calendar/Tizen.Pims.Calendar/DBChangedEventArgs.cs @@ -19,7 +19,7 @@ using System; namespace Tizen.Pims.Calendar { /// - /// Event arguments passed when calendar database is changed + /// The event arguments passed when the calendar database is changed. /// /// 4 public class DBChangedEventArgs : EventArgs @@ -30,7 +30,7 @@ namespace Tizen.Pims.Calendar } /// - /// The calendar view URI changed. + /// The calendar view URI is changed. /// /// 4 public string ViewUri diff --git a/src/Tizen.Pims.Calendar/Tizen.Pims.Calendar/ReminderEventArgs.cs b/src/Tizen.Pims.Calendar/Tizen.Pims.Calendar/ReminderEventArgs.cs index 4acfb81..3fdc9d3 100644 --- a/src/Tizen.Pims.Calendar/Tizen.Pims.Calendar/ReminderEventArgs.cs +++ b/src/Tizen.Pims.Calendar/Tizen.Pims.Calendar/ReminderEventArgs.cs @@ -19,7 +19,7 @@ using System; namespace Tizen.Pims.Calendar { /// - /// Event arguments passed when alarm is alerted. + /// The event arguments passed when the alarm is alerted. /// /// 4 public class ReminderAlertedEventArgs : EventArgs @@ -31,11 +31,11 @@ namespace Tizen.Pims.Calendar } /// - /// The parameter which data is combined. + /// The parameter which the data is combined. /// /// 4 /// - /// The combination of reminder data(Value string like id=value&time=value&tick=value&unit=value&type=value) + /// The combination of the reminder data (Value string like id=value&time=value&tick=value&unit=value&type=value). /// public string Param { diff --git a/src/Tizen.Pims.Contacts/Interop/Interop.Activity.cs b/src/Tizen.Pims.Contacts/Interop/Interop.Activity.cs index 7033526..e6dea65 100755 --- a/src/Tizen.Pims.Contacts/Interop/Interop.Activity.cs +++ b/src/Tizen.Pims.Contacts/Interop/Interop.Activity.cs @@ -17,7 +17,7 @@ using System.Runtime.InteropServices; /// -/// Partial Interop Class +/// The Partial Interop class. /// internal static partial class Interop { diff --git a/src/Tizen.Pims.Contacts/Interop/Interop.Group.cs b/src/Tizen.Pims.Contacts/Interop/Interop.Group.cs index 9eb1ab7..b1a936f 100755 --- a/src/Tizen.Pims.Contacts/Interop/Interop.Group.cs +++ b/src/Tizen.Pims.Contacts/Interop/Interop.Group.cs @@ -17,12 +17,12 @@ using System.Runtime.InteropServices; /// -/// Partial Interop Class +/// The Partial Interop class. /// internal static partial class Interop { /// - /// Contacts Interop Class + /// The Contacts Interop class. /// internal static class Group { diff --git a/src/Tizen.Pims.Contacts/Interop/Interop.Libraries.cs b/src/Tizen.Pims.Contacts/Interop/Interop.Libraries.cs index b916131..0e9c0de 100755 --- a/src/Tizen.Pims.Contacts/Interop/Interop.Libraries.cs +++ b/src/Tizen.Pims.Contacts/Interop/Interop.Libraries.cs @@ -15,7 +15,7 @@ */ /// -/// Partial Interop Class +/// The Partial Interop class. /// internal static partial class Interop { diff --git a/src/Tizen.Pims.Contacts/Interop/Interop.PhoneLog.cs b/src/Tizen.Pims.Contacts/Interop/Interop.PhoneLog.cs index f530c5f..f0e2262 100755 --- a/src/Tizen.Pims.Contacts/Interop/Interop.PhoneLog.cs +++ b/src/Tizen.Pims.Contacts/Interop/Interop.PhoneLog.cs @@ -17,7 +17,7 @@ using System.Runtime.InteropServices; /// -/// Partial Interop Class +/// The Partial Interop class. /// internal static partial class Interop { diff --git a/src/Tizen.Pims.Contacts/Interop/Interop.Service.cs b/src/Tizen.Pims.Contacts/Interop/Interop.Service.cs index 223b5a3..199f1e5 100644 --- a/src/Tizen.Pims.Contacts/Interop/Interop.Service.cs +++ b/src/Tizen.Pims.Contacts/Interop/Interop.Service.cs @@ -17,12 +17,12 @@ using System.Runtime.InteropServices; /// -/// Partial Interop Class +/// The Partial Interop class. /// internal static partial class Interop { /// - /// Contacts Interop Class + /// The Contacts Interop class. /// internal static class Service { diff --git a/src/Tizen.Pims.Contacts/Interop/Interop.Setting.cs b/src/Tizen.Pims.Contacts/Interop/Interop.Setting.cs index 902d7e3..b71c78a 100755 --- a/src/Tizen.Pims.Contacts/Interop/Interop.Setting.cs +++ b/src/Tizen.Pims.Contacts/Interop/Interop.Setting.cs @@ -19,7 +19,7 @@ using System.Runtime.InteropServices; using Tizen.Pims.Contacts; /// -/// Partial Interop Class +/// The Partial Interop class. /// internal static partial class Interop { diff --git a/src/Tizen.Pims.Contacts/Interop/Interop.Sim.cs b/src/Tizen.Pims.Contacts/Interop/Interop.Sim.cs index 488a5f6..ccb43bb 100755 --- a/src/Tizen.Pims.Contacts/Interop/Interop.Sim.cs +++ b/src/Tizen.Pims.Contacts/Interop/Interop.Sim.cs @@ -18,7 +18,7 @@ using System; using System.Runtime.InteropServices; /// -/// Partial Interop Class +/// The Partial Interop class. /// internal static partial class Interop { diff --git a/src/Tizen.Pims.Contacts/Tizen.Pims.Contacts/ContactsDatabase.cs b/src/Tizen.Pims.Contacts/Tizen.Pims.Contacts/ContactsDatabase.cs index 61e73d8..954def3 100644 --- a/src/Tizen.Pims.Contacts/Tizen.Pims.Contacts/ContactsDatabase.cs +++ b/src/Tizen.Pims.Contacts/Tizen.Pims.Contacts/ContactsDatabase.cs @@ -23,10 +23,10 @@ namespace Tizen.Pims.Contacts { /// - /// ContactsDatabase provides methods to manage contacts information from/to the database. + /// The ContactsDatabase provides methods to manage contacts information from/to the database. /// /// - /// This class allows user to access/create/update db operations for contacts information. + /// This class allows the user to access/create/update database operations for the contacts information. /// /// 4 public class ContactsDatabase @@ -43,13 +43,13 @@ namespace Tizen.Pims.Contacts } /// - /// Enumeration for contacts database status. + /// Enumeration for the contacts database status. /// /// 4 public enum DBStatus { /// - /// Normal + /// Normal. /// /// 4 Normal, @@ -61,41 +61,41 @@ namespace Tizen.Pims.Contacts } /// - /// Enumeration for Contacts search range. + /// Enumeration for the contacts search range. /// /// 4 [Flags] public enum SearchRanges { /// - /// None + /// None. /// /// 4 None = 0, /// - /// Search record from name + /// Search record from name. /// /// 4 Name = 0x00000001, /// - /// Search record from number + /// Search record from number. /// /// 4 Number = 0x00000002, /// - /// Search record from data + /// Search record from data. /// /// 4 Data = 0x00000004, /// - /// Search record from email. Now, support only PersonEmail view + /// Search record from email. Now, support only PersonEmail view. /// /// 4 Email = 0x00000008, } /// - /// Occurs when contacts database status is changed. + /// Occurs when the contacts database status is changed. /// /// 4 public event EventHandler DBStatusChanged @@ -209,16 +209,16 @@ namespace Tizen.Pims.Contacts /// /// Inserts a record into the contacts database. /// - /// The record to insert - /// The ID of inserted record + /// The record to insert. + /// The ID of inserted record. /// http://tizen.org/privilege/contact.write /// http://tizen.org/privilege/callhistory.write /// http://tizen.org/feature/contact - /// Thrown when method failed due to invalid operation - /// Thrown when feature is not supported - /// Thrown when one of the arguments provided to a method is not valid - /// Thrown when failed due to out of memory - /// Thrown when application does not have proper privileges + /// Thrown when the method failed due to an invalid operation. + /// Thrown when the feature is not supported. + /// Thrown when one of the arguments provided to a method is not valid. + /// Thrown when failed due to out of memory. + /// Thrown when the application does not have proper privileges. /// 4 [SuppressMessage("Microsoft.Performance", "CA1822:MarkMembersAsStatic")] public int Insert(ContactsRecord record) @@ -236,16 +236,16 @@ namespace Tizen.Pims.Contacts /// /// Inserts multiple records into the contacts database as a batch operation. /// - /// The record list - /// The inserted record ID array + /// The record list. + /// The inserted record ID array. /// http://tizen.org/privilege/contact.write /// http://tizen.org/privilege/callhistory.write /// http://tizen.org/feature/contact - /// Thrown when method failed due to invalid operation - /// Thrown when feature is not supported - /// Thrown when one of the arguments provided to a method is not valid - /// Thrown when failed due to out of memory - /// Thrown when application does not have proper privileges + /// Thrown when the method failed due to an invalid operation. + /// Thrown when the feature is not supported. + /// Thrown when one of the arguments provided to a method is not valid. + /// Thrown when failed due to out of memory. + /// Thrown when the application does not have proper privileges. /// 4 [SuppressMessage("Microsoft.Performance", "CA1822:MarkMembersAsStatic")] public int[] Insert(ContactsList list) @@ -268,17 +268,17 @@ namespace Tizen.Pims.Contacts /// /// Gets a record from the contacts database. /// - /// The view URI of a record - /// The record ID + /// The view URI of a record. + /// The record ID. /// The record associated with the record ID /// http://tizen.org/privilege/contact.read /// http://tizen.org/privilege/callhistory.read /// http://tizen.org/feature/contact - /// Thrown when method failed due to invalid operation - /// Thrown when feature is not supported - /// Thrown when one of the arguments provided to a method is not valid - /// Thrown when failed due to out of memory - /// Thrown when application does not have proper privileges + /// Thrown when the method failed due to an invalid operation. + /// Thrown when the feature is not supported. + /// Thrown when one of the arguments provided to a method is not valid. + /// Thrown when failed due to out of memory. + /// Thrown when the application does not have proper privileges. /// 4 [SuppressMessage("Microsoft.Performance", "CA1822:MarkMembersAsStatic")] [SuppressMessage("Microsoft.Design", "CA1054:UriParametersShouldNotBeStrings")] @@ -297,15 +297,15 @@ namespace Tizen.Pims.Contacts /// /// Updates a record in the contacts database. /// - /// The record to update + /// The record to update. /// http://tizen.org/privilege/contact.write /// http://tizen.org/privilege/callhistory.write /// http://tizen.org/feature/contact - /// Thrown when method failed due to invalid operation - /// Thrown when feature is not supported - /// Thrown when one of the arguments provided to a method is not valid - /// Thrown when failed due to out of memory - /// Thrown when application does not have proper privileges + /// Thrown when the method failed due to an invalid operation. + /// Thrown when the feature is not supported. + /// Thrown when one of the arguments provided to a method is not valid. + /// Thrown when failed due to out of memory. + /// Thrown when the application does not have proper privileges. /// 4 [SuppressMessage("Microsoft.Performance", "CA1822:MarkMembersAsStatic")] public void Update(ContactsRecord record) @@ -321,15 +321,15 @@ namespace Tizen.Pims.Contacts /// /// Updates multiple records in the contacts database as a batch operation. /// - /// The record list + /// The record list. /// http://tizen.org/privilege/contact.write /// http://tizen.org/privilege/callhistory.write /// http://tizen.org/feature/contact - /// Thrown when method failed due to invalid operation - /// Thrown when feature is not supported - /// Thrown when one of the arguments provided to a method is not valid - /// Thrown when failed due to out of memory - /// Thrown when application does not have proper privileges + /// Thrown when the method failed due to an invalid operation. + /// Thrown when the feature is not supported. + /// Thrown when one of the arguments provided to a method is not valid. + /// Thrown when failed due to out of memory. + /// Thrown when the application does not have proper privileges. /// 4 [SuppressMessage("Microsoft.Performance", "CA1822:MarkMembersAsStatic")] public void Update(ContactsList list) @@ -343,18 +343,18 @@ namespace Tizen.Pims.Contacts } /// - /// Deletes a record from the contacts database with related child records. + /// Deletes a record from the contacts database with the related child records. /// - /// The view URI of a record - /// The record ID to delete + /// The view URI of a record. + /// The record ID to delete. /// http://tizen.org/privilege/contact.write /// http://tizen.org/privilege/callhistory.write /// http://tizen.org/feature/contact - /// Thrown when method failed due to invalid operation - /// Thrown when feature is not supported - /// Thrown when one of the arguments provided to a method is not valid - /// Thrown when failed due to out of memory - /// Thrown when application does not have proper privileges + /// Thrown when the method failed due to an invalid operation. + /// Thrown when the feature is not supported. + /// Thrown when one of the arguments provided to a method is not valid. + /// Thrown when failed due to out of memory. + /// Thrown when the application does not have proper privileges. /// 4 [SuppressMessage("Microsoft.Performance", "CA1822:MarkMembersAsStatic")] [SuppressMessage("Microsoft.Design", "CA1054:UriParametersShouldNotBeStrings")] @@ -369,18 +369,18 @@ namespace Tizen.Pims.Contacts } /// - /// Deletes multiple records with related child records from the contacts database as a batch operation. + /// Deletes multiple records with the related child records from the contacts database as a batch operation. /// - /// The view URI of the records to delete - /// The record IDs to delete + /// The view URI of the records to delete. + /// The record IDs to delete. /// http://tizen.org/privilege/contact.write /// http://tizen.org/privilege/callhistory.write /// http://tizen.org/feature/contact - /// Thrown when method failed due to invalid operation - /// Thrown when feature is not supported - /// Thrown when one of the arguments provided to a method is not valid - /// Thrown when failed due to out of memory - /// Thrown when application does not have proper privileges + /// Thrown when the method failed due to an invalid operation. + /// Thrown when the feature is not supported. + /// Thrown when one of the arguments provided to a method is not valid. + /// Thrown when failed due to out of memory. + /// Thrown when the application does not have proper privileges. /// 4 [SuppressMessage("Microsoft.Performance", "CA1822:MarkMembersAsStatic")] [SuppressMessage("Microsoft.Design", "CA1054:UriParametersShouldNotBeStrings")] @@ -397,16 +397,16 @@ namespace Tizen.Pims.Contacts /// /// Replaces a record in the contacts database. /// - /// The record to replace - /// the record ID to be replaced + /// The record to replace. + /// The record ID to be replaced. /// http://tizen.org/privilege/contact.write /// http://tizen.org/privilege/callhistory.write /// http://tizen.org/feature/contact - /// Thrown when method failed due to invalid operation - /// Thrown when feature is not supported - /// Thrown when one of the arguments provided to a method is not valid - /// Thrown when failed due to out of memory - /// Thrown when application does not have proper privileges + /// Thrown when the method failed due to an invalid operation<./exception> + /// Thrown when the feature is not supported. + /// Thrown when one of the arguments provided to a method is not valid. + /// Thrown when failed due to out of memory. + /// Thrown when the application does not have proper privileges. /// 4 [SuppressMessage("Microsoft.Performance", "CA1822:MarkMembersAsStatic")] public void Replace(ContactsRecord record, int recordId) @@ -422,16 +422,16 @@ namespace Tizen.Pims.Contacts /// /// Replaces multiple records in the contacts database as a batch operation. /// - /// The record list to replace - /// The record IDs to be replaced + /// The record list to replace. + /// The record IDs to be replaced. /// http://tizen.org/privilege/contact.write /// http://tizen.org/privilege/callhistory.write /// http://tizen.org/feature/contact - /// Thrown when method failed due to invalid operation - /// Thrown when feature is not supported - /// Thrown when one of the arguments provided to a method is not valid - /// Thrown when failed due to out of memory - /// Thrown when application does not have proper privileges + /// Thrown when the method failed due to an invalid operation. + /// Thrown when feature is not supported. + /// Thrown when one of the arguments provided to a method is not valid. + /// Thrown when failed due to out of memory. + /// Thrown when the application does not have proper privileges. /// 4 [SuppressMessage("Microsoft.Performance", "CA1822:MarkMembersAsStatic")] public void Replace(ContactsList list, int[] idArray) @@ -445,22 +445,22 @@ namespace Tizen.Pims.Contacts } /// - /// Retrieves all records as a list. + /// Retrieves all the records as a list. /// - /// The view URI to get records - /// The index from which results - /// The number to limit results(value 0 is used for all records) + /// The view URI to get records. + /// The index from which results. + /// The number to limit results (value 0 is used for get all records). /// - /// The record list + /// The record list. /// /// http://tizen.org/privilege/contact.read /// http://tizen.org/privilege/callhistory.read /// http://tizen.org/feature/contact - /// Thrown when method failed due to invalid operation - /// Thrown when feature is not supported - /// Thrown when one of the arguments provided to a method is not valid - /// Thrown when failed due to out of memory - /// Thrown when application does not have proper privileges + /// Thrown when the method failed due to an invalid operation. + /// Thrown when the feature is not supported. + /// Thrown when one of the arguments provided to a method is not valid. + /// Thrown when failed due to out of memory. + /// Thrown when the application does not have proper privileges. /// 4 [SuppressMessage("Microsoft.Performance", "CA1822:MarkMembersAsStatic")] [SuppressMessage("Microsoft.Design", "CA1054:UriParametersShouldNotBeStrings")] @@ -477,22 +477,22 @@ namespace Tizen.Pims.Contacts } /// - /// Retrieves records using a query. + /// Retrieves the records using a query. /// - /// The query to filter the results - /// The index from which to get results - /// The number to limit results(value 0 is used for get all records) + /// The query to filter the results. + /// The index from which to get results. + /// The number to limit results (value 0 is used for get all records). /// /// The record list /// /// http://tizen.org/privilege/contact.read /// http://tizen.org/privilege/callhistory.read /// http://tizen.org/feature/contact - /// Thrown when method failed due to invalid operation - /// Thrown when feature is not supported - /// Thrown when one of the arguments provided to a method is not valid - /// Thrown when failed due to out of memory - /// Thrown when application does not have proper privileges + /// Thrown when the method failed due to an invalid operation. + /// Thrown when the feature is not supported. + /// Thrown when one of the arguments provided to a method is not valid. + /// Thrown when failed due to out of memory. + /// Thrown when the application does not have proper privileges. /// 4 [SuppressMessage("Microsoft.Performance", "CA1822:MarkMembersAsStatic")] public ContactsList GetRecordsWithQuery(ContactsQuery query, int offset, int limit) @@ -508,22 +508,22 @@ namespace Tizen.Pims.Contacts } /// - /// Retrieves records changes since the given database version. + /// Retrieves the records changes since the given database version. /// - /// The view URI to get records - /// The address book ID to filter - /// The contacts database version - /// The current contacts database version + /// The view URI to get records. + /// The address book ID to filter. + /// The contacts database version. + /// The current contacts database version. /// - /// The record list + /// The record list. /// /// http://tizen.org/privilege/contact.read /// http://tizen.org/feature/contact - /// Thrown when method failed due to invalid operation - /// Thrown when feature is not supported - /// Thrown when one of the arguments provided to a method is not valid - /// Thrown when failed due to out of memory - /// Thrown when application does not have proper privileges + /// Thrown when the method failed due to an invalid operation. + /// Thrown when the feature is not supported. + /// Thrown when one of the arguments provided to a method is not valid. + /// Thrown when failed due to out of memory. + /// Thrown when the application does not have proper privileges. /// 4 [SuppressMessage("Microsoft.Performance", "CA1822:MarkMembersAsStatic")] [SuppressMessage("Microsoft.Design", "CA1054:UriParametersShouldNotBeStrings")] @@ -540,24 +540,24 @@ namespace Tizen.Pims.Contacts } /// - /// Finds records based on a given keyword. + /// Finds the records based on a given keyword. /// /// - /// This API works only for the Views below. - /// Person, PersonContact, PersonGroupRelation, PersonGroupAssigned and PersonGroupNotAssigned. + /// This API works only for the views below: + /// Person, PersonContact, PersonGroupRelation, PersonGroupAssigned, and PersonGroupNotAssigned. /// - /// The view URI to find records - /// The keyword - /// The index from which to get results - /// The number to limit results(value 0 is used for get all records) + /// The view URI to find records. + /// The keyword. + /// The index from which to get results. + /// The number to limit results (value 0 is used for get all records). /// The record list /// http://tizen.org/privilege/contact.read /// http://tizen.org/feature/contact - /// Thrown when method failed due to invalid operation - /// Thrown when feature is not supported - /// Thrown when one of the arguments provided to a method is not valid - /// Thrown when failed due to out of memory - /// Thrown when application does not have proper privileges + /// Thrown when the method failed due to an invalid operation. + /// Thrown when the feature is not supported. + /// Thrown when one of the arguments provided to a method is not valid. + /// Thrown when failed due to out of memory. + /// Thrown when the application does not have proper privileges. /// 4 [SuppressMessage("Microsoft.Performance", "CA1822:MarkMembersAsStatic")] [SuppressMessage("Microsoft.Design", "CA1054:UriParametersShouldNotBeStrings")] @@ -574,24 +574,24 @@ namespace Tizen.Pims.Contacts } /// - /// Finds records based on given query and keyword. + /// Finds the records based on a given query and keyword. /// /// - /// This API works only for the Views below. - /// Person, PersonContact, PersonGroupRelation, PersonGroupAssigned and PersonGroupNotAssigned. + /// This API works only for the views below: + /// Person, PersonContact, PersonGroupRelation, PersonGroupAssigned, and PersonGroupNotAssigned. /// - /// The query to filter - /// The keyword - /// The index from which to get results - /// The number to limit results(value 0 used for get all records) - /// The record list + /// The query to filter. + /// The keyword. + /// The index from which to get results. + /// The number to limit results (value 0 is used for get all records). + /// The record list. /// http://tizen.org/privilege/contact.read /// http://tizen.org/feature/contact - /// Thrown when method failed due to invalid operation - /// Thrown when feature is not supported - /// Thrown when one of the arguments provided to a method is not valid - /// Thrown when failed due to out of memory - /// Thrown when application does not have proper privileges + /// Thrown when the method failed due to an invalid operation. + /// Thrown when the feature is not supported. + /// Thrown when one of the arguments provided to a method is not valid. + /// Thrown when failed due to out of memory. + /// Thrown when the application does not have proper privileges. /// 4 [SuppressMessage("Microsoft.Performance", "CA1822:MarkMembersAsStatic")] public ContactsList Search(ContactsQuery query, string keyword, int offset, int limit) @@ -607,25 +607,25 @@ namespace Tizen.Pims.Contacts } /// - /// Finds records based on a keyword and range. + /// Finds the records based on a keyword and range. /// /// - /// This API works only for the Views below. - /// Person, PersonContact, PersonGroupRelation, PersonGroupAssigned, PersonGroupNotAssigned, PersonNumber and PersonEmail + /// This API works only for the views below: + /// Person, PersonContact, PersonGroupRelation, PersonGroupAssigned, PersonGroupNotAssigned, PersonNumber, and PersonEmail. /// - /// The view URI - /// The keyword - /// The index from which to get results - /// The number to limit results(value 0 is used for get all records) - /// The search range, it should be a element of SearchRange or bitwise OR operation of them - /// The record list + /// The view URI. + /// The keyword. + /// The index from which to get results. + /// The number to limit results (value 0 is used for get all records). + /// The search range should be an element of the SearchRange or bitwise OR operation of them. + /// The record list. /// http://tizen.org/privilege/contact.read /// http://tizen.org/feature/contact - /// Thrown when method failed due to invalid operation - /// Thrown when feature is not supported - /// Thrown when one of the arguments provided to a method is not valid - /// Thrown when failed due to out of memory - /// Thrown when application does not have proper privileges + /// Thrown when the method failed due to an invalid operation. + /// Thrown when the feature is not supported. + /// Thrown when one of the arguments provided to a method is not valid. + /// Thrown when failed due to out of memory. + /// Thrown when the application does not have proper privileges. /// 4 [SuppressMessage("Microsoft.Performance", "CA1822:MarkMembersAsStatic")] [SuppressMessage("Microsoft.Design", "CA1054:UriParametersShouldNotBeStrings")] @@ -642,28 +642,28 @@ namespace Tizen.Pims.Contacts } /// - /// Finds records based on a given keyword for snippet + /// Finds the records based on a given keyword for the snippet. /// /// - /// This API works only for the Views below. - /// Person, PersonContact, PersonGroupRelation, PersonGroupAssigned and PersonGroupNotAssigned. - /// Because start match and end match are needed to be composed with keyword, this API performance is lower than Search(string viewUri, string keyword, int offset, int limit). + /// This API works only for the views below: + /// Person, PersonContact, PersonGroupRelation, PersonGroupAssigned, and PersonGroupNotAssigned. + /// Because the start match and end match are needed to be composed with a keyword, this API performance is lower than Search (string viewUri, string keyword, int offset, int limit). /// - /// The view URI to find records - /// The keyword - /// The index from which to get results - /// The number to limit results(value 0 used for get all records) - /// The text which is inserted into the fragment before the keyword(If NULL, default is "[") - /// The text which is inserted into the fragment after the keyword(If NULL, default is "]") - /// The one side extra number of tokens near keyword(If negative value, full sentence is printed. e.g. if token number is 3 with 'abc' keyword, "my name is [abc]de and my home") + /// The view URI to find records. + /// The keyword. + /// The index from which to get results. + /// The number to limit results (value 0 is used for get all records). + /// The text, which is inserted into the fragment before the keyword (If NULL, default is "[".) + /// The text, which is inserted into the fragment after the keyword (If NULL, default is "]") + /// The one side extra number of tokens near keyword (If negative value, full sentence is printed. For example, if the token number is 3 with 'abc' keyword, snippet string will be like "my name is [abc]de and my home"). /// The record list /// http://tizen.org/privilege/contact.read /// http://tizen.org/feature/contact - /// Thrown when method failed due to invalid operation - /// Thrown when feature is not supported - /// Thrown when one of the arguments provided to a method is not valid - /// Thrown when failed due to out of memory - /// Thrown when application does not have proper privileges + /// Thrown when the method failed due to an invalid operation. + /// Thrown when the feature is not supported. + /// Thrown when one of the arguments provided to a method is not valid. + /// Thrown when failed due to out of memory. + /// Thrown when the application does not have proper privileges. /// 4 [SuppressMessage("Microsoft.Performance", "CA1822:MarkMembersAsStatic")] [SuppressMessage("Microsoft.Design", "CA1054:UriParametersShouldNotBeStrings")] @@ -680,28 +680,28 @@ namespace Tizen.Pims.Contacts } /// - /// Finds records based on given query and keyword for snippet. + /// Finds the records based on a given query and keyword for the snippet. /// /// - /// This API works only for the Views below. - /// Person, PersonContact, PersonGroupRelation, PersonGroupAssigned and PersonGroupNotAssigned. - /// Because start match and end match are needed to be composed with keyword, this API performance is lower than Search(ContactsQuery query, string keyword, int offset, int limit). + /// This API works only for the views below: + /// Person, PersonContact, PersonGroupRelation, PersonGroupAssigned, and PersonGroupNotAssigned. + /// Because the start match and end match are needed to be composed with a keyword, this API performance is lower than Search (ContactsQuery query, string keyword, int offset, int limit). /// - /// The query to filter - /// The keyword - /// The index from which to get results - /// The number to limit results(value 0 used for get all records) - /// The text which is inserted into the fragment before the keyword(If NULL, default is "[") - /// The text which is inserted into the fragment after the keyword(If NULL, default is "]") - /// The one side extra number of tokens near keyword(If negative value, full sentence is printed. e.g. if token number is 3 with 'abc' keyword, "my name is [abc]de and my home") - /// The record list + /// The query to filter. + /// The keyword. + /// The index from which to get results. + /// The number to limit results (value 0 is used for get all records). + /// The text, which is inserted into the fragment before a keyword (If NULL, default is "["). + /// The text, which is inserted into the fragment after a keyword (If NULL, default is "]".) + /// The one side extra number of tokens near a keyword (If negative value, full sentence is printed. For example, if the token number is 3 with 'abc' keyword, snippet string will be like "my name is [abc]de and my home"). + /// The record list. /// http://tizen.org/privilege/contact.read /// http://tizen.org/feature/contact - /// Thrown when method failed due to invalid operation - /// Thrown when feature is not supported - /// Thrown when one of the arguments provided to a method is not valid - /// Thrown when failed due to out of memory - /// Thrown when application does not have proper privileges + /// Thrown when the method failed due to an invalid operation. + /// Thrown when the feature is not supported. + /// Thrown when one of the arguments provided to a method is not valid. + /// Thrown when failed due to out of memory. + /// Thrown when the application does not have proper privileges. /// 4 [SuppressMessage("Microsoft.Performance", "CA1822:MarkMembersAsStatic")] public ContactsList Search(ContactsQuery query, string keyword, int offset, int limit, string startMatch, string endMatch, int tokenNumber) @@ -717,29 +717,29 @@ namespace Tizen.Pims.Contacts } /// - /// Finds records based on a keyword and range for snippet. + /// Finds the records based on a keyword and range for the snippet. /// /// - /// This API works only for the Views below. - /// Person, PersonContact, PersonGroupRelation, PersonGroupAssigned, PersonGroupNotAssigned, PersonNumber and PersonEmail - /// Because start match and end match are needed to be composed with keyword, this API performance is lower than Search(string viewUri, string keyword, int offset, int limit, int range). + /// This API works only for the views below: + /// Person, PersonContact, PersonGroupRelation, PersonGroupAssigned, PersonGroupNotAssigned, PersonNumber, and PersonEmail, + /// Because the start match and end match are needed to be composed with a keyword, this API performance is lower than Search (string viewUri, string keyword, int offset, int limit, int range). /// - /// The view URI - /// The keyword - /// The index from which to get results - /// The number to limit results(value 0 is used for get all records) - /// The search range, it should be a element of SearchRange or bitwise OR operation of them - /// The text which is inserted into the fragment before the keyword(If NULL, default is "[") - /// The text which is inserted into the fragment after the keyword(If NULL, default is "]") - /// The one side extra number of tokens near keyword(If negative value, full sentence is printed. e.g. if token number is 3 with 'abc' keyword, "my name is [abc]de and my home") - /// The record list + /// The view URI. + /// The keyword. + /// The index from which to get results. + /// The number to limit results (value 0 is used for get all records). + /// The search range should be an element of the SearchRange or bitwise OR operation of them. + /// The text, which is inserted into the fragment before a keyword (If NULL, default is "["). + /// The text, which is inserted into the fragment after a keyword (If NULL, default is "]"). + /// The one side extra number of tokens near a keyword (If negative value, full sentence is printed. For example, if a token number is 3 with 'abc' keyword, snippet string will be like "my name is [abc]de and my home"). + /// The record list. /// http://tizen.org/privilege/contact.read /// http://tizen.org/feature/contact - /// Thrown when method failed due to invalid operation - /// Thrown when feature is not supported - /// Thrown when one of the arguments provided to a method is not valid - /// Thrown when failed due to out of memory - /// Thrown when application does not have proper privileges + /// Thrown when the method failed due to an invalid operation. + /// Thrown when the feature is not supported. + /// Thrown when one of the arguments provided to a method is not valid. + /// Thrown when failed due to out of memory. + /// Thrown when the application does not have proper privileges. /// 4 [SuppressMessage("Microsoft.Performance", "CA1822:MarkMembersAsStatic")] [SuppressMessage("Microsoft.Design", "CA1054:UriParametersShouldNotBeStrings")] @@ -756,10 +756,10 @@ namespace Tizen.Pims.Contacts } /// - /// Gets the number of records in a specific view + /// Gets the number of records in a specific view. /// - /// The view URI - /// The count of records + /// The view URI. + /// The count of records. /// 4 [SuppressMessage("Microsoft.Performance", "CA1822:MarkMembersAsStatic")] [SuppressMessage("Microsoft.Design", "CA1054:UriParametersShouldNotBeStrings")] @@ -778,8 +778,8 @@ namespace Tizen.Pims.Contacts /// /// Gets the number of records matching a query. /// - /// The query used for filtering the results - /// The count of records + /// The query used for filtering the results. + /// The count of records. /// 4 [SuppressMessage("Microsoft.Performance", "CA1822:MarkMembersAsStatic")] public int GetCount(ContactsQuery query) @@ -795,18 +795,18 @@ namespace Tizen.Pims.Contacts } /// - /// Registers a EventHandler to be invoked when a record changes. + /// Registers an EventHandler to be invoked when a record changes. /// - /// The view URI of records whose changes are monitored - /// The EventHandler to register + /// The view URI of records whose changes are monitored. + /// The EventHandler to register. /// http://tizen.org/privilege/contact.read /// http://tizen.org/privilege/callhistory.read /// http://tizen.org/feature/contact - /// Thrown when method failed due to invalid operation - /// Thrown when feature is not supported - /// Thrown when one of the arguments provided to a method is not valid - /// Thrown when failed due to out of memory - /// Thrown when application does not have proper privileges + /// Thrown when the method failed due to an invalid operation. + /// Thrown when the feature is not supported. + /// Thrown when one of the arguments provided to a method is not valid. + /// Thrown when failed due to out of memory. + /// Thrown when the application does not have proper privileges. /// 4 [SuppressMessage("Microsoft.Design", "CA1054:UriParametersShouldNotBeStrings")] public void AddDBChangedEventHandler(string viewUri, EventHandler DBChanged) @@ -835,15 +835,15 @@ namespace Tizen.Pims.Contacts } /// - /// Deregisters a EventHandler. + /// Deregisters an EventHandler. /// - /// The view URI of records whose changes are monitored - /// The EventHandler to deregister + /// The view URI of records whose changes are monitored. + /// The EventHandler to deregister. /// http://tizen.org/feature/contact - /// Thrown when method failed due to invalid operation - /// Thrown when feature is not supported - /// Thrown when one of the arguments provided to a method is not valid - /// Thrown when failed due to out of memory + /// Thrown when the method failed due to an invalid operation. + /// Thrown when the feature is not supported. + /// Thrown when one of the arguments provided to a method is not valid. + /// Thrown when failed due to out of memory. /// 4 [SuppressMessage("Microsoft.Design", "CA1054:UriParametersShouldNotBeStrings")] public void RemoveDBChangedEventHandler(string viewUri, EventHandler DBChanged) diff --git a/src/Tizen.Pims.Contacts/Tizen.Pims.Contacts/ContactsFilter.cs b/src/Tizen.Pims.Contacts/Tizen.Pims.Contacts/ContactsFilter.cs index b202299..2685e99 100644 --- a/src/Tizen.Pims.Contacts/Tizen.Pims.Contacts/ContactsFilter.cs +++ b/src/Tizen.Pims.Contacts/Tizen.Pims.Contacts/ContactsFilter.cs @@ -20,7 +20,7 @@ using System.Diagnostics.CodeAnalysis; namespace Tizen.Pims.Contacts { /// - /// A filter includes the conditions for the search + /// A filter includes the conditions for the search. /// /// 4 public class ContactsFilter:IDisposable @@ -30,14 +30,14 @@ namespace Tizen.Pims.Contacts /// /// Creates a filter with a condition for a string type property. /// - /// The view URI of a filter - /// The property ID to add a condition - /// The match flag - /// The match value + /// The view URI of a filter. + /// The property ID to add a condition. + /// The match flag. + /// The match value. /// http://tizen.org/feature/contact - /// Thrown when feature is not supported - /// Thrown when one of the arguments provided to a method is not valid - /// Thrown when failed due to out of memory + /// Thrown when the feature is not supported. + /// Thrown when one of the arguments provided to a method is not valid. + /// Thrown when failed due to out of memory. /// 4 [SuppressMessage("Microsoft.Design", "CA1054:UriParametersShouldNotBeStrings")] public ContactsFilter(string viewUri, uint propertyId, StringMatchType matchType, string matchValue) @@ -61,14 +61,14 @@ namespace Tizen.Pims.Contacts /// /// Creates a filter with a condition for an integer type property. /// - /// The view URI of a filter - /// The property ID to add a condition - /// The match flag - /// The match value + /// The view URI of a filter. + /// The property ID to add a condition. + /// The match flag. + /// The match value. /// http://tizen.org/feature/contact - /// Thrown when feature is not supported - /// Thrown when one of the arguments provided to a method is not valid - /// Thrown when failed due to out of memory + /// Thrown when the feature is not supported. + /// Thrown when one of the arguments provided to a method is not valid. + /// Thrown when failed due to out of memory. /// 4 [SuppressMessage("Microsoft.Design", "CA1054:UriParametersShouldNotBeStrings")] public ContactsFilter(string viewUri, uint propertyId, IntegerMatchType matchType, int matchValue) @@ -92,14 +92,14 @@ namespace Tizen.Pims.Contacts /// /// Creates a filter with a condition for a long type property. /// - /// The view URI of a filter - /// The property ID to add a condition - /// The match flag - /// The match value + /// The view URI of a filter. + /// The property ID to add a condition. + /// The match flag. + /// The match value. /// http://tizen.org/feature/contact - /// Thrown when feature is not supported - /// Thrown when one of the arguments provided to a method is not valid - /// Thrown when failed due to out of memory + /// Thrown when the feature is not supported. + /// Thrown when one of the arguments provided to a method is not valid. + /// Thrown when failed due to out of memory. /// 4 [SuppressMessage("Microsoft.Design", "CA1054:UriParametersShouldNotBeStrings")] public ContactsFilter(string viewUri, uint propertyId, IntegerMatchType matchType, long matchValue) @@ -123,14 +123,14 @@ namespace Tizen.Pims.Contacts /// /// Creates a filter with a condition for a double type property. /// - /// The view URI of a filter - /// The property ID to add a condition - /// The match flag - /// The match value + /// The view URI of a filter. + /// The property ID to add a condition. + /// The match flag. + /// The match value. /// http://tizen.org/feature/contact - /// Thrown when feature is not supported - /// Thrown when one of the arguments provided to a method is not valid - /// Thrown when failed due to out of memory + /// Thrown when the feature is not supported. + /// Thrown when one of the arguments provided to a method is not valid. + /// Thrown when failed due to out of memory. /// 4 [SuppressMessage("Microsoft.Design", "CA1054:UriParametersShouldNotBeStrings")] public ContactsFilter(string viewUri, uint propertyId, IntegerMatchType matchType, double matchValue) @@ -154,13 +154,13 @@ namespace Tizen.Pims.Contacts /// /// Creates a filter with a condition for a boolean type property. /// - /// The view URI of a filter - /// The property ID to add a condition - /// The match value + /// The view URI of a filter. + /// The property ID to add a condition. + /// The match value. /// http://tizen.org/feature/contact - /// Thrown when feature is not supported - /// Thrown when one of the arguments provided to a method is not valid - /// Thrown when failed due to out of memory + /// Thrown when the feature is not supported. + /// Thrown when one of the arguments provided to a method is not valid. + /// Thrown when failed due to out of memory. /// 4 [SuppressMessage("Microsoft.Design", "CA1054:UriParametersShouldNotBeStrings")] public ContactsFilter(string viewUri, uint propertyId, bool matchValue) @@ -182,7 +182,7 @@ namespace Tizen.Pims.Contacts } /// - /// Destructor + /// The destructor. /// /// 4 ~ContactsFilter() @@ -191,45 +191,45 @@ namespace Tizen.Pims.Contacts } /// - /// Enumeration for the filter match type of a string. + /// Enumeration for the filter match types of a string. /// /// 4 public enum StringMatchType { /// - /// Full string, case-sensitive + /// Full string, case-sensitive. /// /// 4 Exactly, /// - /// Full string, case-insensitive + /// Full string, case-insensitive. /// /// 4 FullString, /// - /// Sub string, case-insensitive + /// Sub string, case-insensitive. /// /// 4 Contains, /// - /// Start with, case-insensitive + /// Start with, case-insensitive. /// /// 4 StartsWith, /// - /// End with, case-insensitive + /// End with, case-insensitive. /// /// 4 EndsWith, /// - /// IS NOT NUL + /// Is not null. /// /// 4 Exists, } /// - /// Enumeration for the filter match type of an integer. + /// Enumeration for the filter match types of an integer. /// /// 4 public enum IntegerMatchType @@ -260,12 +260,12 @@ namespace Tizen.Pims.Contacts /// 4 LessThanOrEqual, /// - /// <>, this flag can yield poor performance + /// <>, this flag can yield poor performance. /// /// 4 NotEqual, /// - /// IS NULL + /// Is null. /// /// 4 None, @@ -278,12 +278,12 @@ namespace Tizen.Pims.Contacts public enum LogicalOperator { /// - /// AND + /// And. /// /// 4 And, /// - /// OR + /// Or. /// /// 4 Or, @@ -293,9 +293,9 @@ namespace Tizen.Pims.Contacts private bool disposedValue = false; // To detect redundant calls /// - /// Releases all resources used by the ContactsFilter. + /// Releases all the resources used by the ContactsFilter. /// - /// Disposing by User + /// Disposing by the user. /// 4 protected virtual void Dispose(bool disposing) { @@ -319,8 +319,8 @@ namespace Tizen.Pims.Contacts } /// - /// Releases all resources used by the ContactsFilter. - /// It should be called after finished using of the object. + /// Releases all the resources used by the ContactsFilter. + /// It should be called after it has finished using the object. /// /// 4 public void Dispose() @@ -333,13 +333,13 @@ namespace Tizen.Pims.Contacts /// /// Adds a condition for a string type property. /// - /// The operator type - /// The property ID to add a condition - /// The match flag - /// The match value + /// The operator type. + /// The property ID to add a condition. + /// The match flag. + /// The match value. /// http://tizen.org/feature/contact - /// Thrown when feature is not supported - /// Thrown when one of the arguments provided to a method is not valid + /// Thrown when the feature is not supported. + /// Thrown when one of the arguments provided to a method is not valid. /// 4 public void AddCondition(LogicalOperator logicalOperator, uint propertyId, StringMatchType matchType, string matchValue) { @@ -359,15 +359,15 @@ namespace Tizen.Pims.Contacts } /// - /// Adds a condition for a integer type property. + /// Adds a condition for an integer type property. /// - /// The operator type - /// The property ID to add a condition - /// The match flag - /// The match value + /// The operator type. + /// The property ID to add a condition. + /// The match flag. + /// The match value. /// http://tizen.org/feature/contact - /// Thrown when feature is not supported - /// Thrown when one of the arguments provided to a method is not valid + /// Thrown when the feature is not supported. + /// Thrown when one of the arguments provided to a method is not valid. /// 4 public void AddCondition(LogicalOperator logicalOperator, uint propertyId, IntegerMatchType matchType, int matchValue) { @@ -389,13 +389,13 @@ namespace Tizen.Pims.Contacts /// /// Adds a condition for a long type property. /// - /// The operator type - /// The property ID to add a condition - /// The match flag - /// The match value + /// The operator type. + /// The property ID to add a condition. + /// The match flag. + /// The match value. /// http://tizen.org/feature/contact - /// Thrown when feature is not supported - /// Thrown when one of the arguments provided to a method is not valid + /// Thrown when the feature is not supported. + /// Thrown when one of the arguments provided to a method is not valid. /// 4 public void AddCondition(LogicalOperator logicalOperator, uint propertyId, IntegerMatchType matchType, long matchValue) { @@ -417,13 +417,13 @@ namespace Tizen.Pims.Contacts /// /// Adds a condition for a double type property. /// - /// The operator type - /// The property ID to add a condition - /// The match flag - /// The match value + /// The operator type. + /// The property ID to add a condition. + /// The match flag. + /// The match value. /// http://tizen.org/feature/contact - /// Thrown when feature is not supported - /// Thrown when one of the arguments provided to a method is not valid + /// Thrown when the feature is not supported. + /// Thrown when one of the arguments provided to a method is not valid. /// 4 public void AddCondition(LogicalOperator logicalOperator, uint propertyId, IntegerMatchType matchType, double matchValue) { @@ -445,12 +445,12 @@ namespace Tizen.Pims.Contacts /// /// Adds a condition for a boolean type property. /// - /// The operator type - /// The property ID to add a condition - /// The match value + /// The operator type. + /// The property ID to add a condition. + /// The match value. /// http://tizen.org/feature/contact - /// Thrown when feature is not supported - /// Thrown when one of the arguments provided to a method is not valid + /// Thrown when the feature is not supported. + /// Thrown when one of the arguments provided to a method is not valid. /// 4 public void AddCondition(LogicalOperator logicalOperator, uint propertyId, bool matchValue) { @@ -472,11 +472,11 @@ namespace Tizen.Pims.Contacts /// /// Adds a child filter to a parent filter. /// - /// The operator type - /// The child filter + /// The operator type. + /// The child filter. /// http://tizen.org/feature/contact - /// Thrown when feature is not supported - /// Thrown when one of the arguments provided to a method is not valid + /// Thrown when the feature is not supported. + /// Thrown when one of the arguments provided to a method is not valid. /// 4 public void AddFilter(LogicalOperator logicalOperator, ContactsFilter filter) { diff --git a/src/Tizen.Pims.Contacts/Tizen.Pims.Contacts/ContactsList.cs b/src/Tizen.Pims.Contacts/Tizen.Pims.Contacts/ContactsList.cs index 577bd69..b1fec65 100644 --- a/src/Tizen.Pims.Contacts/Tizen.Pims.Contacts/ContactsList.cs +++ b/src/Tizen.Pims.Contacts/Tizen.Pims.Contacts/ContactsList.cs @@ -19,7 +19,7 @@ using System; namespace Tizen.Pims.Contacts { /// - /// A list of records with the same type + /// A list of records with the same type. /// /// 4 public class ContactsList:IDisposable @@ -45,8 +45,8 @@ namespace Tizen.Pims.Contacts /// Creates a contacts record list. /// /// http://tizen.org/feature/contact - /// Thrown when feature is not supported - /// Thrown when failed due to out of memory + /// Thrown when the feature is not supported. + /// Thrown when failed due to out of memory. /// 4 public ContactsList() { @@ -60,7 +60,7 @@ namespace Tizen.Pims.Contacts } /// - /// Destructor + /// The destructor. /// /// 4 ~ContactsList() @@ -69,9 +69,9 @@ namespace Tizen.Pims.Contacts } /// - /// The count of contact entity. + /// The count of the contact entity. /// - /// The count of contact entity. + /// The count of the contact entity. /// 4 public int Count { @@ -91,9 +91,9 @@ namespace Tizen.Pims.Contacts private bool disposedValue = false; // To detect redundant calls /// - /// Releases all resources used by the ContactsList. + /// Releases all the resources used by the ContactsList. /// - /// Disposing by User + /// Disposing by the user. /// 4 protected virtual void Dispose(bool disposing) { @@ -118,8 +118,8 @@ namespace Tizen.Pims.Contacts } /// - /// Releases all resources used by the ContactsList. - /// It should be called after finished using of the object. + /// Releases all the resources used by the ContactsList. + /// It should be called after it has finished using the object. /// /// 4 public void Dispose() @@ -132,10 +132,10 @@ namespace Tizen.Pims.Contacts /// /// Adds a record to the contacts list. /// - /// The record to add + /// The record to add. /// http://tizen.org/feature/contact - /// Thrown when feature is not supported - /// Thrown when one of the arguments provided to a method is not valid + /// Thrown when the feature is not supported. + /// Thrown when one of the arguments provided to a method is not valid. /// 4 public void AddRecord(ContactsRecord record) { @@ -152,10 +152,10 @@ namespace Tizen.Pims.Contacts /// /// Removes a record from the contacts list. /// - /// The record to remove + /// The record to remove. /// http://tizen.org/feature/contact - /// Thrown when feature is not supported - /// Thrown when one of the arguments provided to a method is not valid + /// Thrown when the feature is not supported. + /// Thrown when one of the arguments provided to a method is not valid. /// 4 public void RemoveRecord(ContactsRecord record) { @@ -173,10 +173,10 @@ namespace Tizen.Pims.Contacts /// Retrieves a record from the contacts list. /// /// - /// contacts record + /// The contacts record. /// /// http://tizen.org/feature/contact - /// Thrown when feature is not supported + /// Thrown when the feature is not supported. /// 4 public ContactsRecord GetCurrentRecord() { @@ -197,7 +197,7 @@ namespace Tizen.Pims.Contacts /// When the cursor is already at the first position, it returns false. /// /// http://tizen.org/feature/contact - /// Thrown when feature is not supported + /// Thrown when the feature is not supported. /// 4 public bool MovePrevious() { @@ -226,7 +226,7 @@ namespace Tizen.Pims.Contacts /// When the cursor is already at the last position, it returns false. /// /// http://tizen.org/feature/contact - /// Thrown when feature is not supported + /// Thrown when the feature is not supported. /// 4 public bool MoveNext() { @@ -252,7 +252,7 @@ namespace Tizen.Pims.Contacts /// Moves a contacts list to the first position. /// /// http://tizen.org/feature/contact - /// Thrown when feature is not supported + /// Thrown when the feature is not supported. /// 4 public void MoveFirst() { @@ -268,7 +268,7 @@ namespace Tizen.Pims.Contacts /// Moves a contacts list to the last position. /// /// http://tizen.org/feature/contact - /// Thrown when feature is not supported + /// Thrown when the feature is not supported. /// 4 public void MoveLast() { diff --git a/src/Tizen.Pims.Contacts/Tizen.Pims.Contacts/ContactsManager.cs b/src/Tizen.Pims.Contacts/Tizen.Pims.Contacts/ContactsManager.cs index 0d8ebbb..e301e47 100644 --- a/src/Tizen.Pims.Contacts/Tizen.Pims.Contacts/ContactsManager.cs +++ b/src/Tizen.Pims.Contacts/Tizen.Pims.Contacts/ContactsManager.cs @@ -20,43 +20,43 @@ using System.Diagnostics.CodeAnalysis; namespace Tizen.Pims.Contacts { /// - /// Enumeration for name display order. + /// Enumeration for the name display order. /// /// 4 public enum ContactDisplayOrder { /// - /// First name comes at the first + /// First name comes at the first. /// /// 4 FirstLast, /// - /// First name comes at the last + /// First name comes at the last. /// /// 4 LastFirst }; /// - /// Enumeration for name sorting order. + /// Enumeration for the name sorting order. /// /// 4 public enum ContactSortingOrder { /// - /// Contacts are first sorted based on the first name + /// Contacts are first sorted based on the first name. /// /// 4 FirstLast, /// - /// Contacts are first sorted based on the last name + /// Contacts are first sorted based on the last name. /// /// 4 LastFirst }; /// - /// A class for managing contact information. It allows applications to access contacts database. + /// A class for managing the contact information. It allows the applications to access the contacts database. /// /// 4 public class ContactsManager : IDisposable @@ -70,8 +70,8 @@ namespace Tizen.Pims.Contacts /// Creates a ContactsManager. /// /// http://tizen.org/feature/contact - /// Thrown when method failed due to invalid operation - /// Thrown when feature is not supported + /// Thrown when the method failed due to an invalid operation. + /// Thrown when the feature is not supported. /// 4 public ContactsManager() { @@ -85,7 +85,7 @@ namespace Tizen.Pims.Contacts } /// - /// Destructor + /// The destructor. /// /// 4 ~ContactsManager() @@ -97,9 +97,9 @@ namespace Tizen.Pims.Contacts private bool disposedValue = false; // To detect redundant calls /// - /// Releases all resources used by the ContactsManager. + /// Releases all the resources used by the ContactsManager. /// - /// Disposing by User + /// Disposing by the user. /// 4 protected virtual void Dispose(bool disposing) { @@ -123,8 +123,8 @@ namespace Tizen.Pims.Contacts } /// - /// Releases all resources used by the ContactsManager. - /// It should be called after finished using of the object. + /// Releases all the resources used by the ContactsManager. + /// It should be called after it has finished using the object. /// /// 4 public void Dispose() @@ -138,7 +138,7 @@ namespace Tizen.Pims.Contacts private EventHandler _nameSortingOrderChanged; /// - /// (event) NameDisplayOrderChanged is raised when changing setting value of contacts name display order + /// (event) NameDisplayOrderChanged is raised when changing the setting value of the contacts name display order. /// /// http://tizen.org/privilege/contact.read /// 4 @@ -189,7 +189,7 @@ namespace Tizen.Pims.Contacts } /// - /// (event) NameSortingOrderChanged is raised when changing setting value of contacts name sorting order + /// (event) NameSortingOrderChanged is raised when changing the setting value of the contacts name sorting order. /// /// http://tizen.org/privilege/contact.read /// 4 @@ -240,9 +240,9 @@ namespace Tizen.Pims.Contacts } /// - /// A ContactsDatabase + /// A ContactsDatabase. /// - /// A ContactsDatabase + /// A ContactsDatabase. /// 4 public ContactsDatabase Database { @@ -253,11 +253,11 @@ namespace Tizen.Pims.Contacts } /// - /// A setting value of contacts name display order + /// A setting value of the contacts name display order. /// - /// A setting value of contacts name display order + /// A setting value of the contacts name display order. /// - /// DisplayName of contacts returned from database are determined by this property + /// DisplayName of the contacts returned from the database is determined by this property. /// /// http://tizen.org/privilege/contact.read /// http://tizen.org/privilege/contact.write @@ -286,11 +286,11 @@ namespace Tizen.Pims.Contacts } /// - /// A setting value of contacts name sorting order + /// A setting value of the contacts name sorting order. /// - /// A setting value of contacts name sorting order + /// A setting value of the contacts name sorting order. /// - /// Contacts returned from database are first sorted based on the first name or last name by this property + /// Contacts returned from the database are first sorted based on the first name or last name by this property. /// /// http://tizen.org/privilege/contact.read /// http://tizen.org/privilege/contact.write diff --git a/src/Tizen.Pims.Contacts/Tizen.Pims.Contacts/ContactsQuery.cs b/src/Tizen.Pims.Contacts/Tizen.Pims.Contacts/ContactsQuery.cs index 4676a9d..5077509 100644 --- a/src/Tizen.Pims.Contacts/Tizen.Pims.Contacts/ContactsQuery.cs +++ b/src/Tizen.Pims.Contacts/Tizen.Pims.Contacts/ContactsQuery.cs @@ -20,10 +20,10 @@ using System.Diagnostics.CodeAnalysis; namespace Tizen.Pims.Contacts { /// - /// A query is used to retrieve data which satisfies given criteria + /// A query is used to retrieve the data, which satisfies a given criteria. /// /// - /// A query is used to retrieve person, group, speed dial, and log data which satisfies a given criteria, such as an integer property being greater than a given value, or a string property containing a given substring. + /// A query is used to retrieve a person, group, speed dial, and log data, which satisfies a given criteria, such as an integer property being greater than a given value or a string property containing a given substring. /// A query needs a filter which can set the conditions for the search. /// /// 4 @@ -34,11 +34,11 @@ namespace Tizen.Pims.Contacts /// /// Creates a query. /// - /// The view URI of a query + /// The view URI of a query. /// http://tizen.org/feature/contact - /// Thrown when feature is not supported - /// Thrown when one of the arguments provided to a method is not valid - /// Thrown when failed due to out of memory + /// Thrown when the feature is not supported. + /// Thrown when one of the arguments provided to a method is not valid. + /// Thrown when failed due to out of memory. /// 4 [SuppressMessage("Microsoft.Design", "CA1054:UriParametersShouldNotBeStrings")] public ContactsQuery(string viewUri) @@ -57,7 +57,7 @@ namespace Tizen.Pims.Contacts } /// - /// Destructor + /// The destructor. /// /// 4 ~ContactsQuery() @@ -68,9 +68,9 @@ namespace Tizen.Pims.Contacts private bool disposedValue = false; /// - /// Releases all resources used by the ContactsQuery. + /// Releases all the resources used by the ContactsQuery. /// - /// Disposing by User + /// Disposing by the user. /// 4 protected virtual void Dispose(bool disposing) { @@ -94,8 +94,8 @@ namespace Tizen.Pims.Contacts } /// - /// Releases all resources used by the ContactsQuery. - /// It should be called after finished using of the object. + /// Releases all the resources used by the ContactsQuery. + /// It should be called after it has finished using the object. /// /// 4 public void Dispose() @@ -106,12 +106,12 @@ namespace Tizen.Pims.Contacts #endregion /// - /// Adds property IDs for projection. + /// Adds the property IDs for projection. /// - /// The property ID array + /// The property ID array. /// http://tizen.org/feature/contact - /// Thrown when feature is not supported - /// Thrown when one of the arguments provided to a method is not valid + /// Thrown when the feature is not supported. + /// Thrown when one of the arguments provided to a method is not valid. /// 4 public void SetProjection(uint[] propertyIdArray) { @@ -131,9 +131,9 @@ namespace Tizen.Pims.Contacts /// /// Sets the "distinct" option for projection. /// - /// If true it is set, otherwise if false it is unset + /// If true it is set, otherwise if false it is unset. /// http://tizen.org/feature/contact - /// Thrown when feature is not supported + /// Thrown when the feature is not supported. /// 4 public void SetDistinct(bool set) { @@ -148,10 +148,10 @@ namespace Tizen.Pims.Contacts /// /// Sets the filter for a query. /// - /// The filter + /// The filter. /// http://tizen.org/feature/contact - /// Thrown when feature is not supported - /// Thrown when one of the arguments provided to a method is not valid + /// Thrown when the feature is not supported. + /// Thrown when one of the arguments provided to a method is not valid. /// 4 public void SetFilter(ContactsFilter filter) { @@ -166,11 +166,11 @@ namespace Tizen.Pims.Contacts /// /// Sets the sort mode for a query. /// - /// The property ID to sort - /// If true it sorts in the ascending order, otherwise if false it sorts in the descending order + /// The property ID to sort. + /// If true it sorts in ascending order, otherwise if false it sorts in descending order. /// http://tizen.org/feature/contact - /// Thrown when feature is not supported - /// Thrown when one of the arguments provided to a method is not valid + /// Thrown when the feature is not supported. + /// Thrown when one of the arguments provided to a method is not valid. /// 4 public void SetSort(uint propertyId, bool isAscending) { diff --git a/src/Tizen.Pims.Contacts/Tizen.Pims.Contacts/ContactsRecord.cs b/src/Tizen.Pims.Contacts/Tizen.Pims.Contacts/ContactsRecord.cs index 464cad3..42d7da5 100644 --- a/src/Tizen.Pims.Contacts/Tizen.Pims.Contacts/ContactsRecord.cs +++ b/src/Tizen.Pims.Contacts/Tizen.Pims.Contacts/ContactsRecord.cs @@ -21,7 +21,7 @@ using System.Runtime.InteropServices; namespace Tizen.Pims.Contacts { /// - /// A record represents an actual record in the database + /// A record represents an actual record in the database. /// /// /// A record represents an actual record in the database, but you can also consider it a piece of information, such as an address, a phone number, or a group of contacts. @@ -85,11 +85,11 @@ namespace Tizen.Pims.Contacts /// /// Creates a record. /// - /// The view URI + /// The view URI. /// http://tizen.org/feature/contact - /// Thrown when feature is not supported - /// Thrown when one of the arguments provided to a method is not valid - /// Thrown when failed due to out of memory + /// Thrown when the feature is not supported. + /// Thrown when one of the arguments provided to a method is not valid. + /// Thrown when failed due to out of memory. /// 4 [SuppressMessage("Microsoft.Design", "CA1054:UriParametersShouldNotBeStrings")] public ContactsRecord(string viewUri) @@ -105,7 +105,7 @@ namespace Tizen.Pims.Contacts } /// - /// Destructor + /// The destructor. /// /// 4 ~ContactsRecord() @@ -114,9 +114,9 @@ namespace Tizen.Pims.Contacts } /// - /// The URI of the record + /// The URI of the record. /// - /// The URI of the record + /// The URI of the record. /// 4 [SuppressMessage("Microsoft.Design", "CA1056:UriPropertiesShouldNotBeStrings")] public string Uri @@ -131,9 +131,9 @@ namespace Tizen.Pims.Contacts internal bool _disposedValue = false; // To detect redundant calls /// - /// Releases all resources used by the ContactsRecord. + /// Releases all the resources used by the ContactsRecord. /// - /// Disposing by User + /// Disposing by the user. /// 4 protected virtual void Dispose(bool disposing) { @@ -157,8 +157,8 @@ namespace Tizen.Pims.Contacts } /// - /// Releases all resources used by the ContactsRecord. - /// It should be called after finished using of the object. + /// Releases all the resources used by the ContactsRecord. + /// It should be called after it has finished using the object. /// /// 4 public void Dispose() @@ -171,10 +171,10 @@ namespace Tizen.Pims.Contacts /// /// Makes a clone of a record. /// - /// A cloned record + /// A cloned record. /// http://tizen.org/feature/contact - /// Thrown when feature is not supported - /// Thrown when failed due to out of memory + /// Thrown when the feature is not supported. + /// Thrown when failed due to out of memory. /// 4 public ContactsRecord Clone() { @@ -191,13 +191,13 @@ namespace Tizen.Pims.Contacts /// /// Gets a value of the property from a record. /// - /// The property ID + /// The property ID. /// - /// The value of the property corresponding to property id. + /// The value of the property corresponding to a property ID. /// /// http://tizen.org/feature/contact - /// Thrown when feature is not supported - /// Thrown when one of the arguments provided to a method is not valid + /// Thrown when the feature is not supported. + /// Thrown when one of the arguments provided to a method is not valid. /// 4 public T Get(uint propertyId) { @@ -269,10 +269,10 @@ namespace Tizen.Pims.Contacts /// Sets a value of the property to a record. /// /// http://tizen.org/feature/contact - /// Thrown when feature is not supported - /// The property ID - /// The value to set - /// Thrown when one of the arguments provided to a method is not valid + /// Thrown when the feature is not supported. + /// The property ID. + /// The value to set. + /// Thrown when one of the arguments provided to a method is not valid. /// 4 public void Set(uint propertyId, T value) { @@ -336,11 +336,11 @@ namespace Tizen.Pims.Contacts /// /// Adds a child record to the parent record. /// - /// The property ID - /// The child record to add to parent record + /// The property ID. + /// The child record to add to the parent record<./param> /// http://tizen.org/feature/contact - /// Thrown when feature is not supported - /// Thrown when one of the arguments provided to a method is not valid + /// Thrown when the feature is not supported. + /// Thrown when one of the arguments provided to a method is not valid. /// 4 public void AddChildRecord(uint propertyId, ContactsRecord childRecord) { @@ -356,11 +356,11 @@ namespace Tizen.Pims.Contacts /// /// Removes a child record from the parent record. /// - /// The property ID - /// The child record to remove from parent record + /// The property ID. + /// The child record to remove from the parent record. /// http://tizen.org/feature/contact - /// Thrown when feature is not supported - /// Thrown when one of the arguments provided to a method is not valid + /// Thrown when feature is not supported. + /// Thrown when one of the arguments provided to a method is not valid. /// 4 public void RemoveChildRecord(uint propertyId, ContactsRecord childRecord) { @@ -376,11 +376,11 @@ namespace Tizen.Pims.Contacts /// /// Gets the number of child records of a parent record. /// - /// The property ID - /// The number of child records corresponding to property ID + /// The property ID. + /// The number of child records corresponding to the property ID. /// http://tizen.org/feature/contact - /// Thrown when feature is not supported - /// Thrown when one of the arguments provided to a method is not valid + /// Thrown when the feature is not supported. + /// Thrown when one of the arguments provided to a method is not valid. /// 4 public int GetChildRecordCount(uint propertyId) { @@ -395,14 +395,14 @@ namespace Tizen.Pims.Contacts } /// - /// Gets a child record from the parent record + /// Gets a child record from the parent record. /// - /// The property ID - /// The index of child record + /// The property ID. + /// The index of the child record. /// The record /// http://tizen.org/feature/contact - /// Thrown when feature is not supported - /// Thrown when one of the arguments provided to a method is not valid + /// Thrown when the feature is not supported. + /// Thrown when one of the arguments provided to a method is not valid. /// 4 public ContactsRecord GetChildRecord(uint propertyId, int index) { @@ -418,15 +418,15 @@ namespace Tizen.Pims.Contacts } /// - /// Clones a child record list corresponding to property ID + /// Clones a child record list corresponding to the property ID. /// - /// The property ID + /// The property ID. /// - /// The record list + /// The record list. /// /// http://tizen.org/feature/contact - /// Thrown when feature is not supported - /// Thrown when one of the arguments provided to a method is not valid + /// Thrown when the feature is not supported. + /// Thrown when one of the arguments provided to a method is not valid. /// 4 public ContactsList CloneChildRecordList(uint propertyId) { diff --git a/src/Tizen.Pims.Contacts/Tizen.Pims.Contacts/ContactsVcard.cs b/src/Tizen.Pims.Contacts/Tizen.Pims.Contacts/ContactsVcard.cs index 4ea6ff0..02bf843 100644 --- a/src/Tizen.Pims.Contacts/Tizen.Pims.Contacts/ContactsVcard.cs +++ b/src/Tizen.Pims.Contacts/Tizen.Pims.Contacts/ContactsVcard.cs @@ -21,18 +21,18 @@ namespace Tizen.Pims.Contacts using ContactsViews; /// - /// Delegate for getting a record parsed from a vCard file + /// Delegates for getting a record parsed from a vCard file. /// - /// The contacts record - /// true to continue with the next iteration of the loop, otherwise false to break out of the loop + /// The contacts record. + /// true to continue with the next iteration of the loop, otherwise false to break out of the loop. /// 4 public delegate bool ParseCallback(ContactsRecord record); /// - /// A class for parsing and making vCards. + /// A class for parsing and making the vCards. /// /// - /// It's based on the vCard v3.0 specification + /// It's based on the vCard v3.0 specification. /// /// 4 public static class ContactsVcard @@ -40,15 +40,15 @@ namespace Tizen.Pims.Contacts /// /// Retrieves the vCard stream from a contacts record. /// - /// The contacts record + /// The contacts record. /// /// The vCard stream. /// /// http://tizen.org/privilege/contact.read /// http://tizen.org/feature/contact - /// Thrown when one of the arguments provided to a method is not valid - /// Thrown when failed due to out of memory - /// Thrown when feature is not supported + /// Thrown when one of the arguments provided to a method is not valid. + /// Thrown when failed due to out of memory. + /// Thrown when the feature is not supported. /// 4 public static string Compose(ContactsRecord record) { @@ -82,16 +82,16 @@ namespace Tizen.Pims.Contacts } /// - /// Retrieves all contacts with a contacts list from a vCard stream + /// Retrieves all the contacts with a contacts list from a vCard stream. /// - /// The vCard stream + /// The vCard stream. /// - /// The contacts list + /// The contacts list. /// /// http://tizen.org/feature/contact - /// Thrown when one of the arguments provided to a method is not valid - /// Thrown when failed due to out of memory - /// Thrown when feature is not supported + /// Thrown when one of the arguments provided to a method is not valid. + /// Thrown when failed due to out of memory. + /// Thrown when the feature is not supported. /// 4 public static ContactsList Parse(string stream) { @@ -108,15 +108,15 @@ namespace Tizen.Pims.Contacts } /// - /// Retrieves all contacts with a record from a vCard file. + /// Retrieves all the contacts with a record from a vCard file. /// - /// The file path of vCard stream file - /// The callback function to invoke + /// The file path of a vCard stream file. + /// The callback function to invoke. /// http://tizen.org/feature/contact - /// Thrown when method failed due to invalid operation - /// Thrown when one of the arguments provided to a method is not valid - /// Thrown when failed due to out of memory - /// Thrown when feature is not supported + /// Thrown when the method failed due to an invalid operation. + /// Thrown when one of the arguments provided to a method is not valid. + /// Thrown when failed due to out of memory. + /// Thrown when the feature is not supported. /// 4 public static void ParseForEach(string path, ParseCallback callback) { diff --git a/src/Tizen.Pims.Contacts/Tizen.Pims.Contacts/ContactsViews.cs b/src/Tizen.Pims.Contacts/Tizen.Pims.Contacts/ContactsViews.cs index cb04fb5..1daded8 100644 --- a/src/Tizen.Pims.Contacts/Tizen.Pims.Contacts/ContactsViews.cs +++ b/src/Tizen.Pims.Contacts/Tizen.Pims.Contacts/ContactsViews.cs @@ -23,13 +23,13 @@ namespace Tizen.Pims.Contacts namespace ContactsViews { /// - /// This namespace provides information about views with properties. + /// This namespace provides information about the views with properties. /// /// /// 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. + /// A record can have basic properties of five types: integer, string, boolean, long, and double. /// /// 4 @@ -388,73 +388,73 @@ namespace Tizen.Pims.Contacts } /// - /// Enumeration for contact change state. + /// Enumeration for the contact change states. /// /// 4 public enum ChangeType { /// - /// Inserted + /// Inserted. /// /// 4 Inserted, /// - /// Updated + /// Updated. /// /// 4 Updated, /// - /// Deleted + /// Deleted. /// /// 4 Deleted, } /// - /// Describes properties of a Address book record. + /// Describes the properties of an address book record. /// /// 4 public static class AddressBook { /// - /// Identifier of this contacts address book view + /// Identifier of this contacts address book view. /// /// 4 public const string Uri = "tizen.contacts_view.addressbook"; /// - /// integer, read only, DB record ID of the address book + /// Integer, read only, database record ID of the address book. /// /// 4 public const uint Id = (uint)Property.Id.AddressBookId; /// - /// integer, read/write once, Account ID that the address book belongs to + /// Integer, read/write once, account ID that the address book belongs to. /// /// 4 public const uint AccountId = (uint)Property.Id.AddressBookAccountId; /// - /// string, read/write, It cannot be NULL. Duplicate names are not allowed. + /// String, read/write, it cannot be null. Duplicate names are not allowed. /// /// 4 public const uint Name = (uint)Property.Id.AddressBookName; /// - /// integer, read/write, AddressBook mode, refer to the ModeValue + /// Integer, read/write, AddressBook mode, refer to the ModeValue. /// /// 4 public const uint Mode = (uint)Property.Id.AddressBookMode; /// - /// Enumeration for Address book mode. + /// Enumeration for the address book modes. /// /// 4 public enum ModeValue { /// - /// All module can read and write contacts of this address_book + /// All modules can read and write the contacts of this address_book. /// /// 4 None, /// - /// All module can only read contacts of this address_book + /// All modules can only read the contacts of this address_book. /// /// 4 ReadOnly, @@ -462,467 +462,467 @@ namespace Tizen.Pims.Contacts } /// - /// Describes properties of a Group record. + /// Describes the properties of a Group record. /// /// 4 public static class Group { /// - /// Identifier of this contacts group view + /// Identifier of this contacts group view. /// /// 4 public const string Uri = "tizen.contacts_view.group"; /// - /// DB record ID of the group + /// Database record ID of the group. /// /// 4 public const uint Id = (uint)Property.Id.GroupId; /// - /// AddressBook ID that the group belongs to + /// AddressBook ID that the group belongs to. /// /// 4 public const uint AddressBookId = (uint)Property.Id.GroupAddressBookId; /// - /// Group name + /// Group name. /// /// 4 public const uint Name = (uint)Property.Id.GroupName; /// - /// Ringtone path of the group + /// Ringtone path of the group. /// /// 4 public const uint RingtonePath = (uint)Property.Id.GroupRingtone; /// - /// Image path of the group + /// Image path of the group. /// /// 4 public const uint ImagePath = (uint)Property.Id.GroupImage; /// - /// Vibration path of the group + /// Vibration path of the group. /// /// 4 public const uint Vibration = (uint)Property.Id.GroupVibration; /// - /// Extra data for default group name + /// Extra data for the default group name. /// /// 4 public const uint ExtraData = (uint)Property.Id.GroupExtraData; /// - /// The group is read only or not + /// The group is read-only or not. /// /// 4 public const uint IsReadOnly = (uint)Property.Id.GroupIsReadOnly; /// - /// Message alert path of the group + /// Message alert path of the group. /// /// 4 public const uint MessageAlert = (uint)Property.Id.GroupMessageAlert; } /// - /// Describes properties of a Person record. + /// Describes the properties of a Person record. /// /// 4 public static class Person { /// - /// Identifier of this contacts person view + /// Identifier of this contacts person view. /// /// 4 public const string Uri = "tizen.contacts_view.person"; /// - /// DB record ID of the person + /// Database record ID of the person. /// /// 4 public const uint Id = (uint)Property.Id.PersonId; /// - /// Display name of the person + /// Display name of the person. /// /// 4 public const uint DisplayName = (uint)Property.Id.PersonDisplayName; /// - /// The first character of first string for grouping. This is normalized using ICU (projection) + /// The first character of the first string for grouping. This is normalized using ICU (projection). /// /// 4 public const uint DisplayNameIndex = (uint)Property.Id.PersonDisplayNameIndex; /// - /// Display contact ID that the person belongs to + /// Display contact ID that the person belongs to. /// /// 4 public const uint DisplayContactId = (uint)Property.Id.PersonDisplayContactId; /// - /// Ringtone path of the person + /// Ringtone path of the person. /// /// 4 public const uint RingtonePath = (uint)Property.Id.PersonRingtone; /// - /// Image thumbnail path of the person + /// Image thumbnail path of the person. /// /// 4 public const uint ThumbnailPath = (uint)Property.Id.PersonThumbnail; /// - /// Vibration path of the person + /// Vibration path of the person. /// /// 4 public const uint Vibration = (uint)Property.Id.PersonVibration; /// - /// Message alert path of the person + /// Message alert path of the person. /// /// 4 public const uint MessageAlert = (uint)Property.Id.PersonMessageAlert; /// - /// Status of social account + /// Status of the social account. /// /// 4 public const uint Status = (uint)Property.Id.PersonStatus; /// - /// The person is favorite or not + /// The person is a favorite or not. /// /// 4 public const uint IsFavorite = (uint)Property.Id.PersonIsFavorite; /// - /// The priority of favorite contacts. it can be used as sorting key + /// The priority of the favorite contacts. It can be used as a sorting key. /// /// 4 public const uint FavoritePriority = (uint)Property.Id.PersonFavoritePriority; /// - /// Link count of contact records (projection) + /// Link count of the contact records (projection). /// /// 4 public const uint LinkCount = (uint)Property.Id.PersonLinkCount; /// - /// AddressBook IDs that the person belongs to (projection) + /// AddressBook IDs that the person belongs to (projection). /// /// 4 public const uint AddressBookIds = (uint)Property.Id.PersonAddressBookIds; /// - /// The person has phone number or not + /// The person has a phone number or not. /// /// 4 public const uint HasPhoneNumber = (uint)Property.Id.PersonHasPhoneNumber; /// - /// The person has email or not + /// The person has an email or not. /// /// 4 public const uint HasEmail = (uint)Property.Id.PersonHasEmail; /// - /// keyword matched data type + /// Keyword matched data type. /// /// 4 public const uint SnippetType = (uint)Property.Id.PersonSnippetType; /// - /// keyword matched data string + /// Keyword matched data string. /// /// 4 public const uint SnippetString = (uint)Property.Id.PersonSnippetString; } /// - /// Describes properties of a Contact record. + /// Describes the properties of a Contact record. /// /// 4 public static class Contact { /// - /// Identifier of this contact view + /// Identifier of this contacts view. /// /// 4 public const string Uri = "tizen.contacts_view.contact"; /// - /// DB record ID of the contact + /// Database record ID of the contact. /// /// 4 public const uint Id = (uint)Property.Id.ContactId; /// - /// Display name of the contact + /// Display name of the contact. /// /// 4 public const uint DisplayName = (uint)Property.Id.ContactDisplayName; /// - /// The source type of display name, refer to the DisplayNameSourceType + /// The source type of the display name, refer to the DisplayNameSourceType. /// /// 4 public const uint DisplaySourceType = (uint)Property.Id.ContactDisplaySourceDataId; /// - /// AddressBook ID that the contact belongs to + /// AddressBook ID that the contact belongs to. /// /// 4 public const uint AddressBookId = (uint)Property.Id.ContactAddressBookId; /// - /// Ringtone path of the contact + /// Ringtone path of the contact. /// /// 4 public const uint RingtonePath = (uint)Property.Id.ContactRingtone; /// - /// Image thumbnail path of the contact + /// Image thumbnail path of the contact. /// /// 4 public const uint ThumbnailPath = (uint)Property.Id.ContactThumbnail; /// - /// The contact is favorite or not + /// The contact is a favorite or not. /// /// 4 public const uint IsFavorite = (uint)Property.Id.ContactIsFavorite; /// - /// The contact has phone number or not + /// The contact has a phone number or not. /// /// 4 public const uint HasPhoneNumber = (uint)Property.Id.ContactHasPhoneNumber; /// - /// The contact has email or not + /// The contact has an email or not. /// /// 4 public const uint HasEmail = (uint)Property.Id.ContactHasEmail; /// - /// Person ID that the contact belongs to. If set when inserting, a contact will be linked to person + /// Person ID that the contact belongs to. If set when inserting, a contact will be linked to the person. /// /// 4 public const uint PersonId = (uint)Property.Id.ContactPersonId; /// - /// Unique identifier + /// Unique identifier. /// /// 4 public const uint UId = (uint)Property.Id.ContactUId; /// - /// Vibration path of the contact + /// Vibration path of the contact. /// /// 4 public const uint Vibration = (uint)Property.Id.ContactVibration; /// - /// Message alert path of the contact + /// Message alert path of the contact. /// /// 4 public const uint MessageAlert = (uint)Property.Id.ContactMessageAlert; /// - /// Last changed contact time + /// Last changed contact time. /// /// 4 public const uint ChangedTime = (uint)Property.Id.ContactChangedTime; /// - /// The link mode, refer to the LinkModeValue. If the person_id was set, this value will be ignored + /// The link mode, refer to the LinkModeValue. If the person_id was set, this value will be ignored. /// /// 4 public const uint LinkMode = (uint)Property.Id.ContactLinkMode; /// - /// Name child record (single) + /// Name child record (single). /// /// 4 public const uint Name = (uint)Property.Id.ContactName; /// - /// Company child record (multiple) + /// Company child record (multiple). /// /// 4 public const uint Company = (uint)Property.Id.ContactCompany; /// - /// Note child record (multiple) + /// Note child record (multiple). /// /// 4 public const uint Note = (uint)Property.Id.ContactNote; /// - /// Number child record (multiple) + /// Number child record (multiple). /// /// 4 public const uint Number = (uint)Property.Id.ContactNumber; /// - /// Email child record (multiple) + /// Email child record (multiple). /// /// 4 public const uint Email = (uint)Property.Id.ContactEmail; /// - /// Event child record (multiple) + /// Event child record (multiple). /// /// 4 public const uint Event = (uint)Property.Id.ContactEvent; /// - /// Messenger child record (multiple) + /// Messenger child record (multiple). /// /// 4 public const uint Messenger = (uint)Property.Id.ContactMessenger; /// - /// Address child record (multiple) + /// Address child record (multiple). /// /// 4 public const uint Address = (uint)Property.Id.ContactAddress; /// - /// URL child record (multiple) + /// URL child record (multiple). /// /// 4 public const uint URL = (uint)Property.Id.ContactURL; /// - /// Nickname child record (multiple) + /// Nickname child record (multiple). /// /// 4 public const uint Nickname = (uint)Property.Id.ContactNickname; /// - /// Profile child record (multiple) + /// Profile child record (multiple). /// /// 4 public const uint Profile = (uint)Property.Id.ContactProfile; /// - /// Relationship child record (multiple) + /// Relationship child record (multiple). /// /// 4 public const uint Relationship = (uint)Property.Id.ContactRelationship; /// - /// Image child record (multiple) + /// Image child record (multiple). /// /// 4 public const uint Image = (uint)Property.Id.ContactImage; /// - /// GroupRelation child record (multiple) + /// GroupRelation child record (multiple). /// /// 4 public const uint GroupRelation = (uint)Property.Id.ContactGroupRelation; /// - /// Extension child record (multiple) + /// Extension child record (multiple). /// /// 4 public const uint Extension = (uint)Property.Id.ContactExtension; /// - /// Sip child record (multiple) + /// SIP child record (multiple). /// /// 4 public const uint Sip = (uint)Property.Id.ContactSip; /// - /// Enumeration for link mode when inserting contact. + /// Enumeration for the link modes when inserting the contact. /// /// 4 public enum LinkModeValue { /// - /// Auto link immediately + /// Auto link immediately. /// /// 4 Auto, /// - /// Do not auto link when the contact is inserted + /// Do not auto link when the contact is inserted. /// /// 4 None } /// - /// Enumeration for Contact display name source type. + /// Enumeration for the Contact display name source types. /// /// 4 public enum DisplayNameSourceType { /// - /// Invalid source of display name + /// Invalid source of the display name. /// /// 4 Invalid, /// - /// Produced display name from email record + /// Produced display name from the email record. /// /// 4 Email, /// - /// Produced display name from number record + /// Produced display name from the number record. /// /// 4 Number, /// - /// Produced display name from nickname record + /// Produced display name from the nickname record. /// /// 4 Nickname, /// - /// Produced display name from company record + /// Produced display name from the company record. /// /// 4 Company, /// - /// Produced display name from name record + /// Produced display name from the name record. /// /// 4 Name, } /// - /// Enumeration for contacts data type. + /// Enumeration for the contacts data types. /// /// 4 public enum DataType { /// - /// None + /// None. /// /// 4 None, /// - /// Name + /// Name. /// /// 4 Name = 1, /// - /// Address + /// Address. /// /// 4 Address = 2, /// - /// Messenger + /// Messenger. /// /// 4 Messenger = 3, /// - /// URL + /// URL. /// /// 4 URL = 4, /// - /// Event + /// Event. /// /// 4 Event = 5, /// - /// Company + /// Company. /// /// 4 Company = 6, /// - /// Nickname + /// Nickname. /// /// 4 Nickname = 7, /// - /// Number + /// Number. /// /// 4 Number = 8, /// - /// Email + /// Email. /// /// 4 Email = 9, /// - /// Profile + /// Profile. /// /// 4 Profile = 10, /// - /// Relationship + /// Relationship. /// /// 4 Relationship = 11, /// - /// Note + /// Note. /// /// 4 Note = 12, /// - /// Image + /// Image. /// /// 4 Image = 13, /// - /// SIP + /// SIP. /// /// 4 Sip = 14, /// - /// Extension + /// Extension. /// /// 4 Extension = 100 @@ -930,425 +930,425 @@ namespace Tizen.Pims.Contacts } /// - /// Describes properties of a Simple contact record. + /// Describes the properties of a Simple contact record. /// /// 4 public static class SimpleContact { /// - /// Identifier of this simple contact view + /// Identifier of this simple contact view. /// /// 4 public const string Uri = "tizen.contacts_view.simple_contact"; /// - /// DB record ID of the contact + /// Database record ID of the contact. /// /// 4 public const uint Id = (uint)Property.Id.ContactId; /// - /// Display name of the contact + /// Display name of the contact. /// /// 4 public const uint DisplayName = (uint)Property.Id.ContactDisplayName; /// - /// The source type of display name, refer to the Contact.DisplayNameSourceType + /// The source type of the display name, refer to the Contact.DisplayNameSourceType /// /// 4 public const uint DisplaySourceType = (uint)Property.Id.ContactDisplaySourceDataId; /// - /// AddressBook that the contact belongs to + /// AddressBook that the contact belongs to. /// /// 4 public const uint AddressBookId = (uint)Property.Id.ContactAddressBookId; /// - /// Ringtone path of the contact + /// Ringtone path of the contact. /// /// 4 public const uint RingtonePath = (uint)Property.Id.ContactRingtone; /// - /// Image thumbnail path of the contact + /// Image thumbnail path of the contact. /// /// 4 public const uint ThumbnailPath = (uint)Property.Id.ContactThumbnail; /// - /// The contact is favorite or not + /// The contact is a favorite or not. /// /// 4 public const uint IsFavorite = (uint)Property.Id.ContactIsFavorite; /// - /// The contact has phone number or not + /// The contact has a phone number or not. /// /// 4 public const uint HasPhoneNumber = (uint)Property.Id.ContactHasPhoneNumber; /// - /// The contact has email or not + /// The contact has an email or not. /// /// 4 public const uint HasEmail = (uint)Property.Id.ContactHasEmail; /// - /// Person ID that the contact belongs to + /// Person ID that the contact belongs to. /// /// 4 public const uint PersonId = (uint)Property.Id.ContactPersonId; /// - /// Unique identifier + /// Unique identifier. /// /// 4 public const uint UId = (uint)Property.Id.ContactUId; /// - /// Vibration path of the contact + /// Vibration path of the contact. /// /// 4 public const uint Vibration = (uint)Property.Id.ContactVibration; /// - /// Message alert path of the contact + /// Message alert path of the contact. /// /// 4 public const uint MessageAlert = (uint)Property.Id.ContactMessageAlert; /// - /// Last changed contact time + /// Last changed contact time. /// /// 4 public const uint ChangedTime = (uint)Property.Id.ContactChangedTime; } /// - /// Describes properties of a My profile record. + /// Describes the properties of My profile record. /// /// 4 public static class MyProfile { /// - /// Identifier of this my profile view + /// Identifier of this my profile view. /// /// 4 public const string Uri = "tizen.contacts_view.my_profile"; /// - /// DB record ID of the my profile + /// Database record ID of the my profile. /// /// 4 public const uint Id = (uint)Property.Id.MyProfileId; /// - /// Display name of the profile + /// Display name of the profile. /// /// 4 public const uint DisplayName = (uint)Property.Id.MyProfileDisplayName; /// - /// AddressBook ID that the profile belongs to + /// AddressBook ID that the profile belongs to. /// /// 4 public const uint AddressBookId = (uint)Property.Id.MyProfileAddressBookId; /// - /// Image thumbnail path of the profile + /// Image thumbnail path of the profile. /// /// 4 public const uint ThumbnailPath = (uint)Property.Id.MyProfileThumbnail; /// - /// Unique identifier + /// Unique identifier. /// /// 4 public const uint UId = (uint)Property.Id.MyProfileUId; /// - /// Last changed profile time + /// Last changed profile time. /// /// 4 public const uint ChangedTime = (uint)Property.Id.MyProfileChangedTime; /// - /// Name child record (single) + /// Name child record (single). /// /// 4 public const uint Name = (uint)Property.Id.MyProfileName; /// - /// Company child record (multiple) + /// Company child record (multiple). /// /// 4 public const uint Company = (uint)Property.Id.MyProfileCompany; /// - /// Note child record (multiple) + /// Note child record (multiple). /// /// 4 public const uint Note = (uint)Property.Id.MyProfileNote; /// - /// Number child record (multiple) + /// Number child record (multiple). /// /// 4 public const uint Number = (uint)Property.Id.MyProfileNumber; /// - /// Email child record (multiple) + /// Email child record (multiple). /// /// 4 public const uint Email = (uint)Property.Id.MyProfileEmail; /// - /// Event child record (multiple) + /// Event child record (multiple). /// /// 4 public const uint Event = (uint)Property.Id.MyProfileEvent; /// - /// Messenger child record (multiple) + /// Messenger child record (multiple). /// /// 4 public const uint Messenger = (uint)Property.Id.MyProfileMessenger; /// - /// Address child record (multiple) + /// Address child record (multiple). /// /// 4 public const uint Address = (uint)Property.Id.MyProfileAddress; /// - /// URL child record (multiple) + /// URL child record (multiple). /// /// 4 public const uint URL = (uint)Property.Id.MyProfileURL; /// - /// Nickname child record (multiple) + /// Nickname child record (multiple). /// /// 4 public const uint Nickname = (uint)Property.Id.MyProfileNickname; /// - /// Profile child record (multiple) + /// Profile child record (multiple). /// /// 4 public const uint Profile = (uint)Property.Id.MyProfileProfile; /// - /// Relationship child record (multiple) + /// Relationship child record (multiple). /// /// 4 public const uint Relationship = (uint)Property.Id.MyProfileRelationship; /// - /// Image child record (multiple) + /// Image child record (multiple). /// /// 4 public const uint Image = (uint)Property.Id.MyProfileImage; /// - /// Extension child record (multiple) + /// Extension child record (multiple). /// /// 4 public const uint Extension = (uint)Property.Id.MyProfileExtension; /// - /// Sip child record (multiple) + /// SIP child record (multiple). /// /// 4 public const uint Sip = (uint)Property.Id.MyProfileSip; } /// - /// Describes properties of a Name record. + /// Describes the properties of a Name record. /// /// 4 public static class Name { /// - /// Identifier of this contacts name view + /// Identifier of this contacts name view. /// /// 4 public const string Uri = "tizen.contacts_view.name"; /// - /// DB record ID of the name + /// Database record ID of the name. /// /// 4 public const uint Id = (uint)Property.Id.NameId; /// - /// Contacts ID that the name record belongs to + /// Contacts ID that the name record belongs to. /// /// 4 public const uint ContactId = (uint)Property.Id.NameContactId; /// - /// First name + /// First name. /// /// 4 public const uint First = (uint)Property.Id.NameFirst; /// - /// Last name + /// Last name. /// /// 4 public const uint Last = (uint)Property.Id.NameLast; /// - /// Middle name + /// Middle name. /// /// 4 public const uint Addition = (uint)Property.Id.NameAddition; /// - /// Suffix + /// Suffix. /// /// 4 public const uint Suffix = (uint)Property.Id.NameSuffix; /// - /// Prefix + /// Prefix. /// /// 4 public const uint Prefix = (uint)Property.Id.NamePrefix; /// - /// Pronounce the first name + /// Pronounce the first name. /// /// 4 public const uint PhoneticFirst = (uint)Property.Id.NamePhoneticFirst; /// - /// Pronounce the middle name + /// Pronounce the middle name. /// /// 4 public const uint PhoneticMiddle = (uint)Property.Id.NamePhoneticMiddle; /// - /// Pronounce the last name + /// Pronounce the last name. /// /// 4 public const uint PhoneticLast = (uint)Property.Id.NamePhoneticLast; } /// - /// Describes properties of a Number record. + /// Describes the properties of a Number record. /// /// 4 public static class Number { /// - /// Identifier of this contacts number view + /// Identifier of this contacts number view. /// /// 4 public const string Uri = "tizen.contacts_view.number"; /// - /// DB record ID of the number + /// Database record ID of the number. /// /// 4 public const uint Id = (uint)Property.Id.NumberId; /// - /// Contact ID that the number belongs to + /// Contact ID that the number belongs to. /// /// 4 public const uint ContactId = (uint)Property.Id.NumberContactId; /// - /// Number type, refer to the Types + /// Number type, refer to the Types. /// /// 4 public const uint Type = (uint)Property.Id.NumberType; /// - /// Custom number type label, when the number type is Types.Custom + /// Custom number type label, when the number type is Types.Custom. /// /// 4 public const uint Label = (uint)Property.Id.NumberLabel; /// - /// The number is default number or not + /// The number is the default number or not. /// /// 4 public const uint IsDefault = (uint)Property.Id.NumberIsDefault; /// - /// Number + /// Number. /// /// 4 public const uint NumberData = (uint)Property.Id.NumberNumber; /// - /// You can only use this property for search filter. + /// You can only use this property for the search filter. /// /// 4 public const uint NormalizedNumber = (uint)Property.Id.NumberNormalizedNumber; /// - /// You can only use this property for search filter. + /// You can only use this property for the search filter. /// /// 4 public const uint CleanedNumber = (uint)Property.Id.NumberCleanedNumber; /// - /// You can only use this property for search filter. + /// You can only use this property for the search filter. /// /// 4 public const uint NumberFilter = (uint)Property.Id.NumberNumberFilter; /// - /// Enumeration for number type. + /// Enumeration for the number types. /// /// 4 [Flags] public enum Types { /// - /// Other number type + /// Other number type. /// /// 4 Other = 0, /// - /// Custom number type + /// Custom number type. /// /// 4 Custom = 1 << 0, /// - /// A telephone number associated with a residence + /// A telephone number associated with a residence. /// /// 4 Home = 1 << 1, /// - /// A telephone number associated with a place of work + /// A telephone number associated with a place of work. /// /// 4 Work = 1 << 2, /// - /// A voice telephone number + /// A voice telephone number. /// /// 4 Voice = 1 << 3, /// - /// A facsimile telephone number + /// A facsimile telephone number. /// /// 4 Fax = 1 << 4, /// - /// The telephone number has voice messaging support + /// The telephone number has voice messaging support. /// /// 4 Message = 1 << 5, /// - /// A cellular telephone number + /// A cellular telephone number. /// /// 4 Cell = 1 << 6, /// - /// A paging device telephone number + /// A paging device telephone number. /// /// 4 Pager = 1 << 7, /// - /// A bulletin board system telephone number + /// A bulletin board system telephone number. /// /// 4 BBS = 1 << 8, /// - /// A MODEM connected telephone number + /// A modem connected telephone number. /// /// 4 Modem = 1 << 9, /// - /// A car-phone telephone number + /// A car-phone telephone number. /// /// 4 Car = 1 << 10, /// - /// An ISDN service telephone number + /// An ISDN service telephone number. /// /// 4 ISDN = 1 << 11, /// - /// A video conferencing telephone number + /// A video conferencing telephone number. /// /// 4 Video = 1 << 12, /// - /// A personal communication services telephone number + /// A personal communication services telephone number. /// /// 4 PCS = 1 << 13, /// - /// A company main number + /// A company main number. /// /// 4 Company = 1 << 14, /// - /// A radio phone number + /// A radio phone number. /// /// 4 Radio = 1 << 15, /// - /// An additional type for main + /// An additional type for the main. /// /// 4 Main = 1 << 29, /// - /// An additional type for assistant + /// An additional type for the assistant. /// /// 4 Assistant = 1 << 30, @@ -1356,76 +1356,76 @@ namespace Tizen.Pims.Contacts } /// - /// Describes properties of a Email record. + /// Describes the properties of an Email record. /// /// 4 public static class Email { /// - /// Identifier of this contacts email view + /// Identifier of this contacts email view. /// /// 4 public const string Uri = "tizen.contacts_view.email"; /// - /// DB record ID of the email + /// Database record ID of the email. /// /// 4 public const uint Id = (uint)Property.Id.EmailId; /// - /// Contact ID that the email belongs to + /// Contact ID that the email belongs to. /// /// 4 public const uint ContactId = (uint)Property.Id.EmailContactId; /// - /// Email type, refer to the Types + /// Email type, refer to the Types. /// /// 4 public const uint Type = (uint)Property.Id.EmailType; /// - /// Custom mail type label, when the email type is Types.Custom + /// Custom mail type label, when the email type is Types.Custom. /// /// 4 public const uint Label = (uint)Property.Id.EmailLabel; /// - /// The email is default email or not + /// The email is default email or not. /// /// 4 public const uint IsDefault = (uint)Property.Id.EmailIsDefault; /// - /// Email address + /// Email address. /// /// 4 public const uint Address = (uint)Property.Id.EmailEmail; /// - /// Enumeration for Contact email type. + /// Enumeration for the contact email types. /// /// 4 [Flags] public enum Types { /// - /// Other email type + /// Other email type. /// /// 4 Other = 0, /// - /// Custom email type + /// Custom email type. /// /// 4 Custom = 1 << 0, /// - /// An email address associated with a residence + /// An email address associated with a residence. /// /// 4 Home = 1 << 1, /// - /// An email address associated with a place of work + /// An email address associated with a place of work. /// /// 4 Work = 1 << 2, /// - /// A mobile email address + /// A mobile email address. /// /// 4 Mobile = 1 << 3, @@ -1433,121 +1433,121 @@ namespace Tizen.Pims.Contacts } /// - /// Describes properties of a Address record. + /// Describes the properties of an Address record. /// /// 4 public static class Address { /// - /// Identifier of this contacts address view + /// Identifier of this contacts address view. /// /// 4 public const string Uri = "tizen.contacts_view.address"; /// - /// DB record ID of the address + /// Database record ID of the address. /// /// 4 public const uint Id = (uint)Property.Id.AddressId; /// - /// Contact ID that the address belongs to + /// Contact ID that the address belongs to. /// /// 4 public const uint ContactId = (uint)Property.Id.AddressContactId; /// - /// Address type, refer to the Types + /// Address type, refer to the Types. /// /// 4 public const uint Type = (uint)Property.Id.AddressType; /// - /// Address type label, when the address type is Types.Custom + /// Address type label, when the address type is Types.Custom. /// /// 4 public const uint Label = (uint)Property.Id.AddressLabel; /// - /// Post office box + /// Post office box. /// /// 4 public const uint Postbox = (uint)Property.Id.AddressPostbox; /// - /// Postal code + /// Postal code. /// /// 4 public const uint PostalCode = (uint)Property.Id.AddressPostalCode; /// - /// Region + /// Region. /// /// 4 public const uint Region = (uint)Property.Id.AddressRegion; /// - /// Locality + /// Locality. /// /// 4 public const uint Locality = (uint)Property.Id.AddressLocality; /// - /// Street + /// Street. /// /// 4 public const uint Street = (uint)Property.Id.AddressStreet; /// - /// Country + /// Country. /// /// 4 public const uint Country = (uint)Property.Id.AddressCountry; /// - /// Extended address + /// Extended address. /// /// 4 public const uint Extended = (uint)Property.Id.AddressExtended; /// - /// The address is default or not + /// The address is the default or not. /// /// 4 public const uint IsDefault = (uint)Property.Id.AddressIsDefault; /// - /// Enumeration for Contact address type. + /// Enumeration for the contact address types. /// /// 4 [Flags] public enum Types { /// - /// Other address type + /// Other address type. /// /// 4 Other = 0, /// - /// Custom address type + /// Custom address type. /// /// 4 Custom = 1 << 0, /// - /// A delivery address for a residence + /// A delivery address for a residence. /// /// 4 Home = 1 << 1, /// - /// A delivery address for a place of work + /// A delivery address for a place of work. /// /// 4 Work = 1 << 2, /// - /// A domestic delivery address + /// A domestic delivery address. /// /// 4 Domestic = 1 << 3, /// - /// An international delivery address + /// An international delivery address. /// /// 4 International = 1 << 4, /// - /// A postal delivery address + /// A postal delivery address. /// /// 4 Postal = 1 << 5, /// - /// A parcel delivery address + /// A parcel delivery address. /// /// 4 Parcel = 1 << 6, @@ -1555,93 +1555,93 @@ namespace Tizen.Pims.Contacts } /// - /// Describes properties of a Note record. + /// Describes the properties of a Note record. /// /// 4 public static class Note { /// - /// Identifier of this contacts note view + /// Identifier of this contacts note view. /// /// 4 public const string Uri = "tizen.contacts_view.note"; /// - /// DB record ID of the note + /// Database record ID of the note. /// /// 4 public const uint Id = (uint)Property.Id.NoteId; /// - /// Contact ID that the note belongs to + /// Contact ID that the note belongs to. /// /// 4 public const uint ContactId = (uint)Property.Id.NoteContactId; /// - /// Note contents + /// Note contents. /// /// 4 public const uint Contents = (uint)Property.Id.NoteNote; } /// - /// Describes properties of a URL record. + /// Describes the properties of a URL record. /// /// 4 public static class URL { /// - /// Identifier of this contacts URL view + /// Identifier of this contacts URL view. /// /// 4 public const string Uri = "tizen.contacts_view.url"; /// - /// DB record ID of the URL + /// Database record ID of the URL. /// /// 4 public const uint Id = (uint)Property.Id.URLId; /// - /// Contact ID that the URL belongs to + /// Contact ID that the URL belongs to. /// /// 4 public const uint ContactId = (uint)Property.Id.URLContactId; /// - /// URL type, refer to the TypeValue + /// URL type, refer to the TypeValue. /// /// 4 public const uint Type = (uint)Property.Id.URLType; /// - /// Custom URL type label, when the URL type is TypeValue.Custom + /// Custom URL type label, when the URL type is TypeValue.Custom. /// /// 4 public const uint Label = (uint)Property.Id.URLLabel; /// - /// URL + /// URL. /// /// 4 public const uint URLData = (uint)Property.Id.URLData; /// - /// Enumeration for Contact URL type. + /// Enumeration for the Contact URL types. /// /// 4 public enum TypeValue { /// - /// Other URL type + /// Other URL type. /// /// 4 Other, /// - /// Custom URL type + /// Custom URL type. /// /// 4 Custom, /// - /// Home URL type + /// Home URL type. /// /// 4 Home, /// - /// Work URL type + /// Work URL type. /// /// 4 Work, @@ -1649,89 +1649,89 @@ namespace Tizen.Pims.Contacts } /// - /// Describes properties of a Event record. + /// Describes the properties of an Event record. /// /// 4 [SuppressMessage("Microsoft.Naming", "CA1716:IdentifiersShouldNotMatchKeywords")] public static class Event { /// - /// Identifier of this contacts event view + /// Identifier of this contacts event view. /// /// 4 public const string Uri = "tizen.contacts_view.event"; /// - /// DB record ID of the event + /// Database record ID of the event. /// /// 4 public const uint Id = (uint)Property.Id.EventId; /// - /// Contact ID that the event belongs to + /// Contact ID that the event belongs to. /// /// 4 public const uint ContactId = (uint)Property.Id.EventContactId; /// - /// Event type, refer to the TypeValue + /// Event type, refer to the TypeValue. /// /// 4 public const uint Type = (uint)Property.Id.EventType; /// - /// Custom event type label, when the event type is TypeValue.Custom + /// Custom event type label, when the event type is TypeValue.Custom. /// /// 4 public const uint Label = (uint)Property.Id.EventLabel; /// - /// Event date(YYYYMMDD). e.g. 2014/1/1 : 20140101. Even if the calendar_type is set as CONTACTS_EVENT_CALENDAR_TYPE_CHINESE, you SHOULD set Gregorian date + /// Event date(YYYYMMDD). For example, 2014/1/1 : 20140101. Even if the calendar_type is set as CONTACTS_EVENT_CALENDAR_TYPE_CHINESE, you should set the Gregorian date. /// /// 4 public const uint Date = (uint)Property.Id.EventDate; /// - /// Calendar type, refer to the CalendarType + /// Calendar type, refer to the CalendarType. /// /// 4 public const uint IsLeapMonth = (uint)Property.Id.EventIsLeapMonth; /// - /// Enumeration for Contact event type. + /// Enumeration for the Contact event types. /// /// 4 public enum TypeValue { /// - /// Other event type + /// Other event type. /// /// 4 Other, /// - /// Custom event type + /// Custom event type. /// /// 4 Custom, /// - /// Birthday event type + /// Birthday event type. /// /// 4 Birthday, /// - /// Anniversary event type + /// Anniversary event type. /// /// 4 Anniversary } /// - /// Enumeration for Contact event calendar type. + /// Enumeration for the Contact event calendar types. /// /// 4 public enum CalendarType { /// - /// Gregorian calendar + /// Gregorian calendar. /// /// 4 Gregorian, /// - /// Chinese calendar + /// Chinese calendar. /// /// 4 Chinese @@ -1739,125 +1739,125 @@ namespace Tizen.Pims.Contacts } /// - /// Describes properties of a Relationship record. + /// Describes the properties of a Relationship record. /// /// 4 public static class Relationship { /// - /// Identifier of this relationship view + /// Identifier of this relationship view. /// /// 4 public const string Uri = "tizen.contacts_view.relationship"; /// - /// DB record ID of the relationship + /// Database record ID of the relationship. /// /// 4 public const uint Id = (uint)Property.Id.RelationshipId; /// - /// Contact ID that the relationship belongs to + /// Contact ID that the relationship belongs to. /// /// 4 public const uint ContactId = (uint)Property.Id.RelationshipContactId; /// - /// Relationship type, refer to the TypeValue + /// Relationship type, refer to the TypeValue. /// /// 4 public const uint Type = (uint)Property.Id.RelationshipType; /// - /// Custom relationship type label, when the relationship type is TypeValue.Custom + /// Custom relationship type label, when the relationship type is TypeValue.Custom. /// /// 4 public const uint Label = (uint)Property.Id.RelationshipLabel; /// - /// Selected contact name that the relationship belongs to + /// Selected contact name that the relationship belongs to. /// /// 4 public const uint Name = (uint)Property.Id.RelationshipName; /// - /// Enumeration for Contact relationship type. + /// Enumeration for the contact relationship types. /// /// 4 public enum TypeValue { /// - /// Other relationship type + /// Other relationship type. /// /// 4 Other, /// - /// Assistant type + /// Assistant type. /// /// 4 Assistant, /// - /// Brother type + /// Brother type. /// /// 4 Brother, /// - /// Child type + /// Child type. /// /// 4 Child, /// - /// Domestic Partner type + /// Domestic Partner type. /// /// 4 DomesticPartner, /// - /// Father type + /// Father type. /// /// 4 Father, /// - /// Friend type + /// Friend type. /// /// 4 Friend, /// - /// Manager type + /// Manager type. /// /// 4 Manager, /// - /// Mother type + /// Mother type. /// /// 4 Mother, /// - /// Parent type + /// Parent type. /// /// 4 Parent, /// - /// Partner type + /// Partner type. /// /// 4 Partner, /// - /// Referred by type + /// Referred by type. /// /// 4 ReferredBy, /// - /// Relative type + /// Relative type. /// /// 4 Relative, /// - /// Sister type + /// Sister type. /// /// 4 Sister, /// - /// Spouse type + /// Spouse type. /// /// 4 Spouse, /// - /// Custom type + /// Custom type. /// /// 4 Custom, @@ -1865,60 +1865,60 @@ namespace Tizen.Pims.Contacts } /// - /// Describes properties of a Image record. + /// Describes the properties of an Image record. /// /// 4 public static class Image { /// - /// Identifier of this contacts image view + /// Identifier of this contacts image view. /// /// 4 public const string Uri = "tizen.contacts_view.image"; /// - /// DB record ID of the image + /// Database record ID of the image. /// /// 4 public const uint Id = (uint)Property.Id.ImageId; /// - /// Contact ID that the image belongs to + /// Contact ID that the image belongs to. /// /// 4 public const uint ContactId = (uint)Property.Id.ImageContactId; /// - /// Image type, refer to the TypeValue + /// Image type, refer to the TypeValue. /// /// 4 public const uint Type = (uint)Property.Id.ImageType; /// - /// Custom image type label, when the image type is TypeValue.Custom + /// Custom image type label, when the image type is TypeValue.Custom. /// /// 4 public const uint Label = (uint)Property.Id.ImageLabel; /// - /// Image thumbnail path + /// Image thumbnail path. /// /// 4 public const uint Path = (uint)Property.Id.ImagePath; /// - /// The Image is default or not + /// The image is the default or not. /// /// 4 public const uint IsDefault = (uint)Property.Id.ImageIsDefault; /// - /// Enumeration for Contact image type. + /// Enumeration for the contact image types. /// /// 4 public enum TypeValue { /// - /// Other type + /// Other type. /// /// 4 Other, /// - /// Custom type + /// Custom type. /// /// 4 Custom, @@ -1926,100 +1926,100 @@ namespace Tizen.Pims.Contacts } /// - /// Describes properties of a Company record. + /// Describes the properties of a Company record. /// /// 4 public static class Company { /// - /// Identifier of this contacts company view + /// Identifier of this contacts company view. /// /// 4 public const string Uri = "tizen.contacts_view.company"; /// - /// DB record ID of the company + /// Database record ID of the company. /// /// 4 public const uint Id = (uint)Property.Id.CompanyId; /// - /// Contact ID that the company belongs to + /// Contact ID that the company belongs to. /// /// 4 public const uint ContactId = (uint)Property.Id.CompanyContactId; /// - /// Company type, refer to the TypeValue + /// Company type, refer to the TypeValue. /// /// 4 public const uint Type = (uint)Property.Id.CompanyType; /// - /// Custom company type label, when the company type is TypeValue.Custom + /// Custom company type label, when the company type is TypeValue.Custom. /// /// 4 public const uint Label = (uint)Property.Id.CompanyLabel; /// - /// Company name + /// Company name. /// /// 4 public const uint Name = (uint)Property.Id.CompanyName; /// - /// Department + /// Department. /// /// 4 public const uint Department = (uint)Property.Id.CompanyDepartment; /// - /// Job title + /// Job title. /// /// 4 public const uint JobTitle = (uint)Property.Id.CompanyJobTitle; /// - /// Assistant name + /// Assistant name. /// /// 4 public const uint AssistantName = (uint)Property.Id.CompanyAssistantName; /// - /// Role + /// Role. /// /// 4 public const uint Role = (uint)Property.Id.CompanyRole; /// - /// Company logo image file path + /// Company logo image file path. /// /// 4 public const uint Logo = (uint)Property.Id.CompanyLogo; /// - /// Company location + /// Company location. /// /// 4 public const uint Location = (uint)Property.Id.CompanyLocation; /// - /// Description + /// Description. /// /// 4 public const uint Description = (uint)Property.Id.CompanyDescription; /// - /// Pronounce the company name + /// Pronounce the company name. /// /// 4 public const uint PhoneticName = (uint)Property.Id.CompanyPhoneticName; /// - /// Enumeration for Contact company type. + /// Enumeration for the contact company types. /// /// 4 public enum TypeValue { /// - /// Other type + /// Other type. /// /// 4 Other = 0, /// - /// Custom type + /// Custom type. /// /// 4 Custom = 1 << 0, /// - /// Work type + /// Work type. /// /// 4 Work = 1 << 1, @@ -2027,133 +2027,133 @@ namespace Tizen.Pims.Contacts } /// - /// Describes properties of a Nickname record. + /// Describes the properties of a Nickname record. /// /// 4 public static class Nickname { /// - /// Identifier of this contacts nickname view + /// Identifier of this contacts nickname view. /// /// 4 public const string Uri = "tizen.contacts_view.nickname"; /// - /// DB record ID of the nickname + /// Database record ID of the nickname. /// /// 4 public const uint Id = (uint)Property.Id.NicknameId; /// - /// Contact ID that the nickname belongs to + /// Contact ID that the nickname belongs to. /// /// 4 public const uint ContactId = (uint)Property.Id.NicknameContactId; /// - /// Nickname + /// Nickname. /// /// 4 public const uint Name = (uint)Property.Id.NicknameName; } /// - /// Describes properties of a Messenger record. + /// Describes the properties of a Messenger record. /// /// 4 public static class Messenger { /// - /// Identifier of this contacts messenger view + /// Identifier of this contacts messenger view. /// /// 4 public const string Uri = "tizen.contacts_view.messenger"; /// - /// DB record ID of the messenger + /// Database record ID of the messenger. /// /// 4 public const uint Id = (uint)Property.Id.MessengerId; /// - /// Contact ID that the messenger belongs to + /// Contact ID that the messenger belongs to. /// /// 4 public const uint ContactId = (uint)Property.Id.MessengerContactId; /// - /// Messenger type, refer to the TypeValue + /// Messenger type, refer to the TypeValue. /// /// 4 public const uint Type = (uint)Property.Id.MessengerType; /// - /// Custom messenger type label, when the messenger type is TypeValue.Custom + /// Custom messenger type label, when the messenger type is TypeValue.Custom. /// /// 4 public const uint Label = (uint)Property.Id.MessengerLabel; /// - /// Messenger ID (email address or email ID...) + /// Messenger ID (email address, email ID, and so on). /// /// 4 public const uint IMId = (uint)Property.Id.MessengerIMId; /// - /// Enumeration for Contact messenger type. + /// Enumeration for the contact messenger types. /// /// 4 public enum TypeValue { /// - /// Other messenger type + /// Other messenger type. /// /// 4 Other, /// - /// Custom messenger type + /// Custom messenger type. /// /// 4 Custom, /// - /// Google messenger type + /// Google messenger type. /// /// 4 Google, /// - /// Windows live messenger type + /// Windows Live messenger type. /// /// 4 WindowsLive, /// - /// Yahoo messenger type + /// Yahoo messenger type. /// /// 4 Yahoo, /// - /// Facebook messenger type + /// Facebook messenger type. /// /// 4 Facebook, /// - /// ICQ type + /// ICQ type. /// /// 4 ICQ, /// - /// AOL instance messenger type + /// AOL instance messenger type. /// /// 4 AOL, /// - /// QQ type + /// QQ type. /// /// 4 QQ, /// - /// Jabber type + /// Jabber type. /// /// 4 Jabber, /// - /// Skype type + /// Skype type. /// /// 4 Skype, /// - /// IRC type + /// IRC type. /// /// 4 IRC, @@ -2161,134 +2161,134 @@ namespace Tizen.Pims.Contacts } /// - /// Describes properties of a Profile record. + /// Describes the properties of a Profile record. /// /// 4 [SuppressMessage("Microsoft.Naming", "CA1724:TypeNamesShouldNotMatchNamespaces")] public static class Profile { /// - /// Identifier of this contacts profile view + /// Identifier of this contacts profile view. /// /// 4 public const string Uri = "tizen.contacts_view.profile"; /// - /// DB record ID of profile + /// Database record ID of the profile. /// /// 4 public const uint Id = (uint)Property.Id.ProfileId; /// - /// Contacts ID that the profile belongs to + /// Contacts ID that the profile belongs to. /// /// 4 public const uint ContactId = (uint)Property.Id.ProfileContactId; /// - /// Unique identifier + /// Unique identifier. /// /// 4 public const uint UId = (uint)Property.Id.ProfileUId; /// - /// Profile contents + /// Profile contents. /// /// 4 public const uint Text = (uint)Property.Id.ProfileText; /// - /// Priority to display the profile + /// Priority to display the profile. /// /// 4 public const uint Order = (uint)Property.Id.ProfileOrder; /// - /// Data for app_control_set_operation + /// Data for app_control_set_operation. /// /// 4 public const uint ServiceOperation = (uint)Property.Id.ProfileServiceOperation; /// - /// Data for app_control_set_mime + /// Data for app_control_set_mime. /// /// 4 public const uint Mime = (uint)Property.Id.ProfileMIME; /// - /// Data for app_control_set_app_id + /// Data for app_control_set_app_id. /// /// 4 public const uint AppId = (uint)Property.Id.ProfileAppId; /// - /// Data for app_control_set_uri + /// Data for app_control_set_uri. /// /// 4 public const uint ProfileUri = (uint)Property.Id.ProfileUri; /// - /// Data for app_control_set_category + /// Data for app_control_set_category. /// /// 4 public const uint Category = (uint)Property.Id.ProfileCategory; /// - /// It includes "key:value,key:value," pairs. You should parse it. And you must base64 encode each key and value + /// It includes "key:value,key:value," pairs. You should parse it. And you must base64 encode each key and value. /// /// 4 public const uint ExtraData = (uint)Property.Id.ProfileExtraData; } /// - /// Describes properties of a Sip record. + /// Describes the properties of a SIP record. /// /// 4 public static class Sip { /// - /// Identifier of this contacts sip view + /// Identifier of this contacts SIP view. /// /// 4 public const string Uri = "tizen.contacts_view.sip"; /// - /// DB record ID of the sip + /// Database record ID of the SIP. /// /// 4 public const uint Id = (uint)Property.Id.SipId; /// - /// Contact ID that the sip belongs to + /// Contact ID that the SIP belongs to. /// /// 4 public const uint ContactId = (uint)Property.Id.SipContactId; /// - /// SIP address + /// SIP address. /// /// 4 public const uint Address = (uint)Property.Id.SipAddress; /// - /// sip type, refer to the TypeValue + /// SIP type, refer to the TypeValue. /// /// 4 public const uint Type = (uint)Property.Id.SipType; /// - /// Custom sip type label, when the sip type is TypeValue.Custom + /// Custom SIP type label, when the SIP type is TypeValue.Custom. /// /// 4 public const uint Label = (uint)Property.Id.SipLabel; /// - /// Enumeration for Contact SIP type. + /// Enumeration for the contact SIP types. /// /// 4 public enum TypeValue { /// - /// Other SIP type + /// Other SIP type. /// /// 4 Other, /// - /// Custom SIP type + /// Custom SIP type. /// /// 4 Custom, /// - /// Home SIP type + /// Home SIP type. /// /// 4 Home, /// - /// Work SIP type + /// Work SIP type. /// /// 4 Work, @@ -2296,364 +2296,364 @@ namespace Tizen.Pims.Contacts } /// - /// Describes properties of a Extension record. + /// Describes the properties of an Extension record. /// /// 4 public static class Extension { /// - /// Identifier of this contacts extension view + /// Identifier of this contacts extension view. /// /// 4 public const string Uri = "tizen.contacts_view.extension"; /// - /// DB record ID of the contact extension + /// Database record ID of the contact extension. /// /// 4 public const uint Id = (uint)Property.Id.ExtensionId; /// - /// Contact ID that the contact extension belongs to + /// Contact ID that the contact extension belongs to. /// /// 4 public const uint ContactId = (uint)Property.Id.ExtensionContactId; /// - /// The extra child record format for non-provided from contacts-service + /// The extra child record format for the non-provided from the contacts-service. /// /// 4 public const uint Data1 = (uint)Property.Id.ExtensionData1; /// - /// The extra child record format for non-provided from contacts-service + /// The extra child record format for the non-provided from the contacts-service. /// /// 4 public const uint Data2 = (uint)Property.Id.ExtensionData2; /// - /// The extra child record format for non-provided from contacts-service + /// The extra child record format for the non-provided from the contacts-service. /// /// 4 public const uint Data3 = (uint)Property.Id.ExtensionData3; /// - /// The extra child record format for non-provided from contacts-service + /// The extra child record format for the non-provided from the contacts-service. /// /// 4 public const uint Data4 = (uint)Property.Id.ExtensionData4; /// - /// The extra child record format for non-provided from contacts-service + /// The extra child record format for the non-provided from the contacts-service. /// /// 4 public const uint Data5 = (uint)Property.Id.ExtensionData5; /// - /// The extra child record format for non-provided from contacts-service + /// The extra child record format for the non-provided from the contacts-service. /// /// 4 public const uint Data6 = (uint)Property.Id.ExtensionData6; /// - /// The extra child record format for non-provided from contacts-service + /// The extra child record format for the non-provided from the contacts-service. /// /// 4 public const uint Data7 = (uint)Property.Id.ExtensionData7; /// - /// The extra child record format for non-provided from contacts-service + /// The extra child record format for the non-provided from the contacts-service. /// /// 4 public const uint Data8 = (uint)Property.Id.ExtensionData8; /// - /// The extra child record format for non-provided from contacts-service + /// The extra child record format for the non-provided from the contacts-service. /// /// 4 public const uint Data9 = (uint)Property.Id.ExtensionData9; /// - /// The extra child record format for non-provided from contacts-service + /// The extra child record format for the non-provided from thecontacts-service. /// /// 4 public const uint Data10 = (uint)Property.Id.ExtensionData10; /// - /// The extra child record format for non-provided from contacts-service + /// The extra child record format for the non-provided from the contacts-service. /// /// 4 public const uint Data11 = (uint)Property.Id.ExtensionData11; /// - /// The extra child record format for non-provided from contacts-service + /// The extra child record format for the non-provided from the contacts-service. /// /// 4 public const uint Data12 = (uint)Property.Id.ExtensionData12; } /// - /// Describes properties of a Group relation record. + /// Describes the properties of a Group relation record. /// /// 4 public static class GroupRelation { /// - /// Identifier of this relationship view + /// Identifier of this relationship view. /// /// 4 public const string Uri = "tizen.contacts_view.group_relation"; /// - /// DB record ID of the group relation (can not be used as filter) + /// Database record ID of the group relation (cannot be used as a filter). /// /// 4 public const uint Id = (uint)Property.Id.GroupRelationId; /// - /// DB record ID of the group + /// Database record ID of the group. /// /// 4 public const uint GroupId = (uint)Property.Id.GroupRelationGroupId; /// - /// DB record ID of the contact + /// Database record ID of the contact. /// /// 4 public const uint ContactId = (uint)Property.Id.GroupRelationContactId; /// - /// Group name + /// Group name. /// /// 4 public const uint Name = (uint)Property.Id.GroupRelationGroupName; } /// - /// Describes properties of a Speed dial record. + /// Describes the properties of a Speed dial record. /// /// 4 public static class SpeedDial { /// - /// Identifier of this contact speed dial view + /// Identifier of this contacts speed dial view. /// /// 4 public const string Uri = "tizen.contacts_view.speeddial"; /// - /// Stored speed dial number + /// Stored speed dial number. /// /// 4 public const uint SpeedDialNumber = (uint)Property.Id.SpeedDialDialNumber; /// - /// Number ID that the speed dial belongs to + /// Number ID that the speed dial belongs to. /// /// 4 public const uint NumberId = (uint)Property.Id.SpeedDialNumberId; /// - /// Contact number of specified speed dial + /// Contact number of the specified speed dial. /// /// 4 public const uint Number = (uint)Property.Id.SpeedDialNumber; /// - /// Contact number label of specified speed dial, when the number type is Number.Types.Custom + /// Contact number label of the specified speed dial, when the number type is Number.Types.Custom. /// /// 4 public const uint NumberLabel = (uint)Property.Id.SpeedDialNumberLabel; /// - /// Contact number type, refer to the Number.Types + /// Contact number type, refer to the Number.Types. /// /// 4 public const uint NumberType = (uint)Property.Id.SpeedDialNumberType; /// - /// Person ID that the speed dial belongs to + /// Person ID that the speed dial belongs to. /// /// 4 public const uint PersonId = (uint)Property.Id.SpeedDialPersonId; /// - /// Display name that the speed dial belongs to + /// Display name that the speed dial belongs to. /// /// 4 public const uint DisplayName = (uint)Property.Id.SpeedDialDisplayName; /// - /// Image thumbnail path that the speed dial belongs to + /// Image thumbnail path that the speed dial belongs to. /// /// 4 public const uint ThumbnailPath = (uint)Property.Id.SpeedDialThumbnail; /// - /// You can only use this property for search filter + /// You can only use this property for the search filter. /// /// 4 public const uint NormalizedNumber = (uint)Property.Id.SpeedDialNormalizedNumber; /// - /// You can only use this property for search filter + /// You can only use this property for the search filter. /// /// 4 public const uint CleanedNumber = (uint)Property.Id.SpeedDialCleanedNumber; /// - /// If you add filter with this property, the string will be normalized as minimal match length internally and the match rule will be applied ContactsFilter.StringMatchType.Exactly + /// If you add filter with this property, the string will be normalized as minimal match length internally and the match rule will be applied ContactsFilter.StringMatchType.Exactly. /// /// 4 public const uint NumberFilter = (uint)Property.Id.SpeedDialNumberFilter; } /// - /// Describes properties of a Phone log record. + /// Describes the properties of a Phone log record. /// /// 4 public static class PhoneLog { /// - /// Identifier of this phone log view + /// Identifier of this phone log view. /// /// 4 public const string Uri = "tizen.contacts_view.phonelog"; /// - /// DB record ID of phone log + /// Database record ID of phone log. /// /// 4 public const uint Id = (uint)Property.Id.PhonelogId; /// - /// Person ID that the phone log belongs to + /// Person ID that the phone log belongs to. /// /// 4 public const uint PersonId = (uint)Property.Id.PhonelogPersonId; /// - /// Number or Email that the phone log displays + /// Number or email that the phone log displays. /// /// 4 public const uint Address = (uint)Property.Id.PhonelogAddress; /// - /// Call end time. The value means number of seconds since 1970-01-01 00:00:00 (UTC) + /// Call end time. The value means the number of seconds since 1970-01-01 00:00:00 (UTC). /// /// 4 public const uint LogTime = (uint)Property.Id.PhonelogLogTime; /// - /// Log type, refer to the Type + /// Log type, refer to the Type. /// /// 4 public const uint LogType = (uint)Property.Id.PhonelogLogType; /// - /// You can set the related integer data (e.g. message_id, email_id or duration(seconds) of call) + /// You can set the related integer data (For example, message_id, email_id, or duration (seconds) of the call). /// /// 4 public const uint ExtraData1 = (uint)Property.Id.PhonelogExtraData1; /// - /// You can set the related string data (e.g. short message, subject) + /// You can set the related string data (For example, short message, subject). /// /// 4 public const uint ExtraData2 = (uint)Property.Id.PhonelogExtraData2; /// - /// You can only use this property for search filter + /// You can only use this property for the search filter. /// /// 4 public const uint NormalizedAddress = (uint)Property.Id.PhonelogNormalizedAddress; /// - /// You can only use this property for search filter + /// You can only use this property for the search filter. /// /// 4 public const uint CleanedAddress = (uint)Property.Id.PhonelogCleanedAddress; /// - /// You can only use this property for search filter + /// You can only use this property for the search filter. /// /// 4 public const uint AddressFilter = (uint)Property.Id.PhonelogAddressFilter; /// - /// You can set the related Sim slot number. SimSlotNo 0 means first Sim card, SimSlotNo 1 means second Sim. + /// You can set the related SIM slot number. SimSlotNo 0 means the first SIM card, SimSlotNo 1 means the second SIM. /// /// 4 public const uint SimSlotNo = (uint)Property.Id.PhonelogSimSlotNo; /// - /// Enumeration for Phone log type. + /// Enumeration for the phone log types. /// /// 4 public enum Type { /// - /// None + /// None. /// /// 4 None, /// - /// Incoming call + /// Incoming call. /// /// 4 VoiceIncoming = 1, /// - /// Outgoing call + /// Outgoing call. /// /// 4 VoiceOutgoing = 2, /// - /// Incoming video call + /// Incoming video call. /// /// 4 VideoIncoming = 3, /// - /// Outgoing video call + /// Outgoing video call. /// /// 4 VideoOutgoing = 4, /// - /// Not confirmed missed call + /// Not confirmed missed call. /// /// 4 VoiceMissedUnseen = 5, /// - /// Confirmed missed call + /// Confirmed missed call. /// /// 4 VoiceMissedSeen = 6, /// - /// Not confirmed missed video call + /// Not confirmed missed video call. /// /// 4 VideoMissedUnseen = 7, /// - /// Confirmed missed video call + /// Confirmed missed video call. /// /// 4 VideoMissedSeen = 8, /// - /// Rejected call + /// Rejected call. /// /// 4 VoiceRejected = 9, /// - /// Rejected video call + /// Rejected video call. /// /// 4 VideoRejected = 10, /// - /// Blocked call + /// Blocked call. /// /// 4 VoiceBlocked = 11, /// - /// Blocked video call + /// Blocked video call. /// /// 4 VideoBlocked = 12, /// - /// Incoming MMS + /// Incoming MMS. /// /// 4 MMSIncoming = 101, /// - /// Outgoing MMS + /// Outgoing MMS. /// /// 4 MMSOutgoing = 102, /// - /// Incoming SMS + /// Incoming SMS. /// /// 4 SMSIncoming = 103, /// - /// Outgoing SMS + /// Outgoing SMS. /// /// 4 SMSOutgoing = 104, /// - /// Blocked SMS + /// Blocked SMS. /// /// 4 SMSBlocked = 105, /// - /// Blocked MMS + /// Blocked MMS. /// /// 4 MMSBlocked = 106, /// - /// Received email + /// Received email. /// /// 4 EmailReceived = 201, /// - /// Sent email + /// Sent email. /// /// 4 EmailSent = 202, @@ -2662,1074 +2662,1074 @@ namespace Tizen.Pims.Contacts } /// - /// Describes properties of a Contact updated information record. + /// Describes the properties of a Contact updated information record. /// /// Read only view /// 4 public static class ContactUpdatedInfo { /// - /// Identifier of this contact updated info view + /// Identifier of this contacts updated information view. /// /// 4 public const string Uri = "tizen.contacts_view.contacts_updated_info"; /// - /// Updated contact ID + /// Updated contact ID. /// /// 4 public const uint ContactId = (uint)Property.Id.UpdateInfoId; /// - /// AddressBook ID that the updated contact belongs to + /// AddressBook ID that the updated contact belongs to. /// /// 4 public const uint AddressBookId = (uint)Property.Id.UpdateInfoAddressBookId; /// - /// Contact change type, refer to the ContactsViews.ChangeType + /// Contact change type, refer to the ContactsViews.ChangeType. /// /// 4 public const uint Type = (uint)Property.Id.UpdateInfoType; /// - /// Updated version + /// Updated version. /// /// 4 public const uint Version = (uint)Property.Id.UpdateInfoVersion; /// - /// Contact image is changed or not + /// Contact image is changed or not. /// /// 4 public const uint ImageChanged = (uint)Property.Id.UpdateInfoImageChanged; } /// - /// Describes properties of a My profile updated information record. + /// Describes the properties of a My profile updated information record. /// /// Read only view /// 4 public static class MyProfileUpdatedInfo { /// - /// Identifier of this my profile updated info view + /// Identifier of this my profile updated information view. /// /// 4 public const string Uri = "tizen.contacts_view.my_profile_updated_info"; /// - /// Address book ID that the updated my profile belongs to + /// Address book ID that the updated my profile belongs to. /// /// 4 public const uint AddressBookId = (uint)Property.Id.UpdateInfoAddressBookId; /// - /// MyProfile change type, refer to the ContactsViews.ChangeType + /// MyProfile change type, refer to the ContactsViews.ChangeType. /// /// 4 public const uint LastChangedType = (uint)Property.Id.UpdateInfoLastChangedType; /// - /// Updated version + /// Updated version. /// /// 4 public const uint Version = (uint)Property.Id.UpdateInfoVersion; } /// - /// Describes properties of a Group updated information record. + /// Describes the properties of a Group updated information record. /// /// Read only view /// 4 public static class GroupUpdatedInfo { /// - /// Identifier of this group updated info view + /// Identifier of this groups updated information view. /// /// 4 public const string Uri = "tizen.contacts_view.groups_updated_info"; /// - /// Updated group ID + /// Updated group ID. /// /// 4 public const uint GroupId = (uint)Property.Id.UpdateInfoId; /// - /// Address book ID that the updated group belongs to + /// Address book ID that the updated group belongs to. /// /// 4 public const uint AddressBookId = (uint)Property.Id.UpdateInfoAddressBookId; /// - /// Group change type, refer to the ContactsViews.ChangeType + /// Group change type, refer to the ContactsViews.ChangeType. /// /// 4 public const uint Type = (uint)Property.Id.UpdateInfoType; /// - /// Updated version + /// Updated version. /// /// 4 public const uint Version = (uint)Property.Id.UpdateInfoVersion; } /// - /// Describes properties of a Group Member updated information record. + /// Describes the properties of a Group Member updated information record. /// - /// Read only view + /// Read-only view. /// 4 public static class GroupMemberUpdatedInfo { /// - /// Identifier of this group member updated info view + /// Identifier of this group members updated information view. /// /// 4 public const string Uri = "tizen.contacts_view.groups_member_updated_info"; /// - /// Updated group ID + /// Updated group ID. /// /// 4 public const uint GroupId = (uint)Property.Id.UpdateInfoId; /// - /// Address book ID that the updated group belongs to + /// Address book ID that the updated group belongs to. /// /// 4 public const uint AddressBookId = (uint)Property.Id.UpdateInfoAddressBookId; /// - /// Updated version + /// Updated version. /// /// 4 public const uint Version = (uint)Property.Id.UpdateInfoVersion; } /// - /// Describes properties of a Relation updated information record. + /// Describes the properties of a Relation updated information record. /// /// Read only view /// 4 public static class GroupRelationUpdatedInfo { /// - /// Identifier of this group relation updated info view + /// Identifier of this group relations updated information view. /// /// 4 public const string Uri = "tizen.contacts_view.group_relations_updated_info"; /// - /// Group ID of group relation + /// Group ID of the group relation. /// /// 4 public const uint GroupId = (uint)Property.Id.GroupId; /// - /// Contact ID of the updated group relation + /// Contact ID of the updated group relation. /// /// 4 public const uint ContactId = (uint)Property.Id.ContactId; /// - /// Address book ID of contact that the updated group relation + /// Address book ID of the contacts updated group relation. /// /// 4 public const uint AddressBookId = (uint)Property.Id.AddressBookId; /// - /// Group relation change type, refer to the ContactsViews.ChangeType + /// Group relation change type, refer to the ContactsViews.ChangeType. /// /// 4 public const uint Type = (uint)Property.Id.UpdateInfoType; /// - /// Updated version + /// Updated version. /// /// 4 public const uint Version = (uint)Property.Id.UpdateInfoVersion; } /// - /// Describes properties of a PersonContact record. + /// Describes the properties of a PersonContact record. /// /// Read only view /// 4 public static class PersonContact { /// - /// Identifier of this person contact view + /// Identifier of this person's contact view. /// /// 4 public const string Uri = "tizen.contacts_view.person/simple_contact"; /// - /// DB record ID of the person + /// Database record ID of the person. /// /// 4 public const uint PersonId = (uint)Property.Id.PersonId; /// - /// Display name of the person + /// Display name of the person. /// /// 4 public const uint DisplayName = (uint)Property.Id.PersonDisplayName; /// - /// The first character of first string for grouping. This is normalized using ICU (projection) + /// The first character of the first string for grouping. This is normalized using ICU (projection). /// /// 4 public const uint DisplayNameIndex = (uint)Property.Id.PersonDisplayNameIndex; /// - /// Display contact ID that the person belongs to (projection) + /// Display contact ID that the person belongs to (projection). /// /// 4 public const uint DisplayContactId = (uint)Property.Id.PersonDisplayContactId; /// - /// Ringtone path of the person (projection) + /// Ringtone path of the person (projection). /// /// 4 public const uint RingtonePath = (uint)Property.Id.PersonRingtone; /// - /// Image thumbnail path of the person (projection) + /// Image thumbnail path of the person (projection). /// /// 4 public const uint ThumbnailPath = (uint)Property.Id.PersonThumbnail; /// - /// Vibration path of the person (projection) + /// Vibration path of the person (projection). /// /// 4 public const uint Vibration = (uint)Property.Id.PersonVibration; /// - /// Message alert path of the person (projection) + /// Message alert path of the person (projection). /// /// 4 public const uint MessageAlert = (uint)Property.Id.PersonMessageAlert; /// - /// Status of social account (projection) + /// Status of the social account (projection). /// /// 4 public const uint Status = (uint)Property.Id.PersonStatus; /// - /// The person is favorite or not + /// The person is a favorite or not. /// /// 4 public const uint IsFavorite = (uint)Property.Id.PersonIsFavorite; /// - /// Link count of contact records (projection) + /// Link count of the contact records (projection). /// /// 4 public const uint LinkCount = (uint)Property.Id.PersonLinkCount; /// - /// Contact ID that the person belongs to + /// Contact ID that the person belongs to. /// /// 4 public const uint ContactId = (uint)Property.Id.ContactId; /// - /// AddressBook IDs that the person belongs to (projection) + /// AddressBook IDs that the person belongs to (projection). /// /// 4 public const uint AddressBookIds = (uint)Property.Id.PersonAddressBookIds; /// - /// The person has phone number or not + /// The person has a phone number or not. /// /// 4 public const uint HasPhoneNumber = (uint)Property.Id.PersonHasPhoneNumber; /// - /// The person has email or not + /// The person has an email or not. /// /// 4 public const uint HasEmail = (uint)Property.Id.PersonHasEmail; /// - /// AddressBook ID that the person belongs to + /// AddressBook ID that the person belongs to. /// /// 4 public const uint AddressBookId = (uint)Property.Id.ContactAddressBookId; /// - /// AddressBook mode, refer to the AddressBook.Mode + /// AddressBook mode, refer to the AddressBook.Mode. /// /// 4 public const uint AddressBookMode = (uint)Property.Id.AddressBookMode; /// - /// AddressBook name that the person belongs to + /// AddressBook name that the person belongs to. /// /// 4 public const uint AddressBookName = (uint)Property.Id.AddressBookName; /// - /// keyword matched data type, refer to the Contact.DataType + /// Keyword matched data type, refer to the Contact.DataType. /// /// 4 public const uint SnippetType = (uint)Property.Id.PersonSnippetType; /// - /// keyword matched data string + /// Keyword matched data string. /// /// 4 public const uint SnippetString = (uint)Property.Id.PersonSnippetString; }; /// - /// Describes properties of a PersonNumber record. + /// Describes the properties of a PersonNumber record. /// /// Read only view /// 4 public static class PersonNumber { /// - /// Identifier of this person number view + /// Identifier of this person's number view. /// /// 4 public const string Uri = "tizen.contacts_view.person/simple_contact/number"; /// - /// DB record ID of the person + /// Database record ID of the person. /// /// 4 public const uint PersonId = (uint)Property.Id.PersonId; /// - /// Display name of the person + /// Display name of the person. /// /// 4 public const uint DisplayName = (uint)Property.Id.PersonDisplayName; /// - /// The first character of first string for grouping. This is normalized using ICU (projection) + /// The first character of the first string for grouping. This is normalized using ICU (projection). /// /// 4 public const uint DisplayNameIndex = (uint)Property.Id.PersonDisplayNameIndex; /// - /// Display contact ID that the person belongs to (projection) + /// Display contact ID that the person belongs to (projection). /// /// 4 public const uint DisplayContactId = (uint)Property.Id.PersonDisplayContactId; /// - /// Ringtone path of the person (projection) + /// Ringtone path of the person (projection). /// /// 4 public const uint RingtonePath = (uint)Property.Id.PersonRingtone; /// - /// Image thumbnail path of the person (projection) + /// Image thumbnail path of the person (projection). /// /// 4 public const uint ThumbnailPath = (uint)Property.Id.PersonThumbnail; /// - /// Vibration path of the person (projection) + /// Vibration path of the person (projection). /// /// 4 public const uint Vibration = (uint)Property.Id.PersonVibration; /// - /// Message alert path of the person (projection) + /// Message alert path of the person (projection). /// /// 4 public const uint MessageAlert = (uint)Property.Id.PersonMessageAlert; /// - /// The person is favorite or not + /// The person is a favorite or not. /// /// 4 public const uint IsFavorite = (uint)Property.Id.PersonIsFavorite; /// - /// The person has phone number or not + /// The person has a phone number or not. /// /// 4 public const uint HasPhoneNumber = (uint)Property.Id.PersonHasPhoneNumber; /// - /// The person has email or not + /// The person has an email or not. /// /// 4 public const uint HasEmail = (uint)Property.Id.PersonHasEmail; /// - /// Number ID that the person belongs to + /// Number ID that the person belongs to. /// /// 4 public const uint NumberId = (uint)Property.Id.NumberId; /// - /// Number type, refer to the Number.Types (projection) + /// Number type, refer to the Number.Types (projection). /// /// 4 public const uint Type = (uint)Property.Id.NumberType; /// - /// Custom number type label, when the number type is Number.Types.Custom (projection) + /// Custom number type label, when the number type is Number.Types.Custom (projection). /// /// 4 public const uint Label = (uint)Property.Id.NumberLabel; /// - /// The number is default number or not + /// The number is the default number or not. /// /// 4 public const uint IsPrimaryDefault = (uint)Property.Id.DataIsPrimaryDefault; /// - /// Number + /// Number. /// /// 4 public const uint Number = (uint)Property.Id.NumberNumber; /// - /// If you add filter with this property, the string will be normalized as minimal match length internally and the match rule will be applied ContactsFilter.StringMatchType.Exactly. + /// If you add filter with this property, the string will be normalized as the minimal match length internally and the match rule will be applied ContactsFilter.StringMatchType.Exactly. /// /// 4 public const uint NumberFilter = (uint)Property.Id.NumberNumberFilter; /// - /// You can only use this property for search filter + /// You can only use this property for the search filter. /// /// 4 public const uint NormalizedNumber = (uint)Property.Id.NumberNormalizedNumber; /// - /// You can only use this property for search filter + /// You can only use this property for the search filter. /// /// 4 public const uint CleanedNumber = (uint)Property.Id.NumberCleanedNumber; /// - /// keyword matched data type, refer to they Contact.DataType + /// Keyword matched data type, refer to they Contact.DataType. /// /// 4 public const uint SnippetType = (uint)Property.Id.PersonSnippetType; /// - /// keyword matched data string + /// Keyword matched data string. /// /// 4 public const uint SnippetString = (uint)Property.Id.PersonSnippetString; }; /// - /// Describes properties of a PersonEmail record. + /// Describes the properties of a PersonEmail record. /// /// Read only view /// 4 public static class PersonEmail { /// - /// Identifier of this person email view + /// Identifier of this person's email view. /// /// 4 public const string Uri = "tizen.contacts_view.person/simple_contact/email"; /// - /// DB record ID of the person + /// Database record ID of the person. /// /// 4 public const uint PersonId = (uint)Property.Id.PersonId; /// - /// Display name of the person + /// Display name of the person. /// /// 4 public const uint DisplayName = (uint)Property.Id.PersonDisplayName; /// - /// The first character of first string for grouping. This is normalized using ICU (projection) + /// The first character of the first string for grouping. This is normalized using ICU (projection). /// /// 4 public const uint DisplayNameIndex = (uint)Property.Id.PersonDisplayNameIndex; /// - /// Display contact ID that the person belongs to (projection) + /// Display contact ID that the person belongs to (projection). /// /// 4 public const uint DisplayContactId = (uint)Property.Id.PersonDisplayContactId; /// - /// Ringtone path of the person (projection) + /// Ringtone path of the person (projection). /// /// 4 public const uint RingtonePath = (uint)Property.Id.PersonRingtone; /// - /// Image thumbnail path of the person (projection) + /// Image thumbnail path of the person (projection). /// /// 4 public const uint ThumbnailPath = (uint)Property.Id.PersonThumbnail; /// - /// Vibration path of the person (projection) + /// Vibration path of the person (projection). /// /// 4 public const uint Vibration = (uint)Property.Id.PersonVibration; /// - /// Message alert path of the person (projection) + /// Message alert path of the person (projection). /// /// 4 public const uint MessageAlert = (uint)Property.Id.PersonMessageAlert; /// - /// The person is favorite or not + /// The person is a favorite or not. /// /// 4 public const uint IsFavorite = (uint)Property.Id.PersonIsFavorite; /// - /// The person has phone number or not + /// The person has a phone number or not. /// /// 4 public const uint HasPhoneNumber = (uint)Property.Id.PersonHasPhoneNumber; /// - /// The person has email or not + /// The person has an email or not. /// /// 4 public const uint HasEmail = (uint)Property.Id.PersonHasEmail; /// - /// Email ID that the person belongs to + /// Email ID that the person belongs to. /// /// 4 public const uint EmailId = (uint)Property.Id.EmailId; /// - /// Email type, refer to the Email.Types (projection) + /// Email type, refer to the Email.Types (projection). /// /// 4 public const uint Type = (uint)Property.Id.EmailType; /// - /// Custom mail type label, when the email type is Email.Types.Custom (projection) + /// Custom mail type label, when the email type is Email.Types.Custom (projection). /// /// 4 public const uint Label = (uint)Property.Id.EmailLabel; /// - /// The email is default email or not + /// The email is the default email or not. /// /// 4 public const uint IsPrimaryDefault = (uint)Property.Id.DataIsPrimaryDefault; /// - /// Email address + /// Email address. /// /// 4 public const uint Email = (uint)Property.Id.EmailEmail; /// - /// keyword matched data type, refer to they Contact.DataType + /// Keyword matched data type, refer to they Contact.DataType. /// /// 4 public const uint SnippetType = (uint)Property.Id.PersonSnippetType; /// - /// keyword matched data string + /// Keyword matched data string. /// /// 4 public const uint SnippetString = (uint)Property.Id.PersonSnippetString; }; /// - /// Describes properties of a PersonGroupRelation record. + /// Describes the properties of a PersonGroupRelation record. /// /// Read only view /// 4 public static class PersonGroupRelation { /// - /// Identifier of this person group relation view + /// Identifier of this person's group relation view. /// /// 4 public const string Uri = "tizen.contacts_view.person/simple_contact/group"; /// - /// DB record ID of the person + /// Database record ID of the person. /// /// 4 public const uint PersonId = (uint)Property.Id.PersonId; /// - /// Display name of the person + /// Display name of the person. /// /// 4 public const uint DisplayName = (uint)Property.Id.PersonDisplayName; /// - /// The first character of first string for grouping. This is normalized using ICU (projection) + /// The first character of the first string for grouping. This is normalized using ICU (projection). /// /// 4 public const uint DisplayNameIndex = (uint)Property.Id.PersonDisplayNameIndex; /// - /// Display contact ID that the person belongs to (projection) + /// Display contact ID that the person belongs to (projection). /// /// 4 public const uint DisplayContactId = (uint)Property.Id.PersonDisplayContactId; /// - /// Ringtone path of the person (projection) + /// Ringtone path of the person (projection). /// /// 4 public const uint RingtonePath = (uint)Property.Id.PersonRingtone; /// - /// Image thumbnail path of the person (projection) + /// Image thumbnail path of the person (projection). /// /// 4 public const uint ThumbnailPath = (uint)Property.Id.PersonThumbnail; /// - /// Vibration path of the person (projection) + /// Vibration path of the person (projection). /// /// 4 public const uint Vibration = (uint)Property.Id.PersonVibration; /// - /// Message alert path of the person (projection) + /// Message alert path of the person (projection). /// /// 4 public const uint MessageAlert = (uint)Property.Id.PersonMessageAlert; /// - /// Status of social account (projection) + /// Status of social account (projection). /// /// 4 public const uint Status = (uint)Property.Id.PersonStatus; /// - /// The person is favorite or not + /// The person is a favorite or not. /// /// 4 public const uint IsFavorite = (uint)Property.Id.PersonIsFavorite; /// - /// The person has phone number or not + /// The person has a phone number or not. /// /// 4 public const uint HasPhoneNumber = (uint)Property.Id.PersonHasPhoneNumber; /// - /// The person has email or not + /// The person has an email or not. /// /// 4 public const uint HasEmail = (uint)Property.Id.PersonHasEmail; /// - /// Link count of contact records (projection) + /// Link count of the contact records (projection). /// /// 4 public const uint LinkCount = (uint)Property.Id.PersonLinkCount; /// - /// AddressBook IDs that the person belongs to (projection) + /// AddressBook IDs that the person belongs to (projection). /// /// 4 public const uint AddressBookIds = (uint)Property.Id.PersonAddressBookIds; /// - /// AddressBook ID that the person belongs to + /// AddressBook ID that the person belongs to. /// /// 4 public const uint AddressBookId = (uint)Property.Id.ContactAddressBookId; /// - /// AddressBook name that the person belongs to + /// AddressBook name that the person belongs to. /// /// 4 public const uint AddressBookName = (uint)Property.Id.AddressBookName; /// - /// AddressBook mode, refer to the AddressBook.Mode + /// AddressBook mode, refer to the AddressBook.Mode. /// /// 4 public const uint AddressBookMode = (uint)Property.Id.AddressBookMode; /// - /// Group ID that the person belongs to + /// Group ID that the person belongs to. /// /// 4 public const uint GroupId = (uint)Property.Id.GroupRelationGroupId; /// - /// Contact ID that the person belongs to (projection) + /// Contact ID that the person belongs to (projection). /// /// 4 public const uint ContactId = (uint)Property.Id.GroupRelationContactId; /// - /// keyword matched data type, refer to they Contact.DataType + /// Keyword matched data type, refer to they Contact.DataType. /// /// 4 public const uint SnippetType = (uint)Property.Id.PersonSnippetType; /// - /// keyword matched data string + /// Keyword matched data string. /// /// 4 public const uint SnippetString = (uint)Property.Id.PersonSnippetString; }; /// - /// Describes properties of a PersonGroupAssigned record. + /// Describes the properties of a PersonGroupAssigned record. /// /// Read only view /// 4 public static class PersonGroupAssigned { /// - /// Identifier of this person group assigned view + /// Identifier of this person's group assigned view. /// /// 4 public const string Uri = "tizen.contacts_view.person/simple_contact/group_assigned"; /// - /// DB record ID of the person + /// Database record ID of the person. /// /// 4 public const uint PersonId = (uint)Property.Id.PersonId; /// - /// Display name of the person + /// Display name of the person. /// /// 4 public const uint DisplayName = (uint)Property.Id.PersonDisplayName; /// - /// The first character of first string for grouping. This is normalized using ICU (projection) + /// The first character of the first string for grouping. This is normalized using ICU (projection). /// /// 4 public const uint DisplayNameIndex = (uint)Property.Id.PersonDisplayNameIndex; /// - /// Display contact ID that the person belongs to (projection) + /// Display contact ID that the person belongs to (projection). /// /// 4 public const uint DisplayContactId = (uint)Property.Id.PersonDisplayContactId; /// - /// Ringtone path of the person (projection) + /// Ringtone path of the person (projection). /// /// 4 public const uint RingtonePath = (uint)Property.Id.PersonRingtone; /// - /// Image thumbnail path of the person (projection) + /// Image thumbnail path of the person (projection). /// /// 4 public const uint ThumbnailPath = (uint)Property.Id.PersonThumbnail; /// - /// Vibration path of the person (projection) + /// Vibration path of the person (projection). /// /// 4 public const uint Vibration = (uint)Property.Id.PersonVibration; /// - /// Message alert path of the person (projection) + /// Message alert path of the person (projection). /// /// 4 public const uint MessageAlert = (uint)Property.Id.PersonMessageAlert; /// - /// Status of social account (projection) + /// Status of the social account (projection). /// /// 4 public const uint Status = (uint)Property.Id.PersonStatus; /// - /// The person is favorite or not + /// The person is a favorite or not. /// /// 4 public const uint IsFavorite = (uint)Property.Id.PersonIsFavorite; /// - /// The person has phone number or not + /// The person has a phone number or not. /// /// 4 public const uint HasPhoneNumber = (uint)Property.Id.PersonHasPhoneNumber; /// - /// The person has email or not + /// The person has an email or not. /// /// 4 public const uint HasEmail = (uint)Property.Id.PersonHasEmail; /// - /// Link count of contact records (projection) + /// Link count of the contact records (projection). /// /// 4 public const uint LinkCount = (uint)Property.Id.PersonLinkCount; /// - /// AddressBook IDs that the linked person belongs to (projection) + /// AddressBook IDs that the linked person belongs to (projection). /// /// 4 public const uint AddressBookIds = (uint)Property.Id.PersonAddressBookIds; /// - /// AddressBook ID that the person belongs to + /// AddressBook ID that the person belongs to. /// /// 4 public const uint AddressBookId = (uint)Property.Id.ContactAddressBookId; /// - /// AddressBook mode, refer to the AddressBook.Mode + /// AddressBook mode, refer to the AddressBook.Mode. /// /// 4 public const uint AddressBookMode = (uint)Property.Id.AddressBookMode; /// - /// Group ID that the person belongs to + /// Group ID that the person belongs to. /// /// 4 public const uint GroupId = (uint)Property.Id.GroupRelationGroupId; /// - /// Contact ID that the person belongs to (projection) + /// Contact ID that the person belongs to (projection). /// /// 4 public const uint ContactId = (uint)Property.Id.GroupRelationContactId; /// - /// keyword matched data type, refer to they Contact.DataType + /// Keyword matched data type, refer to they Contact.DataType. /// /// 4 public const uint SnippetType = (uint)Property.Id.PersonSnippetType; /// - /// keyword matched data string + /// Keyword matched data string. /// /// 4 public const uint SnippetString = (uint)Property.Id.PersonSnippetString; }; /// - /// Describes properties of a PersonGroupNotAssigned record. + /// Describes the properties of a PersonGroupNotAssigned record. /// /// Read only view /// 4 public static class PersonGroupNotAssigned { /// - /// Identifier of this person group not assigned view + /// Identifier of this person's group not assigned view. /// /// 4 public const string Uri = "tizen.contacts_view.person/simple_contact/group_not_assigned"; /// - /// DB record ID of the person + /// Database record ID of the person. /// /// 4 public const uint PersonId = (uint)Property.Id.PersonId; /// - /// Display name of the person + /// Display name of the person. /// /// 4 public const uint DisplayName = (uint)Property.Id.PersonDisplayName; /// - /// The first character of first string for grouping. This is normalized using ICU (projection) + /// The first character of first string for grouping. This is normalized using ICU (projection). /// /// 4 public const uint DisplayNameIndex = (uint)Property.Id.PersonDisplayNameIndex; /// - /// Display contact ID that the person belongs to (projection) + /// Display contact ID that the person belongs to (projection). /// /// 4 public const uint DisplayContactId = (uint)Property.Id.PersonDisplayContactId; /// - /// Ringtone path of the person (projection) + /// Ringtone path of the person (projection). /// /// 4 public const uint RingtonePath = (uint)Property.Id.PersonRingtone; /// - /// Image thumbnail path of the person (projection) + /// Image thumbnail path of the person (projection). /// /// 4 public const uint ThumbnailPath = (uint)Property.Id.PersonThumbnail; /// - /// Vibration path of the person (projection) + /// Vibration path of the person (projection). /// /// 4 public const uint Vibration = (uint)Property.Id.PersonVibration; /// - /// Message alert path of the person (projection) + /// Message alert path of the person (projection). /// /// 4 public const uint MessageAlert = (uint)Property.Id.PersonMessageAlert; /// - /// Status of social account (projection) + /// Status of the social account (projection). /// /// 4 public const uint Status = (uint)Property.Id.PersonStatus; /// - /// The person is favorite or not + /// The person is a favorite or not. /// /// 4 public const uint IsFavorite = (uint)Property.Id.PersonIsFavorite; /// - /// The person has phone number or not + /// The person has a phone number or not. /// /// 4 public const uint HasPhoneNumber = (uint)Property.Id.PersonHasPhoneNumber; /// - /// The person has email or not + /// The person has an email or not. /// /// 4 public const uint HasEmail = (uint)Property.Id.PersonHasEmail; /// - /// Link count of contact records (projection) + /// Link count of the contact records (projection). /// /// 4 public const uint LinkCount = (uint)Property.Id.PersonLinkCount; /// - /// AddressBook IDs that the linked person belongs to (projection) + /// AddressBook IDs that the linked person belongs to (projection). /// /// 4 public const uint AddressBookIds = (uint)Property.Id.PersonAddressBookIds; /// - /// AddressBook ID that the person belongs to + /// AddressBook ID that the person belongs to. /// /// 4 public const uint AddressBookId = (uint)Property.Id.ContactAddressBookId; /// - /// AddressBook mode, refer to the AddressBook.Mode + /// AddressBook mode, refer to the AddressBook.Mode. /// /// 4 public const uint AddressBookMode = (uint)Property.Id.AddressBookMode; /// - /// Contact ID that the person belongs to (projection) + /// Contact ID that the person belongs to (projection). /// /// 4 public const uint ContactId = (uint)Property.Id.ContactId; /// - /// keyword matched data type, refer to they Contact.DataType + /// Keyword matched data type, refer to they Contact.DataType. /// /// 4 public const uint SnippetType = (uint)Property.Id.PersonSnippetType; /// - /// keyword matched data string + /// Keyword matched data string. /// /// 4 public const uint SnippetString = (uint)Property.Id.PersonSnippetString; }; /// - /// Describes properties of a PersonPhoneLog record. + /// Describes the properties of a PersonPhoneLog record. /// /// Read only view /// 4 public static class PersonPhoneLog { /// - /// Identifier of this phone log view + /// Identifier of this phone log view. /// /// 4 public const string Uri = "tizen.contacts_view.person/simple_contact/phonelog"; /// - /// DB record ID of the person + /// Database record ID of the person. /// /// 4 public const uint PersonId = (uint)Property.Id.PersonId; /// - /// Display name of the person + /// Display name of the person. /// /// 4 public const uint DisplayName = (uint)Property.Id.PersonDisplayName; /// - /// Image thumbnail path of the person (projection) + /// Image thumbnail path of the person (projection). /// /// 4 public const uint ThumbnailPath = (uint)Property.Id.PersonThumbnail; /// - /// DB record ID of phone log + /// Database record ID of phone log. /// /// 4 public const uint LogId = (uint)Property.Id.PhonelogId; /// - /// Number or Email that the phone log displays + /// Number or email that the phone log displays. /// /// 4 public const uint Address = (uint)Property.Id.PhonelogAddress; /// - /// Number or Email type (projection) + /// Number or email type (projection). /// /// 4 public const uint AddressType = (uint)Property.Id.DataData1; /// - /// Call end time. The value means number of seconds since 1970-01-01 00:00:00 (UTC) + /// Call end time. The value means the number of seconds since 1970-01-01 00:00:00 (UTC). /// /// 4 public const uint LogTime = (uint)Property.Id.PhonelogLogTime; /// - /// Log type, refer to the PhoneLog.Types + /// Log type, refer to the PhoneLog.Types. /// /// 4 public const uint LogType = (uint)Property.Id.PhonelogLogType; /// - /// You can set the related integer data (e.g. message_id, email_id or duration(seconds) of call) (projection) + /// You can set the related integer data (For exmaple, message_id, email_id, or duration (seconds) of the call) (projection). /// /// 4 public const uint ExtraData1 = (uint)Property.Id.PhonelogExtraData1; /// - /// You can set the related string data (e.g. short message, subject) (projection) + /// You can set the related string data (For example, short message, subject) (projection). /// /// 4 public const uint ExtraData2 = (uint)Property.Id.PhonelogExtraData2; /// - /// You can only use this property for search filter + /// You can only use this property for the search filter. /// /// 4 public const uint NormalizedAddress = (uint)Property.Id.PhonelogNormalizedAddress; /// - /// You can only use this property for search filter + /// You can only use this property for the search filter. /// /// 4 public const uint CleanedAddress = (uint)Property.Id.PhonelogCleanedAddress; /// - /// You can only use this property for search filter + /// You can only use this property for the search filter. /// /// 4 public const uint AddressFilter = (uint)Property.Id.PhonelogAddressFilter; /// - /// It is related to the Sim slot number. SimSlotNo 0 means first Sim card, SimSlotNo 1 means second Sim. + /// It is related to the Sim SIM number. SimSlotNo 0 means the first SIM card, SimSlotNo 1 means the second SIM. /// /// 4 public const uint SimSlotNo = (uint)Property.Id.PhonelogSimSlotNo; }; /// - /// Describes properties of a Person Usage record. + /// Describes the properties of a Person Usage record. /// /// Read only view /// 4 public static class PersonUsage { /// - /// Identifier of this person usage view + /// Identifier of this person's usage view. /// /// 4 public const string Uri = "tizen.contacts_view.person/usag"; /// - /// DB record ID of the person + /// Database record ID of the person. /// /// 4 public const uint PersonId = (uint)Property.Id.PersonId; /// - /// Display name of the person + /// Display name of the person. /// /// 4 public const uint DisplayName = (uint)Property.Id.PersonDisplayName; /// - /// The first character of first string for grouping. This is normalized using ICU (projection) + /// The first character of the first string for grouping. This is normalized using ICU (projection). /// /// 4 public const uint DisplayNameIndex = (uint)Property.Id.PersonDisplayNameIndex; /// - /// Display contact ID that the person belongs to (projection) + /// Display contact ID that the person belongs to (projection). /// /// 4 public const uint DisplayContactId = (uint)Property.Id.PersonDisplayContactId; /// - /// Ringtone path of the person (projection) + /// Ringtone path of the person (projection). /// /// 4 public const uint RingtonePath = (uint)Property.Id.PersonRingtone; /// - /// Image thumbnail path of the person (projection) + /// Image thumbnail path of the person (projection). /// /// 4 public const uint ThumbnailPath = (uint)Property.Id.PersonThumbnail; /// - /// Vibration path of the person (projection) + /// Vibration path of the person (projection). /// /// 4 public const uint Vibration = (uint)Property.Id.PersonVibration; /// - /// Message alert path of the person (projection) + /// Message alert path of the person (projection). /// /// 4 public const uint MessageAlert = (uint)Property.Id.PersonMessageAlert; /// - /// The person is favorite or not + /// The person is a favorite or not. /// /// 4 public const uint IsFavorite = (uint)Property.Id.PersonIsFavorite; /// - /// The person has phone number or not + /// The person has a phone number or not. /// /// 4 public const uint HasPhoneNumber = (uint)Property.Id.PersonHasPhoneNumber; /// - /// The person has email or not + /// The person has an email or not. /// /// 4 public const uint HasEmail = (uint)Property.Id.PersonHasEmail; /// - /// Usage type, refer to the Type + /// Usage type, refer to the Type. /// /// 4 public const uint UsageType = (uint)Property.Id.PersonUsageType; /// - /// Usage number of person + /// Usage number of the person. /// /// 4 public const uint TimesUsed = (uint)Property.Id.PersonTimesUsed; /// - /// Enumeration for Person usage type. + /// Enumeration for the person usage types. /// /// 4 public enum Type { /// - /// None + /// None. /// /// 4 None, /// - /// Outgoing call + /// Outgoing call. /// /// 4 OutgoingCall, /// - /// Outgoing message + /// Outgoing message. /// /// 4 OutgoingMessage, /// - /// Outgoing email + /// Outgoing email. /// /// 4 OutgoingEmail, /// - /// Incoming call + /// Incoming call. /// /// 4 IncomingCall, /// - /// Incoming message + /// Incoming message. /// /// 4 IncomingMessage, /// - /// Incoming email + /// Incoming email. /// /// 4 IncomingEmail, /// - /// Missed call + /// Missed call. /// /// 4 MissedCall, /// - /// Rejected call + /// Rejected call. /// /// 4 RejectedCall, /// - /// Blocked call + /// Blocked call. /// /// 4 BlockedCall, /// - /// Blocked message + /// Blocked message. /// /// 4 BlockedMessage @@ -3737,251 +3737,251 @@ namespace Tizen.Pims.Contacts }; /// - /// Describes properties of a ContactNumber record. + /// Describes the properties of a ContactNumber record. /// - /// Read only view + /// Read-only view. /// 4 public static class ContactNumber { /// - /// Identifier of this contacts number view + /// Identifier of this contacts number view. /// /// 4 public const string Uri = "tizen.contacts_view.simple_contact/number"; /// - /// Contact ID that the number belongs to + /// Contact ID that the number belongs to. /// /// 4 public const uint ContactId = (uint)Property.Id.ContactId; /// - /// Display name of contact that the number belongs to + /// Display name of the contact that the number belongs to. /// /// 4 public const uint DisplayName = (uint)Property.Id.ContactDisplayName; /// - /// The source type of display name, refer to the Contact.DisplayNameSourceType (projection) + /// The source type of the display name, refer to the Contact.DisplayNameSourceType (projection). /// /// 4 public const uint DisplaySourceType = (uint)Property.Id.ContactDisplaySourceDataId; /// - /// AddressBook ID that the number belongs to + /// AddressBook ID that the number belongs to. /// /// 4 public const uint AddressBookId = (uint)Property.Id.ContactAddressBookId; /// - /// Person ID that the number belongs to + /// Person ID that the number belongs to. /// /// 4 public const uint PersonId = (uint)Property.Id.ContactPersonId; /// - /// Ringtone path that the number belongs to (projection) + /// Ringtone path that the number belongs to (projection). /// /// 4 public const uint RingtonePath = (uint)Property.Id.ContactRingtone; /// - /// Image thumbnail path that the number belongs to (projection) + /// Image thumbnail path that the number belongs to (projection). /// /// 4 public const uint ThumbnailPath = (uint)Property.Id.ContactThumbnail; /// - /// DB record ID of the number + /// Database record ID of the number. /// /// 4 public const uint NumberId = (uint)Property.Id.NumberId; /// - /// Number type, refer to the Number.Types (projection) + /// Number type, refer to the Number.Types (projection). /// /// 4 public const uint Type = (uint)Property.Id.NumberType; /// - /// Custom number type label, when the number type is Number.Types.Custom (projection) + /// Custom number type label, when the number type is Number.Types.Custom (projection). /// /// 4 public const uint Label = (uint)Property.Id.NumberLabel; /// - /// The number is default number or not + /// The number is the default number or not. /// /// 4 public const uint IsDefault = (uint)Property.Id.NumberIsDefault; /// - /// Number + /// Number. /// /// 4 public const uint Number = (uint)Property.Id.NumberNumber; /// - /// If you add filter with this property, the string will be normalized as minimal match length internally and the match rule will be applied ContactsFilter.StringMatchType.Exactly + /// If you add a filter with this property, the string will be normalized as the minimal match length internally and the match rule will be applied ContactsFilter.StringMatchType.Exactly. /// /// 4 public const uint NumberFilter = (uint)Property.Id.NumberNumberFilter; /// - /// You can only use this property for search filter + /// You can only use this property for the search filter. /// /// 4 public const uint NormalizedNumber = (uint)Property.Id.NumberNormalizedNumber; /// - /// You can only use this property for search filter + /// You can only use this property for the search filter. /// /// 4 public const uint CleanedNumber = (uint)Property.Id.NumberCleanedNumber; }; /// - /// Describes properties of a ContactEmail record. + /// Describes the properties of a ContactEmail record. /// /// Read only view /// 4 public static class ContactEmail { /// - /// Identifier of this contacts email view + /// Identifier of this contacts email view. /// /// 4 public const string Uri = "tizen.contacts_view.simple_contact/email"; /// - /// Contact ID that the number belongs to + /// Contact ID that the number belongs to. /// /// 4 public const uint ContactId = (uint)Property.Id.ContactId; /// - /// Display name of contact that the number belongs to + /// Display name of the contact that the number belongs to. /// /// 4 public const uint DisplayName = (uint)Property.Id.ContactDisplayName; /// - /// The source type of display name, refer to the Contact.DisplayNameSourceType (projection) + /// The source type of the display name, refer to the Contact.DisplayNameSourceType (projection). /// /// 4 public const uint DisplaySourceType = (uint)Property.Id.ContactDisplaySourceDataId; /// - /// AddressBook ID that the number belongs to + /// AddressBook ID that the number belongs to. /// /// 4 public const uint AddressBookId = (uint)Property.Id.ContactAddressBookId; /// - /// Person ID that the number belongs to + /// Person ID that the number belongs to. /// /// 4 public const uint PersonId = (uint)Property.Id.ContactPersonId; /// - /// Ringtone path that the number belongs to (projection) + /// Ringtone path that the number belongs to (projection). /// /// 4 public const uint RingtonePath = (uint)Property.Id.ContactRingtone; /// - /// Image thumbnail path that the number belongs to (projection) + /// Image thumbnail path that the number belongs to (projection). /// /// 4 public const uint ThumbnailPath = (uint)Property.Id.ContactThumbnail; /// - /// DB record ID of the email + /// Database record ID of the email. /// /// 4 public const uint EmailId = (uint)Property.Id.EmailId; /// - /// Email type, refer to the Email.Types (projection) + /// Email type, refer to the Email.Types (projection). /// /// 4 public const uint Type = (uint)Property.Id.EmailType; /// - /// Custom mail type label, when the email type is Email.Types.Custom (projection) + /// Custom mail type label, when the email type is Email.Types.Custom (projection). /// /// 4 public const uint Label = (uint)Property.Id.EmailLabel; /// - /// Email is default email or not + /// The email is the default email or not. /// /// 4 public const uint IsDefault = (uint)Property.Id.EmailIsDefault; /// - /// Email address + /// Email address. /// /// 4 public const uint Email = (uint)Property.Id.EmailEmail; }; /// - /// Describes properties of a ContactGroupRelation record. + /// Describes the properties of a ContactGroupRelation record. /// /// Read only view /// 4 public static class ContactGroupRelation { /// - /// Identifier of this contact group relation view + /// Identifier of this contacts group relation view. /// /// 4 public const string Uri = "tizen.contacts_view.simple_contact/group"; /// - /// Contact ID that the number belongs to + /// Contact ID that the number belongs to. /// /// 4 public const uint ContactId = (uint)Property.Id.ContactId; /// - /// Display name of contact that the number belongs to + /// Display name of the contact that the number belongs to. /// /// 4 public const uint DisplayName = (uint)Property.Id.ContactDisplayName; /// - /// The source type of display name, refer to the Contact.DisplayNameSourceType (projection) + /// The source type of the display name, refer to the Contact.DisplayNameSourceType (projection). /// /// 4 public const uint DisplaySourceType = (uint)Property.Id.ContactDisplaySourceDataId; /// - /// AddressBook ID that the number belongs to + /// AddressBook ID that the number belongs to. /// /// 4 public const uint AddressBookId = (uint)Property.Id.ContactAddressBookId; /// - /// Person ID that the number belongs to + /// Person ID that the number belongs to. /// /// 4 public const uint PersonId = (uint)Property.Id.ContactPersonId; /// - /// Ringtone path that the number belongs to (projection) + /// Ringtone path that the number belongs to (projection). /// /// 4 public const uint RingtonePath = (uint)Property.Id.ContactRingtone; /// - /// Image thumbnail path that the number belongs to (projection) + /// Image thumbnail path that the number belongs to (projection). /// /// 4 public const uint ThumbnailPath = (uint)Property.Id.ContactThumbnail; /// - /// DB record ID of the group relation + /// Database record ID of the group relation. /// /// 4 public const uint GroupId = (uint)Property.Id.GroupRelationGroupId; /// - /// Group name (projection) + /// Group name (projection). /// /// 4 public const uint GroupName = (uint)Property.Id.GroupRelationGroupName; }; /// - /// Describes properties of a Phone Log Statistics record. + /// Describes the properties of a Phone Log Statistics record. /// - /// Read only view + /// Read-only view. /// 4 public static class PhoneLogStatistics { /// - /// Identifier of this log statistics view + /// Identifier of this log statistics view. /// /// 4 public const string Uri = "tizen.contacts_view.phonelog_stat"; /// - /// Log count (projection) + /// Log count (projection). /// /// 4 public const uint LogCount = (uint)Property.Id.PhonelogStatLogCount; /// - /// Log type, see the contacts_phone_log_type_e + /// Log type, see the contacts_phone_log_type_e. /// /// 4 public const uint LogType = (uint)Property.Id.PhonelogStatLogType; /// - /// It is related to the Sim slot number. sim_slot_no 0 means first Sim card, sim_slot_no 1 means second Sim. It is same with handle index of telephony handle list. Refer to the telephony_init() + /// It is related to the SIM slot number. sim_slot_no 0 means the first SIM card, sim_slot_no 1 means the second SIM. It is same with the handle index of the telephony handle list. Refer to the telephony_init(). /// /// 4 public const uint SimSlotNo = (uint)Property.Id.PhonelogStatSimSlotNo; diff --git a/src/Tizen.Pims.Contacts/Tizen.Pims.Contacts/DBChangedEventArgs.cs b/src/Tizen.Pims.Contacts/Tizen.Pims.Contacts/DBChangedEventArgs.cs index 7aeb146..d546c2e 100644 --- a/src/Tizen.Pims.Contacts/Tizen.Pims.Contacts/DBChangedEventArgs.cs +++ b/src/Tizen.Pims.Contacts/Tizen.Pims.Contacts/DBChangedEventArgs.cs @@ -19,7 +19,7 @@ using System; namespace Tizen.Pims.Contacts { /// - /// Event arguments passed when contacts database is changed + /// Event arguments passed when the contacts database is changed. /// /// 4 public class DBChangedEventArgs : EventArgs @@ -30,7 +30,7 @@ namespace Tizen.Pims.Contacts } /// - /// The contacts view URI changed. + /// The contacts view URI is changed. /// /// 4 public string ViewUri diff --git a/src/Tizen.Pims.Contacts/Tizen.Pims.Contacts/DBStatusChangedEventArgs.cs b/src/Tizen.Pims.Contacts/Tizen.Pims.Contacts/DBStatusChangedEventArgs.cs index 0eb9611..f02e6d8 100644 --- a/src/Tizen.Pims.Contacts/Tizen.Pims.Contacts/DBStatusChangedEventArgs.cs +++ b/src/Tizen.Pims.Contacts/Tizen.Pims.Contacts/DBStatusChangedEventArgs.cs @@ -20,7 +20,7 @@ using static Tizen.Pims.Contacts.ContactsDatabase; namespace Tizen.Pims.Contacts { /// - /// Event arguments passed when contacts database status is changed + /// Event arguments passed when the contacts database status is changed. /// /// 4 public class DBStatusChangedEventArgs : EventArgs diff --git a/src/Tizen.Pims.Contacts/Tizen.Pims.Contacts/NameDisplayOrderChangedEventArgs.cs b/src/Tizen.Pims.Contacts/Tizen.Pims.Contacts/NameDisplayOrderChangedEventArgs.cs index bb2abf4..f763bd1 100644 --- a/src/Tizen.Pims.Contacts/Tizen.Pims.Contacts/NameDisplayOrderChangedEventArgs.cs +++ b/src/Tizen.Pims.Contacts/Tizen.Pims.Contacts/NameDisplayOrderChangedEventArgs.cs @@ -19,7 +19,7 @@ using System; namespace Tizen.Pims.Contacts { /// - /// Event arguments passed when setting value of contacts name display order is changed + /// Event arguments passed when a setting value of the contacts name display order is changed. /// /// 4 public class NameDisplayOrderChangedEventArgs : EventArgs @@ -30,7 +30,7 @@ namespace Tizen.Pims.Contacts } /// - /// A setting value of contacts name display order + /// A setting value of the contacts name display order. /// /// 4 public ContactDisplayOrder NameDisplayOrder diff --git a/src/Tizen.Pims.Contacts/Tizen.Pims.Contacts/NameSortingOrderChangedEventArgs.cs b/src/Tizen.Pims.Contacts/Tizen.Pims.Contacts/NameSortingOrderChangedEventArgs.cs index eda3bf0..02e7e40 100644 --- a/src/Tizen.Pims.Contacts/Tizen.Pims.Contacts/NameSortingOrderChangedEventArgs.cs +++ b/src/Tizen.Pims.Contacts/Tizen.Pims.Contacts/NameSortingOrderChangedEventArgs.cs @@ -19,7 +19,7 @@ using System; namespace Tizen.Pims.Contacts { /// - /// Event arguments passed when setting value of contacts name sorting order is changed + /// Event arguments passed when a setting value of the contacts name sorting order is changed. /// /// 4 public class NameSortingOrderChangedEventArgs : EventArgs @@ -30,7 +30,7 @@ namespace Tizen.Pims.Contacts } /// - /// A setting value of contacts name sorting order + /// A setting value of the contacts name sorting order. /// /// 4 public ContactSortingOrder NameSortingOrder -- 2.7.4