namespace Tizen.Pims.Calendar
{
/// <summary>
- /// CalendarDatabase provides methods to manage calendar information from/to the database.
+ /// The CalendarDatabase provides methods to manage calendar information from/to the database.
/// </summary>
/// <remarks>
- /// 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.
/// </remarks>
/// <since_tizen> 4 </since_tizen>
public class CalendarDatabase
}
/// <summary>
- /// Gets last successful changed calendar database version on the current connection.
+ /// Gets the last successful changed calendar database version on the current connection.
/// </summary>
/// <since_tizen> 4 </since_tizen>
- /// <returns>The last successful changed calendar database version on the current connection</returns>
+ /// <returns>The last successful changed calendar database version on the current connection.</returns>
/// <privilege>http://tizen.org/privilege/calendar.read</privilege>
- /// <exception cref="InvalidOperationException">Thrown when method failed due to invalid operation</exception>
- /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory</exception>
- /// <exception cref="UnauthorizedAccessException">Thrown when application does not have proper privileges</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the method failed due to an invalid operation.</exception>
+ /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory.</exception>
+ /// <exception cref="UnauthorizedAccessException">Thrown when the application does not have proper privileges.</exception>
/// <value>The last successful changed calendar database version on the current connection.</value>
[SuppressMessage("Microsoft.Performance", "CA1822:MarkMembersAsStatic")]
public int LastChangeVersion
/// Inserts a record into the calendar database.
/// </summary>
/// <since_tizen> 4 </since_tizen>
- /// <param name="record">The record to be inserted</param>
- /// <returns>The ID of inserted record</returns>
+ /// <param name="record">The record to be inserted.</param>
+ /// <returns>The ID of inserted record.</returns>
/// <privilege>http://tizen.org/privilege/calendar.write</privilege>
/// <feature>http://tizen.org/feature/calendar</feature>
- /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
- /// <exception cref="InvalidOperationException">Thrown when method failed due to invalid operation</exception>
- /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid</exception>
- /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory</exception>
- /// <exception cref="UnauthorizedAccessException">Thrown when application does not have proper privileges</exception>
+ /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the method failed due to an invalid operation.</exception>
+ /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid.</exception>
+ /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory.</exception>
+ /// <exception cref="UnauthorizedAccessException">Thrown when the application does not have proper privileges.</exception>
[SuppressMessage("Microsoft.Performance", "CA1822:MarkMembersAsStatic")]
public int Insert(CalendarRecord record)
{
/// Gets a record from the calendar database.
/// </summary>
/// <since_tizen> 4 </since_tizen>
- /// <param name="viewUri">The view URI of a record</param>
- /// <param name="recordId">The record ID</param>
+ /// <param name="viewUri">The view URI of a record.</param>
+ /// <param name="recordId">The record ID.</param>
/// <returns>
- /// The record associated with the record ID
+ /// The record associated with the record ID.
/// </returns>
/// <privilege>http://tizen.org/privilege/calendar.read</privilege>
/// <feature>http://tizen.org/feature/calendar</feature>
- /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
- /// <exception cref="InvalidOperationException">Thrown when method failed due to invalid operation</exception>
- /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid</exception>
- /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory</exception>
- /// <exception cref="UnauthorizedAccessException">Thrown when application does not have proper privileges</exception>
+ /// <exception cref="NotSupportedException">Thrown when feature is not supported.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the method failed due to an invalid operation.</exception>
+ /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid.</exception>
+ /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory.</exception>
+ /// <exception cref="UnauthorizedAccessException">Thrown when the application does not have proper privileges.</exception>
[SuppressMessage("Microsoft.Performance", "CA1822:MarkMembersAsStatic")]
[SuppressMessage("Microsoft.Design", "CA1054:UriParametersShouldNotBeStrings")]
public CalendarRecord Get(string viewUri, int recordId)
/// Updates a record in the calendar database.
/// </summary>
/// <since_tizen> 4 </since_tizen>
- /// <param name="record">The record to be updated</param>
+ /// <param name="record">The record to be updated.</param>
/// <privilege>http://tizen.org/privilege/calendar.write</privilege>
/// <feature>http://tizen.org/feature/calendar</feature>
- /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
- /// <exception cref="InvalidOperationException">Thrown when method failed due to invalid operation</exception>
- /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid</exception>
- /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory</exception>
- /// <exception cref="UnauthorizedAccessException">Thrown when application does not have proper privileges</exception>
+ /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the method failed due to an invalid operation.</exception>
+ /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid.</exception>
+ /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory.</exception>
+ /// <exception cref="UnauthorizedAccessException">Thrown when the application does not have proper privileges.</exception>
[SuppressMessage("Microsoft.Performance", "CA1822:MarkMembersAsStatic")]
public void Update(CalendarRecord record)
{
/// Deletes a record from the calendar database with related child records.
/// </summary>
/// <since_tizen> 4 </since_tizen>
- /// <param name="viewUri">The view URI of a record</param>
- /// <param name="recordId">The record ID to be deleted</param>
+ /// <param name="viewUri">The view URI of a record.</param>
+ /// <param name="recordId">The record ID to be deleted.</param>
/// <privilege>http://tizen.org/privilege/calendar.write</privilege>
/// <feature>http://tizen.org/feature/calendar</feature>
- /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
- /// <exception cref="InvalidOperationException">Thrown when method failed due to invalid operation</exception>
- /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid</exception>
- /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory</exception>
- /// <exception cref="UnauthorizedAccessException">Thrown when application does not have proper privileges</exception>
+ /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the method failed due to an invalid operation.</exception>
+ /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid.</exception>
+ /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory.</exception>
+ /// <exception cref="UnauthorizedAccessException">Thrown when the application does not have proper privileges.</exception>
[SuppressMessage("Microsoft.Performance", "CA1822:MarkMembersAsStatic")]
[SuppressMessage("Microsoft.Design", "CA1054:UriParametersShouldNotBeStrings")]
public void Delete(string viewUri, int recordId)
/// Replaces a record in the calendar database.
/// </summary>
/// <since_tizen> 4 </since_tizen>
- /// <param name="record">The record to be replaced</param>
- /// <param name="id">the record id</param>
+ /// <param name="record">The record to be replaced.</param>
+ /// <param name="id">The record ID.</param>
/// <privilege>http://tizen.org/privilege/calendar.write</privilege>
/// <feature>http://tizen.org/feature/calendar</feature>
- /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
- /// <exception cref="InvalidOperationException">Thrown when method failed due to invalid operation</exception>
- /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid</exception>
- /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory</exception>
- /// <exception cref="UnauthorizedAccessException">Thrown when application does not have proper privileges</exception>
+ /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the method failed due to an invalid operation.</exception>
+ /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid.</exception>
+ /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory.</exception>
+ /// <exception cref="UnauthorizedAccessException">Thrown when the application does not have proper privileges.</exception>
[SuppressMessage("Microsoft.Performance", "CA1822:MarkMembersAsStatic")]
public void Replace(CalendarRecord record, int id)
{
}
/// <summary>
- /// Retrieves all records as a list.
+ /// Retrieves all the records as a list.
/// </summary>
/// <since_tizen> 4 </since_tizen>
- /// <param name="viewUri">The view URI to get records from</param>
- /// <param name="offset">The index from which results are received</param>
- /// <param name="limit">The maximum number of results(value 0 is used for all records)</param>
+ /// <param name="viewUri">The view URI to get records from.</param>
+ /// <param name="offset">The index from which results are received.</param>
+ /// <param name="limit">The maximum number of results (value 0 is used for all the records).</param>
/// <returns>
- /// The record list
+ /// The record list.
/// </returns>
/// <privilege>http://tizen.org/privilege/calendar.read</privilege>
/// <feature>http://tizen.org/feature/calendar</feature>
- /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
- /// <exception cref="InvalidOperationException">Thrown when method failed due to invalid operation</exception>
- /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid</exception>
- /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory</exception>
- /// <exception cref="UnauthorizedAccessException">Thrown when application does not have proper privileges</exception>
+ /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the method failed due to an invalid operation.</exception>
+ /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid.</exception>
+ /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory.</exception>
+ /// <exception cref="UnauthorizedAccessException">Thrown when the application does not have proper privileges.</exception>
[SuppressMessage("Microsoft.Performance", "CA1822:MarkMembersAsStatic")]
[SuppressMessage("Microsoft.Design", "CA1054:UriParametersShouldNotBeStrings")]
public CalendarList GetAll(string viewUri, int offset, int limit)
}
/// <summary>
- /// Retrieves records using a query.
+ /// Retrieves the records using a query.
/// </summary>
/// <since_tizen> 4 </since_tizen>
- /// <param name="query">The query used to filter results</param>
- /// <param name="offset">The index from which results are received</param>
- /// <param name="limit">The maximum number of results(value 0 is used for all records)</param>
+ /// <param name="query">The query used to filter results.</param>
+ /// <param name="offset">The index from which results are received.</param>
+ /// <param name="limit">The maximum number of results (value 0 is used for all the records).</param>
/// <returns>
- /// CalendarList
+ /// CalendarList.
/// </returns>
/// <privilege>http://tizen.org/privilege/calendar.read</privilege>
/// <feature>http://tizen.org/feature/calendar</feature>
- /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
- /// <exception cref="InvalidOperationException">Thrown when method failed due to invalid operation</exception>
- /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory</exception>
- /// <exception cref="UnauthorizedAccessException">Thrown when application does not have proper privileges</exception>
+ /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the method failed due to an invalid operation.</exception>
+ /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory.</exception>
+ /// <exception cref="UnauthorizedAccessException">Thrown when the application does not have proper privileges.</exception>
[SuppressMessage("Microsoft.Performance", "CA1822:MarkMembersAsStatic")]
public CalendarList GetRecordsWithQuery(CalendarQuery query, int offset, int limit)
{
/// Inserts multiple records into the calendar database as a batch operation.
/// </summary>
/// <since_tizen> 4 </since_tizen>
- /// <param name="list">The record list</param>
+ /// <param name="list">The record list.</param>
/// <returns>
- /// The inserted record id array
+ /// The inserted record ID array.
/// </returns>
/// <privilege>http://tizen.org/privilege/calendar.write</privilege>
/// <feature>http://tizen.org/feature/calendar</feature>
- /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
- /// <exception cref="InvalidOperationException">Thrown when method failed due to invalid operation</exception>
- /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid</exception>
- /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory</exception>
- /// <exception cref="UnauthorizedAccessException">Thrown when application does not have proper privileges</exception>
+ /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the method failed due to an invalid operation.</exception>
+ /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid.</exception>
+ /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory.</exception>
+ /// <exception cref="UnauthorizedAccessException">Thrown when the application does not have proper privileges.</exception>
[SuppressMessage("Microsoft.Performance", "CA1822:MarkMembersAsStatic")]
public int[] Insert(CalendarList list)
{
/// Updates multiple records into the calendar database as a batch operation.
/// </summary>
/// <since_tizen> 4 </since_tizen>
- /// <param name="list">The record list</param>
+ /// <param name="list">The record list.</param>
/// <privilege>http://tizen.org/privilege/calendar.write</privilege>
/// <feature>http://tizen.org/feature/calendar</feature>
- /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
- /// <exception cref="InvalidOperationException">Thrown when method failed due to invalid operation</exception>
- /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid</exception>
- /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory</exception>
- /// <exception cref="UnauthorizedAccessException">Thrown when application does not have proper privileges</exception>
+ /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the method failed due to an invalid operation.</exception>
+ /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid.</exception>
+ /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory.</exception>
+ /// <exception cref="UnauthorizedAccessException">Thrown when the application does not have proper privileges.</exception>
[SuppressMessage("Microsoft.Performance", "CA1822:MarkMembersAsStatic")]
public void Update(CalendarList list)
{
}
/// <summary>
- /// 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.
/// </summary>
/// <since_tizen> 4 </since_tizen>
- /// <param name="viewUri">The view URI of the records to delete</param>
- /// <param name="idArray">The record IDs to delete</param>
+ /// <param name="viewUri">The view URI of the records to delete.</param>
+ /// <param name="idArray">The record IDs to delete.</param>
/// <privilege>http://tizen.org/privilege/calendar.write</privilege>
/// <feature>http://tizen.org/feature/calendar</feature>
- /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
- /// <exception cref="InvalidOperationException">Thrown when method failed due to invalid operation</exception>
- /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid</exception>
- /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory</exception>
- /// <exception cref="UnauthorizedAccessException">Thrown when application does not have proper privileges</exception>
+ /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the method failed due to an invalid operation.</exception>
+ /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid.</exception>
+ /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory.</exception>
+ /// <exception cref="UnauthorizedAccessException">Thrown when the application does not have proper privileges.</exception>
[SuppressMessage("Microsoft.Performance", "CA1822:MarkMembersAsStatic")]
[SuppressMessage("Microsoft.Design", "CA1054:UriParametersShouldNotBeStrings")]
public void Delete(string viewUri, int[] idArray)
}
/// <summary>
- /// 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.
/// </summary>
/// <since_tizen> 4 </since_tizen>
- /// <param name="list">The record list</param>
+ /// <param name="list">The record list.</param>
/// <privilege>http://tizen.org/privilege/calendar.write</privilege>
/// <feature>http://tizen.org/feature/calendar</feature>
- /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
- /// <exception cref="InvalidOperationException">Thrown when method failed due to invalid operation</exception>
- /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory</exception>
- /// <exception cref="UnauthorizedAccessException">Thrown when application does not have proper privileges</exception>
+ /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the method failed due to an invalid operation.</exception>
+ /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory.</exception>
+ /// <exception cref="UnauthorizedAccessException">Thrown when the application does not have proper privileges.</exception>
public void Delete(CalendarList list)
{
CalendarRecord record = null;
/// Replaces multiple records in the calendar database as a batch operation.
/// </summary>
/// <since_tizen> 4 </since_tizen>
- /// <param name="list">The record list</param>
- /// <param name="idArray">The record IDs</param>
+ /// <param name="list">The record list.</param>
+ /// <param name="idArray">The record IDs.</param>
/// <privilege>http://tizen.org/privilege/calendar.write</privilege>
/// <feature>http://tizen.org/feature/calendar</feature>
- /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
- /// <exception cref="InvalidOperationException">Thrown when method failed due to invalid operation</exception>
- /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid</exception>
- /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory</exception>
- /// <exception cref="UnauthorizedAccessException">Thrown when application does not have proper privileges</exception>
+ /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the method failed due to an invalid operation.</exception>
+ /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid.</exception>
+ /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory.</exception>
+ /// <exception cref="UnauthorizedAccessException">Thrown when the application does not have proper privileges.</exception>
[SuppressMessage("Microsoft.Performance", "CA1822:MarkMembersAsStatic")]
public void Replace(CalendarList list, int[] idArray)
{
}
/// <summary>
- /// Retrieves records with the given calendar database version.
+ /// Retrieves the records with the given calendar database version.
/// </summary>
/// <since_tizen> 4 </since_tizen>
- /// <param name="viewUri">The view URI to get records from</param>
- /// <param name="BookId">The calendar book ID to filter</param>
- /// <param name="calendarDBVersion">The calendar database version</param>
- /// <param name="currentDBVersion">The current calendar database version</param>
+ /// <param name="viewUri">The view URI to get records from.</param>
+ /// <param name="BookId">The calendar book ID to filter.</param>
+ /// <param name="calendarDBVersion">The calendar database version.</param>
+ /// <param name="currentDBVersion">The current calendar database version.</param>
/// <returns>
- /// The record list
+ /// The record list.
/// </returns>
/// <privilege>http://tizen.org/privilege/calendar.read</privilege>
/// <feature>http://tizen.org/feature/calendar</feature>
- /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
- /// <exception cref="InvalidOperationException">Thrown when method failed due to invalid operation</exception>
- /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid</exception>
- /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory</exception>
- /// <exception cref="UnauthorizedAccessException">Thrown when application does not have proper privileges</exception>
+ /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the method failed due to an invalid operation.</exception>
+ /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid.</exception>
+ /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory.</exception>
+ /// <exception cref="UnauthorizedAccessException">Thrown when the application does not have proper privileges.</exception>
[SuppressMessage("Microsoft.Performance", "CA1822:MarkMembersAsStatic")]
[SuppressMessage("Microsoft.Design", "CA1054:UriParametersShouldNotBeStrings")]
public CalendarList GetChangesByVersion(string viewUri, int BookId, int calendarDBVersion, out int currentDBVersion)
/// Gets the record count of a specific view.
/// </summary>
/// <since_tizen> 4 </since_tizen>
- /// <param name="viewUri">The view URI to get records from</param>
+ /// <param name="viewUri">The view URI to get records from.</param>
/// <returns>
- /// The count of records
+ /// The count of records.
/// </returns>
/// <privilege>http://tizen.org/privilege/calendar.read</privilege>
[SuppressMessage("Microsoft.Design", "CA1822:MarkMembersAsStatic")]
/// Gets the record count with a query.
/// </summary>
/// <since_tizen> 4 </since_tizen>
- /// <param name="query">The query used for filtering the results</param>
+ /// <param name="query">The query used for filtering the results.</param>
/// <returns>
- /// The count of records
+ /// The count of records.
/// </returns>
/// <privilege>http://tizen.org/privilege/calendar.read</privilege>
[SuppressMessage("Microsoft.Design", "CA1822:MarkMembersAsStatic")]
/// Registers a callback function to be invoked when a record changes.
/// </summary>
/// <since_tizen> 4 </since_tizen>
- /// <param name="viewUri">The view URI of the record to subscribe for change notifications</param>
- /// <param name="DBChanged">The EventHandler to register</param>
+ /// <param name="viewUri">The view URI of the record to subscribe for change notifications.</param>
+ /// <param name="DBChanged">The EventHandler to register.</param>
/// <privilege>http://tizen.org/privilege/calendar.read</privilege>
/// <feature>http://tizen.org/feature/calendar</feature>
- /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
- /// <exception cref="InvalidOperationException">Thrown when method failed due to invalid operation</exception>
- /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid</exception>
- /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory</exception>
- /// <exception cref="UnauthorizedAccessException">Thrown when application does not have proper privileges</exception>
+ /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the method failed due to an invalid operation.</exception>
+ /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid.</exception>
+ /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory.</exception>
+ /// <exception cref="UnauthorizedAccessException">Thrown when the application does not have proper privileges.</exception>
[SuppressMessage("Microsoft.Design", "CA1054:UriParametersShouldNotBeStrings")]
public void AddDBChangedDelegate(string viewUri, EventHandler<DBChangedEventArgs> DBChanged)
{
/// Deregisters a callback function.
/// </summary>
/// <since_tizen> 4 </since_tizen>
- /// <param name="viewUri">The view URI of the record to subscribe for change notifications</param>
- /// <param name="DBChanged">The EventHandler to deregister</param>
+ /// <param name="viewUri">The view URI of the record to subscribe for change notifications.</param>
+ /// <param name="DBChanged">The EventHandler to deregister.</param>
/// <privilege>http://tizen.org/privilege/calendar.read</privilege>
/// <feature>http://tizen.org/feature/calendar</feature>
- /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
- /// <exception cref="InvalidOperationException">Thrown when method failed due to invalid operation</exception>
- /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory</exception>
- /// <exception cref="UnauthorizedAccessException">Thrown when application does not have proper privileges</exception>
+ /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the method failed due to an invalid operation.</exception>
+ /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory.</exception>
+ /// <exception cref="UnauthorizedAccessException">Thrown when the application does not have proper privileges.</exception>
[SuppressMessage("Microsoft.Design", "CA1054:UriParametersShouldNotBeStrings")]
public void RemoveDBChangedDelegate(string viewUri, EventHandler<DBChangedEventArgs> DBChanged)
{
}
/// <summary>
- /// Link a record to another record.
+ /// Links a record to another record.
/// </summary>
/// <since_tizen> 4 </since_tizen>
- /// <param name="baseId">The base record ID</param>
- /// <param name="recordId">The record ID to link to</param>
+ /// <param name="baseId">The base record ID.</param>
+ /// <param name="recordId">The record ID to link to.</param>
/// <privilege>http://tizen.org/privilege/calendar.write</privilege>
/// <feature>http://tizen.org/feature/calendar</feature>
- /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
- /// <exception cref="InvalidOperationException">Thrown when method failed due to invalid operation</exception>
- /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid</exception>
- /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory</exception>
- /// <exception cref="UnauthorizedAccessException">Thrown when application does not have proper privileges</exception>
+ /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the method failed due to an invalid operation.</exception>
+ /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid.</exception>
+ /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory.</exception>
+ /// <exception cref="UnauthorizedAccessException">Thrown when the application does not have proper privileges.</exception>
[SuppressMessage("Microsoft.Design", "CA1822:MarkMembersAsStatic")]
public void LinkRecord(int baseId, int recordId)
{
}
/// <summary>
- /// Unlink a record from base record.
+ /// Unlinks a record from the base record.
/// </summary>
/// <since_tizen> 4 </since_tizen>
- /// <param name="recordId">The record ID to unlink</param>
+ /// <param name="recordId">The record ID to unlink.</param>
/// <privilege>http://tizen.org/privilege/calendar.write</privilege>
/// <feature>http://tizen.org/feature/calendar</feature>
- /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
- /// <exception cref="InvalidOperationException">Thrown when method failed due to invalid operation</exception>
- /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid</exception>
- /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory</exception>
- /// <exception cref="UnauthorizedAccessException">Thrown when application does not have proper privileges</exception>
+ /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the method failed due to an invalid operation.</exception>
+ /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid.</exception>
+ /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory.</exception>
+ /// <exception cref="UnauthorizedAccessException">Thrown when the application does not have proper privileges.</exception>
[SuppressMessage("Microsoft.Performance", "CA1822:MarkMembersAsStatic")]
public void UnlinkRecord(int recordId)
{
/// </summary>
/// <since_tizen> 4 </since_tizen>
/// <feature>http://tizen.org/feature/calendar</feature>
- /// <param name="viewUri">The view URI of a filter</param>
- /// <param name="propertyId">The property ID to add a condition</param>
- /// <param name="matchType">The match flag</param>
- /// <param name="matchValue">The match value</param>
- /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
- /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid</exception>
- /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory</exception>
+ /// <param name="viewUri">The view URI of a filter.</param>
+ /// <param name="propertyId">The property ID to add a condition.</param>
+ /// <param name="matchType">The match flag.</param>
+ /// <param name="matchValue">The match value.</param>
+ /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
+ /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid.</exception>
+ /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory.</exception>
[SuppressMessage("Microsoft.Design", "CA1054:UriParametersShouldNotBeStrings")]
public CalendarFilter(string viewUri, uint propertyId, StringMatchType matchType, string matchValue)
{
/// </summary>
/// <since_tizen> 4 </since_tizen>
/// <feature>http://tizen.org/feature/calendar</feature>
- /// <param name="viewUri">The view URI of a filter</param>
- /// <param name="propertyId">The property ID to add a condition</param>
- /// <param name="matchType">The match flag</param>
- /// <param name="matchValue">The match value</param>
- /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
- /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid</exception>
- /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory</exception>
+ /// <param name="viewUri">The view URI of a filter.</param>
+ /// <param name="propertyId">The property ID to add a condition.</param>
+ /// <param name="matchType">The match flag.</param>
+ /// <param name="matchValue">The match value.</param>
+ /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
+ /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid.</exception>
+ /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory.</exception>
[SuppressMessage("Microsoft.Design", "CA1054:UriParametersShouldNotBeStrings")]
public CalendarFilter(string viewUri, uint propertyId, IntegerMatchType matchType, int matchValue)
{
}
/// <summary>
- /// Creates a filter with a condition for long type.
+ /// Creates a filter with a condition for a long type.
/// </summary>
/// <since_tizen> 4 </since_tizen>
/// <feature>http://tizen.org/feature/calendar</feature>
- /// <param name="viewUri">The view URI of a filter</param>
- /// <param name="propertyId">The property ID to add a condition</param>
- /// <param name="matchType">The match flag</param>
- /// <param name="matchValue">The match value</param>
- /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
- /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid</exception>
- /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory</exception>
+ /// <param name="viewUri">The view URI of a filter.</param>
+ /// <param name="propertyId">The property ID to add a condition.</param>
+ /// <param name="matchType">The match flag.</param>
+ /// <param name="matchValue">The match value.</param>
+ /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
+ /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid.</exception>
+ /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory.</exception>
[SuppressMessage("Microsoft.Design", "CA1054:UriParametersShouldNotBeStrings")]
public CalendarFilter(string viewUri, uint propertyId, IntegerMatchType matchType, long matchValue)
{
}
/// <summary>
- /// Creates a filter with a condition for double type.
+ /// Creates a filter with a condition for a double type.
/// </summary>
/// <since_tizen> 4 </since_tizen>
/// <feature>http://tizen.org/feature/calendar</feature>
- /// <param name="viewUri">The view URI of a filter</param>
- /// <param name="propertyId">The property ID to add a condition</param>
- /// <param name="matchType">The match flag</param>
- /// <param name="matchValue">The match value</param>
- /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
- /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid</exception>
- /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory</exception>
+ /// <param name="viewUri">The view URI of a filter.</param>
+ /// <param name="propertyId">The property ID to add a condition.</param>
+ /// <param name="matchType">The match flag.</param>
+ /// <param name="matchValue">The match value.</param>
+ /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
+ /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid.</exception>
+ /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory.</exception>
[SuppressMessage("Microsoft.Design", "CA1054:UriParametersShouldNotBeStrings")]
public CalendarFilter(string viewUri, uint propertyId, IntegerMatchType matchType, double matchValue)
{
}
/// <summary>
- /// Creates a filter with a condition for CalendarTime type.
+ /// Creates a filter with a condition for the CalendarTime type.
/// </summary>
/// <since_tizen> 4 </since_tizen>
/// <feature>http://tizen.org/feature/calendar</feature>
- /// <param name="viewUri">The view URI of a filter</param>
- /// <param name="propertyId">The property ID to add a condition</param>
- /// <param name="matchType">The match flag</param>
- /// <param name="matchValue">The match value</param>
- /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
- /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid</exception>
- /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory</exception>
+ /// <param name="viewUri">The view URI of a filter.</param>
+ /// <param name="propertyId">The property ID to add a condition.</param>
+ /// <param name="matchType">The match flag.</param>
+ /// <param name="matchValue">The match value.</param>
+ /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
+ /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid.</exception>
+ /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory.</exception>
[SuppressMessage("Microsoft.Design", "CA1054:UriParametersShouldNotBeStrings")]
public CalendarFilter(string viewUri, uint propertyId, IntegerMatchType matchType, CalendarTime matchValue)
{
}
/// <summary>
- /// Destroy filter.
+ /// Destroys the filter.
/// </summary>
~CalendarFilter()
{
public enum StringMatchType
{
/// <summary>
- /// Full string, case-sensitive
+ /// Full string, case-sensitive.
/// </summary>
Exactly,
/// <summary>
- /// Full string, case-insensitive
+ /// Full string, case-insensitive.
/// </summary>
FullString,
/// <summary>
- /// Sub string, case-insensitive
+ /// Sub-string, case-insensitive.
/// </summary>
Contains,
/// <summary>
- /// Start with, case-insensitive
+ /// Starts with, case-insensitive.
/// </summary>
StartsWith,
/// <summary>
- /// End with, case-insensitive
+ /// Ends with, case-insensitive.
/// </summary>
EndsWith,
/// <summary>
- /// IS NOT NUL
+ /// IS NOT NULL.
/// </summary>
Exists,
}
/// </summary>
LessThanOrEqual,
/// <summary>
- /// <>, this flag can yield poor performance
+ /// <>, this flag can yield poor performance.
/// </summary>
NotEqual,
/// <summary>
- /// IS NULL
+ /// IS NULL.
/// </summary>
None,
}
public enum LogicalOperator
{
/// <summary>
- /// AND
+ /// And.
/// </summary>
And,
/// <summary>
- /// OR
+ /// Or.
/// </summary>
Or,
}
private bool disposedValue = false; // To detect redundant calls
/// <summary>
- /// Dispose
+ /// Dispose.
/// </summary>
- /// <param name="disposing">true to release both managed and unmanaged resources; false to release only unmanaged resources.</param>
+ /// <param name="disposing">true to release both managed and unmanaged resources, false to release only unmanaged resources.</param>
/// <since_tizen> 4 </since_tizen>
protected virtual void Dispose(bool disposing)
{
}
/// <summary>
- /// 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.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public void Dispose()
/// </summary>
/// <since_tizen> 4 </since_tizen>
/// <feature>http://tizen.org/feature/calendar</feature>
- /// <param name="logicalOperator">The operator type</param>
- /// <param name="propertyId">The property ID to add a condition</param>
- /// <param name="matchType">The match flag</param>
- /// <param name="matchValue">The match value</param>
- /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
- /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid</exception>
+ /// <param name="logicalOperator">The operator type.</param>
+ /// <param name="propertyId">The property ID to add a condition.</param>
+ /// <param name="matchType">The match flag.</param>
+ /// <param name="matchValue">The match value.</param>
+ /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
+ /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid.</exception>
public void AddCondition(LogicalOperator logicalOperator, uint propertyId, StringMatchType matchType, string matchValue)
{
int error = Interop.Filter.AddOperator(_filterHandle, logicalOperator);
/// </summary>
/// <since_tizen> 4 </since_tizen>
/// <feature>http://tizen.org/feature/calendar</feature>
- /// <param name="logicalOperator">The operator type</param>
- /// <param name="propertyId">The property ID to add a condition</param>
- /// <param name="matchType">The match flag</param>
- /// <param name="matchValue">The match value</param>
- /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
- /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid</exception>
+ /// <param name="logicalOperator">The operator type.</param>
+ /// <param name="propertyId">The property ID to add a condition.</param>
+ /// <param name="matchType">The match flag.</param>
+ /// <param name="matchValue">The match value.</param>
+ /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
+ /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid.</exception>
public void AddCondition(LogicalOperator logicalOperator, uint propertyId, IntegerMatchType matchType, int matchValue)
{
int error = Interop.Filter.AddOperator(_filterHandle, logicalOperator);
/// </summary>
/// <since_tizen> 4 </since_tizen>
/// <feature>http://tizen.org/feature/calendar</feature>
- /// <param name="logicalOperator">The operator type</param>
- /// <param name="propertyId">The property ID to add a condition</param>
- /// <param name="matchType">The match flag</param>
- /// <param name="matchValue">The match value</param>
- /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
- /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid</exception>
+ /// <param name="logicalOperator">The operator type.</param>
+ /// <param name="propertyId">The property ID to add a condition.</param>
+ /// <param name="matchType">The match flag.</param>
+ /// <param name="matchValue">The match value.</param>
+ /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
+ /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid.</exception>
public void AddCondition(LogicalOperator logicalOperator, uint propertyId, IntegerMatchType matchType, long matchValue)
{
int error = Interop.Filter.AddOperator(_filterHandle, logicalOperator);
/// </summary>
/// <since_tizen> 4 </since_tizen>
/// <feature>http://tizen.org/feature/calendar</feature>
- /// <param name="logicalOperator">The operator type</param>
- /// <param name="propertyId">The property ID to add a condition</param>
- /// <param name="matchType">The match flag</param>
- /// <param name="matchValue">The match value</param>
- /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
- /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid</exception>
+ /// <param name="logicalOperator">The operator type.</param>
+ /// <param name="propertyId">The property ID to add a condition.</param>
+ /// <param name="matchType">The match flag.</param>
+ /// <param name="matchValue">The match value.</param>
+ /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
+ /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid.</exception>
public void AddCondition(LogicalOperator logicalOperator, uint propertyId, IntegerMatchType matchType, double matchValue)
{
int error = Interop.Filter.AddOperator(_filterHandle, logicalOperator);
/// </summary>
/// <since_tizen> 4 </since_tizen>
/// <feature>http://tizen.org/feature/calendar</feature>
- /// <param name="logicalOperator">The operator type</param>
- /// <param name="propertyId">The property ID to add a condition</param>
- /// <param name="matchType">The match flag</param>
- /// <param name="matchValue">The match value</param>
- /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
- /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid</exception>
+ /// <param name="logicalOperator">The operator type.</param>
+ /// <param name="propertyId">The property ID to add a condition.</param>
+ /// <param name="matchType">The match flag.</param>
+ /// <param name="matchValue">The match value.</param>
+ /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
+ /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid.</exception>
public void AddCondition(LogicalOperator logicalOperator, uint propertyId, IntegerMatchType matchType, CalendarTime matchValue)
{
int error = Interop.Filter.AddOperator(_filterHandle, logicalOperator);
/// </summary>
/// <since_tizen> 4 </since_tizen>
/// <feature>http://tizen.org/feature/calendar</feature>
- /// <param name="logicalOperator">The operator type</param>
- /// <param name="filter">The child filter</param>
- /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
- /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid</exception>
+ /// <param name="logicalOperator">The operator type.</param>
+ /// <param name="filter">The child filter.</param>
+ /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
+ /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid.</exception>
public void AddFilter(LogicalOperator logicalOperator, CalendarFilter filter)
{
int error = Interop.Filter.AddOperator(_filterHandle, logicalOperator);
/// </summary>
/// <since_tizen> 4 </since_tizen>
/// <feature>http://tizen.org/feature/calendar</feature>
- /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
- /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory</exception>
+ /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
+ /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory.</exception>
public CalendarList()
{
int error = Interop.List.Create(out _listHandle);
/// The count of the calendar entity.
/// </summary>
/// <since_tizen> 4 </since_tizen>
- /// <value>The count of calendar entity.</value>
+ /// <value>The count of the calendar entity.</value>
public int Count
{
get
}
/// <summary>
- /// Destroy CalendarList resource.
+ /// Destroys the CalendarList resource.
/// </summary>
~CalendarList()
{
private bool disposedValue = false; // To detect redundant calls
/// <summary>
- /// Disposes of the resources (other than memory) used by the CalendarList.
+ /// Disposes off the resources (other than memory) used by the CalendarList.
/// </summary>
- /// <param name="disposing">true to release both managed and unmanaged resources; false to release only unmanaged resources.</param>
+ /// <param name="disposing">true to release both managed and unmanaged resources, false to release only unmanaged resources.</param>
/// <since_tizen> 4 </since_tizen>
protected virtual void Dispose(bool disposing)
{
/// <summary>
/// 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.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public void Dispose()
/// Adds a record to the calendar list.
/// </summary>
/// <since_tizen> 4 </since_tizen>
- /// <param name="record">The record to be added</param>
+ /// <param name="record">The record to be added.</param>
/// <feature>http://tizen.org/feature/calendar</feature>
- /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
+ /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
public void AddRecord(CalendarRecord record)
{
int error = Interop.List.Add(_listHandle, record._recordHandle);
/// Removes a record from the calendar list.
/// </summary>
/// <since_tizen> 4 </since_tizen>
- /// <param name="record">The record to be removed</param>
+ /// <param name="record">The record to be removed.</param>
/// <feature>http://tizen.org/feature/calendar</feature>
- /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
+ /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
public void RemoveRecord(CalendarRecord record)
{
int error = Interop.List.Remove(_listHandle, record._recordHandle);
/// </summary>
/// <since_tizen> 4 </since_tizen>
/// <returns>
- /// calendar record
+ /// The calendar record.
/// </returns>
/// <feature>http://tizen.org/feature/calendar</feature>
- /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
+ /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
public CalendarRecord GetCurrentRecord()
{
IntPtr handle;
/// </summary>
/// <since_tizen> 4 </since_tizen>
/// <returns>
- /// if cursor is moved to the end, it returns false.
+ /// If the cursor is moved to the end, it returns false.
/// </returns>
/// <feature>http://tizen.org/feature/calendar</feature>
- /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
+ /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
public bool MovePrevious()
{
int error = Interop.List.Prev(_listHandle);
/// </summary>
/// <since_tizen> 4 </since_tizen>
/// <returns>
- /// if cursor is moved to the end, it returns false.
+ /// If the cursor is moved to the end, it returns false.
/// </returns>
/// <feature>http://tizen.org/feature/calendar</feature>
- /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
+ /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
public bool MoveNext()
{
int error = Interop.List.Next(_listHandle);
/// </summary>
/// <since_tizen> 4 </since_tizen>
/// <feature>http://tizen.org/feature/calendar</feature>
- /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
+ /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
public void MoveFirst()
{
int error = Interop.List.First(_listHandle);
/// </summary>
/// <since_tizen> 4 </since_tizen>
/// <feature>http://tizen.org/feature/calendar</feature>
- /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
+ /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
public void MoveLast()
{
int error = Interop.List.Last(_listHandle);
namespace Tizen.Pims.Calendar
{
/// <summary>
- /// 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.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public class CalendarManager : IDisposable
private CalendarDatabase _db = null;
/// <summary>
- /// Create a manager.
+ /// Creates a manager.
/// </summary>
/// <since_tizen> 4 </since_tizen>
/// <feature>http://tizen.org/feature/calendar</feature>
- /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
- /// <exception cref="InvalidOperationException">Thrown when method failed due to invalid operation</exception>
+ /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the method failed due to an invalid operation.</exception>
public CalendarManager()
{
int error = Interop.Service.Connect();
}
/// <summary>
- /// Destroy CalendarManager resource.
+ /// Destroys the CalendarManager resource.
/// </summary>
~CalendarManager()
{
}
#region IDisposable Support
- /// To detect redundant calls
+ /// To detect redundant calls.
private bool disposedValue = false;
/// <summary>
/// Disposes of the resources (other than memory) used by the CalendarManager.
/// </summary>
- /// <param name="disposing">true to release both managed and unmanaged resources; false to release only unmanaged resources.</param>
+ /// <param name="disposing">true to release both managed and unmanaged resources, false to release only unmanaged resources.</param>
/// <since_tizen> 4 </since_tizen>
protected virtual void Dispose(bool disposing)
{
}
/// <summary>
- /// 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.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public void Dispose()
#endregion
/// <summary>
- /// Get database.
+ /// Gets the database.
/// </summary>
/// <since_tizen> 4 </since_tizen>
- /// <value>The database instance</value>
+ /// <value>The database instance.</value>
public CalendarDatabase Database
{
get
namespace Tizen.Pims.Calendar
{
/// <summary>
- /// A query is used to retrieve data which satisfies given criteria.
+ /// A query is used to retrieve the data, which satisfies the given criteria.
/// </summary>
/// <since_tizen> 4 </since_tizen>
/// <remarks>
- /// 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.
/// </remarks>
public class CalendarQuery:IDisposable
{
/// </summary>
/// <since_tizen> 4 </since_tizen>
/// <feature>http://tizen.org/feature/calendar</feature>
- /// <param name="viewUri">The view URI of a query</param>
- /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
- /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid</exception>
- /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory</exception>
+ /// <param name="viewUri">The view URI of a query.</param>
+ /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
+ /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid.</exception>
+ /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory.</exception>
[SuppressMessage("Microsoft.Design", "CA1054:UriParametersShouldNotBeStrings")]
public CalendarQuery(string viewUri)
{
}
/// <summary>
- /// Destructor
+ /// Destructor.
/// </summary>
~CalendarQuery()
{
/// <summary>
/// Disposes of the resources (other than memory) used by the CalendarQuery.
/// </summary>
- /// <param name="disposing">true to release both managed and unmanaged resources; false to release only unmanaged resources.</param>
+ /// <param name="disposing">true to release both managed and unmanaged resources, false to release only unmanaged resources.</param>
/// <since_tizen> 4 </since_tizen>
protected virtual void Dispose(bool disposing)
{
}
/// <summary>
- /// 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.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public void Dispose()
#endregion
/// <summary>
- /// Adds property IDs for projection.
+ /// Adds the property IDs for projection.
/// </summary>
/// <since_tizen> 4 </since_tizen>
- /// <param name="propertyIdArray">The property ID array </param>
+ /// <param name="propertyIdArray">The property ID array.</param>
/// <feature>http://tizen.org/feature/calendar</feature>
- /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
- /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid</exception>
+ /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
+ /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid.</exception>
public void SetProjection(uint[] propertyIdArray)
{
if (propertyIdArray == null)
/// Sets the "distinct" option for projection.
/// </summary>
/// <since_tizen> 4 </since_tizen>
- /// <param name="set">If true it is set, otherwise if false it is unset</param>
+ /// <param name="set">If true it is set, otherwise if false it is unset.</param>
/// <feature>http://tizen.org/feature/calendar</feature>
- /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
+ /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
public void SetDistinct(bool set)
{
int error = Interop.Query.SetDistinct(_queryHandle, set);
/// Sets the filter for a query.
/// </summary>
/// <since_tizen> 4 </since_tizen>
- /// <param name="filter">The filter</param>
+ /// <param name="filter">The filter.</param>
/// <feature>http://tizen.org/feature/calendar</feature>
- /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
- /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid</exception>
+ /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
+ /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid.</exception>
public void SetFilter(CalendarFilter filter)
{
int error = Interop.Query.SetFilter(_queryHandle, filter._filterHandle);
/// Sets the sort mode for a query.
/// </summary>
/// <since_tizen> 4 </since_tizen>
- /// <param name="propertyId">The property ID to sort</param>
- /// <param name="isAscending">If true it sorts in the ascending order, otherwise if false it sorts in the descending order</param>
+ /// <param name="propertyId">The property ID to sort.</param>
+ /// <param name="isAscending">If true it sorts in the ascending order, otherwise if false it sorts in the descending order.</param>
/// <feature>http://tizen.org/feature/calendar</feature>
- /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
- /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid</exception>
+ /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
+ /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid.</exception>
public void SetSort(uint propertyId, bool isAscending)
{
int error = Interop.Query.SetSort(_queryHandle, propertyId, isAscending);
namespace Tizen.Pims.Calendar
{
/// <summary>
- /// A record represents an actual record in the database
+ /// A record represents an actual record in the database.
/// </summary>
/// <since_tizen> 4 </since_tizen>
/// <remarks>
/// 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.
/// </remarks>
public class CalendarRecord : IDisposable
{
/// </summary>
/// <since_tizen> 4 </since_tizen>
/// <feature>http://tizen.org/feature/calendar</feature>
- /// <param name="viewUri">The view URI</param>
- /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
- /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid</exception>
- /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory</exception>
+ /// <param name="viewUri">The view URI.</param>
+ /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
+ /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid.</exception>
+ /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory.</exception>
[SuppressMessage("Microsoft.Design", "CA1054:UriParametersShouldNotBeStrings")]
public CalendarRecord(string viewUri)
{
}
/// <summary>
- /// Destructor
+ /// Destructor.
/// </summary>
~CalendarRecord()
{
}
#region IDisposable Support
- /// To detect redundant calls
+ /// To detect redundant calls.
internal bool _disposedValue = false;
/// <summary>
/// Disposes of the resources (other than memory) used by the CalendarRecord.
/// </summary>
- /// <param name="disposing">true to release both managed and unmanaged resources; false to release only unmanaged resources.</param>
+ /// <param name="disposing">true to release both managed and unmanaged resources, false to release only unmanaged resources.</param>
/// <since_tizen> 4 </since_tizen>
protected virtual void Dispose(bool disposing)
{
}
/// <summary>
- /// 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.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public void Dispose()
/// </summary>
/// <since_tizen> 4 </since_tizen>
/// <returns>
- /// A cloned record
+ /// A cloned record.
/// </returns>
/// <feature>http://tizen.org/feature/calendar</feature>
- /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
- /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory</exception>
+ /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
+ /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory.</exception>
public CalendarRecord Clone()
{
IntPtr _clonedRecordHandle;
}
/// <summary>
- /// Get record URI.
+ /// Gets the record URI.
/// </summary>
/// <since_tizen> 4 </since_tizen>
- /// <value>The URI of the record</value>
+ /// <value>The URI of the record.</value>
[SuppressMessage("Microsoft.Design", "CA1056:UriPropertiesShouldNotBeStrings")]
public string Uri
{
/// Gets a object from a record.
/// </summary>
/// <since_tizen> 4 </since_tizen>
- /// <param name="propertyId">The property ID</param>
+ /// <param name="propertyId">The property ID.</param>
/// <returns>
- /// The value of the property corresponding to property id.
+ /// The value of the property corresponding to property ID.
/// </returns>
/// <feature>http://tizen.org/feature/calendar</feature>
- /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
- /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid</exception>
+ /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
+ /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid.</exception>
public T Get<T>(uint propertyId)
{
object parsedValue = null;
/// Sets a value of the property to a record.
/// </summary>
/// <since_tizen> 4 </since_tizen>
- /// <param name="propertyId">The property ID</param>
- /// <param name="value">value</param>
+ /// <param name="propertyId">The property ID.</param>
+ /// <param name="value">The value.</param>
/// <feature>http://tizen.org/feature/calendar</feature>
- /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
- /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid</exception>
+ /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
+ /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid.</exception>
public void Set<T>(uint propertyId, T value)
{
if (typeof(T) == typeof(string))
/// Adds a child record to the parent record.
/// </summary>
/// <since_tizen> 4 </since_tizen>
- /// <param name="propertyId">The property ID</param>
- /// <param name="childRecord">The child record</param>
+ /// <param name="propertyId">The property ID.</param>
+ /// <param name="childRecord">The child record.</param>
/// <feature>http://tizen.org/feature/calendar</feature>
- /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
- /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid</exception>
+ /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
+ /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid.</exception>
public void AddChildRecord(uint propertyId, CalendarRecord childRecord)
{
int error = Interop.Record.AddChildRecord(_recordHandle, propertyId, childRecord._recordHandle);
/// Removes a child record from the parent record.
/// </summary>
/// <since_tizen> 4 </since_tizen>
- /// <param name="propertyId">The property ID</param>
- /// <param name="childRecord">The child record</param>
+ /// <param name="propertyId">The property ID.</param>
+ /// <param name="childRecord">The child record.</param>
/// <feature>http://tizen.org/feature/calendar</feature>
- /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
- /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid</exception>
+ /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
+ /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid.</exception>
public void RemoveChildRecord(uint propertyId, CalendarRecord childRecord)
{
int error = Interop.Record.RemoveChildRecord(_recordHandle, propertyId, childRecord._recordHandle);
}
/// <summary>
- /// Gets a child record from the parent record
+ /// Gets a child record from the parent record.
/// </summary>
/// <since_tizen> 4 </since_tizen>
- /// <param name="propertyId">The property ID</param>
+ /// <param name="propertyId">The property ID.</param>
/// <returns>
- /// The number of child records corresponding to property ID
+ /// The number of child records corresponding to property ID.
/// </returns>
/// <feature>http://tizen.org/feature/calendar</feature>
- /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
- /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid</exception>
+ /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
+ /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid.</exception>
public int GetChildRecordCount(uint propertyId)
{
int count = 0;
}
/// <summary>
- /// Gets a child record from the parent record
+ /// Gets a child record from the parent record.
/// </summary>
/// <since_tizen> 4 </since_tizen>
- /// <param name="propertyId">The property ID</param>
- /// <param name="index">The child record index</param>
+ /// <param name="propertyId">The property ID.</param>
+ /// <param name="index">The child record index.</param>
/// <returns>
- /// The record
+ /// The record.
/// </returns>
/// <feature>http://tizen.org/feature/calendar</feature>
- /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
- /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid</exception>
+ /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
+ /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid.</exception>
public CalendarRecord GetChildRecord(uint propertyId, int index)
{
IntPtr handle;
}
/// <summary>
- /// Clones a child record list corresponding to property ID
+ /// Clones a child record list corresponding to property ID.
/// </summary>
/// <since_tizen> 4 </since_tizen>
- /// <param name="propertyId">The property ID</param>
+ /// <param name="propertyId">The property ID.</param>
/// <returns>
- /// the record list
+ /// The record list.
/// </returns>
/// <feature>http://tizen.org/feature/calendar</feature>
- /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
- /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid</exception>
+ /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
+ /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid.</exception>
public CalendarList CloneChildRecordList(uint propertyId)
{
IntPtr listHandle;
namespace Tizen.Pims.Calendar
{
/// <summary>
- /// A class for reminder for event.
+ /// A class for the reminder for an event.
/// </summary>
/// <since_tizen> 4 </since_tizen>
/// <remarks>
- /// 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.
/// </remarks>
public class CalendarReminder:IDisposable
{
/// <summary>
/// Disposes of the resources (other than memory) used by the CalendarReminder.
/// </summary>
- /// <param name="disposing">true to release both managed and unmanaged resources; false to release only unmanaged resources.</param>
+ /// <param name="disposing">true to release both managed and unmanaged resources, false to release only unmanaged resources.</param>
/// <since_tizen> 4 </since_tizen>
protected virtual void Dispose(bool disposing)
{
}
/// <summary>
- /// 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.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public void Dispose()
private static event EventHandler<ReminderAlertedEventArgs> s_reminderAlerted;
/// <summary>
- /// Reminder event is triggered when the alarm is alerted.
+ /// The Reminder event is triggered when the alarm is alerted.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public static event EventHandler<ReminderAlertedEventArgs> ReminderAlerted
namespace Tizen.Pims.Calendar
{
/// <summary>
- /// A class for time to set, get or calculate.
+ /// A class for the time to set, get, or calculate.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public class CalendarTime:IComparable<CalendarTime>
public enum Type
{
/// <summary>
- /// UTC time
+ /// UTC time.
/// </summary>
/// <since_tizen> 4 </since_tizen>
Utc,
/// <summary>
- /// Local time
+ /// Local time.
/// </summary>
/// <since_tizen> 4 </since_tizen>
Local
}
/// <summary>
- /// Create UTC CalendarTime
+ /// Creates the UTC CalendarTime.
/// </summary>
/// <since_tizen> 4 </since_tizen>
- /// <param name="utcTime">UTC epoch time. 0 is 1971/01/01</param>
+ /// <param name="utcTime">The UTC epoch time. 0 is 1971/01/01.</param>
public CalendarTime(long utcTime)
{
_type = (int)Type.Utc;
}
/// <summary>
- /// Create Local CalendarTime
+ /// Creates the local CalendarTime
/// </summary>
/// <since_tizen> 4 </since_tizen>
- /// <param name="year">year</param>
- /// <param name="month">month</param>
- /// <param name="day">day</param>
- /// <param name="hour">hour</param>
- /// <param name="minute">minute</param>
- /// <param name="second">second</param>
+ /// <param name="year">The year.</param>
+ /// <param name="month">The month.</param>
+ /// <param name="day">The day.</param>
+ /// <param name="hour">The hour.</param>
+ /// <param name="minute">The minute.</param>
+ /// <param name="second">The second.</param>
public CalendarTime(int year, int month, int day, int hour, int minute, int second)
{
_type = (int)Type.Local;
}
/// <summary>
- /// Get UtcTime
+ /// Gets the UtcTime.
/// </summary>
/// <since_tizen> 4 </since_tizen>
- /// <value>The Utc time</value>
+ /// <value>The UTC time.</value>
public DateTime UtcTime
{
get;
}
/// <summary>
- /// Get localTime
+ /// Gets the LocalTime
/// </summary>
/// <since_tizen> 4 </since_tizen>
- /// <value>The Localtime</value>
+ /// <value>The local time.</value>
public DateTime LocalTime
{
get;
}
/// <summary>
- /// Compare CalendarTime
+ /// Compares the CalendarTime.
/// </summary>
/// <since_tizen> 4 </since_tizen>
- /// <param name="other">The CalendarTime to be compared</param>
+ /// <param name="other">The CalendarTime to be compared.</param>
/// <returns>
/// A 32-bit signed integer that indicates the relative order of the objects being compared.
/// </returns>
}
/// <summary>
- /// Equals CalendarTime
+ /// Equals the CalendarTime.
/// </summary>
/// <since_tizen> 4 </since_tizen>
- /// <param name="obj">The CalendarTime to be compared</param>
+ /// <param name="obj">The CalendarTime to be compared.</param>
/// <returns>
/// A 32-bit signed integer that indicates the relative order of the objects being compared.
/// </returns>
}
/// <summary>
- /// GetHashCode CalendarTime
+ /// The GetHashCode for the CalendarTime.
/// </summary>
/// <since_tizen> 4 </since_tizen>
/// <returns>
namespace Tizen.Pims.Calendar
{
/// <summary>
- /// This class provides enumerations about calendar information.
+ /// This class provides enumerations about the calendar information.
/// </summary>
/// <since_tizen> 4 </since_tizen>
/// <remarks>
- /// 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
/// </remarks>
public static class CalendarTypes
{
/// <summary>
- /// Enumeration for Default book
+ /// Enumeration for the default books.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public enum DefaultBook
{
/// <summary>
- /// Default event calendar book.
+ /// The default event calendar book.
/// </summary>
/// <since_tizen> 4 </since_tizen>
Event,
/// <summary>
- /// Default Todo calendar book.
+ /// The default todo calendar book.
/// </summary>
/// <since_tizen> 4 </since_tizen>
Todo,
/// <summary>
- /// Default Birthday calendar book.
+ /// The default birthday calendar book.
/// </summary>
/// <since_tizen> 4 </since_tizen>
Birthday,
}
/// <summary>
- /// Enumeration for Store type
+ /// Enumeration for the store types.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public enum StoreType
{
/// <summary>
- /// Book type
+ /// Book type.
/// </summary>
/// <since_tizen> 4 </since_tizen>
Book,
/// <summary>
- /// Event type
+ /// Event type.
/// </summary>
/// <since_tizen> 4 </since_tizen>
Event,
/// <summary>
- /// Todo type
+ /// Todo type.
/// </summary>
/// <since_tizen> 4 </since_tizen>
Todo,
}
/// <summary>
- /// Enumeration for the book mode.
+ /// Enumeration for the book modes.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public enum BookMode
{
/// <summary>
- /// All modules can read and write records of this calendar_book
+ /// All modules can read and write records of this calendar book.
/// </summary>
/// <since_tizen> 4 </since_tizen>
Default,
/// <summary>
- /// All modules can only read records of this calendar book
+ /// All modules can only read records of this calendar book.
/// </summary>
/// <since_tizen> 4 </since_tizen>
ReadOnly,
public enum EventStatus
{
/// <summary>
- /// No status
+ /// No status.
/// </summary>
/// <since_tizen> 4 </since_tizen>
None = 0x01,
/// <summary>
- /// The event is tentative
+ /// The event is tentative.
/// </summary>
/// <since_tizen> 4 </since_tizen>
Tentative = 0x02,
/// <summary>
- /// The event is confirmed
+ /// The event is confirmed.
/// </summary>
/// <since_tizen> 4 </since_tizen>
Confirmed = 0x04,
/// <summary>
- /// The event is cancelled
+ /// The event is cancelled.
/// </summary>
/// <since_tizen> 4 </since_tizen>
Cancelled = 0x08,
}
/// <summary>
- /// Enumeration for for the status of a to-do.
+ /// Enumeration for the status of a to-do.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public enum TodoStatus
{
/// <summary>
- /// No status
+ /// No status.
/// </summary>
/// <since_tizen> 4 </since_tizen>
None = 0x0100,
/// <summary>
- /// Needs action status
+ /// Needs action status.
/// </summary>
/// <since_tizen> 4 </since_tizen>
NeedAction = 0x0200,
/// <summary>
- /// Completed status
+ /// Completed status.
/// </summary>
/// <since_tizen> 4 </since_tizen>
Completed = 0x0400,
/// <summary>
- /// Work in process status
+ /// Work in process status.
/// </summary>
/// <since_tizen> 4 </since_tizen>
InProcess = 0x0800,
/// <summary>
- /// Cancelled status
+ /// Cancelled status.
/// </summary>
/// <since_tizen> 4 </since_tizen>
Cancelled = 0x1000,
public enum BusyStatus
{
/// <summary>
- /// The free status
+ /// The free status.
/// </summary>
/// <since_tizen> 4 </since_tizen>
Free,
/// <summary>
- /// The busy status
+ /// The busy status.
/// </summary>
/// <since_tizen> 4 </since_tizen>
Busy,
/// <summary>
- /// The unavailable status
+ /// The unavailable status.
/// </summary>
/// <since_tizen> 4 </since_tizen>
Unavailable,
/// <summary>
- /// The tentative status
+ /// The tentative status.
/// </summary>
/// <since_tizen> 4 </since_tizen>
Tentative,
public enum Sensitivity
{
/// <summary>
- /// Public Sensitivity
+ /// Public sensitivity.
/// </summary>
/// <since_tizen> 4 </since_tizen>
Public,
/// <summary>
- /// Private Sensitivity
+ /// Private sensitivity.
/// </summary>
/// <since_tizen> 4 </since_tizen>
Private,
/// <summary>
- /// Confidential Sensitivity
+ /// Confidential sensitivity.
/// </summary>
/// <since_tizen> 4 </since_tizen>
Confidential,
public enum MeetingStatus
{
/// <summary>
- /// No meeting
+ /// No meeting.
/// </summary>
/// <since_tizen> 4 </since_tizen>
NoMeeting,
/// <summary>
- /// Meeting exists
+ /// Meeting exists.
/// </summary>
/// <since_tizen> 4 </since_tizen>
Meeting,
/// <summary>
- /// Meeting received
+ /// Meeting received.
/// </summary>
/// <since_tizen> 4 </since_tizen>
Received,
/// <summary>
- /// Meeting cancelled
+ /// Meeting canceled.
/// </summary>
/// <since_tizen> 4 </since_tizen>
Cancelled,
}
/// <summary>
- /// Enumeration for the calendar event item's priority
+ /// Enumeration for the calendar event item's priority.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public enum Priority
{
/// <summary>
- /// No priority
+ /// No priority.
/// </summary>
/// <since_tizen> 4 </since_tizen>
None = 0x01,
/// <summary>
- /// Low priority
+ /// Low priority.
/// </summary>
/// <since_tizen> 4 </since_tizen>
High = 0x02,
/// <summary>
- /// Normal priority
+ /// Normal priority.
/// </summary>
/// <since_tizen> 4 </since_tizen>
Normal = 0x04,
/// <summary>
- /// High priority
+ /// High priority.
/// </summary>
/// <since_tizen> 4 </since_tizen>
Low = 0x08,
public enum Recurrence
{
/// <summary>
- /// No recurrence event
+ /// No recurrence event.
/// </summary>
/// <since_tizen> 4 </since_tizen>
None,
/// <summary>
- /// An event occurs every day
+ /// An event occurs every day.
/// </summary>
/// <since_tizen> 4 </since_tizen>
Daily,
/// <summary>
- /// 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.
/// </summary>
/// <since_tizen> 4 </since_tizen>
Weekly,
/// <summary>
- /// An event occurs on the same day of every month
+ /// An event occurs on the same day of every month.
/// </summary>
/// <since_tizen> 4 </since_tizen>
Monthly,
/// <summary>
- /// An event occurs on the same day of every year
+ /// An event occurs on the same day of every year.
/// </summary>
/// <since_tizen> 4 </since_tizen>
Yearly,
}
/// <summary>
- /// Enumeration for the range type.
+ /// Enumeration for the range types.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public enum RangeType
{
/// <summary>
- /// Range until
+ /// Range until.
/// </summary>
/// <since_tizen> 4 </since_tizen>
Until,
/// <summary>
- /// Range count
+ /// Range count.
/// </summary>
/// <since_tizen> 4 </since_tizen>
Count,
/// <summary>
- /// No range
+ /// No range.
/// </summary>
/// <since_tizen> 4 </since_tizen>
None,
}
/// <summary>
- /// Enumeration for the system type.
+ /// Enumeration for the system types.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public enum SystemType
{
/// <summary>
- /// Locale's default calendar
+ /// Locale's default calendar.
/// </summary>
/// <since_tizen> 4 </since_tizen>
Default,
/// <summary>
- /// Locale's default calendar
+ /// Locale's default calendar.
/// </summary>
/// <since_tizen> 4 </since_tizen>
Gregorian,
/// <summary>
- /// East Asian lunisolar calendar
+ /// East Asian lunisolar calendar.
/// </summary>
/// <since_tizen> 4 </since_tizen>
Lunisolar,
public enum TickUnit
{
/// <summary>
- /// No reminder set
+ /// No reminder set.
/// </summary>
/// <since_tizen> 4 </since_tizen>
None = -1,
/// <summary>
- /// Specific in seconds
+ /// Specific in seconds.
/// </summary>
/// <since_tizen> 4 </since_tizen>
Specific = 1,
/// <summary>
- /// Alarm time unit in minutes
+ /// Alarm time unit in minutes.
/// </summary>
/// <since_tizen> 4 </since_tizen>
Minute = 60,
/// <summary>
- /// Alarm time unit in hours
+ /// Alarm time unit in hours.
/// </summary>
/// <since_tizen> 4 </since_tizen>
Hour = 3600,
/// <summary>
- /// Alarm time unit in days
+ /// Alarm time unit in days.
/// </summary>
/// <since_tizen> 4 </since_tizen>
Day = 86400,
/// <summary>
- /// Alarm time unit in weeks
+ /// Alarm time unit in weeks.
/// </summary>
/// <since_tizen> 4 </since_tizen>
Week = 604800,
public enum WeekDay
{
/// <summary>
- /// Sunday
+ /// Sunday.
/// </summary>
/// <since_tizen> 4 </since_tizen>
Sunday = 1,
/// <summary>
- /// Monday
+ /// Monday.
/// </summary>
/// <since_tizen> 4 </since_tizen>
Monday,
/// <summary>
- /// Tuesday
+ /// Tuesday.
/// </summary>
/// <since_tizen> 4 </since_tizen>
Tuesday,
/// <summary>
- /// Wednesday
+ /// Wednesday.
/// </summary>
/// <since_tizen> 4 </since_tizen>
Wednesday,
/// <summary>
- /// Thursday
+ /// Thursday.
/// </summary>
/// <since_tizen> 4 </since_tizen>
Thursday,
/// <summary>
- /// Friday
+ /// Friday.
/// </summary>
/// <since_tizen> 4 </since_tizen>
Friday,
/// <summary>
- /// Saturday
+ /// Saturday.
/// </summary>
/// <since_tizen> 4 </since_tizen>
Saturday,
}
/// <summary>
- /// Enumeration to specify the type of calendar user specified by the property.
+ /// Enumeration to specify the type of calendar user, specified by the property.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public enum Cutype
{
/// <summary>
- /// An individual
+ /// An individual.
/// </summary>
/// <since_tizen> 4 </since_tizen>
Individual,
/// <summary>
- /// A group of individuals
+ /// A group of individuals.
/// </summary>
/// <since_tizen> 4 </since_tizen>
Group,
/// <summary>
- /// A physical resource
+ /// A physical resource.
/// </summary>
/// <since_tizen> 4 </since_tizen>
Resource,
/// <summary>
- /// A room resource
+ /// A room resource.
/// </summary>
/// <since_tizen> 4 </since_tizen>
Room,
/// <summary>
- /// Otherwise not known
+ /// Otherwise not known.
/// </summary>
/// <since_tizen> 4 </since_tizen>
Unknown,
}
/// <summary>
- /// Enumeration for the attendee role.
+ /// Enumeration for the attendee roles.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public enum AttendeeRole
{
/// <summary>
- /// Participation is required
+ /// Participation is required.
/// </summary>
/// <since_tizen> 4 </since_tizen>
ReqParticipant,
/// <summary>
- /// Accepted status
+ /// Accepted status.
/// </summary>
/// <since_tizen> 4 </since_tizen>
OptParticipant,
/// <summary>
- /// Non-Participant
+ /// Non-Participant.
/// </summary>
/// <since_tizen> 4 </since_tizen>
NonParticipant,
/// <summary>
- /// Chairperson
+ /// Chairperson.
/// </summary>
/// <since_tizen> 4 </since_tizen>
Chair,
public enum AttendeeStatus
{
/// <summary>
- /// Pending status
+ /// Pending status.
/// </summary>
/// <since_tizen> 4 </since_tizen>
Pending,
/// <summary>
- /// Accepted status
+ /// Accepted status.
/// </summary>
/// <since_tizen> 4 </since_tizen>
Accepted,
/// <summary>
- /// Declined status
+ /// Declined status.
/// </summary>
/// <since_tizen> 4 </since_tizen>
Declined,
/// <summary>
- /// Tentative status
+ /// Tentative status.
/// </summary>
/// <since_tizen> 4 </since_tizen>
Tentative,
/// <summary>
- /// Delegated status
+ /// Delegated status.
/// </summary>
/// <since_tizen> 4 </since_tizen>
Delegated,
/// <summary>
- /// Completed status
+ /// Completed status.
/// </summary>
/// <since_tizen> 4 </since_tizen>
Completed,
/// <summary>
- /// In process status
+ /// In process status.
/// </summary>
/// <since_tizen> 4 </since_tizen>
InProcess,
}
/// <summary>
- /// Enumeration for the alarm action.
+ /// Enumeration for the alarm actions.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public enum Action
{
/// <summary>
- /// Audio action
+ /// Audio action.
/// </summary>
/// <since_tizen> 4 </since_tizen>
Audio,
/// <summary>
- /// Display action
+ /// Display action.
/// </summary>
/// <since_tizen> 4 </since_tizen>
Display,
/// <summary>
- /// Email action
+ /// Email action.
/// </summary>
/// <since_tizen> 4 </since_tizen>
Email,
namespace Tizen.Pims.Calendar
{
/// <summary>
- /// Parsing vcalendar file callback function.
+ /// Parsing the vCalendar file callback function.
/// </summary>
- /// <param name="record">The record</param>
- /// <returns>true to continue with the next iteration of the loop, otherwise false to break out of the loop</returns>
+ /// <param name="record">The record.</param>
+ /// <returns>true to continue with the next iteration of the loop, otherwise false to break out of the loop.</returns>
/// <since_tizen> 4 </since_tizen>
public delegate bool ParseCallback(CalendarRecord record);
/// <summary>
- /// A class for parsing and composing vCalendar.
+ /// A class for parsing and composing the vCalendar.
/// </summary>
/// <remarks>
- /// It's based on the vCalendar v2.0 specification
+ /// It's based on the vCalendar v2.0 specification.
/// </remarks>
/// <since_tizen> 4 </since_tizen>
public static class CalendarVcalendar
{
/// <summary>
- /// Retrieves a vcalendar stream from a calendar list.
+ /// Retrieves a vCalendar stream from a calendar list.
/// </summary>
- /// <param name="list">The calendar list</param>
+ /// <param name="list">The calendar list.</param>
/// <returns>
/// The composed stream.
/// </returns>
- /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid</exception>
- /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory</exception>
+ /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid.</exception>
+ /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory.</exception>
/// <since_tizen> 4 </since_tizen>
public static string Compose(CalendarList list)
{
}
/// <summary>
- /// Retrieves all calendars from a vcalendar stream.
+ /// Retrieves all the calendars from a vCalendar stream.
/// </summary>
- /// <param name="stream">The vcalendar stream</param>
+ /// <param name="stream">The vCalendar stream.</param>
/// <returns>
- /// the record list
+ /// The record list.
/// </returns>
- /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid</exception>
- /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory</exception>
+ /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid.</exception>
+ /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory.</exception>
/// <since_tizen> 4 </since_tizen>
public static CalendarList Parse(string stream)
{
}
/// <summary>
- /// Parse vcalendar file with ForEach
+ /// Parses the vCalendar file with ForEach.
/// </summary>
- /// <param name="path">The file path of the vCalendar stream file</param>
- /// <param name="callback">he callback function to invoke</param>
- /// <exception cref="InvalidOperationException">Thrown when method failed due to invalid operation</exception>
- /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid</exception>
- /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory</exception>
+ /// <param name="path">The file path of the vCalendar stream file.</param>
+ /// <param name="callback">The callback function to invoke.</param>
+ /// <exception cref="InvalidOperationException">Thrown when the method failed due to an invalid operation.</exception>
+ /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid.</exception>
+ /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory.</exception>
/// <since_tizen> 4 </since_tizen>
public static void ParseForEach(string path, ParseCallback callback)
{
}
/// <summary>
- /// Describes properties of a Book record.
+ /// Describes the properties of a Book record.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public static class Book
{
/// <summary>
- /// Identifier of this calendar book view
+ /// Identifier of this calendar book view.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const string Uri = "tizen.calendar_view.book";
/// <summary>
- /// DB record ID of the calendar book
+ /// Database record ID of the calendar book.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Id = (uint)Property.Id.BookId;
/// <summary>
- /// Unique identifier
+ /// Unique identifier.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Uid = (uint)Property.Id.BookUid;
/// <summary>
- /// Calendar book name
+ /// Calendar book name.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Name = (uint)Property.Id.BookName;
/// <summary>
- /// Calendar book description
+ /// Calendar book description.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Description = (uint)Property.Id.BookDescription;
/// <summary>
- /// Calendar book color for UX
+ /// Calendar book color for UX.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Color = (uint)Property.Id.BookColor;
/// <summary>
- /// Location of the event
+ /// Location of the event.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Location = (uint)Property.Id.BookLocation;
/// <summary>
- /// Visibility of the calendar book for UX
+ /// Visibility of the calendar book for UX.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Visibility = (uint)Property.Id.BookVisibility;
/// <summary>
- /// Currently NOT Used
+ /// Currently not used.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint SyncEvent = (uint)Property.Id.BookSyncEvent;
/// <summary>
- /// Account for this calendar
+ /// Account for this calendar.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint AccountId = (uint)Property.Id.BookAccountId;
/// <summary>
- /// Type of calendar contents(refer to the CalendarTypes.StoreType)
+ /// Type of calendar contents (refer to the CalendarTypes.StoreType).
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint StoreType = (uint)Property.Id.BookStoreType;
/// <summary>
- /// Generic data for use by syncing
+ /// Generic data for use by syncing.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint SyncData1 = (uint)Property.Id.BookSyncData1;
/// <summary>
- /// Generic data for use by syncing
+ /// Generic data for use by syncing.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint SyncData2 = (uint)Property.Id.BookSyncData2;
/// <summary>
- /// Generic data for use by syncing
+ /// Generic data for use by syncing.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint SyncData3 = (uint)Property.Id.BookSyncData3;
/// <summary>
- /// Generic data for use by syncing
+ /// Generic data for use by syncing.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint SyncData4 = (uint)Property.Id.BookSyncData4;
/// <summary>
- /// Calendar book mode(refer to the CalendarTypes.BookMode)
+ /// Calendar book mode (refer to the CalendarTypes.BookMode).
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Mode = (uint)Property.Id.BookMode;
}
/// <summary>
- /// Describes properties of a Event record.
+ /// Describes the properties of a Event record.
/// </summary>
/// <since_tizen> 4 </since_tizen>
[SuppressMessage("Microsoft.Naming", "CA1716:IdentifiersShouldNotMatchKeywords")]
public static class Event
{
/// <summary>
- /// Identifier of this event view
+ /// Identifier of this event view.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const string Uri = "tizen.calendar_view.event";
/// <summary>
- /// DB record ID of the event
+ /// Database record ID of the event.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Id = (uint)Property.Id.EventId;
/// <summary>
- /// ID of the calendar book to which the event belongs
+ /// ID of the calendar book to which the event belongs.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint BookId = (uint)Property.Id.EventBookId;
/// <summary>
- /// The short description of the event
+ /// The short description of the event.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Summary = (uint)Property.Id.EventSummary;
/// <summary>
- /// The description of the event
+ /// The description of the event.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Description = (uint)Property.Id.EventDescription;
/// <summary>
- /// The location of the event
+ /// The location of the event.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Location = (uint)Property.Id.EventLocation;
/// <summary>
- /// The category of the event. For example APPOINTMENT, BIRTHDAY
+ /// The category of the event. For example, appointment, birthday.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Categories = (uint)Property.Id.EventCategories;
/// <summary>
- /// 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.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Exdate = (uint)Property.Id.EventExdate;
/// <summary>
- /// The status of event(refer to the CalendarTypes.EventStatus).
+ /// The status of event (refer to the CalendarTypes.EventStatus).
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint EventStatus = (uint)Property.Id.EventEventStatus;
/// <summary>
- /// The priority of event(refer to the CalendarTypes.Priority).
+ /// The priority of event (refer to the CalendarTypes.Priority).
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Priority = (uint)Property.Id.EventPriority;
/// <summary>
- /// The timezone_id of the event if it exists.
+ /// The timezone_id of the event, if it exists.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Timezone = (uint)Property.Id.EventTimezone;
/// <summary>
- /// 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.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint ContactId = (uint)Property.Id.EventContactId;
/// <summary>
- /// The busy status of event(refer to the CalendarTypes.BusyStatus).
+ /// The busy status of event (refer to the CalendarTypes.BusyStatus).
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint BusyStatus = (uint)Property.Id.EventBusyStatus;
/// <summary>
- /// The Sensitivity of event(refer to the CalendarTypes.Sensitivity).
+ /// The sensitivity of event (refer to the CalendarTypes.Sensitivity).
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Sensitivity = (uint)Property.Id.EventSensitivity;
/// <summary>
- /// The unique ID of the event
+ /// The unique ID of the event.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Uid = (uint)Property.Id.EventUid;
/// <summary>
- /// The name of organizer of the event
+ /// The name of organizer of the event.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint OrganizerName = (uint)Property.Id.EventOrganizerName;
/// <summary>
- /// The email address of the organizer of the event
+ /// The email address of the organizer of the event.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint OrganizerEmail = (uint)Property.Id.EventOrganizerEmail;
/// <summary>
- /// The meeting status of event(refer to the CalendarTypes.MeetingStatus).
+ /// The meeting status of event (refer to the CalendarTypes.MeetingStatus).
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint MeetingStatus = (uint)Property.Id.EventMeetingStatus;
/// <summary>
- /// The ID of the original event if the event is an exception.
+ /// The ID of the original event, if the event is an exception.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint OriginalEventId = (uint)Property.Id.EventOriginalEventId;
/// <summary>
- /// The latitude of the location of the event
+ /// The latitude of the location of the event.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Latitude = (uint)Property.Id.EventLatitude;
/// <summary>
- /// The longitude of the location of the event
+ /// The longitude of the location of the event.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Longitude = (uint)Property.Id.EventLongitude;
/// <since_tizen> 4 </since_tizen>
public const uint EmailId = (uint)Property.Id.EventEmailId;
/// <summary>
- /// The time when the event is created
+ /// The time when the event is created.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint CreatedTime = (uint)Property.Id.EventCreatedTime;
/// <summary>
- /// The time when the event is updated
+ /// The time when the event is updated.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint LastModifiedTime = (uint)Property.Id.EventLastModifiedTime;
/// <summary>
- /// Whether or not the event is deleted
+ /// Whether or not the event is deleted.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint IsDeleted = (uint)Property.Id.EventIsDeleted;
/// <summary>
- /// The frequent type of event recurrence(refer to the CalendarTypes.Recurrence).
+ /// The frequent type of event recurrence (refer to the CalendarTypes.Recurrence).
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Freq = (uint)Property.Id.EventFreq;
/// <summary>
- /// The range type of event recurrence(refer to the CalendarTypes.RangeType).
+ /// The range type of event recurrence (refer to the CalendarTypes.RangeType).
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint RangeType = (uint)Property.Id.EventRangeType;
/// <since_tizen> 4 </since_tizen>
public const uint Count = (uint)Property.Id.EventCount;
/// <summary>
- /// The interval of the event recurrence
+ /// The interval of the event recurrence.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Interval = (uint)Property.Id.EventInterval;
/// <summary>
- /// 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.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Bysecond = (uint)Property.Id.EventBysecond;
/// <summary>
- /// 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.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Byminute = (uint)Property.Id.EventByminute;
/// <summary>
- /// 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.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Byhour = (uint)Property.Id.EventByhour;
/// <since_tizen> 4 </since_tizen>
public const uint Bymonthday = (uint)Property.Id.EventBymonthday;
/// <summary>
- /// 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.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Byyearday = (uint)Property.Id.EventByyearday;
/// <summary>
- /// 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.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Byweekno = (uint)Property.Id.EventByweekno;
/// <summary>
- /// 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.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Bymonth = (uint)Property.Id.EventBymonth;
/// <summary>
- /// 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.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Bysetpos = (uint)Property.Id.EventBysetpos;
/// <summary>
- /// The start day of the week(refer to the CalendarTypes.WeekDay).
+ /// The start day of the week (refer to the CalendarTypes.WeekDay).
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Wkst = (uint)Property.Id.EventWkst;
/// <summary>
- /// RECURRENCE-ID of RFC #2445
+ /// RECURRENCE-ID of RFC #2445.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint RecurrenceId = (uint)Property.Id.EventRecurrenceId;
/// <summary>
- /// RDATE of RFC #2445
+ /// RDATE of RFC #2445.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Rdate = (uint)Property.Id.EventRdate;
/// <summary>
- /// Whether or not the event has an attendee list
+ /// Whether or not the event has an attendee list.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint HasAttendee = (uint)Property.Id.EventHasAttendee;
/// <summary>
- /// Whether or not the event has an alarm list
+ /// Whether or not the event has an alarm list.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint HasAlarm = (uint)Property.Id.EventHasAlarm;
/// <summary>
- /// 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.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint SyncData1 = (uint)Property.Id.EventSyncData1;
/// <summary>
- /// 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.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint SyncData2 = (uint)Property.Id.EventSyncData2;
/// <summary>
- /// 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.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint SyncData3 = (uint)Property.Id.EventSyncData3;
/// <summary>
- /// 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.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint SyncData4 = (uint)Property.Id.EventSyncData4;
/// <summary>
- /// The start time of the event
+ /// The start time of the event.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Start = (uint)Property.Id.EventStart;
/// <summary>
- /// The end time of the event
+ /// The end time of the event.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint End = (uint)Property.Id.EventEnd;
/// <since_tizen> 4 </since_tizen>
public const uint Attendee = (uint)Property.Id.EventAttendee;
/// <summary>
- /// The Calendar system type(refer to the CalendarTypes.SystemType).
+ /// The calendar system type (refer to the CalendarTypes.SystemType).
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint CalendarSystemType = (uint)Property.Id.EventCalendarSystemType;
/// <summary>
- /// The timezone of the start_time
+ /// The timezone of the start_time.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint StartTzid = (uint)Property.Id.EventStartTzid;
/// <summary>
- /// The timezone of the end_time
+ /// The timezone of the end_time.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint EndTzid = (uint)Property.Id.EventEndTzid;
/// <summary>
- /// The exception mod event list of the event
+ /// The exception mod event list of the event.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Exception = (uint)Property.Id.EventException;
/// <since_tizen> 4 </since_tizen>
public const uint Extended = (uint)Property.Id.EventExtended;
/// <summary>
- /// The event is an allday event or not
+ /// The event is an allday event or not.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint IsAllday = (uint)Property.Id.EventIsAllday;
/// <summary>
- /// The linked event count
+ /// The linked event count.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint LinkCount = (uint)Property.Id.EventLinkCount;
/// <summary>
- /// The event is an base linked event
+ /// The event is an base linked event.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint LinkBaseId = (uint)Property.Id.EventLinkBaseId;
}
/// <summary>
- /// Describes properties of a Todo record.
+ /// Describes the properties of a Todo record.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public static class Todo
{
/// <summary>
- /// Identifier of this todo view
+ /// Identifier of this todo view.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const string Uri = "tizen.calendar_view.todo";
/// <summary>
- /// DB record ID of the todo
+ /// Database record ID of the todo.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Id = (uint)Property.Id.TodoId;
/// <summary>
- /// ID of the calendar book to which the todo belongs
+ /// ID of the calendar book to which the todo belongs to.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint BookId = (uint)Property.Id.TodoBookId;
/// <summary>
- /// The short description of the todo
+ /// The short description of the todo.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Summary = (uint)Property.Id.TodoSummary;
/// <summary>
- /// The description of the todo
+ /// The description of the todo.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Description = (uint)Property.Id.TodoDescription;
/// <summary>
- /// The location of the todo
+ /// The location of the todo.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Location = (uint)Property.Id.TodoLocation;
/// <summary>
- /// The category of the todo. i.g. APPOINTMENT, BIRTHDAY
+ /// The category of the todo. For example, APPOINTMENT, BIRTHDAY.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Categories = (uint)Property.Id.TodoCategories;
/// <summary>
- /// The status of todo(refer to the CalendarTypes.TodoStatus).
+ /// The status of the todo (refer to the CalendarTypes.TodoStatus).
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint TodoStatus = (uint)Property.Id.TodoStatus;
/// <summary>
- /// The Priority of todo(refer to the CalendarTypes.Priority).
+ /// The priority of the todo (refer to the CalendarTypes.Priority).
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Priority = (uint)Property.Id.TodoPriority;
/// <summary>
- /// The Sensitivity of todo(refer to the CalendarTypes.Sensitivity).
+ /// The sensitivity of the todo (refer to the CalendarTypes.Sensitivity).
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Sensitivity = (uint)Property.Id.TodoSensitivity;
/// <summary>
- /// The unique ID of the todo
+ /// The unique ID of the todo.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Uid = (uint)Property.Id.TodoUid;
/// <summary>
- /// The latitude of the location of the todo
+ /// The latitude of the location of the todo.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Latitude = (uint)Property.Id.TodoLatitude;
/// <summary>
- /// The longitude of the location of the todo
+ /// The longitude of the location of the todo.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Longitude = (uint)Property.Id.TodoLongitude;
/// <summary>
- /// 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.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Progress = (uint)Property.Id.TodoProgress;
/// <summary>
- /// The time when the todo is create
+ /// The time when the todo is created.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint CreatedTime = (uint)Property.Id.TodoCreatedTime;
/// <summary>
- /// The time when the todo is updated
+ /// The time when the todo is updated.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint LastModifiedTime = (uint)Property.Id.TodoLastModifiedTime;
/// <summary>
- /// The time when the todo is completed
+ /// The time when the todo is completed.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint CompletedTime = (uint)Property.Id.TodoCompletedTime;
/// <summary>
- /// Whether or not the todo is deleted
+ /// Whether or not the todo is deleted.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint IsDeleted = (uint)Property.Id.TodoIsDeleted;
/// <summary>
- /// The frequent type of todo recurrence(refer to the CalendarTypes.Recurrence).
+ /// The frequent type of the todo recurrence (refer to the CalendarTypes.Recurrence).
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Freq = (uint)Property.Id.TodoFreq;
/// <summary>
- /// The range type of todo recurrence(refer to the CalendarTypes.RangeType).
+ /// The range type of the todo recurrence (refer to the CalendarTypes.RangeType).
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint RangeType = (uint)Property.Id.TodoRangeType;
/// <summary>
- /// 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..
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Until = (uint)Property.Id.TodoUntil;
/// <since_tizen> 4 </since_tizen>
public const uint Count = (uint)Property.Id.TodoCount;
/// <summary>
- /// The interval of the todo recurrence
+ /// The interval of the todo recurrence.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Interval = (uint)Property.Id.TodoInterval;
/// <summary>
- /// 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.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Bysecond = (uint)Property.Id.TodoBysecond;
/// <summary>
- /// 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.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Byminute = (uint)Property.Id.TodoByminute;
/// <summary>
- /// 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.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Byhour = (uint)Property.Id.TodoByhour;
/// <summary>
- /// 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.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Byday = (uint)Property.Id.TodoByday;
/// <summary>
- /// 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.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Bymonthday = (uint)Property.Id.TodoBymonthday;
/// <summary>
- /// 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.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Byyearday = (uint)Property.Id.TodoByyearday;
/// <summary>
- /// 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.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Byweekno = (uint)Property.Id.TodoByweekno;
/// <summary>
- /// 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.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Bymonth = (uint)Property.Id.TodoBymonth;
/// <summary>
- /// 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.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Bysetpos = (uint)Property.Id.TodoBysetpos;
/// <summary>
- /// The start day of the week(refer to the CalendarTypes.WeekDay).
+ /// The start day of the week (refer to the CalendarTypes.WeekDay).
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Wkst = (uint)Property.Id.TodoWkst;
/// <summary>
- /// Whether or not the todo has an alarm list
+ /// Whether or not the todo has an alarm list.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint HasAlarm = (uint)Property.Id.TodoHasAlarm;
/// <summary>
- /// 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.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint SyncData1 = (uint)Property.Id.TodoSyncData1;
/// <summary>
- /// 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.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint SyncData2 = (uint)Property.Id.TodoSyncData2;
/// <summary>
- /// 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.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint SyncData3 = (uint)Property.Id.TodoSyncData3;
/// <summary>
- /// 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.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint SyncData4 = (uint)Property.Id.TodoSyncData4;
/// <summary>
- /// The start time of the todo
+ /// The start time of the todo.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Start = (uint)Property.Id.TodoStart;
/// <summary>
- /// The due time of the todo
+ /// The due time of the todo.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Due = (uint)Property.Id.TodoDue;
/// <since_tizen> 4 </since_tizen>
public const uint Alarm = (uint)Property.Id.TodoAlarm;
/// <summary>
- /// The timezone of the start_time
+ /// The timezone of the start_time.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint StartTzid = (uint)Property.Id.TodoStartTzid;
/// <summary>
- /// The timezone of the due_time
+ /// The timezone of the due_time.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint DueTzid = (uint)Property.Id.TodoDueTzid;
/// <summary>
- /// The name of the organizer of the event
+ /// The name of the organizer of the event.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint OrganizerName = (uint)Property.Id.TodoOrganizerName;
/// <summary>
- /// The email address of the organizer of the todo
+ /// The email address of the organizer of the todo.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint OrganizerEmail = (uint)Property.Id.TodoOrganizerEmail;
/// <summary>
- /// Whether or not the todo has an attendee list
+ /// Whether or not the todo has an attendee list.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint HasAttendee = (uint)Property.Id.TodoHasAttendee;
/// <since_tizen> 4 </since_tizen>
public const uint Extended = (uint)Property.Id.TodoExtended;
/// <summary>
- /// The todo is an allday event or not
+ /// The todo is an allday event or not.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint IsAllday = (uint)Property.Id.TodoIsAllday;
}
/// <summary>
- /// Describes properties of a Timezone record.
+ /// Describes the properties of a timezone record.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public static class Timezone
{
/// <summary>
- /// Identifier of this timezone view
+ /// Identifier of this timezone view.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const string Uri = "tizen.calendar_view.timezone";
/// <summary>
- /// DB record ID of the timezone
+ /// Database record ID of the timezone.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Id = (uint)Property.Id.TimezoneId;
/// <summary>
- /// 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).
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint TzOffsetFromGmt = (uint)Property.Id.TimezoneTzOffsetFromGmt;
/// <summary>
- /// Name of the Standard Time
+ /// Name of the standard time.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint StandardName = (uint)Property.Id.TimezoneStandardName;
/// <summary>
- /// 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.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint StdStartMonth = (uint)Property.Id.TimezoneStdStartMonth;
/// <summary>
- /// 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.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint StdStartPositionOfWeek = (uint)Property.Id.TimezoneStdStartPositionOfWeek;
/// <summary>
- /// 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).
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint StdStartDay = (uint)Property.Id.TimezoneStdStartDay;
/// <summary>
- /// Starting hour of the Standard Time. Valid values are 0 to 23
+ /// Starting hour of the standard time. Valid values are 0 to 23.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint StdStartHour = (uint)Property.Id.TimezoneStdStartHour;
/// <summary>
- /// The number of minutes added during the Standard Time
+ /// The number of minutes added during the standard time.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint StandardBias = (uint)Property.Id.TimezoneStandardBias;
/// <summary>
- /// Name of Daylight
+ /// Name of the Daylight.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint DayLightName = (uint)Property.Id.TimezoneDayLightName;
/// <summary>
- /// 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.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint DayLightStartMonth = (uint)Property.Id.TimezoneDayLightStartMonth;
/// <summary>
- /// 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.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint DayLightStartPositionOfWeek = (uint)Property.Id.TimezoneDayLightStartPositionOfWeek;
/// <summary>
- /// 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).
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint DayLightStartDay = (uint)Property.Id.TimezoneDayLightStartDay;
/// <summary>
- /// Starting hour of Daylight. Valid values are 0 to 23
+ /// Starting hour of the Daylight. Valid values are 0 to 23.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint DayLightStartHour = (uint)Property.Id.TimezoneDayLightStartHour;
/// <summary>
- /// The number of minutes added during Daylight Time
+ /// The number of minutes added during the Daylight time.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint DayLightBias = (uint)Property.Id.TimezoneDayLightBias;
/// <summary>
- /// DB record ID of a related calendar book
+ /// Database record ID of a related calendar book.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint CalendarId = (uint)Property.Id.TimezoneCalendarId;
}
/// <summary>
- /// Describes properties of a Attendee record.
+ /// Describes the properties of an Attendee record.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public static class Attendee
{
/// <summary>
- /// Identifier of this calendar attendee view
+ /// Identifier of this calendar attendee view.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const string Uri = "tizen.calendar_view.attendee";
/// <summary>
- /// The number of the attendee
+ /// The number of the attendee.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Number = (uint)Property.Id.AttendeeNumber;
/// <summary>
- /// The type of attendee(refer to the CalendarTypes.Cutype).
+ /// The type of attendee (refer to the CalendarTypes.Cutype).
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Cutype = (uint)Property.Id.AttendeeCutype;
/// <summary>
- /// CtIndex
+ /// CtIndex.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint CtIndex = (uint)Property.Id.AttendeeCtIndex;
/// <summary>
- /// Unique identifier
+ /// Unique identifier.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Uid = (uint)Property.Id.AttendeeUid;
/// <summary>
- /// Group
+ /// Group.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Group = (uint)Property.Id.AttendeeGroup;
/// <summary>
- /// The email address of the attendee
+ /// The email address of the attendee.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Email = (uint)Property.Id.AttendeeEmail;
/// <summary>
- /// Attendee role(refer to the CalendarTypes.AttendeeRole).
+ /// Attendee role (refer to the CalendarTypes.AttendeeRole).
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Role = (uint)Property.Id.AttendeeRole;
/// <summary>
- /// Attendee status(refer to the CalendarTypes.AttendeeStatus).
+ /// Attendee status (refer to the CalendarTypes.AttendeeStatus).
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Status = (uint)Property.Id.AttendeeStatus;
/// <summary>
- /// RSVP invitation reply (one of true, false)
+ /// RSVP invitation reply (one of true, false).
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Rsvp = (uint)Property.Id.AttendeeRsvp;
/// <summary>
- /// Delegatee (DELEGATED-TO)
+ /// Delegatee (DELEGATED-TO).
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint DelegateeUri = (uint)Property.Id.AttendeeDelegateeUri;
/// <summary>
- /// Delegator (DELEGATED-FROM)
+ /// Delegator (DELEGATED-FROM).
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint DelegatorUri = (uint)Property.Id.AttendeeDelegatorUri;
/// <summary>
- /// Attendee name
+ /// Attendee name.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Name = (uint)Property.Id.AttendeeName;
/// <summary>
- /// Group that the attendee belongs to
+ /// Group that the attendee belongs to.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Member = (uint)Property.Id.AttendeeMember;
/// <summary>
- /// Event/TODO that the attendee belongs to
+ /// Event/TODO that the attendee belongs to.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint ParentId = (uint)Property.Id.AttendeeParentId;
}
/// <summary>
- /// Describes properties of a Alarm record.
+ /// Describes the properties of an Alarm record.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public static class Alarm
{
/// <summary>
- /// Identifier of this calendar alarm view
+ /// Identifier of this calendar alarm view.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const string Uri = "tizen.calendar_view.alarm";
/// <summary>
- /// 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.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Tick = (uint)Property.Id.AlarmTick;
/// <summary>
- /// Reminder tick time unit(refer to the CalendarTypes.TickUnit).
+ /// Reminder tick time unit (refer to the CalendarTypes.TickUnit).
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint TickUnit = (uint)Property.Id.AlarmTickUnit;
/// <summary>
- /// Alarm description
+ /// Alarm description.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Description = (uint)Property.Id.AlarmDescription;
/// <summary>
- /// Event that the alarm belongs to
+ /// Event that the alarm belongs to.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint ParentId = (uint)Property.Id.AlarmParentId;
/// <summary>
- /// Alarm summary
+ /// Alarm summary.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Summary = (uint)Property.Id.AlarmSummary;
/// <summary>
- /// Action of alarm(refer to the CalendarTypes.Action).
+ /// Action of alarm (refer to the CalendarTypes.Action).
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Action = (uint)Property.Id.AlarmAction;
/// <summary>
- /// Alarm tone path
+ /// Alarm tone path.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Attach = (uint)Property.Id.AlarmAttach;
/// <summary>
- /// The alarm time
+ /// The alarm time.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint AlarmTime = (uint)Property.Id.AlarmAlarm;
}
/// <summary>
- /// Describes properties of a InstanceUtimeBook record.
+ /// Describes the properties of an InstanceUtimeBook record.
/// </summary>
/// <since_tizen> 4 </since_tizen>
- /// <remarks>Read only view</remarks>
+ /// <remarks>Read only view.</remarks>
public static class InstanceUtimeBook
{
/// <summary>
- /// Identifier of this instance utime book
+ /// Identifier of this instance utime book.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const string Uri = "tizen.calendar_view.instance_utime/book";
/// <summary>
- /// Event id
+ /// Event ID.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint EventId = (uint)Property.Id.InstanceUtimeBookEventId;
/// <summary>
- /// Start time
+ /// Start time.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Start = (uint)Property.Id.InstanceUtimeBookStart;
/// <summary>
- /// End time
+ /// End time.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint End = (uint)Property.Id.InstanceUtimeBookEnd;
/// <summary>
- /// Summary
+ /// Summary.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Summary = (uint)Property.Id.InstanceUtimeBookSummary;
/// <summary>
- /// Location
+ /// Location.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Location = (uint)Property.Id.InstanceUtimeBookLocation;
/// <summary>
- /// Book id
+ /// Book ID.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint BookId = (uint)Property.Id.InstanceUtimeBookBookId;
/// <summary>
- /// Description
+ /// Description.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Description = (uint)Property.Id.InstanceUtimeBookDescription;
/// <summary>
- /// BusyStatus
+ /// BusyStatus.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint BusyStatus = (uint)Property.Id.InstanceUtimeBookBusyStatus;
/// <summary>
- /// EventStatus
+ /// EventStatus.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint EventStatus = (uint)Property.Id.InstanceUtimeBookEventStatus;
/// <summary>
- /// Priority
+ /// Priority.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Priority = (uint)Property.Id.InstanceUtimeBookPriority;
/// <summary>
- /// Sensitivity
+ /// Sensitivity.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Sensitivity = (uint)Property.Id.InstanceUtimeBookSensitivity;
/// <summary>
- /// HasRrule
+ /// HasRrule.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint HasRrule = (uint)Property.Id.InstanceUtimeBookHasRrule;
/// <summary>
- /// Latitude
+ /// Latitude.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Latitude = (uint)Property.Id.InstanceUtimeBookLatitude;
/// <summary>
- /// Longitude
+ /// Longitude.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Longitude = (uint)Property.Id.InstanceUtimeBookLongitude;
/// <summary>
- /// HasAlarm
+ /// HasAlarm.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint HasAlarm = (uint)Property.Id.InstanceUtimeBookHasAlarm;
/// <summary>
- /// OriginalEventId
+ /// OriginalEventId.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint OriginalEventId = (uint)Property.Id.InstanceUtimeBookOriginalEventId;
/// <summary>
- /// LastModifiedtime
+ /// LastModifiedtime.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint LastModifiedtime = (uint)Property.Id.InstanceUtimeBookLastModifiedTime;
/// <summary>
- /// SyncData1
+ /// SyncData1.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint SyncData1 = (uint)Property.Id.InstanceUtimeBookSyncData1;
}
/// <summary>
- /// Describes properties of a InstanceLocaltimeBook record.
+ /// Describes the properties of an InstanceLocaltimeBook record.
/// </summary>
/// <since_tizen> 4 </since_tizen>
- /// <remarks>Read only view</remarks>
+ /// <remarks>Read only view.</remarks>
public static class InstanceLocaltimeBook
{
/// <summary>
- /// Uri
+ /// URI.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const string Uri = "tizen.calendar_view.instance_localtime/book";
/// <summary>
- /// EventId
+ /// EventId.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint EventId = (uint)Property.Id.InstanceLocaltimeBookEventId;
/// <summary>
- /// Start
+ /// Start.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Start = (uint)Property.Id.InstanceLocaltimeBookStart;
/// <summary>
- /// End
+ /// End.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint End = (uint)Property.Id.InstanceLocaltimeBookEnd;
/// <summary>
- /// Summary
+ /// Summary.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Summary = (uint)Property.Id.InstanceLocaltimeBookSummary;
/// <summary>
- /// Location
+ /// Location.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Location = (uint)Property.Id.InstanceLocaltimeBookLocation;
/// <summary>
- /// BookId
+ /// BookId.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint BookId = (uint)Property.Id.InstanceLocaltimeBookBookId;
/// <summary>
- /// Description
+ /// Description.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Description = (uint)Property.Id.InstanceLocaltimeBookDescription;
/// <summary>
- /// BusyStatus
+ /// BusyStatus.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint BusyStatus = (uint)Property.Id.InstanceLocaltimeBookBusyStatus;
/// <summary>
- /// EventStatus
+ /// EventStatus.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint EventStatus = (uint)Property.Id.InstanceLocaltimeBookEventStatus;
/// <summary>
- /// Priority
+ /// Priority.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Priority = (uint)Property.Id.InstanceLocaltimeBookPriority;
/// <summary>
- /// Sensitivity
+ /// Sensitivity.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Sensitivity = (uint)Property.Id.InstanceLocaltimeBookSensitivity;
/// <summary>
- /// HasRrule
+ /// HasRrule.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint HasRrule = (uint)Property.Id.InstanceLocaltimeBookHasRrule;
/// <summary>
- /// Latitude
+ /// Latitude.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Latitude = (uint)Property.Id.InstanceLocaltimeBookLatitude;
/// <summary>
- /// Longitude
+ /// Longitude.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Longitude = (uint)Property.Id.InstanceLocaltimeBookLongitude;
/// <summary>
- /// HasAlarm
+ /// HasAlarm.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint HasAlarm = (uint)Property.Id.InstanceLocaltimeBookHasAlarm;
/// <summary>
- /// OriginalEventId
+ /// OriginalEventId.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint OriginalEventId = (uint)Property.Id.InstanceLocaltimeBookOriginalEventId;
/// <summary>
- /// LastModifiedTime
+ /// LastModifiedTime.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint LastModifiedTime = (uint)Property.Id.InstanceLocaltimeBookLastModifiedTime;
/// <summary>
- /// SyncData1
+ /// SyncData1.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint SyncData1 = (uint)Property.Id.InstanceLocaltimeBookSyncData1;
/// <summary>
- /// IsAllday
+ /// IsAllday.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint IsAllday = (uint)Property.Id.InstanceLocaltimeBookIsAllday;
}
/// <summary>
- /// Describes properties of a InstanceUtimeBookExtended record.
+ /// Describes the properties of an InstanceUtimeBookExtended record.
/// </summary>
/// <since_tizen> 4 </since_tizen>
- /// <remarks>Read only view</remarks>
+ /// <remarks>Read only view.</remarks>
public static class InstanceUtimeBookExtended
{
/// <summary>
- /// Uri
+ /// URI.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const string Uri = "tizen.calendar_view.extended/instance_utime/book";
/// <summary>
- /// EventId
+ /// EventId.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint EventId = (uint)Property.Id.InstanceUtimeBookExtendedEventId;
/// <summary>
- /// Start
+ /// Start.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Start = (uint)Property.Id.InstanceUtimeBookExtendedStart;
/// <summary>
- /// End
+ /// End.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint End = (uint)Property.Id.InstanceUtimeBookExtendedEnd;
/// <summary>
- /// Summary
+ /// Summary.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Summary = (uint)Property.Id.InstanceUtimeBookExtendedSummary;
/// <summary>
- /// Location
+ /// Location.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Location = (uint)Property.Id.InstanceUtimeBookExtendedLocation;
/// <summary>
- /// BookId
+ /// BookId.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint BookId = (uint)Property.Id.InstanceUtimeBookExtendedBookId;
/// <summary>
- /// Description
+ /// Description.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Description = (uint)Property.Id.InstanceUtimeBookExtendedDescription;
/// <summary>
- /// BusyStatus
+ /// BusyStatus.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint BusyStatus = (uint)Property.Id.InstanceUtimeBookExtendedBusyStatus;
/// <summary>
- /// EventStatus
+ /// EventStatus.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint EventStatus = (uint)Property.Id.InstanceUtimeBookExtendedEventStatus;
/// <summary>
- /// Priority
+ /// Priority.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Priority = (uint)Property.Id.InstanceUtimeBookExtendedPriority;
/// <summary>
- /// Sensitivity
+ /// Sensitivity.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Sensitivity = (uint)Property.Id.InstanceUtimeBookExtendedSensitivity;
/// <summary>
- /// HasRrule
+ /// HasRrule.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint HasRrule = (uint)Property.Id.InstanceUtimeBookExtendedHasRrule;
/// <summary>
- /// Latitude
+ /// Latitude.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Latitude = (uint)Property.Id.InstanceUtimeBookExtendedLatitude;
/// <summary>
- /// Longitude
+ /// Longitude.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Longitude = (uint)Property.Id.InstanceUtimeBookExtendedLongitude;
/// <summary>
- /// HasAlarm
+ /// HasAlarm.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint HasAlarm = (uint)Property.Id.InstanceUtimeBookExtendedHasAlarm;
/// <summary>
- /// OriginalEventId
+ /// OriginalEventId.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint OriginalEventId = (uint)Property.Id.InstanceUtimeBookExtendedOriginalEventId;
/// <summary>
- /// LastModifiedTime
+ /// LastModifiedTime.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint LastModifiedTime = (uint)Property.Id.InstanceUtimeBookExtendedLastModifiedTime;
/// <summary>
- /// SyncData1
+ /// SyncData1.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint SyncData1 = (uint)Property.Id.InstanceUtimeBookExtendedSyncData1;
/// <summary>
- /// OrganizerName
+ /// OrganizerName.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint OrganizerName = (uint)Property.Id.InstanceUtimeBookExtendedOrganizerName;
/// <summary>
- /// Categories
+ /// Categories.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Categories = (uint)Property.Id.InstanceUtimeBookExtendedCategories;
/// <summary>
- /// HasAttendee
+ /// HasAttendee.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint HasAttendee = (uint)Property.Id.InstanceUtimeBookExtendedHasAttendee;
/// <summary>
- /// SyncData2
+ /// SyncData2.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint SyncData2 = (uint)Property.Id.InstanceUtimeBookExtendedSyncData2;
/// <summary>
- /// SyncData3
+ /// SyncData3.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint SyncData3 = (uint)Property.Id.InstanceUtimeBookExtendedSyncData3;
/// <summary>
- /// SyncData4
+ /// SyncData4.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint SyncData4 = (uint)Property.Id.InstanceUtimeBookExtendedSyncData4;
}
/// <summary>
- /// Describes properties of a InstanceLocaltimeBookExtended record.
+ /// Describes the properties of an InstanceLocaltimeBookExtended record.
/// </summary>
/// <since_tizen> 4 </since_tizen>
- /// <remarks>Read only view</remarks>
+ /// <remarks>Read only view.</remarks>
public static class InstanceLocaltimeBookExtended
{
/// <summary>
- /// Uri
+ /// URI.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const string Uri = "tizen.calendar_view.extended/instance_localtime/book";
/// <summary>
- /// EventId
+ /// EventId.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint EventId = (uint)Property.Id.InstanceLocaltimeBookExtendedEventId;
/// <summary>
- /// Start
+ /// Start.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Start = (uint)Property.Id.InstanceLocaltimeBookExtendedStart;
/// <summary>
- /// End
+ /// End.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint End = (uint)Property.Id.InstanceLocaltimeBookExtendedEnd;
/// <summary>
- /// Summary
+ /// Summary.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Summary = (uint)Property.Id.InstanceLocaltimeBookExtendedSummary;
/// <summary>
- /// Location
+ /// Location.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Location = (uint)Property.Id.InstanceLocaltimeBookExtendedLocation;
/// <summary>
- /// BookId
+ /// BookId.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint BookId = (uint)Property.Id.InstanceLocaltimeBookExtendedBookId;
/// <summary>
- /// Description
+ /// Description.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Description = (uint)Property.Id.InstanceLocaltimeBookExtendedDescription;
/// <summary>
- /// BusyStatus
+ /// BusyStatus.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint BusyStatus = (uint)Property.Id.InstanceLocaltimeBookExtendedBusyStatus;
/// <summary>
- /// EventStatus
+ /// EventStatus.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint EventStatus = (uint)Property.Id.InstanceLocaltimeBookExtendedEventStatus;
/// <summary>
- /// Priority
+ /// Priority.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Priority = (uint)Property.Id.InstanceLocaltimeBookExtendedPriority;
/// <summary>
- /// Sensitivity
+ /// Sensitivity.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Sensitivity = (uint)Property.Id.InstanceLocaltimeBookExtendedSensitivity;
/// <summary>
- /// HasRrule
+ /// HasRrule.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint HasRrule = (uint)Property.Id.InstanceLocaltimeBookExtendedHasRrule;
/// <summary>
- /// Latitude
+ /// Latitude.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Latitude = (uint)Property.Id.InstanceLocaltimeBookExtendedLatitude;
/// <summary>
- /// Longitude
+ /// Longitude.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Longitude = (uint)Property.Id.InstanceLocaltimeBookExtendedLongitude;
/// <summary>
- /// HasAlarm
+ /// HasAlarm.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint HasAlarm = (uint)Property.Id.InstanceLocaltimeBookExtendedHasAlarm;
/// <summary>
- /// OriginalEventId
+ /// OriginalEventId.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint OriginalEventId = (uint)Property.Id.InstanceLocaltimeBookExtendedOriginalEventId;
/// <summary>
- /// LastModifiedTime
+ /// LastModifiedTime.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint LastModifiedTime = (uint)Property.Id.InstanceLocaltimeBookExtendedLastModifiedTime;
/// <summary>
- /// SyncData1
+ /// SyncData1.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint SyncData1 = (uint)Property.Id.InstanceLocaltimeBookExtendedSyncData1;
/// <summary>
- /// OrganizerName
+ /// OrganizerName.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint OrganizerName = (uint)Property.Id.InstanceLocaltimeBookExtendedOrganizerName;
/// <summary>
- /// Categories
+ /// Categories.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Categories = (uint)Property.Id.InstanceLocaltimeBookExtendedCategories;
/// <summary>
- /// HasAttendee
+ /// HasAttendee.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint HasAttendee = (uint)Property.Id.InstanceLocaltimeBookExtendedHasAttendee;
/// <summary>
- /// SyncData2
+ /// SyncData2.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint SyncData2 = (uint)Property.Id.InstanceLocaltimeBookExtendedSyncData2;
/// <summary>
- /// SyncData3
+ /// SyncData3.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint SyncData3 = (uint)Property.Id.InstanceLocaltimeBookExtendedSyncData3;
/// <summary>
- /// SyncData4
+ /// SyncData4.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint SyncData4 = (uint)Property.Id.InstanceLocaltimeBookExtendedSyncData4;
/// <summary>
- /// IsAllday
+ /// IsAllday.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint IsAllday = (uint)Property.Id.InstanceLocaltimeBookExtendedIsAllday;
}
/// <summary>
- /// Describes properties of a UpdatedInfo record.
+ /// Describes the properties of an UpdatedInfo record.
/// </summary>
/// <since_tizen> 4 </since_tizen>
- /// <remarks>Read only view</remarks>
+ /// <remarks>Read only view.</remarks>
public static class UpdatedInfo
{
/// <summary>
- /// Identifier of this updatedInfo view
+ /// Identifier of this UpdatedInfo view.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const string Uri = "tizen.calendar_view.updated_info";
/// <summary>
- /// Modified event(or todo) record ID
+ /// Modified event (or todo) record ID.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Id = (uint)Property.Id.UpdateInfoId;
/// <summary>
- /// Calendar book ID of the modified event(or todo) record
+ /// Calendar book ID of the modified event (or todo) record.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint CalendarId = (uint)Property.Id.UpdateInfoCalendarId;
/// <since_tizen> 4 </since_tizen>
public const uint Type = (uint)Property.Id.UpdateInfoType;
/// <summary>
- /// Version after change
+ /// Version after change.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Version = (uint)Property.Id.UpdateInfoVersion;
}
/// <summary>
- /// Describes properties of a Extended record.
+ /// Describes the properties of an Extended record.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public static class Extended
{
/// <summary>
- /// Identifier of this extended_property view
+ /// Identifier of this extended_property view.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const string Uri = "tizen.calendar_view.extended_property";
/// <summary>
- /// DB record ID of the extended_property
+ /// Database record ID of the extended_property.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Id = (uint)Property.Id.ExtendedId;
/// <summary>
- /// Related record ID
+ /// Related record ID.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint RecordId = (uint)Property.Id.ExtendedRecordId;
/// <since_tizen> 4 </since_tizen>
public const uint RecordType = (uint)Property.Id.ExtendedRecordType;
/// <summary>
- /// The key of the property
+ /// The key of the property.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Key = (uint)Property.Id.ExtendedKey;
/// <summary>
- /// The value of the property
+ /// The value of the property.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Value = (uint)Property.Id.ExtendedValue;
namespace Tizen.Pims.Calendar
{
/// <summary>
- /// Event arguments passed when calendar database is changed
+ /// The event arguments passed when the calendar database is changed.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public class DBChangedEventArgs : EventArgs
}
/// <summary>
- /// The calendar view URI changed.
+ /// The calendar view URI is changed.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public string ViewUri
namespace Tizen.Pims.Calendar
{
/// <summary>
- /// Event arguments passed when alarm is alerted.
+ /// The event arguments passed when the alarm is alerted.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public class ReminderAlertedEventArgs : EventArgs
}
/// <summary>
- /// The parameter which data is combined.
+ /// The parameter which the data is combined.
/// </summary>
/// <since_tizen> 4 </since_tizen>
/// <value>
- /// 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).
/// </value>
public string Param
{
using System.Runtime.InteropServices;
/// <summary>
-/// Partial Interop Class
+/// The Partial Interop class.
/// </summary>
internal static partial class Interop
{
using System.Runtime.InteropServices;
/// <summary>
-/// Partial Interop Class
+/// The Partial Interop class.
/// </summary>
internal static partial class Interop
{
/// <summary>
- /// Contacts Interop Class
+ /// The Contacts Interop class.
/// </summary>
internal static class Group
{
*/
/// <summary>
-/// Partial Interop Class
+/// The Partial Interop class.
/// </summary>
internal static partial class Interop
{
using System.Runtime.InteropServices;
/// <summary>
-/// Partial Interop Class
+/// The Partial Interop class.
/// </summary>
internal static partial class Interop
{
using System.Runtime.InteropServices;
/// <summary>
-/// Partial Interop Class
+/// The Partial Interop class.
/// </summary>
internal static partial class Interop
{
/// <summary>
- /// Contacts Interop Class
+ /// The Contacts Interop class.
/// </summary>
internal static class Service
{
using Tizen.Pims.Contacts;
/// <summary>
-/// Partial Interop Class
+/// The Partial Interop class.
/// </summary>
internal static partial class Interop
{
using System.Runtime.InteropServices;
/// <summary>
-/// Partial Interop Class
+/// The Partial Interop class.
/// </summary>
internal static partial class Interop
{
{
/// <summary>
- /// ContactsDatabase provides methods to manage contacts information from/to the database.
+ /// The ContactsDatabase provides methods to manage contacts information from/to the database.
/// </summary>
/// <remarks>
- /// 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.
/// </remarks>
/// <since_tizen> 4 </since_tizen>
public class ContactsDatabase
}
/// <summary>
- /// Enumeration for contacts database status.
+ /// Enumeration for the contacts database status.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public enum DBStatus
{
/// <summary>
- /// Normal
+ /// Normal.
/// </summary>
/// <since_tizen> 4 </since_tizen>
Normal,
}
/// <summary>
- /// Enumeration for Contacts search range.
+ /// Enumeration for the contacts search range.
/// </summary>
/// <since_tizen> 4 </since_tizen>
[Flags]
public enum SearchRanges
{
/// <summary>
- /// None
+ /// None.
/// </summary>
/// <since_tizen> 4 </since_tizen>
None = 0,
/// <summary>
- /// Search record from name
+ /// Search record from name.
/// </summary>
/// <since_tizen> 4 </since_tizen>
Name = 0x00000001,
/// <summary>
- /// Search record from number
+ /// Search record from number.
/// </summary>
/// <since_tizen> 4 </since_tizen>
Number = 0x00000002,
/// <summary>
- /// Search record from data
+ /// Search record from data.
/// </summary>
/// <since_tizen> 4 </since_tizen>
Data = 0x00000004,
/// <summary>
- /// Search record from email. Now, support only PersonEmail view
+ /// Search record from email. Now, support only PersonEmail view.
/// </summary>
/// <since_tizen> 4 </since_tizen>
Email = 0x00000008,
}
/// <summary>
- /// Occurs when contacts database status is changed.
+ /// Occurs when the contacts database status is changed.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public event EventHandler<DBStatusChangedEventArgs> DBStatusChanged
/// <summary>
/// Inserts a record into the contacts database.
/// </summary>
- /// <param name="record">The record to insert</param>
- /// <returns>The ID of inserted record</returns>
+ /// <param name="record">The record to insert.</param>
+ /// <returns>The ID of inserted record.</returns>
/// <privilege>http://tizen.org/privilege/contact.write</privilege>
/// <privilege>http://tizen.org/privilege/callhistory.write</privilege>
/// <feature>http://tizen.org/feature/contact</feature>
- /// <exception cref="InvalidOperationException">Thrown when method failed due to invalid operation</exception>
- /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
- /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid</exception>
- /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory</exception>
- /// <exception cref="UnauthorizedAccessException">Thrown when application does not have proper privileges</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the method failed due to an invalid operation.</exception>
+ /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
+ /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid.</exception>
+ /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory.</exception>
+ /// <exception cref="UnauthorizedAccessException">Thrown when the application does not have proper privileges.</exception>
/// <since_tizen> 4 </since_tizen>
[SuppressMessage("Microsoft.Performance", "CA1822:MarkMembersAsStatic")]
public int Insert(ContactsRecord record)
/// <summary>
/// Inserts multiple records into the contacts database as a batch operation.
/// </summary>
- /// <param name="list">The record list</param>
- /// <returns>The inserted record ID array</returns>
+ /// <param name="list">The record list.</param>
+ /// <returns>The inserted record ID array.</returns>
/// <privilege>http://tizen.org/privilege/contact.write</privilege>
/// <privilege>http://tizen.org/privilege/callhistory.write</privilege>
/// <feature>http://tizen.org/feature/contact</feature>
- /// <exception cref="InvalidOperationException">Thrown when method failed due to invalid operation</exception>
- /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
- /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid</exception>
- /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory</exception>
- /// <exception cref="UnauthorizedAccessException">Thrown when application does not have proper privileges</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the method failed due to an invalid operation.</exception>
+ /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
+ /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid.</exception>
+ /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory.</exception>
+ /// <exception cref="UnauthorizedAccessException">Thrown when the application does not have proper privileges.</exception>
/// <since_tizen> 4 </since_tizen>
[SuppressMessage("Microsoft.Performance", "CA1822:MarkMembersAsStatic")]
public int[] Insert(ContactsList list)
/// <summary>
/// Gets a record from the contacts database.
/// </summary>
- /// <param name="viewUri">The view URI of a record</param>
- /// <param name="recordId">The record ID</param>
+ /// <param name="viewUri">The view URI of a record.</param>
+ /// <param name="recordId">The record ID.</param>
/// <returns>The record associated with the record ID</returns>
/// <privilege>http://tizen.org/privilege/contact.read</privilege>
/// <privilege>http://tizen.org/privilege/callhistory.read</privilege>
/// <feature>http://tizen.org/feature/contact</feature>
- /// <exception cref="InvalidOperationException">Thrown when method failed due to invalid operation</exception>
- /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
- /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid</exception>
- /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory</exception>
- /// <exception cref="UnauthorizedAccessException">Thrown when application does not have proper privileges</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the method failed due to an invalid operation.</exception>
+ /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
+ /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid.</exception>
+ /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory.</exception>
+ /// <exception cref="UnauthorizedAccessException">Thrown when the application does not have proper privileges.</exception>
/// <since_tizen> 4 </since_tizen>
[SuppressMessage("Microsoft.Performance", "CA1822:MarkMembersAsStatic")]
[SuppressMessage("Microsoft.Design", "CA1054:UriParametersShouldNotBeStrings")]
/// <summary>
/// Updates a record in the contacts database.
/// </summary>
- /// <param name="record">The record to update</param>
+ /// <param name="record">The record to update.</param>
/// <privilege>http://tizen.org/privilege/contact.write</privilege>
/// <privilege>http://tizen.org/privilege/callhistory.write</privilege>
/// <feature>http://tizen.org/feature/contact</feature>
- /// <exception cref="InvalidOperationException">Thrown when method failed due to invalid operation</exception>
- /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
- /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid</exception>
- /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory</exception>
- /// <exception cref="UnauthorizedAccessException">Thrown when application does not have proper privileges</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the method failed due to an invalid operation.</exception>
+ /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
+ /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid.</exception>
+ /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory.</exception>
+ /// <exception cref="UnauthorizedAccessException">Thrown when the application does not have proper privileges.</exception>
/// <since_tizen> 4 </since_tizen>
[SuppressMessage("Microsoft.Performance", "CA1822:MarkMembersAsStatic")]
public void Update(ContactsRecord record)
/// <summary>
/// Updates multiple records in the contacts database as a batch operation.
/// </summary>
- /// <param name="list">The record list</param>
+ /// <param name="list">The record list.</param>
/// <privilege>http://tizen.org/privilege/contact.write</privilege>
/// <privilege>http://tizen.org/privilege/callhistory.write</privilege>
/// <feature>http://tizen.org/feature/contact</feature>
- /// <exception cref="InvalidOperationException">Thrown when method failed due to invalid operation</exception>
- /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
- /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid</exception>
- /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory</exception>
- /// <exception cref="UnauthorizedAccessException">Thrown when application does not have proper privileges</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the method failed due to an invalid operation.</exception>
+ /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
+ /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid.</exception>
+ /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory.</exception>
+ /// <exception cref="UnauthorizedAccessException">Thrown when the application does not have proper privileges.</exception>
/// <since_tizen> 4 </since_tizen>
[SuppressMessage("Microsoft.Performance", "CA1822:MarkMembersAsStatic")]
public void Update(ContactsList list)
}
/// <summary>
- /// Deletes a record from the contacts database with related child records.
+ /// Deletes a record from the contacts database with the related child records.
/// </summary>
- /// <param name="viewUri">The view URI of a record</param>
- /// <param name="recordId">The record ID to delete</param>
+ /// <param name="viewUri">The view URI of a record.</param>
+ /// <param name="recordId">The record ID to delete.</param>
/// <privilege>http://tizen.org/privilege/contact.write</privilege>
/// <privilege>http://tizen.org/privilege/callhistory.write</privilege>
/// <feature>http://tizen.org/feature/contact</feature>
- /// <exception cref="InvalidOperationException">Thrown when method failed due to invalid operation</exception>
- /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
- /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid</exception>
- /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory</exception>
- /// <exception cref="UnauthorizedAccessException">Thrown when application does not have proper privileges</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the method failed due to an invalid operation.</exception>
+ /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
+ /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid.</exception>
+ /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory.</exception>
+ /// <exception cref="UnauthorizedAccessException">Thrown when the application does not have proper privileges.</exception>
/// <since_tizen> 4 </since_tizen>
[SuppressMessage("Microsoft.Performance", "CA1822:MarkMembersAsStatic")]
[SuppressMessage("Microsoft.Design", "CA1054:UriParametersShouldNotBeStrings")]
}
/// <summary>
- /// 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.
/// </summary>
- /// <param name="viewUri">The view URI of the records to delete</param>
- /// <param name="idArray">The record IDs to delete</param>
+ /// <param name="viewUri">The view URI of the records to delete.</param>
+ /// <param name="idArray">The record IDs to delete.</param>
/// <privilege>http://tizen.org/privilege/contact.write</privilege>
/// <privilege>http://tizen.org/privilege/callhistory.write</privilege>
/// <feature>http://tizen.org/feature/contact</feature>
- /// <exception cref="InvalidOperationException">Thrown when method failed due to invalid operation</exception>
- /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
- /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid</exception>
- /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory</exception>
- /// <exception cref="UnauthorizedAccessException">Thrown when application does not have proper privileges</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the method failed due to an invalid operation.</exception>
+ /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
+ /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid.</exception>
+ /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory.</exception>
+ /// <exception cref="UnauthorizedAccessException">Thrown when the application does not have proper privileges.</exception>
/// <since_tizen> 4 </since_tizen>
[SuppressMessage("Microsoft.Performance", "CA1822:MarkMembersAsStatic")]
[SuppressMessage("Microsoft.Design", "CA1054:UriParametersShouldNotBeStrings")]
/// <summary>
/// Replaces a record in the contacts database.
/// </summary>
- /// <param name="record">The record to replace</param>
- /// <param name="recordId">the record ID to be replaced</param>
+ /// <param name="record">The record to replace.</param>
+ /// <param name="recordId">The record ID to be replaced.</param>
/// <privilege>http://tizen.org/privilege/contact.write</privilege>
/// <privilege>http://tizen.org/privilege/callhistory.write</privilege>
/// <feature>http://tizen.org/feature/contact</feature>
- /// <exception cref="InvalidOperationException">Thrown when method failed due to invalid operation</exception>
- /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
- /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid</exception>
- /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory</exception>
- /// <exception cref="UnauthorizedAccessException">Thrown when application does not have proper privileges</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the method failed due to an invalid operation<./exception>
+ /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
+ /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid.</exception>
+ /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory.</exception>
+ /// <exception cref="UnauthorizedAccessException">Thrown when the application does not have proper privileges.</exception>
/// <since_tizen> 4 </since_tizen>
[SuppressMessage("Microsoft.Performance", "CA1822:MarkMembersAsStatic")]
public void Replace(ContactsRecord record, int recordId)
/// <summary>
/// Replaces multiple records in the contacts database as a batch operation.
/// </summary>
- /// <param name="list">The record list to replace</param>
- /// <param name="idArray">The record IDs to be replaced</param>
+ /// <param name="list">The record list to replace.</param>
+ /// <param name="idArray">The record IDs to be replaced.</param>
/// <privilege>http://tizen.org/privilege/contact.write</privilege>
/// <privilege>http://tizen.org/privilege/callhistory.write</privilege>
/// <feature>http://tizen.org/feature/contact</feature>
- /// <exception cref="InvalidOperationException">Thrown when method failed due to invalid operation</exception>
- /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
- /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid</exception>
- /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory</exception>
- /// <exception cref="UnauthorizedAccessException">Thrown when application does not have proper privileges</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the method failed due to an invalid operation.</exception>
+ /// <exception cref="NotSupportedException">Thrown when feature is not supported.</exception>
+ /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid.</exception>
+ /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory.</exception>
+ /// <exception cref="UnauthorizedAccessException">Thrown when the application does not have proper privileges.</exception>
/// <since_tizen> 4 </since_tizen>
[SuppressMessage("Microsoft.Performance", "CA1822:MarkMembersAsStatic")]
public void Replace(ContactsList list, int[] idArray)
}
/// <summary>
- /// Retrieves all records as a list.
+ /// Retrieves all the records as a list.
/// </summary>
- /// <param name="viewUri">The view URI to get records</param>
- /// <param name="offset">The index from which results</param>
- /// <param name="limit">The number to limit results(value 0 is used for all records)</param>
+ /// <param name="viewUri">The view URI to get records.</param>
+ /// <param name="offset">The index from which results.</param>
+ /// <param name="limit">The number to limit results (value 0 is used for get all records).</param>
/// <returns>
- /// The record list
+ /// The record list.
/// </returns>
/// <privilege>http://tizen.org/privilege/contact.read</privilege>
/// <privilege>http://tizen.org/privilege/callhistory.read</privilege>
/// <feature>http://tizen.org/feature/contact</feature>
- /// <exception cref="InvalidOperationException">Thrown when method failed due to invalid operation</exception>
- /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
- /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid</exception>
- /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory</exception>
- /// <exception cref="UnauthorizedAccessException">Thrown when application does not have proper privileges</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the method failed due to an invalid operation.</exception>
+ /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
+ /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid.</exception>
+ /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory.</exception>
+ /// <exception cref="UnauthorizedAccessException">Thrown when the application does not have proper privileges.</exception>
/// <since_tizen> 4 </since_tizen>
[SuppressMessage("Microsoft.Performance", "CA1822:MarkMembersAsStatic")]
[SuppressMessage("Microsoft.Design", "CA1054:UriParametersShouldNotBeStrings")]
}
/// <summary>
- /// Retrieves records using a query.
+ /// Retrieves the records using a query.
/// </summary>
- /// <param name="query">The query to filter the results</param>
- /// <param name="offset">The index from which to get results</param>
- /// <param name="limit">The number to limit results(value 0 is used for get all records)</param>
+ /// <param name="query">The query to filter the results.</param>
+ /// <param name="offset">The index from which to get results.</param>
+ /// <param name="limit">The number to limit results (value 0 is used for get all records).</param>
/// <returns>
/// The record list
/// </returns>
/// <privilege>http://tizen.org/privilege/contact.read</privilege>
/// <privilege>http://tizen.org/privilege/callhistory.read</privilege>
/// <feature>http://tizen.org/feature/contact</feature>
- /// <exception cref="InvalidOperationException">Thrown when method failed due to invalid operation</exception>
- /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
- /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid</exception>
- /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory</exception>
- /// <exception cref="UnauthorizedAccessException">Thrown when application does not have proper privileges</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the method failed due to an invalid operation.</exception>
+ /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
+ /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid.</exception>
+ /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory.</exception>
+ /// <exception cref="UnauthorizedAccessException">Thrown when the application does not have proper privileges.</exception>
/// <since_tizen> 4 </since_tizen>
[SuppressMessage("Microsoft.Performance", "CA1822:MarkMembersAsStatic")]
public ContactsList GetRecordsWithQuery(ContactsQuery query, int offset, int limit)
}
/// <summary>
- /// Retrieves records changes since the given database version.
+ /// Retrieves the records changes since the given database version.
/// </summary>
- /// <param name="viewUri">The view URI to get records</param>
- /// <param name="addressBookId">The address book ID to filter</param>
- /// <param name="contactsDBVersion">The contacts database version</param>
- /// <param name="currentDBVersion">The current contacts database version</param>
+ /// <param name="viewUri">The view URI to get records.</param>
+ /// <param name="addressBookId">The address book ID to filter.</param>
+ /// <param name="contactsDBVersion">The contacts database version.</param>
+ /// <param name="currentDBVersion">The current contacts database version.</param>
/// <returns>
- /// The record list
+ /// The record list.
/// </returns>
/// <privilege>http://tizen.org/privilege/contact.read</privilege>
/// <feature>http://tizen.org/feature/contact</feature>
- /// <exception cref="InvalidOperationException">Thrown when method failed due to invalid operation</exception>
- /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
- /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid</exception>
- /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory</exception>
- /// <exception cref="UnauthorizedAccessException">Thrown when application does not have proper privileges</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the method failed due to an invalid operation.</exception>
+ /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
+ /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid.</exception>
+ /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory.</exception>
+ /// <exception cref="UnauthorizedAccessException">Thrown when the application does not have proper privileges.</exception>
/// <since_tizen> 4 </since_tizen>
[SuppressMessage("Microsoft.Performance", "CA1822:MarkMembersAsStatic")]
[SuppressMessage("Microsoft.Design", "CA1054:UriParametersShouldNotBeStrings")]
}
/// <summary>
- /// Finds records based on a given keyword.
+ /// Finds the records based on a given keyword.
/// </summary>
/// <remarks>
- /// 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.
/// </remarks>
- /// <param name="viewUri">The view URI to find records</param>
- /// <param name="keyword">The keyword</param>
- /// <param name="offset">The index from which to get results</param>
- /// <param name="limit">The number to limit results(value 0 is used for get all records)</param>
+ /// <param name="viewUri">The view URI to find records.</param>
+ /// <param name="keyword">The keyword.</param>
+ /// <param name="offset">The index from which to get results.</param>
+ /// <param name="limit">The number to limit results (value 0 is used for get all records).</param>
/// <returns>The record list</returns>
/// <privilege>http://tizen.org/privilege/contact.read</privilege>
/// <feature>http://tizen.org/feature/contact</feature>
- /// <exception cref="InvalidOperationException">Thrown when method failed due to invalid operation</exception>
- /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
- /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid</exception>
- /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory</exception>
- /// <exception cref="UnauthorizedAccessException">Thrown when application does not have proper privileges</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the method failed due to an invalid operation.</exception>
+ /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
+ /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid.</exception>
+ /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory.</exception>
+ /// <exception cref="UnauthorizedAccessException">Thrown when the application does not have proper privileges.</exception>
/// <since_tizen> 4 </since_tizen>
[SuppressMessage("Microsoft.Performance", "CA1822:MarkMembersAsStatic")]
[SuppressMessage("Microsoft.Design", "CA1054:UriParametersShouldNotBeStrings")]
}
/// <summary>
- /// Finds records based on given query and keyword.
+ /// Finds the records based on a given query and keyword.
/// </summary>
/// <remarks>
- /// 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.
/// </remarks>
- /// <param name="query">The query to filter</param>
- /// <param name="keyword">The keyword</param>
- /// <param name="offset">The index from which to get results</param>
- /// <param name="limit">The number to limit results(value 0 used for get all records)</param>
- /// <returns>The record list</returns>
+ /// <param name="query">The query to filter.</param>
+ /// <param name="keyword">The keyword.</param>
+ /// <param name="offset">The index from which to get results.</param>
+ /// <param name="limit">The number to limit results (value 0 is used for get all records).</param>
+ /// <returns>The record list.</returns>
/// <privilege>http://tizen.org/privilege/contact.read</privilege>
/// <feature>http://tizen.org/feature/contact</feature>
- /// <exception cref="InvalidOperationException">Thrown when method failed due to invalid operation</exception>
- /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
- /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid</exception>
- /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory</exception>
- /// <exception cref="UnauthorizedAccessException">Thrown when application does not have proper privileges</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the method failed due to an invalid operation.</exception>
+ /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
+ /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid.</exception>
+ /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory.</exception>
+ /// <exception cref="UnauthorizedAccessException">Thrown when the application does not have proper privileges.</exception>
/// <since_tizen> 4 </since_tizen>
[SuppressMessage("Microsoft.Performance", "CA1822:MarkMembersAsStatic")]
public ContactsList Search(ContactsQuery query, string keyword, int offset, int limit)
}
/// <summary>
- /// Finds records based on a keyword and range.
+ /// Finds the records based on a keyword and range.
/// </summary>
/// <remarks>
- /// 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.
/// </remarks>
- /// <param name="viewUri">The view URI</param>
- /// <param name="keyword">The keyword</param>
- /// <param name="offset">The index from which to get results</param>
- /// <param name="limit">The number to limit results(value 0 is used for get all records)</param>
- /// <param name="range">The search range, it should be a element of SearchRange or bitwise OR operation of them</param>
- /// <returns>The record list</returns>
+ /// <param name="viewUri">The view URI.</param>
+ /// <param name="keyword">The keyword.</param>
+ /// <param name="offset">The index from which to get results.</param>
+ /// <param name="limit">The number to limit results (value 0 is used for get all records).</param>
+ /// <param name="range">The search range should be an element of the SearchRange or bitwise OR operation of them.</param>
+ /// <returns>The record list.</returns>
/// <privilege>http://tizen.org/privilege/contact.read</privilege>
/// <feature>http://tizen.org/feature/contact</feature>
- /// <exception cref="InvalidOperationException">Thrown when method failed due to invalid operation</exception>
- /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
- /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid</exception>
- /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory</exception>
- /// <exception cref="UnauthorizedAccessException">Thrown when application does not have proper privileges</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the method failed due to an invalid operation.</exception>
+ /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
+ /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid.</exception>
+ /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory.</exception>
+ /// <exception cref="UnauthorizedAccessException">Thrown when the application does not have proper privileges.</exception>
/// <since_tizen> 4 </since_tizen>
[SuppressMessage("Microsoft.Performance", "CA1822:MarkMembersAsStatic")]
[SuppressMessage("Microsoft.Design", "CA1054:UriParametersShouldNotBeStrings")]
}
/// <summary>
- /// Finds records based on a given keyword for snippet
+ /// Finds the records based on a given keyword for the snippet.
/// </summary>
/// <remarks>
- /// 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).
/// </remarks>
- /// <param name="viewUri">The view URI to find records</param>
- /// <param name="keyword">The keyword</param>
- /// <param name="offset">The index from which to get results</param>
- /// <param name="limit">The number to limit results(value 0 used for get all records)</param>
- /// <param name="startMatch">The text which is inserted into the fragment before the keyword(If NULL, default is "[")</param>
- /// <param name="endMatch">The text which is inserted into the fragment after the keyword(If NULL, default is "]")</param>
- /// <param name="tokenNumber">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")</param>
+ /// <param name="viewUri">The view URI to find records.</param>
+ /// <param name="keyword">The keyword.</param>
+ /// <param name="offset">The index from which to get results.</param>
+ /// <param name="limit">The number to limit results (value 0 is used for get all records).</param>
+ /// <param name="startMatch">The text, which is inserted into the fragment before the keyword (If NULL, default is "[".)</param>
+ /// <param name="endMatch">The text, which is inserted into the fragment after the keyword (If NULL, default is "]")</param>
+ /// <param name="tokenNumber">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").</param>
/// <returns>The record list</returns>
/// <privilege>http://tizen.org/privilege/contact.read</privilege>
/// <feature>http://tizen.org/feature/contact</feature>
- /// <exception cref="InvalidOperationException">Thrown when method failed due to invalid operation</exception>
- /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
- /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid</exception>
- /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory</exception>
- /// <exception cref="UnauthorizedAccessException">Thrown when application does not have proper privileges</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the method failed due to an invalid operation.</exception>
+ /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
+ /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid.</exception>
+ /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory.</exception>
+ /// <exception cref="UnauthorizedAccessException">Thrown when the application does not have proper privileges.</exception>
/// <since_tizen> 4 </since_tizen>
[SuppressMessage("Microsoft.Performance", "CA1822:MarkMembersAsStatic")]
[SuppressMessage("Microsoft.Design", "CA1054:UriParametersShouldNotBeStrings")]
}
/// <summary>
- /// Finds records based on given query and keyword for snippet.
+ /// Finds the records based on a given query and keyword for the snippet.
/// </summary>
/// <remarks>
- /// 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).
/// </remarks>
- /// <param name="query">The query to filter</param>
- /// <param name="keyword">The keyword</param>
- /// <param name="offset">The index from which to get results</param>
- /// <param name="limit">The number to limit results(value 0 used for get all records)</param>
- /// <param name="startMatch">The text which is inserted into the fragment before the keyword(If NULL, default is "[")</param>
- /// <param name="endMatch">The text which is inserted into the fragment after the keyword(If NULL, default is "]")</param>
- /// <param name="tokenNumber">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")</param>
- /// <returns>The record list</returns>
+ /// <param name="query">The query to filter.</param>
+ /// <param name="keyword">The keyword.</param>
+ /// <param name="offset">The index from which to get results.</param>
+ /// <param name="limit">The number to limit results (value 0 is used for get all records).</param>
+ /// <param name="startMatch">The text, which is inserted into the fragment before a keyword (If NULL, default is "[").</param>
+ /// <param name="endMatch">The text, which is inserted into the fragment after a keyword (If NULL, default is "]".)</param>
+ /// <param name="tokenNumber">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").</param>
+ /// <returns>The record list.</returns>
/// <privilege>http://tizen.org/privilege/contact.read</privilege>
/// <feature>http://tizen.org/feature/contact</feature>
- /// <exception cref="InvalidOperationException">Thrown when method failed due to invalid operation</exception>
- /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
- /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid</exception>
- /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory</exception>
- /// <exception cref="UnauthorizedAccessException">Thrown when application does not have proper privileges</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the method failed due to an invalid operation.</exception>
+ /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
+ /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid.</exception>
+ /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory.</exception>
+ /// <exception cref="UnauthorizedAccessException">Thrown when the application does not have proper privileges.</exception>
/// <since_tizen> 4 </since_tizen>
[SuppressMessage("Microsoft.Performance", "CA1822:MarkMembersAsStatic")]
public ContactsList Search(ContactsQuery query, string keyword, int offset, int limit, string startMatch, string endMatch, int tokenNumber)
}
/// <summary>
- /// Finds records based on a keyword and range for snippet.
+ /// Finds the records based on a keyword and range for the snippet.
/// </summary>
/// <remarks>
- /// 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).
/// </remarks>
- /// <param name="viewUri">The view URI</param>
- /// <param name="keyword">The keyword</param>
- /// <param name="offset">The index from which to get results</param>
- /// <param name="limit">The number to limit results(value 0 is used for get all records)</param>
- /// <param name="range">The search range, it should be a element of SearchRange or bitwise OR operation of them</param>
- /// <param name="startMatch">The text which is inserted into the fragment before the keyword(If NULL, default is "[")</param>
- /// <param name="endMatch">The text which is inserted into the fragment after the keyword(If NULL, default is "]")</param>
- /// <param name="tokenNumber">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")</param>
- /// <returns>The record list</returns>
+ /// <param name="viewUri">The view URI.</param>
+ /// <param name="keyword">The keyword.</param>
+ /// <param name="offset">The index from which to get results.</param>
+ /// <param name="limit">The number to limit results (value 0 is used for get all records).</param>
+ /// <param name="range">The search range should be an element of the SearchRange or bitwise OR operation of them.</param>
+ /// <param name="startMatch">The text, which is inserted into the fragment before a keyword (If NULL, default is "[").</param>
+ /// <param name="endMatch">The text, which is inserted into the fragment after a keyword (If NULL, default is "]").</param>
+ /// <param name="tokenNumber">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").</param>
+ /// <returns>The record list.</returns>
/// <privilege>http://tizen.org/privilege/contact.read</privilege>
/// <feature>http://tizen.org/feature/contact</feature>
- /// <exception cref="InvalidOperationException">Thrown when method failed due to invalid operation</exception>
- /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
- /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid</exception>
- /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory</exception>
- /// <exception cref="UnauthorizedAccessException">Thrown when application does not have proper privileges</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the method failed due to an invalid operation.</exception>
+ /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
+ /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid.</exception>
+ /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory.</exception>
+ /// <exception cref="UnauthorizedAccessException">Thrown when the application does not have proper privileges.</exception>
/// <since_tizen> 4 </since_tizen>
[SuppressMessage("Microsoft.Performance", "CA1822:MarkMembersAsStatic")]
[SuppressMessage("Microsoft.Design", "CA1054:UriParametersShouldNotBeStrings")]
}
/// <summary>
- /// Gets the number of records in a specific view
+ /// Gets the number of records in a specific view.
/// </summary>
- /// <param name="viewUri">The view URI</param>
- /// <returns>The count of records</returns>
+ /// <param name="viewUri">The view URI.</param>
+ /// <returns>The count of records.</returns>
/// <since_tizen> 4 </since_tizen>
[SuppressMessage("Microsoft.Performance", "CA1822:MarkMembersAsStatic")]
[SuppressMessage("Microsoft.Design", "CA1054:UriParametersShouldNotBeStrings")]
/// <summary>
/// Gets the number of records matching a query.
/// </summary>
- /// <param name="query">The query used for filtering the results</param>
- /// <returns>The count of records</returns>
+ /// <param name="query">The query used for filtering the results.</param>
+ /// <returns>The count of records.</returns>
/// <since_tizen> 4 </since_tizen>
[SuppressMessage("Microsoft.Performance", "CA1822:MarkMembersAsStatic")]
public int GetCount(ContactsQuery query)
}
/// <summary>
- /// Registers a EventHandler to be invoked when a record changes.
+ /// Registers an EventHandler to be invoked when a record changes.
/// </summary>
- /// <param name="viewUri">The view URI of records whose changes are monitored</param>
- /// <param name="DBChanged">The EventHandler to register</param>
+ /// <param name="viewUri">The view URI of records whose changes are monitored.</param>
+ /// <param name="DBChanged">The EventHandler to register.</param>
/// <privilege>http://tizen.org/privilege/contact.read</privilege>
/// <privilege>http://tizen.org/privilege/callhistory.read</privilege>
/// <feature>http://tizen.org/feature/contact</feature>
- /// <exception cref="InvalidOperationException">Thrown when method failed due to invalid operation</exception>
- /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
- /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid</exception>
- /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory</exception>
- /// <exception cref="UnauthorizedAccessException">Thrown when application does not have proper privileges</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the method failed due to an invalid operation.</exception>
+ /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
+ /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid.</exception>
+ /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory.</exception>
+ /// <exception cref="UnauthorizedAccessException">Thrown when the application does not have proper privileges.</exception>
/// <since_tizen> 4 </since_tizen>
[SuppressMessage("Microsoft.Design", "CA1054:UriParametersShouldNotBeStrings")]
public void AddDBChangedEventHandler(string viewUri, EventHandler<DBChangedEventArgs> DBChanged)
}
/// <summary>
- /// Deregisters a EventHandler.
+ /// Deregisters an EventHandler.
/// </summary>
- /// <param name="viewUri">The view URI of records whose changes are monitored</param>
- /// <param name="DBChanged">The EventHandler to deregister</param>
+ /// <param name="viewUri">The view URI of records whose changes are monitored.</param>
+ /// <param name="DBChanged">The EventHandler to deregister.</param>
/// <feature>http://tizen.org/feature/contact</feature>
- /// <exception cref="InvalidOperationException">Thrown when method failed due to invalid operation</exception>
- /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
- /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid</exception>
- /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the method failed due to an invalid operation.</exception>
+ /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
+ /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid.</exception>
+ /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory.</exception>
/// <since_tizen> 4 </since_tizen>
[SuppressMessage("Microsoft.Design", "CA1054:UriParametersShouldNotBeStrings")]
public void RemoveDBChangedEventHandler(string viewUri, EventHandler<DBChangedEventArgs> DBChanged)
namespace Tizen.Pims.Contacts
{
/// <summary>
- /// A filter includes the conditions for the search
+ /// A filter includes the conditions for the search.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public class ContactsFilter:IDisposable
/// <summary>
/// Creates a filter with a condition for a string type property.
/// </summary>
- /// <param name="viewUri">The view URI of a filter</param>
- /// <param name="propertyId">The property ID to add a condition</param>
- /// <param name="matchType">The match flag</param>
- /// <param name="matchValue">The match value</param>
+ /// <param name="viewUri">The view URI of a filter.</param>
+ /// <param name="propertyId">The property ID to add a condition.</param>
+ /// <param name="matchType">The match flag.</param>
+ /// <param name="matchValue">The match value.</param>
/// <feature>http://tizen.org/feature/contact</feature>
- /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
- /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid</exception>
- /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory</exception>
+ /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
+ /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid.</exception>
+ /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory.</exception>
/// <since_tizen> 4 </since_tizen>
[SuppressMessage("Microsoft.Design", "CA1054:UriParametersShouldNotBeStrings")]
public ContactsFilter(string viewUri, uint propertyId, StringMatchType matchType, string matchValue)
/// <summary>
/// Creates a filter with a condition for an integer type property.
/// </summary>
- /// <param name="viewUri">The view URI of a filter</param>
- /// <param name="propertyId">The property ID to add a condition</param>
- /// <param name="matchType">The match flag</param>
- /// <param name="matchValue">The match value</param>
+ /// <param name="viewUri">The view URI of a filter.</param>
+ /// <param name="propertyId">The property ID to add a condition.</param>
+ /// <param name="matchType">The match flag.</param>
+ /// <param name="matchValue">The match value.</param>
/// <feature>http://tizen.org/feature/contact</feature>
- /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
- /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid</exception>
- /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory</exception>
+ /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
+ /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid.</exception>
+ /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory.</exception>
/// <since_tizen> 4 </since_tizen>
[SuppressMessage("Microsoft.Design", "CA1054:UriParametersShouldNotBeStrings")]
public ContactsFilter(string viewUri, uint propertyId, IntegerMatchType matchType, int matchValue)
/// <summary>
/// Creates a filter with a condition for a long type property.
/// </summary>
- /// <param name="viewUri">The view URI of a filter</param>
- /// <param name="propertyId">The property ID to add a condition</param>
- /// <param name="matchType">The match flag</param>
- /// <param name="matchValue">The match value</param>
+ /// <param name="viewUri">The view URI of a filter.</param>
+ /// <param name="propertyId">The property ID to add a condition.</param>
+ /// <param name="matchType">The match flag.</param>
+ /// <param name="matchValue">The match value.</param>
/// <feature>http://tizen.org/feature/contact</feature>
- /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
- /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid</exception>
- /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory</exception>
+ /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
+ /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid.</exception>
+ /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory.</exception>
/// <since_tizen> 4 </since_tizen>
[SuppressMessage("Microsoft.Design", "CA1054:UriParametersShouldNotBeStrings")]
public ContactsFilter(string viewUri, uint propertyId, IntegerMatchType matchType, long matchValue)
/// <summary>
/// Creates a filter with a condition for a double type property.
/// </summary>
- /// <param name="viewUri">The view URI of a filter</param>
- /// <param name="propertyId">The property ID to add a condition</param>
- /// <param name="matchType">The match flag</param>
- /// <param name="matchValue">The match value</param>
+ /// <param name="viewUri">The view URI of a filter.</param>
+ /// <param name="propertyId">The property ID to add a condition.</param>
+ /// <param name="matchType">The match flag.</param>
+ /// <param name="matchValue">The match value.</param>
/// <feature>http://tizen.org/feature/contact</feature>
- /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
- /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid</exception>
- /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory</exception>
+ /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
+ /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid.</exception>
+ /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory.</exception>
/// <since_tizen> 4 </since_tizen>
[SuppressMessage("Microsoft.Design", "CA1054:UriParametersShouldNotBeStrings")]
public ContactsFilter(string viewUri, uint propertyId, IntegerMatchType matchType, double matchValue)
/// <summary>
/// Creates a filter with a condition for a boolean type property.
/// </summary>
- /// <param name="viewUri">The view URI of a filter</param>
- /// <param name="propertyId">The property ID to add a condition</param>
- /// <param name="matchValue">The match value</param>
+ /// <param name="viewUri">The view URI of a filter.</param>
+ /// <param name="propertyId">The property ID to add a condition.</param>
+ /// <param name="matchValue">The match value.</param>
/// <feature>http://tizen.org/feature/contact</feature>
- /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
- /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid</exception>
- /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory</exception>
+ /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
+ /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid.</exception>
+ /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory.</exception>
/// <since_tizen> 4 </since_tizen>
[SuppressMessage("Microsoft.Design", "CA1054:UriParametersShouldNotBeStrings")]
public ContactsFilter(string viewUri, uint propertyId, bool matchValue)
}
/// <summary>
- /// Destructor
+ /// The destructor.
/// </summary>
/// <since_tizen> 4 </since_tizen>
~ContactsFilter()
}
/// <summary>
- /// Enumeration for the filter match type of a string.
+ /// Enumeration for the filter match types of a string.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public enum StringMatchType
{
/// <summary>
- /// Full string, case-sensitive
+ /// Full string, case-sensitive.
/// </summary>
/// <since_tizen> 4 </since_tizen>
Exactly,
/// <summary>
- /// Full string, case-insensitive
+ /// Full string, case-insensitive.
/// </summary>
/// <since_tizen> 4 </since_tizen>
FullString,
/// <summary>
- /// Sub string, case-insensitive
+ /// Sub string, case-insensitive.
/// </summary>
/// <since_tizen> 4 </since_tizen>
Contains,
/// <summary>
- /// Start with, case-insensitive
+ /// Start with, case-insensitive.
/// </summary>
/// <since_tizen> 4 </since_tizen>
StartsWith,
/// <summary>
- /// End with, case-insensitive
+ /// End with, case-insensitive.
/// </summary>
/// <since_tizen> 4 </since_tizen>
EndsWith,
/// <summary>
- /// IS NOT NUL
+ /// Is not null.
/// </summary>
/// <since_tizen> 4 </since_tizen>
Exists,
}
/// <summary>
- /// Enumeration for the filter match type of an integer.
+ /// Enumeration for the filter match types of an integer.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public enum IntegerMatchType
/// <since_tizen> 4 </since_tizen>
LessThanOrEqual,
/// <summary>
- /// <>, this flag can yield poor performance
+ /// <>, this flag can yield poor performance.
/// </summary>
/// <since_tizen> 4 </since_tizen>
NotEqual,
/// <summary>
- /// IS NULL
+ /// Is null.
/// </summary>
/// <since_tizen> 4 </since_tizen>
None,
public enum LogicalOperator
{
/// <summary>
- /// AND
+ /// And.
/// </summary>
/// <since_tizen> 4 </since_tizen>
And,
/// <summary>
- /// OR
+ /// Or.
/// </summary>
/// <since_tizen> 4 </since_tizen>
Or,
private bool disposedValue = false; // To detect redundant calls
/// <summary>
- /// Releases all resources used by the ContactsFilter.
+ /// Releases all the resources used by the ContactsFilter.
/// </summary>
- /// <param name="disposing">Disposing by User</param>
+ /// <param name="disposing">Disposing by the user.</param>
/// <since_tizen> 4 </since_tizen>
protected virtual void Dispose(bool disposing)
{
}
/// <summary>
- /// 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.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public void Dispose()
/// <summary>
/// Adds a condition for a string type property.
/// </summary>
- /// <param name="logicalOperator">The operator type</param>
- /// <param name="propertyId">The property ID to add a condition</param>
- /// <param name="matchType">The match flag</param>
- /// <param name="matchValue">The match value</param>
+ /// <param name="logicalOperator">The operator type.</param>
+ /// <param name="propertyId">The property ID to add a condition.</param>
+ /// <param name="matchType">The match flag.</param>
+ /// <param name="matchValue">The match value.</param>
/// <feature>http://tizen.org/feature/contact</feature>
- /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
- /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid</exception>
+ /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
+ /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid.</exception>
/// <since_tizen> 4 </since_tizen>
public void AddCondition(LogicalOperator logicalOperator, uint propertyId, StringMatchType matchType, string matchValue)
{
}
/// <summary>
- /// Adds a condition for a integer type property.
+ /// Adds a condition for an integer type property.
/// </summary>
- /// <param name="logicalOperator">The operator type</param>
- /// <param name="propertyId">The property ID to add a condition</param>
- /// <param name="matchType">The match flag</param>
- /// <param name="matchValue">The match value</param>
+ /// <param name="logicalOperator">The operator type.</param>
+ /// <param name="propertyId">The property ID to add a condition.</param>
+ /// <param name="matchType">The match flag.</param>
+ /// <param name="matchValue">The match value.</param>
/// <feature>http://tizen.org/feature/contact</feature>
- /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
- /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid</exception>
+ /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
+ /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid.</exception>
/// <since_tizen> 4 </since_tizen>
public void AddCondition(LogicalOperator logicalOperator, uint propertyId, IntegerMatchType matchType, int matchValue)
{
/// <summary>
/// Adds a condition for a long type property.
/// </summary>
- /// <param name="logicalOperator">The operator type</param>
- /// <param name="propertyId">The property ID to add a condition</param>
- /// <param name="matchType">The match flag</param>
- /// <param name="matchValue">The match value</param>
+ /// <param name="logicalOperator">The operator type.</param>
+ /// <param name="propertyId">The property ID to add a condition.</param>
+ /// <param name="matchType">The match flag.</param>
+ /// <param name="matchValue">The match value.</param>
/// <feature>http://tizen.org/feature/contact</feature>
- /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
- /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid</exception>
+ /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
+ /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid.</exception>
/// <since_tizen> 4 </since_tizen>
public void AddCondition(LogicalOperator logicalOperator, uint propertyId, IntegerMatchType matchType, long matchValue)
{
/// <summary>
/// Adds a condition for a double type property.
/// </summary>
- /// <param name="logicalOperator">The operator type</param>
- /// <param name="propertyId">The property ID to add a condition</param>
- /// <param name="matchType">The match flag</param>
- /// <param name="matchValue">The match value</param>
+ /// <param name="logicalOperator">The operator type.</param>
+ /// <param name="propertyId">The property ID to add a condition.</param>
+ /// <param name="matchType">The match flag.</param>
+ /// <param name="matchValue">The match value.</param>
/// <feature>http://tizen.org/feature/contact</feature>
- /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
- /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid</exception>
+ /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
+ /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid.</exception>
/// <since_tizen> 4 </since_tizen>
public void AddCondition(LogicalOperator logicalOperator, uint propertyId, IntegerMatchType matchType, double matchValue)
{
/// <summary>
/// Adds a condition for a boolean type property.
/// </summary>
- /// <param name="logicalOperator">The operator type</param>
- /// <param name="propertyId">The property ID to add a condition</param>
- /// <param name="matchValue">The match value</param>
+ /// <param name="logicalOperator">The operator type.</param>
+ /// <param name="propertyId">The property ID to add a condition.</param>
+ /// <param name="matchValue">The match value.</param>
/// <feature>http://tizen.org/feature/contact</feature>
- /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
- /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid</exception>
+ /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
+ /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid.</exception>
/// <since_tizen> 4 </since_tizen>
public void AddCondition(LogicalOperator logicalOperator, uint propertyId, bool matchValue)
{
/// <summary>
/// Adds a child filter to a parent filter.
/// </summary>
- /// <param name="logicalOperator">The operator type</param>
- /// <param name="filter">The child filter</param>
+ /// <param name="logicalOperator">The operator type.</param>
+ /// <param name="filter">The child filter.</param>
/// <feature>http://tizen.org/feature/contact</feature>
- /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
- /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid</exception>
+ /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
+ /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid.</exception>
/// <since_tizen> 4 </since_tizen>
public void AddFilter(LogicalOperator logicalOperator, ContactsFilter filter)
{
namespace Tizen.Pims.Contacts
{
/// <summary>
- /// A list of records with the same type
+ /// A list of records with the same type.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public class ContactsList:IDisposable
/// Creates a contacts record list.
/// </summary>
/// <feature>http://tizen.org/feature/contact</feature>
- /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
- /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory</exception>
+ /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
+ /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory.</exception>
/// <since_tizen> 4 </since_tizen>
public ContactsList()
{
}
/// <summary>
- /// Destructor
+ /// The destructor.
/// </summary>
/// <since_tizen> 4 </since_tizen>
~ContactsList()
}
/// <summary>
- /// The count of contact entity.
+ /// The count of the contact entity.
/// </summary>
- /// <value>The count of contact entity.</value>
+ /// <value>The count of the contact entity.</value>
/// <since_tizen> 4 </since_tizen>
public int Count
{
private bool disposedValue = false; // To detect redundant calls
/// <summary>
- /// Releases all resources used by the ContactsList.
+ /// Releases all the resources used by the ContactsList.
/// </summary>
- /// <param name="disposing">Disposing by User</param>
+ /// <param name="disposing">Disposing by the user.</param>
/// <since_tizen> 4 </since_tizen>
protected virtual void Dispose(bool disposing)
{
}
/// <summary>
- /// 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.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public void Dispose()
/// <summary>
/// Adds a record to the contacts list.
/// </summary>
- /// <param name="record">The record to add</param>
+ /// <param name="record">The record to add.</param>
/// <feature>http://tizen.org/feature/contact</feature>
- /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
- /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid</exception>
+ /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
+ /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid.</exception>
/// <since_tizen> 4 </since_tizen>
public void AddRecord(ContactsRecord record)
{
/// <summary>
/// Removes a record from the contacts list.
/// </summary>
- /// <param name="record">The record to remove</param>
+ /// <param name="record">The record to remove.</param>
/// <feature>http://tizen.org/feature/contact</feature>
- /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
- /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid</exception>
+ /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
+ /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid.</exception>
/// <since_tizen> 4 </since_tizen>
public void RemoveRecord(ContactsRecord record)
{
/// Retrieves a record from the contacts list.
/// </summary>
/// <returns>
- /// contacts record
+ /// The contacts record.
/// </returns>
/// <feature>http://tizen.org/feature/contact</feature>
- /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
+ /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
/// <since_tizen> 4 </since_tizen>
public ContactsRecord GetCurrentRecord()
{
/// When the cursor is already at the first position, it returns false.
/// </returns>
/// <feature>http://tizen.org/feature/contact</feature>
- /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
+ /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
/// <since_tizen> 4 </since_tizen>
public bool MovePrevious()
{
/// When the cursor is already at the last position, it returns false.
/// </returns>
/// <feature>http://tizen.org/feature/contact</feature>
- /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
+ /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
/// <since_tizen> 4 </since_tizen>
public bool MoveNext()
{
/// Moves a contacts list to the first position.
/// </summary>
/// <feature>http://tizen.org/feature/contact</feature>
- /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
+ /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
/// <since_tizen> 4 </since_tizen>
public void MoveFirst()
{
/// Moves a contacts list to the last position.
/// </summary>
/// <feature>http://tizen.org/feature/contact</feature>
- /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
+ /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
/// <since_tizen> 4 </since_tizen>
public void MoveLast()
{
namespace Tizen.Pims.Contacts
{
/// <summary>
- /// Enumeration for name display order.
+ /// Enumeration for the name display order.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public enum ContactDisplayOrder
{
/// <summary>
- /// First name comes at the first
+ /// First name comes at the first.
/// </summary>
/// <since_tizen> 4 </since_tizen>
FirstLast,
/// <summary>
- /// First name comes at the last
+ /// First name comes at the last.
/// </summary>
/// <since_tizen> 4 </since_tizen>
LastFirst
};
/// <summary>
- /// Enumeration for name sorting order.
+ /// Enumeration for the name sorting order.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public enum ContactSortingOrder
{
/// <summary>
- /// Contacts are first sorted based on the first name
+ /// Contacts are first sorted based on the first name.
/// </summary>
/// <since_tizen> 4 </since_tizen>
FirstLast,
/// <summary>
- /// Contacts are first sorted based on the last name
+ /// Contacts are first sorted based on the last name.
/// </summary>
/// <since_tizen> 4 </since_tizen>
LastFirst
};
/// <summary>
- /// 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.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public class ContactsManager : IDisposable
/// Creates a ContactsManager.
/// </summary>
/// <feature>http://tizen.org/feature/contact</feature>
- /// <exception cref="InvalidOperationException">Thrown when method failed due to invalid operation</exception>
- /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the method failed due to an invalid operation.</exception>
+ /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
/// <since_tizen> 4 </since_tizen>
public ContactsManager()
{
}
/// <summary>
- /// Destructor
+ /// The destructor.
/// </summary>
/// <since_tizen> 4 </since_tizen>
~ContactsManager()
private bool disposedValue = false; // To detect redundant calls
/// <summary>
- /// Releases all resources used by the ContactsManager.
+ /// Releases all the resources used by the ContactsManager.
/// </summary>
- /// <param name="disposing">Disposing by User</param>
+ /// <param name="disposing">Disposing by the user.</param>
/// <since_tizen> 4 </since_tizen>
protected virtual void Dispose(bool disposing)
{
}
/// <summary>
- /// 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.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public void Dispose()
private EventHandler<NameSortingOrderChangedEventArgs> _nameSortingOrderChanged;
/// <summary>
- /// (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.
/// </summary>
/// <privilege>http://tizen.org/privilege/contact.read</privilege>
/// <since_tizen> 4 </since_tizen>
}
/// <summary>
- /// (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.
/// </summary>
/// <privilege>http://tizen.org/privilege/contact.read</privilege>
/// <since_tizen> 4 </since_tizen>
}
/// <summary>
- /// A ContactsDatabase
+ /// A ContactsDatabase.
/// </summary>
- /// <value>A ContactsDatabase</value>
+ /// <value>A ContactsDatabase.</value>
/// <since_tizen> 4 </since_tizen>
public ContactsDatabase Database
{
}
/// <summary>
- /// A setting value of contacts name display order
+ /// A setting value of the contacts name display order.
/// </summary>
- /// <value>A setting value of contacts name display order</value>
+ /// <value>A setting value of the contacts name display order.</value>
/// <remarks>
- /// DisplayName of contacts returned from database are determined by this property
+ /// DisplayName of the contacts returned from the database is determined by this property.
/// </remarks>
/// <privilege>http://tizen.org/privilege/contact.read</privilege>
/// <privilege>http://tizen.org/privilege/contact.write</privilege>
}
/// <summary>
- /// A setting value of contacts name sorting order
+ /// A setting value of the contacts name sorting order.
/// </summary>
- /// <value>A setting value of contacts name sorting order</value>
+ /// <value>A setting value of the contacts name sorting order.</value>
/// <remarks>
- /// 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.
/// </remarks>
/// <privilege>http://tizen.org/privilege/contact.read</privilege>
/// <privilege>http://tizen.org/privilege/contact.write</privilege>
namespace Tizen.Pims.Contacts
{
/// <summary>
- /// A query is used to retrieve data which satisfies given criteria
+ /// A query is used to retrieve the data, which satisfies a given criteria.
/// </summary>
/// <remarks>
- /// 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.
/// </remarks>
/// <since_tizen> 4 </since_tizen>
/// <summary>
/// Creates a query.
/// </summary>
- /// <param name="viewUri">The view URI of a query</param>
+ /// <param name="viewUri">The view URI of a query.</param>
/// <feature>http://tizen.org/feature/contact</feature>
- /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
- /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid</exception>
- /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory</exception>
+ /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
+ /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid.</exception>
+ /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory.</exception>
/// <since_tizen> 4 </since_tizen>
[SuppressMessage("Microsoft.Design", "CA1054:UriParametersShouldNotBeStrings")]
public ContactsQuery(string viewUri)
}
/// <summary>
- /// Destructor
+ /// The destructor.
/// </summary>
/// <since_tizen> 4 </since_tizen>
~ContactsQuery()
private bool disposedValue = false;
/// <summary>
- /// Releases all resources used by the ContactsQuery.
+ /// Releases all the resources used by the ContactsQuery.
/// </summary>
- /// <param name="disposing">Disposing by User</param>
+ /// <param name="disposing">Disposing by the user.</param>
/// <since_tizen> 4 </since_tizen>
protected virtual void Dispose(bool disposing)
{
}
/// <summary>
- /// 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.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public void Dispose()
#endregion
/// <summary>
- /// Adds property IDs for projection.
+ /// Adds the property IDs for projection.
/// </summary>
- /// <param name="propertyIdArray">The property ID array </param>
+ /// <param name="propertyIdArray">The property ID array.</param>
/// <feature>http://tizen.org/feature/contact</feature>
- /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
- /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid</exception>
+ /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
+ /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid.</exception>
/// <since_tizen> 4 </since_tizen>
public void SetProjection(uint[] propertyIdArray)
{
/// <summary>
/// Sets the "distinct" option for projection.
/// </summary>
- /// <param name="set">If true it is set, otherwise if false it is unset</param>
+ /// <param name="set">If true it is set, otherwise if false it is unset.</param>
/// <feature>http://tizen.org/feature/contact</feature>
- /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
+ /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
/// <since_tizen> 4 </since_tizen>
public void SetDistinct(bool set)
{
/// <summary>
/// Sets the filter for a query.
/// </summary>
- /// <param name="filter">The filter</param>
+ /// <param name="filter">The filter.</param>
/// <feature>http://tizen.org/feature/contact</feature>
- /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
- /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid</exception>
+ /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
+ /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid.</exception>
/// <since_tizen> 4 </since_tizen>
public void SetFilter(ContactsFilter filter)
{
/// <summary>
/// Sets the sort mode for a query.
/// </summary>
- /// <param name="propertyId">The property ID to sort</param>
- /// <param name="isAscending">If true it sorts in the ascending order, otherwise if false it sorts in the descending order</param>
+ /// <param name="propertyId">The property ID to sort.</param>
+ /// <param name="isAscending">If true it sorts in ascending order, otherwise if false it sorts in descending order.</param>
/// <feature>http://tizen.org/feature/contact</feature>
- /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
- /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid</exception>
+ /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
+ /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid.</exception>
/// <since_tizen> 4 </since_tizen>
public void SetSort(uint propertyId, bool isAscending)
{
namespace Tizen.Pims.Contacts
{
/// <summary>
- /// A record represents an actual record in the database
+ /// A record represents an actual record in the database.
/// </summary>
/// <remarks>
/// 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.
/// <summary>
/// Creates a record.
/// </summary>
- /// <param name="viewUri">The view URI</param>
+ /// <param name="viewUri">The view URI.</param>
/// <feature>http://tizen.org/feature/contact</feature>
- /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
- /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid</exception>
- /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory</exception>
+ /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
+ /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid.</exception>
+ /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory.</exception>
/// <since_tizen> 4 </since_tizen>
[SuppressMessage("Microsoft.Design", "CA1054:UriParametersShouldNotBeStrings")]
public ContactsRecord(string viewUri)
}
/// <summary>
- /// Destructor
+ /// The destructor.
/// </summary>
/// <since_tizen> 4 </since_tizen>
~ContactsRecord()
}
/// <summary>
- /// The URI of the record
+ /// The URI of the record.
/// </summary>
- /// <value>The URI of the record</value>
+ /// <value>The URI of the record.</value>
/// <since_tizen> 4 </since_tizen>
[SuppressMessage("Microsoft.Design", "CA1056:UriPropertiesShouldNotBeStrings")]
public string Uri
internal bool _disposedValue = false; // To detect redundant calls
/// <summary>
- /// Releases all resources used by the ContactsRecord.
+ /// Releases all the resources used by the ContactsRecord.
/// </summary>
- /// <param name="disposing">Disposing by User</param>
+ /// <param name="disposing">Disposing by the user.</param>
/// <since_tizen> 4 </since_tizen>
protected virtual void Dispose(bool disposing)
{
}
/// <summary>
- /// 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.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public void Dispose()
/// <summary>
/// Makes a clone of a record.
/// </summary>
- /// <returns>A cloned record</returns>
+ /// <returns>A cloned record.</returns>
/// <feature>http://tizen.org/feature/contact</feature>
- /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
- /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory</exception>
+ /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
+ /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory.</exception>
/// <since_tizen> 4 </since_tizen>
public ContactsRecord Clone()
{
/// <summary>
/// Gets a value of the property from a record.
/// </summary>
- /// <param name="propertyId">The property ID</param>
+ /// <param name="propertyId">The property ID.</param>
/// <returns>
- /// The value of the property corresponding to property id.
+ /// The value of the property corresponding to a property ID.
/// </returns>
/// <feature>http://tizen.org/feature/contact</feature>
- /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
- /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid</exception>
+ /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
+ /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid.</exception>
/// <since_tizen> 4 </since_tizen>
public T Get<T>(uint propertyId)
{
/// Sets a value of the property to a record.
/// </summary>
/// <feature>http://tizen.org/feature/contact</feature>
- /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
- /// <param name="propertyId">The property ID</param>
- /// <param name="value">The value to set</param>
- /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid</exception>
+ /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
+ /// <param name="propertyId">The property ID.</param>
+ /// <param name="value">The value to set.</param>
+ /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid.</exception>
/// <since_tizen> 4 </since_tizen>
public void Set<T>(uint propertyId, T value)
{
/// <summary>
/// Adds a child record to the parent record.
/// </summary>
- /// <param name="propertyId">The property ID</param>
- /// <param name="childRecord">The child record to add to parent record</param>
+ /// <param name="propertyId">The property ID.</param>
+ /// <param name="childRecord">The child record to add to the parent record<./param>
/// <feature>http://tizen.org/feature/contact</feature>
- /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
- /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid</exception>
+ /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
+ /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid.</exception>
/// <since_tizen> 4 </since_tizen>
public void AddChildRecord(uint propertyId, ContactsRecord childRecord)
{
/// <summary>
/// Removes a child record from the parent record.
/// </summary>
- /// <param name="propertyId">The property ID</param>
- /// <param name="childRecord">The child record to remove from parent record</param>
+ /// <param name="propertyId">The property ID.</param>
+ /// <param name="childRecord">The child record to remove from the parent record.</param>
/// <feature>http://tizen.org/feature/contact</feature>
- /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
- /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid</exception>
+ /// <exception cref="NotSupportedException">Thrown when feature is not supported.</exception>
+ /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid.</exception>
/// <since_tizen> 4 </since_tizen>
public void RemoveChildRecord(uint propertyId, ContactsRecord childRecord)
{
/// <summary>
/// Gets the number of child records of a parent record.
/// </summary>
- /// <param name="propertyId">The property ID</param>
- /// <returns>The number of child records corresponding to property ID</returns>
+ /// <param name="propertyId">The property ID.</param>
+ /// <returns>The number of child records corresponding to the property ID.</returns>
/// <feature>http://tizen.org/feature/contact</feature>
- /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
- /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid</exception>
+ /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
+ /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid.</exception>
/// <since_tizen> 4 </since_tizen>
public int GetChildRecordCount(uint propertyId)
{
}
/// <summary>
- /// Gets a child record from the parent record
+ /// Gets a child record from the parent record.
/// </summary>
- /// <param name="propertyId">The property ID</param>
- /// <param name="index">The index of child record</param>
+ /// <param name="propertyId">The property ID.</param>
+ /// <param name="index">The index of the child record.</param>
/// <returns>The record </returns>
/// <feature>http://tizen.org/feature/contact</feature>
- /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
- /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid</exception>
+ /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
+ /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid.</exception>
/// <since_tizen> 4 </since_tizen>
public ContactsRecord GetChildRecord(uint propertyId, int index)
{
}
/// <summary>
- /// Clones a child record list corresponding to property ID
+ /// Clones a child record list corresponding to the property ID.
/// </summary>
- /// <param name="propertyId">The property ID</param>
+ /// <param name="propertyId">The property ID.</param>
/// <returns>
- /// The record list
+ /// The record list.
/// </returns>
/// <feature>http://tizen.org/feature/contact</feature>
- /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
- /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid</exception>
+ /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
+ /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid.</exception>
/// <since_tizen> 4 </since_tizen>
public ContactsList CloneChildRecordList(uint propertyId)
{
using ContactsViews;
/// <summary>
- /// Delegate for getting a record parsed from a vCard file
+ /// Delegates for getting a record parsed from a vCard file.
/// </summary>
- /// <param name="record">The contacts record</param>
- /// <returns> true to continue with the next iteration of the loop, otherwise false to break out of the loop</returns>
+ /// <param name="record">The contacts record.</param>
+ /// <returns>true to continue with the next iteration of the loop, otherwise false to break out of the loop.</returns>
/// <since_tizen> 4 </since_tizen>
public delegate bool ParseCallback(ContactsRecord record);
/// <summary>
- /// A class for parsing and making vCards.
+ /// A class for parsing and making the vCards.
/// </summary>
/// <remarks>
- /// It's based on the vCard v3.0 specification
+ /// It's based on the vCard v3.0 specification.
/// </remarks>
/// <since_tizen> 4 </since_tizen>
public static class ContactsVcard
/// <summary>
/// Retrieves the vCard stream from a contacts record.
/// </summary>
- /// <param name="record">The contacts record</param>
+ /// <param name="record">The contacts record.</param>
/// <returns>
/// The vCard stream.
/// </returns>
/// <privilege>http://tizen.org/privilege/contact.read</privilege>
/// <feature>http://tizen.org/feature/contact</feature>
- /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid</exception>
- /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory</exception>
- /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
+ /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid.</exception>
+ /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory.</exception>
+ /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
/// <since_tizen> 4 </since_tizen>
public static string Compose(ContactsRecord record)
{
}
/// <summary>
- /// Retrieves all contacts with a contacts list from a vCard stream
+ /// Retrieves all the contacts with a contacts list from a vCard stream.
/// </summary>
- /// <param name="stream">The vCard stream</param>
+ /// <param name="stream">The vCard stream.</param>
/// <returns>
- /// The contacts list
+ /// The contacts list.
/// </returns>
/// <feature>http://tizen.org/feature/contact</feature>
- /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid</exception>
- /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory</exception>
- /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
+ /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid.</exception>
+ /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory.</exception>
+ /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
/// <since_tizen> 4 </since_tizen>
public static ContactsList Parse(string stream)
{
}
/// <summary>
- /// Retrieves all contacts with a record from a vCard file.
+ /// Retrieves all the contacts with a record from a vCard file.
/// </summary>
- /// <param name="path">The file path of vCard stream file</param>
- /// <param name="callback">The callback function to invoke</param>
+ /// <param name="path">The file path of a vCard stream file.</param>
+ /// <param name="callback">The callback function to invoke.</param>
/// <feature>http://tizen.org/feature/contact</feature>
- /// <exception cref="InvalidOperationException">Thrown when method failed due to invalid operation</exception>
- /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid</exception>
- /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory</exception>
- /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the method failed due to an invalid operation.</exception>
+ /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid.</exception>
+ /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory.</exception>
+ /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
/// <since_tizen> 4 </since_tizen>
public static void ParseForEach(string path, ParseCallback callback)
{
namespace ContactsViews
{
/// <summary>
- /// This namespace provides information about views with properties.
+ /// This namespace provides information about the views with properties.
/// </summary>
/// <remarks>
/// 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.
/// </remarks>
/// <since_tizen> 4 </since_tizen>
}
/// <summary>
- /// Enumeration for contact change state.
+ /// Enumeration for the contact change states.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public enum ChangeType
{
/// <summary>
- /// Inserted
+ /// Inserted.
/// </summary>
/// <since_tizen> 4 </since_tizen>
Inserted,
/// <summary>
- /// Updated
+ /// Updated.
/// </summary>
/// <since_tizen> 4 </since_tizen>
Updated,
/// <summary>
- /// Deleted
+ /// Deleted.
/// </summary>
/// <since_tizen> 4 </since_tizen>
Deleted,
}
/// <summary>
- /// Describes properties of a Address book record.
+ /// Describes the properties of an address book record.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public static class AddressBook
{
/// <summary>
- /// Identifier of this contacts address book view
+ /// Identifier of this contacts address book view.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const string Uri = "tizen.contacts_view.addressbook";
/// <summary>
- /// integer, read only, DB record ID of the address book
+ /// Integer, read only, database record ID of the address book.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Id = (uint)Property.Id.AddressBookId;
/// <summary>
- /// integer, read/write once, Account ID that the address book belongs to
+ /// Integer, read/write once, account ID that the address book belongs to.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint AccountId = (uint)Property.Id.AddressBookAccountId;
/// <summary>
- /// string, read/write, It cannot be NULL. Duplicate names are not allowed.
+ /// String, read/write, it cannot be null. Duplicate names are not allowed.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Name = (uint)Property.Id.AddressBookName;
/// <summary>
- /// integer, read/write, AddressBook mode, refer to the ModeValue
+ /// Integer, read/write, AddressBook mode, refer to the ModeValue.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Mode = (uint)Property.Id.AddressBookMode;
/// <summary>
- /// Enumeration for Address book mode.
+ /// Enumeration for the address book modes.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public enum ModeValue
{
/// <summary>
- /// All module can read and write contacts of this address_book
+ /// All modules can read and write the contacts of this address_book.
/// </summary>
/// <since_tizen> 4 </since_tizen>
None,
/// <summary>
- /// All module can only read contacts of this address_book
+ /// All modules can only read the contacts of this address_book.
/// </summary>
/// <since_tizen> 4 </since_tizen>
ReadOnly,
}
/// <summary>
- /// Describes properties of a Group record.
+ /// Describes the properties of a Group record.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public static class Group
{
/// <summary>
- /// Identifier of this contacts group view
+ /// Identifier of this contacts group view.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const string Uri = "tizen.contacts_view.group";
/// <summary>
- /// DB record ID of the group
+ /// Database record ID of the group.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Id = (uint)Property.Id.GroupId;
/// <summary>
- /// AddressBook ID that the group belongs to
+ /// AddressBook ID that the group belongs to.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint AddressBookId = (uint)Property.Id.GroupAddressBookId;
/// <summary>
- /// Group name
+ /// Group name.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Name = (uint)Property.Id.GroupName;
/// <summary>
- /// Ringtone path of the group
+ /// Ringtone path of the group.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint RingtonePath = (uint)Property.Id.GroupRingtone;
/// <summary>
- /// Image path of the group
+ /// Image path of the group.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint ImagePath = (uint)Property.Id.GroupImage;
/// <summary>
- /// Vibration path of the group
+ /// Vibration path of the group.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Vibration = (uint)Property.Id.GroupVibration;
/// <summary>
- /// Extra data for default group name
+ /// Extra data for the default group name.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint ExtraData = (uint)Property.Id.GroupExtraData;
/// <summary>
- /// The group is read only or not
+ /// The group is read-only or not.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint IsReadOnly = (uint)Property.Id.GroupIsReadOnly;
/// <summary>
- /// Message alert path of the group
+ /// Message alert path of the group.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint MessageAlert = (uint)Property.Id.GroupMessageAlert;
}
/// <summary>
- /// Describes properties of a Person record.
+ /// Describes the properties of a Person record.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public static class Person
{
/// <summary>
- /// Identifier of this contacts person view
+ /// Identifier of this contacts person view.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const string Uri = "tizen.contacts_view.person";
/// <summary>
- /// DB record ID of the person
+ /// Database record ID of the person.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Id = (uint)Property.Id.PersonId;
/// <summary>
- /// Display name of the person
+ /// Display name of the person.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint DisplayName = (uint)Property.Id.PersonDisplayName;
/// <summary>
- /// 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).
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint DisplayNameIndex = (uint)Property.Id.PersonDisplayNameIndex;
/// <summary>
- /// Display contact ID that the person belongs to
+ /// Display contact ID that the person belongs to.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint DisplayContactId = (uint)Property.Id.PersonDisplayContactId;
/// <summary>
- /// Ringtone path of the person
+ /// Ringtone path of the person.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint RingtonePath = (uint)Property.Id.PersonRingtone;
/// <summary>
- /// Image thumbnail path of the person
+ /// Image thumbnail path of the person.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint ThumbnailPath = (uint)Property.Id.PersonThumbnail;
/// <summary>
- /// Vibration path of the person
+ /// Vibration path of the person.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Vibration = (uint)Property.Id.PersonVibration;
/// <summary>
- /// Message alert path of the person
+ /// Message alert path of the person.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint MessageAlert = (uint)Property.Id.PersonMessageAlert;
/// <summary>
- /// Status of social account
+ /// Status of the social account.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Status = (uint)Property.Id.PersonStatus;
/// <summary>
- /// The person is favorite or not
+ /// The person is a favorite or not.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint IsFavorite = (uint)Property.Id.PersonIsFavorite;
/// <summary>
- /// 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.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint FavoritePriority = (uint)Property.Id.PersonFavoritePriority;
/// <summary>
- /// Link count of contact records (projection)
+ /// Link count of the contact records (projection).
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint LinkCount = (uint)Property.Id.PersonLinkCount;
/// <summary>
- /// AddressBook IDs that the person belongs to (projection)
+ /// AddressBook IDs that the person belongs to (projection).
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint AddressBookIds = (uint)Property.Id.PersonAddressBookIds;
/// <summary>
- /// The person has phone number or not
+ /// The person has a phone number or not.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint HasPhoneNumber = (uint)Property.Id.PersonHasPhoneNumber;
/// <summary>
- /// The person has email or not
+ /// The person has an email or not.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint HasEmail = (uint)Property.Id.PersonHasEmail;
/// <summary>
- /// keyword matched data type
+ /// Keyword matched data type.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint SnippetType = (uint)Property.Id.PersonSnippetType;
/// <summary>
- /// keyword matched data string
+ /// Keyword matched data string.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint SnippetString = (uint)Property.Id.PersonSnippetString;
}
/// <summary>
- /// Describes properties of a Contact record.
+ /// Describes the properties of a Contact record.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public static class Contact
{
/// <summary>
- /// Identifier of this contact view
+ /// Identifier of this contacts view.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const string Uri = "tizen.contacts_view.contact";
/// <summary>
- /// DB record ID of the contact
+ /// Database record ID of the contact.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Id = (uint)Property.Id.ContactId;
/// <summary>
- /// Display name of the contact
+ /// Display name of the contact.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint DisplayName = (uint)Property.Id.ContactDisplayName;
/// <summary>
- /// The source type of display name, refer to the DisplayNameSourceType
+ /// The source type of the display name, refer to the DisplayNameSourceType.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint DisplaySourceType = (uint)Property.Id.ContactDisplaySourceDataId;
/// <summary>
- /// AddressBook ID that the contact belongs to
+ /// AddressBook ID that the contact belongs to.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint AddressBookId = (uint)Property.Id.ContactAddressBookId;
/// <summary>
- /// Ringtone path of the contact
+ /// Ringtone path of the contact.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint RingtonePath = (uint)Property.Id.ContactRingtone;
/// <summary>
- /// Image thumbnail path of the contact
+ /// Image thumbnail path of the contact.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint ThumbnailPath = (uint)Property.Id.ContactThumbnail;
/// <summary>
- /// The contact is favorite or not
+ /// The contact is a favorite or not.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint IsFavorite = (uint)Property.Id.ContactIsFavorite;
/// <summary>
- /// The contact has phone number or not
+ /// The contact has a phone number or not.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint HasPhoneNumber = (uint)Property.Id.ContactHasPhoneNumber;
/// <summary>
- /// The contact has email or not
+ /// The contact has an email or not.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint HasEmail = (uint)Property.Id.ContactHasEmail;
/// <summary>
- /// 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.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint PersonId = (uint)Property.Id.ContactPersonId;
/// <summary>
- /// Unique identifier
+ /// Unique identifier.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint UId = (uint)Property.Id.ContactUId;
/// <summary>
- /// Vibration path of the contact
+ /// Vibration path of the contact.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Vibration = (uint)Property.Id.ContactVibration;
/// <summary>
- /// Message alert path of the contact
+ /// Message alert path of the contact.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint MessageAlert = (uint)Property.Id.ContactMessageAlert;
/// <summary>
- /// Last changed contact time
+ /// Last changed contact time.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint ChangedTime = (uint)Property.Id.ContactChangedTime;
/// <summary>
- /// 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.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint LinkMode = (uint)Property.Id.ContactLinkMode;
/// <summary>
- /// Name child record (single)
+ /// Name child record (single).
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Name = (uint)Property.Id.ContactName;
/// <summary>
- /// Company child record (multiple)
+ /// Company child record (multiple).
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Company = (uint)Property.Id.ContactCompany;
/// <summary>
- /// Note child record (multiple)
+ /// Note child record (multiple).
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Note = (uint)Property.Id.ContactNote;
/// <summary>
- /// Number child record (multiple)
+ /// Number child record (multiple).
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Number = (uint)Property.Id.ContactNumber;
/// <summary>
- /// Email child record (multiple)
+ /// Email child record (multiple).
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Email = (uint)Property.Id.ContactEmail;
/// <summary>
- /// Event child record (multiple)
+ /// Event child record (multiple).
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Event = (uint)Property.Id.ContactEvent;
/// <summary>
- /// Messenger child record (multiple)
+ /// Messenger child record (multiple).
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Messenger = (uint)Property.Id.ContactMessenger;
/// <summary>
- /// Address child record (multiple)
+ /// Address child record (multiple).
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Address = (uint)Property.Id.ContactAddress;
/// <summary>
- /// URL child record (multiple)
+ /// URL child record (multiple).
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint URL = (uint)Property.Id.ContactURL;
/// <summary>
- /// Nickname child record (multiple)
+ /// Nickname child record (multiple).
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Nickname = (uint)Property.Id.ContactNickname;
/// <summary>
- /// Profile child record (multiple)
+ /// Profile child record (multiple).
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Profile = (uint)Property.Id.ContactProfile;
/// <summary>
- /// Relationship child record (multiple)
+ /// Relationship child record (multiple).
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Relationship = (uint)Property.Id.ContactRelationship;
/// <summary>
- /// Image child record (multiple)
+ /// Image child record (multiple).
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Image = (uint)Property.Id.ContactImage;
/// <summary>
- /// GroupRelation child record (multiple)
+ /// GroupRelation child record (multiple).
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint GroupRelation = (uint)Property.Id.ContactGroupRelation;
/// <summary>
- /// Extension child record (multiple)
+ /// Extension child record (multiple).
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Extension = (uint)Property.Id.ContactExtension;
/// <summary>
- /// Sip child record (multiple)
+ /// SIP child record (multiple).
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Sip = (uint)Property.Id.ContactSip;
/// <summary>
- /// Enumeration for link mode when inserting contact.
+ /// Enumeration for the link modes when inserting the contact.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public enum LinkModeValue
{
/// <summary>
- /// Auto link immediately
+ /// Auto link immediately.
/// </summary>
/// <since_tizen> 4 </since_tizen>
Auto,
/// <summary>
- /// Do not auto link when the contact is inserted
+ /// Do not auto link when the contact is inserted.
/// </summary>
/// <since_tizen> 4 </since_tizen>
None
}
/// <summary>
- /// Enumeration for Contact display name source type.
+ /// Enumeration for the Contact display name source types.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public enum DisplayNameSourceType
{
/// <summary>
- /// Invalid source of display name
+ /// Invalid source of the display name.
/// </summary>
/// <since_tizen> 4 </since_tizen>
Invalid,
/// <summary>
- /// Produced display name from email record
+ /// Produced display name from the email record.
/// </summary>
/// <since_tizen> 4 </since_tizen>
Email,
/// <summary>
- /// Produced display name from number record
+ /// Produced display name from the number record.
/// </summary>
/// <since_tizen> 4 </since_tizen>
Number,
/// <summary>
- /// Produced display name from nickname record
+ /// Produced display name from the nickname record.
/// </summary>
/// <since_tizen> 4 </since_tizen>
Nickname,
/// <summary>
- /// Produced display name from company record
+ /// Produced display name from the company record.
/// </summary>
/// <since_tizen> 4 </since_tizen>
Company,
/// <summary>
- /// Produced display name from name record
+ /// Produced display name from the name record.
/// </summary>
/// <since_tizen> 4 </since_tizen>
Name,
}
/// <summary>
- /// Enumeration for contacts data type.
+ /// Enumeration for the contacts data types.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public enum DataType
{
/// <summary>
- /// None
+ /// None.
/// </summary>
/// <since_tizen> 4 </since_tizen>
None,
/// <summary>
- /// Name
+ /// Name.
/// </summary>
/// <since_tizen> 4 </since_tizen>
Name = 1,
/// <summary>
- /// Address
+ /// Address.
/// </summary>
/// <since_tizen> 4 </since_tizen>
Address = 2,
/// <summary>
- /// Messenger
+ /// Messenger.
/// </summary>
/// <since_tizen> 4 </since_tizen>
Messenger = 3,
/// <summary>
- /// URL
+ /// URL.
/// </summary>
/// <since_tizen> 4 </since_tizen>
URL = 4,
/// <summary>
- /// Event
+ /// Event.
/// </summary>
/// <since_tizen> 4 </since_tizen>
Event = 5,
/// <summary>
- /// Company
+ /// Company.
/// </summary>
/// <since_tizen> 4 </since_tizen>
Company = 6,
/// <summary>
- /// Nickname
+ /// Nickname.
/// </summary>
/// <since_tizen> 4 </since_tizen>
Nickname = 7,
/// <summary>
- /// Number
+ /// Number.
/// </summary>
/// <since_tizen> 4 </since_tizen>
Number = 8,
/// <summary>
- /// Email
+ /// Email.
/// </summary>
/// <since_tizen> 4 </since_tizen>
Email = 9,
/// <summary>
- /// Profile
+ /// Profile.
/// </summary>
/// <since_tizen> 4 </since_tizen>
Profile = 10,
/// <summary>
- /// Relationship
+ /// Relationship.
/// </summary>
/// <since_tizen> 4 </since_tizen>
Relationship = 11,
/// <summary>
- /// Note
+ /// Note.
/// </summary>
/// <since_tizen> 4 </since_tizen>
Note = 12,
/// <summary>
- /// Image
+ /// Image.
/// </summary>
/// <since_tizen> 4 </since_tizen>
Image = 13,
/// <summary>
- /// SIP
+ /// SIP.
/// </summary>
/// <since_tizen> 4 </since_tizen>
Sip = 14,
/// <summary>
- /// Extension
+ /// Extension.
/// </summary>
/// <since_tizen> 4 </since_tizen>
Extension = 100
}
/// <summary>
- /// Describes properties of a Simple contact record.
+ /// Describes the properties of a Simple contact record.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public static class SimpleContact
{
/// <summary>
- /// Identifier of this simple contact view
+ /// Identifier of this simple contact view.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const string Uri = "tizen.contacts_view.simple_contact";
/// <summary>
- /// DB record ID of the contact
+ /// Database record ID of the contact.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Id = (uint)Property.Id.ContactId;
/// <summary>
- /// Display name of the contact
+ /// Display name of the contact.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint DisplayName = (uint)Property.Id.ContactDisplayName;
/// <summary>
- /// The source type of display name, refer to the Contact.DisplayNameSourceType
+ /// The source type of the display name, refer to the Contact.DisplayNameSourceType
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint DisplaySourceType = (uint)Property.Id.ContactDisplaySourceDataId;
/// <summary>
- /// AddressBook that the contact belongs to
+ /// AddressBook that the contact belongs to.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint AddressBookId = (uint)Property.Id.ContactAddressBookId;
/// <summary>
- /// Ringtone path of the contact
+ /// Ringtone path of the contact.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint RingtonePath = (uint)Property.Id.ContactRingtone;
/// <summary>
- /// Image thumbnail path of the contact
+ /// Image thumbnail path of the contact.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint ThumbnailPath = (uint)Property.Id.ContactThumbnail;
/// <summary>
- /// The contact is favorite or not
+ /// The contact is a favorite or not.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint IsFavorite = (uint)Property.Id.ContactIsFavorite;
/// <summary>
- /// The contact has phone number or not
+ /// The contact has a phone number or not.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint HasPhoneNumber = (uint)Property.Id.ContactHasPhoneNumber;
/// <summary>
- /// The contact has email or not
+ /// The contact has an email or not.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint HasEmail = (uint)Property.Id.ContactHasEmail;
/// <summary>
- /// Person ID that the contact belongs to
+ /// Person ID that the contact belongs to.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint PersonId = (uint)Property.Id.ContactPersonId;
/// <summary>
- /// Unique identifier
+ /// Unique identifier.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint UId = (uint)Property.Id.ContactUId;
/// <summary>
- /// Vibration path of the contact
+ /// Vibration path of the contact.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Vibration = (uint)Property.Id.ContactVibration;
/// <summary>
- /// Message alert path of the contact
+ /// Message alert path of the contact.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint MessageAlert = (uint)Property.Id.ContactMessageAlert;
/// <summary>
- /// Last changed contact time
+ /// Last changed contact time.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint ChangedTime = (uint)Property.Id.ContactChangedTime;
}
/// <summary>
- /// Describes properties of a My profile record.
+ /// Describes the properties of My profile record.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public static class MyProfile
{
/// <summary>
- /// Identifier of this my profile view
+ /// Identifier of this my profile view.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const string Uri = "tizen.contacts_view.my_profile";
/// <summary>
- /// DB record ID of the my profile
+ /// Database record ID of the my profile.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Id = (uint)Property.Id.MyProfileId;
/// <summary>
- /// Display name of the profile
+ /// Display name of the profile.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint DisplayName = (uint)Property.Id.MyProfileDisplayName;
/// <summary>
- /// AddressBook ID that the profile belongs to
+ /// AddressBook ID that the profile belongs to.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint AddressBookId = (uint)Property.Id.MyProfileAddressBookId;
/// <summary>
- /// Image thumbnail path of the profile
+ /// Image thumbnail path of the profile.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint ThumbnailPath = (uint)Property.Id.MyProfileThumbnail;
/// <summary>
- /// Unique identifier
+ /// Unique identifier.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint UId = (uint)Property.Id.MyProfileUId;
/// <summary>
- /// Last changed profile time
+ /// Last changed profile time.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint ChangedTime = (uint)Property.Id.MyProfileChangedTime;
/// <summary>
- /// Name child record (single)
+ /// Name child record (single).
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Name = (uint)Property.Id.MyProfileName;
/// <summary>
- /// Company child record (multiple)
+ /// Company child record (multiple).
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Company = (uint)Property.Id.MyProfileCompany;
/// <summary>
- /// Note child record (multiple)
+ /// Note child record (multiple).
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Note = (uint)Property.Id.MyProfileNote;
/// <summary>
- /// Number child record (multiple)
+ /// Number child record (multiple).
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Number = (uint)Property.Id.MyProfileNumber;
/// <summary>
- /// Email child record (multiple)
+ /// Email child record (multiple).
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Email = (uint)Property.Id.MyProfileEmail;
/// <summary>
- /// Event child record (multiple)
+ /// Event child record (multiple).
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Event = (uint)Property.Id.MyProfileEvent;
/// <summary>
- /// Messenger child record (multiple)
+ /// Messenger child record (multiple).
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Messenger = (uint)Property.Id.MyProfileMessenger;
/// <summary>
- /// Address child record (multiple)
+ /// Address child record (multiple).
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Address = (uint)Property.Id.MyProfileAddress;
/// <summary>
- /// URL child record (multiple)
+ /// URL child record (multiple).
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint URL = (uint)Property.Id.MyProfileURL;
/// <summary>
- /// Nickname child record (multiple)
+ /// Nickname child record (multiple).
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Nickname = (uint)Property.Id.MyProfileNickname;
/// <summary>
- /// Profile child record (multiple)
+ /// Profile child record (multiple).
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Profile = (uint)Property.Id.MyProfileProfile;
/// <summary>
- /// Relationship child record (multiple)
+ /// Relationship child record (multiple).
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Relationship = (uint)Property.Id.MyProfileRelationship;
/// <summary>
- /// Image child record (multiple)
+ /// Image child record (multiple).
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Image = (uint)Property.Id.MyProfileImage;
/// <summary>
- /// Extension child record (multiple)
+ /// Extension child record (multiple).
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Extension = (uint)Property.Id.MyProfileExtension;
/// <summary>
- /// Sip child record (multiple)
+ /// SIP child record (multiple).
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Sip = (uint)Property.Id.MyProfileSip;
}
/// <summary>
- /// Describes properties of a Name record.
+ /// Describes the properties of a Name record.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public static class Name
{
/// <summary>
- /// Identifier of this contacts name view
+ /// Identifier of this contacts name view.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const string Uri = "tizen.contacts_view.name";
/// <summary>
- /// DB record ID of the name
+ /// Database record ID of the name.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Id = (uint)Property.Id.NameId;
/// <summary>
- /// Contacts ID that the name record belongs to
+ /// Contacts ID that the name record belongs to.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint ContactId = (uint)Property.Id.NameContactId;
/// <summary>
- /// First name
+ /// First name.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint First = (uint)Property.Id.NameFirst;
/// <summary>
- /// Last name
+ /// Last name.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Last = (uint)Property.Id.NameLast;
/// <summary>
- /// Middle name
+ /// Middle name.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Addition = (uint)Property.Id.NameAddition;
/// <summary>
- /// Suffix
+ /// Suffix.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Suffix = (uint)Property.Id.NameSuffix;
/// <summary>
- /// Prefix
+ /// Prefix.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Prefix = (uint)Property.Id.NamePrefix;
/// <summary>
- /// Pronounce the first name
+ /// Pronounce the first name.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint PhoneticFirst = (uint)Property.Id.NamePhoneticFirst;
/// <summary>
- /// Pronounce the middle name
+ /// Pronounce the middle name.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint PhoneticMiddle = (uint)Property.Id.NamePhoneticMiddle;
/// <summary>
- /// Pronounce the last name
+ /// Pronounce the last name.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint PhoneticLast = (uint)Property.Id.NamePhoneticLast;
}
/// <summary>
- /// Describes properties of a Number record.
+ /// Describes the properties of a Number record.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public static class Number
{
/// <summary>
- /// Identifier of this contacts number view
+ /// Identifier of this contacts number view.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const string Uri = "tizen.contacts_view.number";
/// <summary>
- /// DB record ID of the number
+ /// Database record ID of the number.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Id = (uint)Property.Id.NumberId;
/// <summary>
- /// Contact ID that the number belongs to
+ /// Contact ID that the number belongs to.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint ContactId = (uint)Property.Id.NumberContactId;
/// <summary>
- /// Number type, refer to the Types
+ /// Number type, refer to the Types.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Type = (uint)Property.Id.NumberType;
/// <summary>
- /// Custom number type label, when the number type is Types.Custom
+ /// Custom number type label, when the number type is Types.Custom.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Label = (uint)Property.Id.NumberLabel;
/// <summary>
- /// The number is default number or not
+ /// The number is the default number or not.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint IsDefault = (uint)Property.Id.NumberIsDefault;
/// <summary>
- /// Number
+ /// Number.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint NumberData = (uint)Property.Id.NumberNumber;
/// <summary>
- /// You can only use this property for search filter.
+ /// You can only use this property for the search filter.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint NormalizedNumber = (uint)Property.Id.NumberNormalizedNumber;
/// <summary>
- /// You can only use this property for search filter.
+ /// You can only use this property for the search filter.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint CleanedNumber = (uint)Property.Id.NumberCleanedNumber;
/// <summary>
- /// You can only use this property for search filter.
+ /// You can only use this property for the search filter.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint NumberFilter = (uint)Property.Id.NumberNumberFilter;
/// <summary>
- /// Enumeration for number type.
+ /// Enumeration for the number types.
/// </summary>
/// <since_tizen> 4 </since_tizen>
[Flags]
public enum Types
{
/// <summary>
- /// Other number type
+ /// Other number type.
/// </summary>
/// <since_tizen> 4 </since_tizen>
Other = 0,
/// <summary>
- /// Custom number type
+ /// Custom number type.
/// </summary>
/// <since_tizen> 4 </since_tizen>
Custom = 1 << 0,
/// <summary>
- /// A telephone number associated with a residence
+ /// A telephone number associated with a residence.
/// </summary>
/// <since_tizen> 4 </since_tizen>
Home = 1 << 1,
/// <summary>
- /// A telephone number associated with a place of work
+ /// A telephone number associated with a place of work.
/// </summary>
/// <since_tizen> 4 </since_tizen>
Work = 1 << 2,
/// <summary>
- /// A voice telephone number
+ /// A voice telephone number.
/// </summary>
/// <since_tizen> 4 </since_tizen>
Voice = 1 << 3,
/// <summary>
- /// A facsimile telephone number
+ /// A facsimile telephone number.
/// </summary>
/// <since_tizen> 4 </since_tizen>
Fax = 1 << 4,
/// <summary>
- /// The telephone number has voice messaging support
+ /// The telephone number has voice messaging support.
/// </summary>
/// <since_tizen> 4 </since_tizen>
Message = 1 << 5,
/// <summary>
- /// A cellular telephone number
+ /// A cellular telephone number.
/// </summary>
/// <since_tizen> 4 </since_tizen>
Cell = 1 << 6,
/// <summary>
- /// A paging device telephone number
+ /// A paging device telephone number.
/// </summary>
/// <since_tizen> 4 </since_tizen>
Pager = 1 << 7,
/// <summary>
- /// A bulletin board system telephone number
+ /// A bulletin board system telephone number.
/// </summary>
/// <since_tizen> 4 </since_tizen>
BBS = 1 << 8,
/// <summary>
- /// A MODEM connected telephone number
+ /// A modem connected telephone number.
/// </summary>
/// <since_tizen> 4 </since_tizen>
Modem = 1 << 9,
/// <summary>
- /// A car-phone telephone number
+ /// A car-phone telephone number.
/// </summary>
/// <since_tizen> 4 </since_tizen>
Car = 1 << 10,
/// <summary>
- /// An ISDN service telephone number
+ /// An ISDN service telephone number.
/// </summary>
/// <since_tizen> 4 </since_tizen>
ISDN = 1 << 11,
/// <summary>
- /// A video conferencing telephone number
+ /// A video conferencing telephone number.
/// </summary>
/// <since_tizen> 4 </since_tizen>
Video = 1 << 12,
/// <summary>
- /// A personal communication services telephone number
+ /// A personal communication services telephone number.
/// </summary>
/// <since_tizen> 4 </since_tizen>
PCS = 1 << 13,
/// <summary>
- /// A company main number
+ /// A company main number.
/// </summary>
/// <since_tizen> 4 </since_tizen>
Company = 1 << 14,
/// <summary>
- /// A radio phone number
+ /// A radio phone number.
/// </summary>
/// <since_tizen> 4 </since_tizen>
Radio = 1 << 15,
/// <summary>
- /// An additional type for main
+ /// An additional type for the main.
/// </summary>
/// <since_tizen> 4 </since_tizen>
Main = 1 << 29,
/// <summary>
- /// An additional type for assistant
+ /// An additional type for the assistant.
/// </summary>
/// <since_tizen> 4 </since_tizen>
Assistant = 1 << 30,
}
/// <summary>
- /// Describes properties of a Email record.
+ /// Describes the properties of an Email record.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public static class Email
{
/// <summary>
- /// Identifier of this contacts email view
+ /// Identifier of this contacts email view.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const string Uri = "tizen.contacts_view.email";
/// <summary>
- /// DB record ID of the email
+ /// Database record ID of the email.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Id = (uint)Property.Id.EmailId;
/// <summary>
- /// Contact ID that the email belongs to
+ /// Contact ID that the email belongs to.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint ContactId = (uint)Property.Id.EmailContactId;
/// <summary>
- /// Email type, refer to the Types
+ /// Email type, refer to the Types.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Type = (uint)Property.Id.EmailType;
/// <summary>
- /// Custom mail type label, when the email type is Types.Custom
+ /// Custom mail type label, when the email type is Types.Custom.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Label = (uint)Property.Id.EmailLabel;
/// <summary>
- /// The email is default email or not
+ /// The email is default email or not.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint IsDefault = (uint)Property.Id.EmailIsDefault;
/// <summary>
- /// Email address
+ /// Email address.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Address = (uint)Property.Id.EmailEmail;
/// <summary>
- /// Enumeration for Contact email type.
+ /// Enumeration for the contact email types.
/// </summary>
/// <since_tizen> 4 </since_tizen>
[Flags]
public enum Types
{
/// <summary>
- /// Other email type
+ /// Other email type.
/// </summary>
/// <since_tizen> 4 </since_tizen>
Other = 0,
/// <summary>
- /// Custom email type
+ /// Custom email type.
/// </summary>
/// <since_tizen> 4 </since_tizen>
Custom = 1 << 0,
/// <summary>
- /// An email address associated with a residence
+ /// An email address associated with a residence.
/// </summary>
/// <since_tizen> 4 </since_tizen>
Home = 1 << 1,
/// <summary>
- /// An email address associated with a place of work
+ /// An email address associated with a place of work.
/// </summary>
/// <since_tizen> 4 </since_tizen>
Work = 1 << 2,
/// <summary>
- /// A mobile email address
+ /// A mobile email address.
/// </summary>
/// <since_tizen> 4 </since_tizen>
Mobile = 1 << 3,
}
/// <summary>
- /// Describes properties of a Address record.
+ /// Describes the properties of an Address record.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public static class Address
{
/// <summary>
- /// Identifier of this contacts address view
+ /// Identifier of this contacts address view.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const string Uri = "tizen.contacts_view.address";
/// <summary>
- /// DB record ID of the address
+ /// Database record ID of the address.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Id = (uint)Property.Id.AddressId;
/// <summary>
- /// Contact ID that the address belongs to
+ /// Contact ID that the address belongs to.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint ContactId = (uint)Property.Id.AddressContactId;
/// <summary>
- /// Address type, refer to the Types
+ /// Address type, refer to the Types.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Type = (uint)Property.Id.AddressType;
/// <summary>
- /// Address type label, when the address type is Types.Custom
+ /// Address type label, when the address type is Types.Custom.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Label = (uint)Property.Id.AddressLabel;
/// <summary>
- /// Post office box
+ /// Post office box.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Postbox = (uint)Property.Id.AddressPostbox;
/// <summary>
- /// Postal code
+ /// Postal code.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint PostalCode = (uint)Property.Id.AddressPostalCode;
/// <summary>
- /// Region
+ /// Region.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Region = (uint)Property.Id.AddressRegion;
/// <summary>
- /// Locality
+ /// Locality.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Locality = (uint)Property.Id.AddressLocality;
/// <summary>
- /// Street
+ /// Street.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Street = (uint)Property.Id.AddressStreet;
/// <summary>
- /// Country
+ /// Country.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Country = (uint)Property.Id.AddressCountry;
/// <summary>
- /// Extended address
+ /// Extended address.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Extended = (uint)Property.Id.AddressExtended;
/// <summary>
- /// The address is default or not
+ /// The address is the default or not.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint IsDefault = (uint)Property.Id.AddressIsDefault;
/// <summary>
- /// Enumeration for Contact address type.
+ /// Enumeration for the contact address types.
/// </summary>
/// <since_tizen> 4 </since_tizen>
[Flags]
public enum Types
{
/// <summary>
- /// Other address type
+ /// Other address type.
/// </summary>
/// <since_tizen> 4 </since_tizen>
Other = 0,
/// <summary>
- /// Custom address type
+ /// Custom address type.
/// </summary>
/// <since_tizen> 4 </since_tizen>
Custom = 1 << 0,
/// <summary>
- /// A delivery address for a residence
+ /// A delivery address for a residence.
/// </summary>
/// <since_tizen> 4 </since_tizen>
Home = 1 << 1,
/// <summary>
- /// A delivery address for a place of work
+ /// A delivery address for a place of work.
/// </summary>
/// <since_tizen> 4 </since_tizen>
Work = 1 << 2,
/// <summary>
- /// A domestic delivery address
+ /// A domestic delivery address.
/// </summary>
/// <since_tizen> 4 </since_tizen>
Domestic = 1 << 3,
/// <summary>
- /// An international delivery address
+ /// An international delivery address.
/// </summary>
/// <since_tizen> 4 </since_tizen>
International = 1 << 4,
/// <summary>
- /// A postal delivery address
+ /// A postal delivery address.
/// </summary>
/// <since_tizen> 4 </since_tizen>
Postal = 1 << 5,
/// <summary>
- /// A parcel delivery address
+ /// A parcel delivery address.
/// </summary>
/// <since_tizen> 4 </since_tizen>
Parcel = 1 << 6,
}
/// <summary>
- /// Describes properties of a Note record.
+ /// Describes the properties of a Note record.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public static class Note
{
/// <summary>
- /// Identifier of this contacts note view
+ /// Identifier of this contacts note view.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const string Uri = "tizen.contacts_view.note";
/// <summary>
- /// DB record ID of the note
+ /// Database record ID of the note.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Id = (uint)Property.Id.NoteId;
/// <summary>
- /// Contact ID that the note belongs to
+ /// Contact ID that the note belongs to.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint ContactId = (uint)Property.Id.NoteContactId;
/// <summary>
- /// Note contents
+ /// Note contents.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Contents = (uint)Property.Id.NoteNote;
}
/// <summary>
- /// Describes properties of a URL record.
+ /// Describes the properties of a URL record.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public static class URL
{
/// <summary>
- /// Identifier of this contacts URL view
+ /// Identifier of this contacts URL view.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const string Uri = "tizen.contacts_view.url";
/// <summary>
- /// DB record ID of the URL
+ /// Database record ID of the URL.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Id = (uint)Property.Id.URLId;
/// <summary>
- /// Contact ID that the URL belongs to
+ /// Contact ID that the URL belongs to.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint ContactId = (uint)Property.Id.URLContactId;
/// <summary>
- /// URL type, refer to the TypeValue
+ /// URL type, refer to the TypeValue.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Type = (uint)Property.Id.URLType;
/// <summary>
- /// Custom URL type label, when the URL type is TypeValue.Custom
+ /// Custom URL type label, when the URL type is TypeValue.Custom.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Label = (uint)Property.Id.URLLabel;
/// <summary>
- /// URL
+ /// URL.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint URLData = (uint)Property.Id.URLData;
/// <summary>
- /// Enumeration for Contact URL type.
+ /// Enumeration for the Contact URL types.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public enum TypeValue
{
/// <summary>
- /// Other URL type
+ /// Other URL type.
/// </summary>
/// <since_tizen> 4 </since_tizen>
Other,
/// <summary>
- /// Custom URL type
+ /// Custom URL type.
/// </summary>
/// <since_tizen> 4 </since_tizen>
Custom,
/// <summary>
- /// Home URL type
+ /// Home URL type.
/// </summary>
/// <since_tizen> 4 </since_tizen>
Home,
/// <summary>
- /// Work URL type
+ /// Work URL type.
/// </summary>
/// <since_tizen> 4 </since_tizen>
Work,
}
/// <summary>
- /// Describes properties of a Event record.
+ /// Describes the properties of an Event record.
/// </summary>
/// <since_tizen> 4 </since_tizen>
[SuppressMessage("Microsoft.Naming", "CA1716:IdentifiersShouldNotMatchKeywords")]
public static class Event
{
/// <summary>
- /// Identifier of this contacts event view
+ /// Identifier of this contacts event view.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const string Uri = "tizen.contacts_view.event";
/// <summary>
- /// DB record ID of the event
+ /// Database record ID of the event.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Id = (uint)Property.Id.EventId;
/// <summary>
- /// Contact ID that the event belongs to
+ /// Contact ID that the event belongs to.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint ContactId = (uint)Property.Id.EventContactId;
/// <summary>
- /// Event type, refer to the TypeValue
+ /// Event type, refer to the TypeValue.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Type = (uint)Property.Id.EventType;
/// <summary>
- /// Custom event type label, when the event type is TypeValue.Custom
+ /// Custom event type label, when the event type is TypeValue.Custom.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Label = (uint)Property.Id.EventLabel;
/// <summary>
- /// 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.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Date = (uint)Property.Id.EventDate;
/// <summary>
- /// Calendar type, refer to the CalendarType
+ /// Calendar type, refer to the CalendarType.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint IsLeapMonth = (uint)Property.Id.EventIsLeapMonth;
/// <summary>
- /// Enumeration for Contact event type.
+ /// Enumeration for the Contact event types.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public enum TypeValue
{
/// <summary>
- /// Other event type
+ /// Other event type.
/// </summary>
/// <since_tizen> 4 </since_tizen>
Other,
/// <summary>
- /// Custom event type
+ /// Custom event type.
/// </summary>
/// <since_tizen> 4 </since_tizen>
Custom,
/// <summary>
- /// Birthday event type
+ /// Birthday event type.
/// </summary>
/// <since_tizen> 4 </since_tizen>
Birthday,
/// <summary>
- /// Anniversary event type
+ /// Anniversary event type.
/// </summary>
/// <since_tizen> 4 </since_tizen>
Anniversary
}
/// <summary>
- /// Enumeration for Contact event calendar type.
+ /// Enumeration for the Contact event calendar types.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public enum CalendarType
{
/// <summary>
- /// Gregorian calendar
+ /// Gregorian calendar.
/// </summary>
/// <since_tizen> 4 </since_tizen>
Gregorian,
/// <summary>
- /// Chinese calendar
+ /// Chinese calendar.
/// </summary>
/// <since_tizen> 4 </since_tizen>
Chinese
}
/// <summary>
- /// Describes properties of a Relationship record.
+ /// Describes the properties of a Relationship record.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public static class Relationship
{
/// <summary>
- /// Identifier of this relationship view
+ /// Identifier of this relationship view.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const string Uri = "tizen.contacts_view.relationship";
/// <summary>
- /// DB record ID of the relationship
+ /// Database record ID of the relationship.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Id = (uint)Property.Id.RelationshipId;
/// <summary>
- /// Contact ID that the relationship belongs to
+ /// Contact ID that the relationship belongs to.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint ContactId = (uint)Property.Id.RelationshipContactId;
/// <summary>
- /// Relationship type, refer to the TypeValue
+ /// Relationship type, refer to the TypeValue.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Type = (uint)Property.Id.RelationshipType;
/// <summary>
- /// Custom relationship type label, when the relationship type is TypeValue.Custom
+ /// Custom relationship type label, when the relationship type is TypeValue.Custom.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Label = (uint)Property.Id.RelationshipLabel;
/// <summary>
- /// Selected contact name that the relationship belongs to
+ /// Selected contact name that the relationship belongs to.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Name = (uint)Property.Id.RelationshipName;
/// <summary>
- /// Enumeration for Contact relationship type.
+ /// Enumeration for the contact relationship types.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public enum TypeValue
{
/// <summary>
- /// Other relationship type
+ /// Other relationship type.
/// </summary>
/// <since_tizen> 4 </since_tizen>
Other,
/// <summary>
- /// Assistant type
+ /// Assistant type.
/// </summary>
/// <since_tizen> 4 </since_tizen>
Assistant,
/// <summary>
- /// Brother type
+ /// Brother type.
/// </summary>
/// <since_tizen> 4 </since_tizen>
Brother,
/// <summary>
- /// Child type
+ /// Child type.
/// </summary>
/// <since_tizen> 4 </since_tizen>
Child,
/// <summary>
- /// Domestic Partner type
+ /// Domestic Partner type.
/// </summary>
/// <since_tizen> 4 </since_tizen>
DomesticPartner,
/// <summary>
- /// Father type
+ /// Father type.
/// </summary>
/// <since_tizen> 4 </since_tizen>
Father,
/// <summary>
- /// Friend type
+ /// Friend type.
/// </summary>
/// <since_tizen> 4 </since_tizen>
Friend,
/// <summary>
- /// Manager type
+ /// Manager type.
/// </summary>
/// <since_tizen> 4 </since_tizen>
Manager,
/// <summary>
- /// Mother type
+ /// Mother type.
/// </summary>
/// <since_tizen> 4 </since_tizen>
Mother,
/// <summary>
- /// Parent type
+ /// Parent type.
/// </summary>
/// <since_tizen> 4 </since_tizen>
Parent,
/// <summary>
- /// Partner type
+ /// Partner type.
/// </summary>
/// <since_tizen> 4 </since_tizen>
Partner,
/// <summary>
- /// Referred by type
+ /// Referred by type.
/// </summary>
/// <since_tizen> 4 </since_tizen>
ReferredBy,
/// <summary>
- /// Relative type
+ /// Relative type.
/// </summary>
/// <since_tizen> 4 </since_tizen>
Relative,
/// <summary>
- /// Sister type
+ /// Sister type.
/// </summary>
/// <since_tizen> 4 </since_tizen>
Sister,
/// <summary>
- /// Spouse type
+ /// Spouse type.
/// </summary>
/// <since_tizen> 4 </since_tizen>
Spouse,
/// <summary>
- /// Custom type
+ /// Custom type.
/// </summary>
/// <since_tizen> 4 </since_tizen>
Custom,
}
/// <summary>
- /// Describes properties of a Image record.
+ /// Describes the properties of an Image record.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public static class Image
{
/// <summary>
- /// Identifier of this contacts image view
+ /// Identifier of this contacts image view.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const string Uri = "tizen.contacts_view.image";
/// <summary>
- /// DB record ID of the image
+ /// Database record ID of the image.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Id = (uint)Property.Id.ImageId;
/// <summary>
- /// Contact ID that the image belongs to
+ /// Contact ID that the image belongs to.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint ContactId = (uint)Property.Id.ImageContactId;
/// <summary>
- /// Image type, refer to the TypeValue
+ /// Image type, refer to the TypeValue.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Type = (uint)Property.Id.ImageType;
/// <summary>
- /// Custom image type label, when the image type is TypeValue.Custom
+ /// Custom image type label, when the image type is TypeValue.Custom.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Label = (uint)Property.Id.ImageLabel;
/// <summary>
- /// Image thumbnail path
+ /// Image thumbnail path.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Path = (uint)Property.Id.ImagePath;
/// <summary>
- /// The Image is default or not
+ /// The image is the default or not.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint IsDefault = (uint)Property.Id.ImageIsDefault;
/// <summary>
- /// Enumeration for Contact image type.
+ /// Enumeration for the contact image types.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public enum TypeValue
{
/// <summary>
- /// Other type
+ /// Other type.
/// </summary>
/// <since_tizen> 4 </since_tizen>
Other,
/// <summary>
- /// Custom type
+ /// Custom type.
/// </summary>
/// <since_tizen> 4 </since_tizen>
Custom,
}
/// <summary>
- /// Describes properties of a Company record.
+ /// Describes the properties of a Company record.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public static class Company
{
/// <summary>
- /// Identifier of this contacts company view
+ /// Identifier of this contacts company view.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const string Uri = "tizen.contacts_view.company";
/// <summary>
- /// DB record ID of the company
+ /// Database record ID of the company.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Id = (uint)Property.Id.CompanyId;
/// <summary>
- /// Contact ID that the company belongs to
+ /// Contact ID that the company belongs to.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint ContactId = (uint)Property.Id.CompanyContactId;
/// <summary>
- /// Company type, refer to the TypeValue
+ /// Company type, refer to the TypeValue.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Type = (uint)Property.Id.CompanyType;
/// <summary>
- /// Custom company type label, when the company type is TypeValue.Custom
+ /// Custom company type label, when the company type is TypeValue.Custom.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Label = (uint)Property.Id.CompanyLabel;
/// <summary>
- /// Company name
+ /// Company name.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Name = (uint)Property.Id.CompanyName;
/// <summary>
- /// Department
+ /// Department.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Department = (uint)Property.Id.CompanyDepartment;
/// <summary>
- /// Job title
+ /// Job title.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint JobTitle = (uint)Property.Id.CompanyJobTitle;
/// <summary>
- /// Assistant name
+ /// Assistant name.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint AssistantName = (uint)Property.Id.CompanyAssistantName;
/// <summary>
- /// Role
+ /// Role.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Role = (uint)Property.Id.CompanyRole;
/// <summary>
- /// Company logo image file path
+ /// Company logo image file path.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Logo = (uint)Property.Id.CompanyLogo;
/// <summary>
- /// Company location
+ /// Company location.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Location = (uint)Property.Id.CompanyLocation;
/// <summary>
- /// Description
+ /// Description.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Description = (uint)Property.Id.CompanyDescription;
/// <summary>
- /// Pronounce the company name
+ /// Pronounce the company name.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint PhoneticName = (uint)Property.Id.CompanyPhoneticName;
/// <summary>
- /// Enumeration for Contact company type.
+ /// Enumeration for the contact company types.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public enum TypeValue
{
/// <summary>
- /// Other type
+ /// Other type.
/// </summary>
/// <since_tizen> 4 </since_tizen>
Other = 0,
/// <summary>
- /// Custom type
+ /// Custom type.
/// </summary>
/// <since_tizen> 4 </since_tizen>
Custom = 1 << 0,
/// <summary>
- /// Work type
+ /// Work type.
/// </summary>
/// <since_tizen> 4 </since_tizen>
Work = 1 << 1,
}
/// <summary>
- /// Describes properties of a Nickname record.
+ /// Describes the properties of a Nickname record.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public static class Nickname
{
/// <summary>
- /// Identifier of this contacts nickname view
+ /// Identifier of this contacts nickname view.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const string Uri = "tizen.contacts_view.nickname";
/// <summary>
- /// DB record ID of the nickname
+ /// Database record ID of the nickname.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Id = (uint)Property.Id.NicknameId;
/// <summary>
- /// Contact ID that the nickname belongs to
+ /// Contact ID that the nickname belongs to.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint ContactId = (uint)Property.Id.NicknameContactId;
/// <summary>
- /// Nickname
+ /// Nickname.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Name = (uint)Property.Id.NicknameName;
}
/// <summary>
- /// Describes properties of a Messenger record.
+ /// Describes the properties of a Messenger record.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public static class Messenger
{
/// <summary>
- /// Identifier of this contacts messenger view
+ /// Identifier of this contacts messenger view.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const string Uri = "tizen.contacts_view.messenger";
/// <summary>
- /// DB record ID of the messenger
+ /// Database record ID of the messenger.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Id = (uint)Property.Id.MessengerId;
/// <summary>
- /// Contact ID that the messenger belongs to
+ /// Contact ID that the messenger belongs to.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint ContactId = (uint)Property.Id.MessengerContactId;
/// <summary>
- /// Messenger type, refer to the TypeValue
+ /// Messenger type, refer to the TypeValue.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Type = (uint)Property.Id.MessengerType;
/// <summary>
- /// Custom messenger type label, when the messenger type is TypeValue.Custom
+ /// Custom messenger type label, when the messenger type is TypeValue.Custom.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Label = (uint)Property.Id.MessengerLabel;
/// <summary>
- /// Messenger ID (email address or email ID...)
+ /// Messenger ID (email address, email ID, and so on).
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint IMId = (uint)Property.Id.MessengerIMId;
/// <summary>
- /// Enumeration for Contact messenger type.
+ /// Enumeration for the contact messenger types.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public enum TypeValue
{
/// <summary>
- /// Other messenger type
+ /// Other messenger type.
/// </summary>
/// <since_tizen> 4 </since_tizen>
Other,
/// <summary>
- /// Custom messenger type
+ /// Custom messenger type.
/// </summary>
/// <since_tizen> 4 </since_tizen>
Custom,
/// <summary>
- /// Google messenger type
+ /// Google messenger type.
/// </summary>
/// <since_tizen> 4 </since_tizen>
Google,
/// <summary>
- /// Windows live messenger type
+ /// Windows Live messenger type.
/// </summary>
/// <since_tizen> 4 </since_tizen>
WindowsLive,
/// <summary>
- /// Yahoo messenger type
+ /// Yahoo messenger type.
/// </summary>
/// <since_tizen> 4 </since_tizen>
Yahoo,
/// <summary>
- /// Facebook messenger type
+ /// Facebook messenger type.
/// </summary>
/// <since_tizen> 4 </since_tizen>
Facebook,
/// <summary>
- /// ICQ type
+ /// ICQ type.
/// </summary>
/// <since_tizen> 4 </since_tizen>
ICQ,
/// <summary>
- /// AOL instance messenger type
+ /// AOL instance messenger type.
/// </summary>
/// <since_tizen> 4 </since_tizen>
AOL,
/// <summary>
- /// QQ type
+ /// QQ type.
/// </summary>
/// <since_tizen> 4 </since_tizen>
QQ,
/// <summary>
- /// Jabber type
+ /// Jabber type.
/// </summary>
/// <since_tizen> 4 </since_tizen>
Jabber,
/// <summary>
- /// Skype type
+ /// Skype type.
/// </summary>
/// <since_tizen> 4 </since_tizen>
Skype,
/// <summary>
- /// IRC type
+ /// IRC type.
/// </summary>
/// <since_tizen> 4 </since_tizen>
IRC,
}
/// <summary>
- /// Describes properties of a Profile record.
+ /// Describes the properties of a Profile record.
/// </summary>
/// <since_tizen> 4 </since_tizen>
[SuppressMessage("Microsoft.Naming", "CA1724:TypeNamesShouldNotMatchNamespaces")]
public static class Profile
{
/// <summary>
- /// Identifier of this contacts profile view
+ /// Identifier of this contacts profile view.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const string Uri = "tizen.contacts_view.profile";
/// <summary>
- /// DB record ID of profile
+ /// Database record ID of the profile.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Id = (uint)Property.Id.ProfileId;
/// <summary>
- /// Contacts ID that the profile belongs to
+ /// Contacts ID that the profile belongs to.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint ContactId = (uint)Property.Id.ProfileContactId;
/// <summary>
- /// Unique identifier
+ /// Unique identifier.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint UId = (uint)Property.Id.ProfileUId;
/// <summary>
- /// Profile contents
+ /// Profile contents.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Text = (uint)Property.Id.ProfileText;
/// <summary>
- /// Priority to display the profile
+ /// Priority to display the profile.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Order = (uint)Property.Id.ProfileOrder;
/// <summary>
- /// Data for app_control_set_operation
+ /// Data for app_control_set_operation.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint ServiceOperation = (uint)Property.Id.ProfileServiceOperation;
/// <summary>
- /// Data for app_control_set_mime
+ /// Data for app_control_set_mime.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Mime = (uint)Property.Id.ProfileMIME;
/// <summary>
- /// Data for app_control_set_app_id
+ /// Data for app_control_set_app_id.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint AppId = (uint)Property.Id.ProfileAppId;
/// <summary>
- /// Data for app_control_set_uri
+ /// Data for app_control_set_uri.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint ProfileUri = (uint)Property.Id.ProfileUri;
/// <summary>
- /// Data for app_control_set_category
+ /// Data for app_control_set_category.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Category = (uint)Property.Id.ProfileCategory;
/// <summary>
- /// 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.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint ExtraData = (uint)Property.Id.ProfileExtraData;
}
/// <summary>
- /// Describes properties of a Sip record.
+ /// Describes the properties of a SIP record.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public static class Sip
{
/// <summary>
- /// Identifier of this contacts sip view
+ /// Identifier of this contacts SIP view.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const string Uri = "tizen.contacts_view.sip";
/// <summary>
- /// DB record ID of the sip
+ /// Database record ID of the SIP.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Id = (uint)Property.Id.SipId;
/// <summary>
- /// Contact ID that the sip belongs to
+ /// Contact ID that the SIP belongs to.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint ContactId = (uint)Property.Id.SipContactId;
/// <summary>
- /// SIP address
+ /// SIP address.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Address = (uint)Property.Id.SipAddress;
/// <summary>
- /// sip type, refer to the TypeValue
+ /// SIP type, refer to the TypeValue.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Type = (uint)Property.Id.SipType;
/// <summary>
- /// Custom sip type label, when the sip type is TypeValue.Custom
+ /// Custom SIP type label, when the SIP type is TypeValue.Custom.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Label = (uint)Property.Id.SipLabel;
/// <summary>
- /// Enumeration for Contact SIP type.
+ /// Enumeration for the contact SIP types.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public enum TypeValue
{
/// <summary>
- /// Other SIP type
+ /// Other SIP type.
/// </summary>
/// <since_tizen> 4 </since_tizen>
Other,
/// <summary>
- /// Custom SIP type
+ /// Custom SIP type.
/// </summary>
/// <since_tizen> 4 </since_tizen>
Custom,
/// <summary>
- /// Home SIP type
+ /// Home SIP type.
/// </summary>
/// <since_tizen> 4 </since_tizen>
Home,
/// <summary>
- /// Work SIP type
+ /// Work SIP type.
/// </summary>
/// <since_tizen> 4 </since_tizen>
Work,
}
/// <summary>
- /// Describes properties of a Extension record.
+ /// Describes the properties of an Extension record.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public static class Extension
{
/// <summary>
- /// Identifier of this contacts extension view
+ /// Identifier of this contacts extension view.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const string Uri = "tizen.contacts_view.extension";
/// <summary>
- /// DB record ID of the contact extension
+ /// Database record ID of the contact extension.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Id = (uint)Property.Id.ExtensionId;
/// <summary>
- /// Contact ID that the contact extension belongs to
+ /// Contact ID that the contact extension belongs to.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint ContactId = (uint)Property.Id.ExtensionContactId;
/// <summary>
- /// The extra child record format for non-provided from contacts-service
+ /// The extra child record format for the non-provided from the contacts-service.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Data1 = (uint)Property.Id.ExtensionData1;
/// <summary>
- /// The extra child record format for non-provided from contacts-service
+ /// The extra child record format for the non-provided from the contacts-service.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Data2 = (uint)Property.Id.ExtensionData2;
/// <summary>
- /// The extra child record format for non-provided from contacts-service
+ /// The extra child record format for the non-provided from the contacts-service.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Data3 = (uint)Property.Id.ExtensionData3;
/// <summary>
- /// The extra child record format for non-provided from contacts-service
+ /// The extra child record format for the non-provided from the contacts-service.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Data4 = (uint)Property.Id.ExtensionData4;
/// <summary>
- /// The extra child record format for non-provided from contacts-service
+ /// The extra child record format for the non-provided from the contacts-service.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Data5 = (uint)Property.Id.ExtensionData5;
/// <summary>
- /// The extra child record format for non-provided from contacts-service
+ /// The extra child record format for the non-provided from the contacts-service.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Data6 = (uint)Property.Id.ExtensionData6;
/// <summary>
- /// The extra child record format for non-provided from contacts-service
+ /// The extra child record format for the non-provided from the contacts-service.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Data7 = (uint)Property.Id.ExtensionData7;
/// <summary>
- /// The extra child record format for non-provided from contacts-service
+ /// The extra child record format for the non-provided from the contacts-service.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Data8 = (uint)Property.Id.ExtensionData8;
/// <summary>
- /// The extra child record format for non-provided from contacts-service
+ /// The extra child record format for the non-provided from the contacts-service.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Data9 = (uint)Property.Id.ExtensionData9;
/// <summary>
- /// The extra child record format for non-provided from contacts-service
+ /// The extra child record format for the non-provided from thecontacts-service.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Data10 = (uint)Property.Id.ExtensionData10;
/// <summary>
- /// The extra child record format for non-provided from contacts-service
+ /// The extra child record format for the non-provided from the contacts-service.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Data11 = (uint)Property.Id.ExtensionData11;
/// <summary>
- /// The extra child record format for non-provided from contacts-service
+ /// The extra child record format for the non-provided from the contacts-service.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Data12 = (uint)Property.Id.ExtensionData12;
}
/// <summary>
- /// Describes properties of a Group relation record.
+ /// Describes the properties of a Group relation record.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public static class GroupRelation
{
/// <summary>
- /// Identifier of this relationship view
+ /// Identifier of this relationship view.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const string Uri = "tizen.contacts_view.group_relation";
/// <summary>
- /// 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).
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Id = (uint)Property.Id.GroupRelationId;
/// <summary>
- /// DB record ID of the group
+ /// Database record ID of the group.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint GroupId = (uint)Property.Id.GroupRelationGroupId;
/// <summary>
- /// DB record ID of the contact
+ /// Database record ID of the contact.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint ContactId = (uint)Property.Id.GroupRelationContactId;
/// <summary>
- /// Group name
+ /// Group name.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Name = (uint)Property.Id.GroupRelationGroupName;
}
/// <summary>
- /// Describes properties of a Speed dial record.
+ /// Describes the properties of a Speed dial record.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public static class SpeedDial
{
/// <summary>
- /// Identifier of this contact speed dial view
+ /// Identifier of this contacts speed dial view.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const string Uri = "tizen.contacts_view.speeddial";
/// <summary>
- /// Stored speed dial number
+ /// Stored speed dial number.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint SpeedDialNumber = (uint)Property.Id.SpeedDialDialNumber;
/// <summary>
- /// Number ID that the speed dial belongs to
+ /// Number ID that the speed dial belongs to.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint NumberId = (uint)Property.Id.SpeedDialNumberId;
/// <summary>
- /// Contact number of specified speed dial
+ /// Contact number of the specified speed dial.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Number = (uint)Property.Id.SpeedDialNumber;
/// <summary>
- /// 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.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint NumberLabel = (uint)Property.Id.SpeedDialNumberLabel;
/// <summary>
- /// Contact number type, refer to the Number.Types
+ /// Contact number type, refer to the Number.Types.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint NumberType = (uint)Property.Id.SpeedDialNumberType;
/// <summary>
- /// Person ID that the speed dial belongs to
+ /// Person ID that the speed dial belongs to.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint PersonId = (uint)Property.Id.SpeedDialPersonId;
/// <summary>
- /// Display name that the speed dial belongs to
+ /// Display name that the speed dial belongs to.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint DisplayName = (uint)Property.Id.SpeedDialDisplayName;
/// <summary>
- /// Image thumbnail path that the speed dial belongs to
+ /// Image thumbnail path that the speed dial belongs to.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint ThumbnailPath = (uint)Property.Id.SpeedDialThumbnail;
/// <summary>
- /// You can only use this property for search filter
+ /// You can only use this property for the search filter.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint NormalizedNumber = (uint)Property.Id.SpeedDialNormalizedNumber;
/// <summary>
- /// You can only use this property for search filter
+ /// You can only use this property for the search filter.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint CleanedNumber = (uint)Property.Id.SpeedDialCleanedNumber;
/// <summary>
- /// 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.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint NumberFilter = (uint)Property.Id.SpeedDialNumberFilter;
}
/// <summary>
- /// Describes properties of a Phone log record.
+ /// Describes the properties of a Phone log record.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public static class PhoneLog
{
/// <summary>
- /// Identifier of this phone log view
+ /// Identifier of this phone log view.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const string Uri = "tizen.contacts_view.phonelog";
/// <summary>
- /// DB record ID of phone log
+ /// Database record ID of phone log.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Id = (uint)Property.Id.PhonelogId;
/// <summary>
- /// Person ID that the phone log belongs to
+ /// Person ID that the phone log belongs to.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint PersonId = (uint)Property.Id.PhonelogPersonId;
/// <summary>
- /// Number or Email that the phone log displays
+ /// Number or email that the phone log displays.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Address = (uint)Property.Id.PhonelogAddress;
/// <summary>
- /// 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).
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint LogTime = (uint)Property.Id.PhonelogLogTime;
/// <summary>
- /// Log type, refer to the Type
+ /// Log type, refer to the Type.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint LogType = (uint)Property.Id.PhonelogLogType;
/// <summary>
- /// 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).
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint ExtraData1 = (uint)Property.Id.PhonelogExtraData1;
/// <summary>
- /// You can set the related string data (e.g. short message, subject)
+ /// You can set the related string data (For example, short message, subject).
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint ExtraData2 = (uint)Property.Id.PhonelogExtraData2;
/// <summary>
- /// You can only use this property for search filter
+ /// You can only use this property for the search filter.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint NormalizedAddress = (uint)Property.Id.PhonelogNormalizedAddress;
/// <summary>
- /// You can only use this property for search filter
+ /// You can only use this property for the search filter.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint CleanedAddress = (uint)Property.Id.PhonelogCleanedAddress;
/// <summary>
- /// You can only use this property for search filter
+ /// You can only use this property for the search filter.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint AddressFilter = (uint)Property.Id.PhonelogAddressFilter;
/// <summary>
- /// 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.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint SimSlotNo = (uint)Property.Id.PhonelogSimSlotNo;
/// <summary>
- /// Enumeration for Phone log type.
+ /// Enumeration for the phone log types.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public enum Type
{
/// <summary>
- /// None
+ /// None.
/// </summary>
/// <since_tizen> 4 </since_tizen>
None,
/// <summary>
- /// Incoming call
+ /// Incoming call.
/// </summary>
/// <since_tizen> 4 </since_tizen>
VoiceIncoming = 1,
/// <summary>
- /// Outgoing call
+ /// Outgoing call.
/// </summary>
/// <since_tizen> 4 </since_tizen>
VoiceOutgoing = 2,
/// <summary>
- /// Incoming video call
+ /// Incoming video call.
/// </summary>
/// <since_tizen> 4 </since_tizen>
VideoIncoming = 3,
/// <summary>
- /// Outgoing video call
+ /// Outgoing video call.
/// </summary>
/// <since_tizen> 4 </since_tizen>
VideoOutgoing = 4,
/// <summary>
- /// Not confirmed missed call
+ /// Not confirmed missed call.
/// </summary>
/// <since_tizen> 4 </since_tizen>
VoiceMissedUnseen = 5,
/// <summary>
- /// Confirmed missed call
+ /// Confirmed missed call.
/// </summary>
/// <since_tizen> 4 </since_tizen>
VoiceMissedSeen = 6,
/// <summary>
- /// Not confirmed missed video call
+ /// Not confirmed missed video call.
/// </summary>
/// <since_tizen> 4 </since_tizen>
VideoMissedUnseen = 7,
/// <summary>
- /// Confirmed missed video call
+ /// Confirmed missed video call.
/// </summary>
/// <since_tizen> 4 </since_tizen>
VideoMissedSeen = 8,
/// <summary>
- /// Rejected call
+ /// Rejected call.
/// </summary>
/// <since_tizen> 4 </since_tizen>
VoiceRejected = 9,
/// <summary>
- /// Rejected video call
+ /// Rejected video call.
/// </summary>
/// <since_tizen> 4 </since_tizen>
VideoRejected = 10,
/// <summary>
- /// Blocked call
+ /// Blocked call.
/// </summary>
/// <since_tizen> 4 </since_tizen>
VoiceBlocked = 11,
/// <summary>
- /// Blocked video call
+ /// Blocked video call.
/// </summary>
/// <since_tizen> 4 </since_tizen>
VideoBlocked = 12,
/// <summary>
- /// Incoming MMS
+ /// Incoming MMS.
/// </summary>
/// <since_tizen> 4 </since_tizen>
MMSIncoming = 101,
/// <summary>
- /// Outgoing MMS
+ /// Outgoing MMS.
/// </summary>
/// <since_tizen> 4 </since_tizen>
MMSOutgoing = 102,
/// <summary>
- /// Incoming SMS
+ /// Incoming SMS.
/// </summary>
/// <since_tizen> 4 </since_tizen>
SMSIncoming = 103,
/// <summary>
- /// Outgoing SMS
+ /// Outgoing SMS.
/// </summary>
/// <since_tizen> 4 </since_tizen>
SMSOutgoing = 104,
/// <summary>
- /// Blocked SMS
+ /// Blocked SMS.
/// </summary>
/// <since_tizen> 4 </since_tizen>
SMSBlocked = 105,
/// <summary>
- /// Blocked MMS
+ /// Blocked MMS.
/// </summary>
/// <since_tizen> 4 </since_tizen>
MMSBlocked = 106,
/// <summary>
- /// Received email
+ /// Received email.
/// </summary>
/// <since_tizen> 4 </since_tizen>
EmailReceived = 201,
/// <summary>
- /// Sent email
+ /// Sent email.
/// </summary>
/// <since_tizen> 4 </since_tizen>
EmailSent = 202,
}
/// <summary>
- /// Describes properties of a Contact updated information record.
+ /// Describes the properties of a Contact updated information record.
/// </summary>
/// <remarks>Read only view</remarks>
/// <since_tizen> 4 </since_tizen>
public static class ContactUpdatedInfo
{
/// <summary>
- /// Identifier of this contact updated info view
+ /// Identifier of this contacts updated information view.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const string Uri = "tizen.contacts_view.contacts_updated_info";
/// <summary>
- /// Updated contact ID
+ /// Updated contact ID.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint ContactId = (uint)Property.Id.UpdateInfoId;
/// <summary>
- /// AddressBook ID that the updated contact belongs to
+ /// AddressBook ID that the updated contact belongs to.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint AddressBookId = (uint)Property.Id.UpdateInfoAddressBookId;
/// <summary>
- /// Contact change type, refer to the ContactsViews.ChangeType
+ /// Contact change type, refer to the ContactsViews.ChangeType.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Type = (uint)Property.Id.UpdateInfoType;
/// <summary>
- /// Updated version
+ /// Updated version.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Version = (uint)Property.Id.UpdateInfoVersion;
/// <summary>
- /// Contact image is changed or not
+ /// Contact image is changed or not.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint ImageChanged = (uint)Property.Id.UpdateInfoImageChanged;
}
/// <summary>
- /// Describes properties of a My profile updated information record.
+ /// Describes the properties of a My profile updated information record.
/// </summary>
/// <remarks>Read only view</remarks>
/// <since_tizen> 4 </since_tizen>
public static class MyProfileUpdatedInfo
{
/// <summary>
- /// Identifier of this my profile updated info view
+ /// Identifier of this my profile updated information view.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const string Uri = "tizen.contacts_view.my_profile_updated_info";
/// <summary>
- /// Address book ID that the updated my profile belongs to
+ /// Address book ID that the updated my profile belongs to.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint AddressBookId = (uint)Property.Id.UpdateInfoAddressBookId;
/// <summary>
- /// MyProfile change type, refer to the ContactsViews.ChangeType
+ /// MyProfile change type, refer to the ContactsViews.ChangeType.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint LastChangedType = (uint)Property.Id.UpdateInfoLastChangedType;
/// <summary>
- /// Updated version
+ /// Updated version.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Version = (uint)Property.Id.UpdateInfoVersion;
}
/// <summary>
- /// Describes properties of a Group updated information record.
+ /// Describes the properties of a Group updated information record.
/// </summary>
/// <remarks>Read only view</remarks>
/// <since_tizen> 4 </since_tizen>
public static class GroupUpdatedInfo
{
/// <summary>
- /// Identifier of this group updated info view
+ /// Identifier of this groups updated information view.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const string Uri = "tizen.contacts_view.groups_updated_info";
/// <summary>
- /// Updated group ID
+ /// Updated group ID.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint GroupId = (uint)Property.Id.UpdateInfoId;
/// <summary>
- /// Address book ID that the updated group belongs to
+ /// Address book ID that the updated group belongs to.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint AddressBookId = (uint)Property.Id.UpdateInfoAddressBookId;
/// <summary>
- /// Group change type, refer to the ContactsViews.ChangeType
+ /// Group change type, refer to the ContactsViews.ChangeType.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Type = (uint)Property.Id.UpdateInfoType;
/// <summary>
- /// Updated version
+ /// Updated version.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Version = (uint)Property.Id.UpdateInfoVersion;
}
/// <summary>
- /// Describes properties of a Group Member updated information record.
+ /// Describes the properties of a Group Member updated information record.
/// </summary>
- /// <remarks>Read only view</remarks>
+ /// <remarks>Read-only view.</remarks>
/// <since_tizen> 4 </since_tizen>
public static class GroupMemberUpdatedInfo
{
/// <summary>
- /// Identifier of this group member updated info view
+ /// Identifier of this group members updated information view.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const string Uri = "tizen.contacts_view.groups_member_updated_info";
/// <summary>
- /// Updated group ID
+ /// Updated group ID.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint GroupId = (uint)Property.Id.UpdateInfoId;
/// <summary>
- /// Address book ID that the updated group belongs to
+ /// Address book ID that the updated group belongs to.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint AddressBookId = (uint)Property.Id.UpdateInfoAddressBookId;
/// <summary>
- /// Updated version
+ /// Updated version.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Version = (uint)Property.Id.UpdateInfoVersion;
}
/// <summary>
- /// Describes properties of a Relation updated information record.
+ /// Describes the properties of a Relation updated information record.
/// </summary>
/// <remarks>Read only view</remarks>
/// <since_tizen> 4 </since_tizen>
public static class GroupRelationUpdatedInfo
{
/// <summary>
- /// Identifier of this group relation updated info view
+ /// Identifier of this group relations updated information view.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const string Uri = "tizen.contacts_view.group_relations_updated_info";
/// <summary>
- /// Group ID of group relation
+ /// Group ID of the group relation.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint GroupId = (uint)Property.Id.GroupId;
/// <summary>
- /// Contact ID of the updated group relation
+ /// Contact ID of the updated group relation.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint ContactId = (uint)Property.Id.ContactId;
/// <summary>
- /// Address book ID of contact that the updated group relation
+ /// Address book ID of the contacts updated group relation.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint AddressBookId = (uint)Property.Id.AddressBookId;
/// <summary>
- /// Group relation change type, refer to the ContactsViews.ChangeType
+ /// Group relation change type, refer to the ContactsViews.ChangeType.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Type = (uint)Property.Id.UpdateInfoType;
/// <summary>
- /// Updated version
+ /// Updated version.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Version = (uint)Property.Id.UpdateInfoVersion;
}
/// <summary>
- /// Describes properties of a PersonContact record.
+ /// Describes the properties of a PersonContact record.
/// </summary>
/// <remarks>Read only view</remarks>
/// <since_tizen> 4 </since_tizen>
public static class PersonContact
{
/// <summary>
- /// Identifier of this person contact view
+ /// Identifier of this person's contact view.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const string Uri = "tizen.contacts_view.person/simple_contact";
/// <summary>
- /// DB record ID of the person
+ /// Database record ID of the person.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint PersonId = (uint)Property.Id.PersonId;
/// <summary>
- /// Display name of the person
+ /// Display name of the person.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint DisplayName = (uint)Property.Id.PersonDisplayName;
/// <summary>
- /// 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).
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint DisplayNameIndex = (uint)Property.Id.PersonDisplayNameIndex;
/// <summary>
- /// Display contact ID that the person belongs to (projection)
+ /// Display contact ID that the person belongs to (projection).
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint DisplayContactId = (uint)Property.Id.PersonDisplayContactId;
/// <summary>
- /// Ringtone path of the person (projection)
+ /// Ringtone path of the person (projection).
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint RingtonePath = (uint)Property.Id.PersonRingtone;
/// <summary>
- /// Image thumbnail path of the person (projection)
+ /// Image thumbnail path of the person (projection).
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint ThumbnailPath = (uint)Property.Id.PersonThumbnail;
/// <summary>
- /// Vibration path of the person (projection)
+ /// Vibration path of the person (projection).
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Vibration = (uint)Property.Id.PersonVibration;
/// <summary>
- /// Message alert path of the person (projection)
+ /// Message alert path of the person (projection).
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint MessageAlert = (uint)Property.Id.PersonMessageAlert;
/// <summary>
- /// Status of social account (projection)
+ /// Status of the social account (projection).
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Status = (uint)Property.Id.PersonStatus;
/// <summary>
- /// The person is favorite or not
+ /// The person is a favorite or not.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint IsFavorite = (uint)Property.Id.PersonIsFavorite;
/// <summary>
- /// Link count of contact records (projection)
+ /// Link count of the contact records (projection).
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint LinkCount = (uint)Property.Id.PersonLinkCount;
/// <summary>
- /// Contact ID that the person belongs to
+ /// Contact ID that the person belongs to.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint ContactId = (uint)Property.Id.ContactId;
/// <summary>
- /// AddressBook IDs that the person belongs to (projection)
+ /// AddressBook IDs that the person belongs to (projection).
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint AddressBookIds = (uint)Property.Id.PersonAddressBookIds;
/// <summary>
- /// The person has phone number or not
+ /// The person has a phone number or not.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint HasPhoneNumber = (uint)Property.Id.PersonHasPhoneNumber;
/// <summary>
- /// The person has email or not
+ /// The person has an email or not.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint HasEmail = (uint)Property.Id.PersonHasEmail;
/// <summary>
- /// AddressBook ID that the person belongs to
+ /// AddressBook ID that the person belongs to.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint AddressBookId = (uint)Property.Id.ContactAddressBookId;
/// <summary>
- /// AddressBook mode, refer to the AddressBook.Mode
+ /// AddressBook mode, refer to the AddressBook.Mode.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint AddressBookMode = (uint)Property.Id.AddressBookMode;
/// <summary>
- /// AddressBook name that the person belongs to
+ /// AddressBook name that the person belongs to.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint AddressBookName = (uint)Property.Id.AddressBookName;
/// <summary>
- /// keyword matched data type, refer to the Contact.DataType
+ /// Keyword matched data type, refer to the Contact.DataType.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint SnippetType = (uint)Property.Id.PersonSnippetType;
/// <summary>
- /// keyword matched data string
+ /// Keyword matched data string.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint SnippetString = (uint)Property.Id.PersonSnippetString;
};
/// <summary>
- /// Describes properties of a PersonNumber record.
+ /// Describes the properties of a PersonNumber record.
/// </summary>
/// <remarks>Read only view</remarks>
/// <since_tizen> 4 </since_tizen>
public static class PersonNumber
{
/// <summary>
- /// Identifier of this person number view
+ /// Identifier of this person's number view.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const string Uri = "tizen.contacts_view.person/simple_contact/number";
/// <summary>
- /// DB record ID of the person
+ /// Database record ID of the person.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint PersonId = (uint)Property.Id.PersonId;
/// <summary>
- /// Display name of the person
+ /// Display name of the person.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint DisplayName = (uint)Property.Id.PersonDisplayName;
/// <summary>
- /// 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).
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint DisplayNameIndex = (uint)Property.Id.PersonDisplayNameIndex;
/// <summary>
- /// Display contact ID that the person belongs to (projection)
+ /// Display contact ID that the person belongs to (projection).
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint DisplayContactId = (uint)Property.Id.PersonDisplayContactId;
/// <summary>
- /// Ringtone path of the person (projection)
+ /// Ringtone path of the person (projection).
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint RingtonePath = (uint)Property.Id.PersonRingtone;
/// <summary>
- /// Image thumbnail path of the person (projection)
+ /// Image thumbnail path of the person (projection).
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint ThumbnailPath = (uint)Property.Id.PersonThumbnail;
/// <summary>
- /// Vibration path of the person (projection)
+ /// Vibration path of the person (projection).
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Vibration = (uint)Property.Id.PersonVibration;
/// <summary>
- /// Message alert path of the person (projection)
+ /// Message alert path of the person (projection).
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint MessageAlert = (uint)Property.Id.PersonMessageAlert;
/// <summary>
- /// The person is favorite or not
+ /// The person is a favorite or not.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint IsFavorite = (uint)Property.Id.PersonIsFavorite;
/// <summary>
- /// The person has phone number or not
+ /// The person has a phone number or not.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint HasPhoneNumber = (uint)Property.Id.PersonHasPhoneNumber;
/// <summary>
- /// The person has email or not
+ /// The person has an email or not.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint HasEmail = (uint)Property.Id.PersonHasEmail;
/// <summary>
- /// Number ID that the person belongs to
+ /// Number ID that the person belongs to.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint NumberId = (uint)Property.Id.NumberId;
/// <summary>
- /// Number type, refer to the Number.Types (projection)
+ /// Number type, refer to the Number.Types (projection).
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Type = (uint)Property.Id.NumberType;
/// <summary>
- /// 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).
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Label = (uint)Property.Id.NumberLabel;
/// <summary>
- /// The number is default number or not
+ /// The number is the default number or not.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint IsPrimaryDefault = (uint)Property.Id.DataIsPrimaryDefault;
/// <summary>
- /// Number
+ /// Number.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Number = (uint)Property.Id.NumberNumber;
/// <summary>
- /// 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.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint NumberFilter = (uint)Property.Id.NumberNumberFilter;
/// <summary>
- /// You can only use this property for search filter
+ /// You can only use this property for the search filter.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint NormalizedNumber = (uint)Property.Id.NumberNormalizedNumber;
/// <summary>
- /// You can only use this property for search filter
+ /// You can only use this property for the search filter.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint CleanedNumber = (uint)Property.Id.NumberCleanedNumber;
/// <summary>
- /// keyword matched data type, refer to they Contact.DataType
+ /// Keyword matched data type, refer to they Contact.DataType.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint SnippetType = (uint)Property.Id.PersonSnippetType;
/// <summary>
- /// keyword matched data string
+ /// Keyword matched data string.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint SnippetString = (uint)Property.Id.PersonSnippetString;
};
/// <summary>
- /// Describes properties of a PersonEmail record.
+ /// Describes the properties of a PersonEmail record.
/// </summary>
/// <remarks>Read only view</remarks>
/// <since_tizen> 4 </since_tizen>
public static class PersonEmail
{
/// <summary>
- /// Identifier of this person email view
+ /// Identifier of this person's email view.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const string Uri = "tizen.contacts_view.person/simple_contact/email";
/// <summary>
- /// DB record ID of the person
+ /// Database record ID of the person.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint PersonId = (uint)Property.Id.PersonId;
/// <summary>
- /// Display name of the person
+ /// Display name of the person.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint DisplayName = (uint)Property.Id.PersonDisplayName;
/// <summary>
- /// 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).
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint DisplayNameIndex = (uint)Property.Id.PersonDisplayNameIndex;
/// <summary>
- /// Display contact ID that the person belongs to (projection)
+ /// Display contact ID that the person belongs to (projection).
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint DisplayContactId = (uint)Property.Id.PersonDisplayContactId;
/// <summary>
- /// Ringtone path of the person (projection)
+ /// Ringtone path of the person (projection).
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint RingtonePath = (uint)Property.Id.PersonRingtone;
/// <summary>
- /// Image thumbnail path of the person (projection)
+ /// Image thumbnail path of the person (projection).
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint ThumbnailPath = (uint)Property.Id.PersonThumbnail;
/// <summary>
- /// Vibration path of the person (projection)
+ /// Vibration path of the person (projection).
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Vibration = (uint)Property.Id.PersonVibration;
/// <summary>
- /// Message alert path of the person (projection)
+ /// Message alert path of the person (projection).
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint MessageAlert = (uint)Property.Id.PersonMessageAlert;
/// <summary>
- /// The person is favorite or not
+ /// The person is a favorite or not.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint IsFavorite = (uint)Property.Id.PersonIsFavorite;
/// <summary>
- /// The person has phone number or not
+ /// The person has a phone number or not.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint HasPhoneNumber = (uint)Property.Id.PersonHasPhoneNumber;
/// <summary>
- /// The person has email or not
+ /// The person has an email or not.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint HasEmail = (uint)Property.Id.PersonHasEmail;
/// <summary>
- /// Email ID that the person belongs to
+ /// Email ID that the person belongs to.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint EmailId = (uint)Property.Id.EmailId;
/// <summary>
- /// Email type, refer to the Email.Types (projection)
+ /// Email type, refer to the Email.Types (projection).
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Type = (uint)Property.Id.EmailType;
/// <summary>
- /// 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).
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Label = (uint)Property.Id.EmailLabel;
/// <summary>
- /// The email is default email or not
+ /// The email is the default email or not.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint IsPrimaryDefault = (uint)Property.Id.DataIsPrimaryDefault;
/// <summary>
- /// Email address
+ /// Email address.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Email = (uint)Property.Id.EmailEmail;
/// <summary>
- /// keyword matched data type, refer to they Contact.DataType
+ /// Keyword matched data type, refer to they Contact.DataType.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint SnippetType = (uint)Property.Id.PersonSnippetType;
/// <summary>
- /// keyword matched data string
+ /// Keyword matched data string.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint SnippetString = (uint)Property.Id.PersonSnippetString;
};
/// <summary>
- /// Describes properties of a PersonGroupRelation record.
+ /// Describes the properties of a PersonGroupRelation record.
/// </summary>
/// <remarks>Read only view</remarks>
/// <since_tizen> 4 </since_tizen>
public static class PersonGroupRelation
{
/// <summary>
- /// Identifier of this person group relation view
+ /// Identifier of this person's group relation view.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const string Uri = "tizen.contacts_view.person/simple_contact/group";
/// <summary>
- /// DB record ID of the person
+ /// Database record ID of the person.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint PersonId = (uint)Property.Id.PersonId;
/// <summary>
- /// Display name of the person
+ /// Display name of the person.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint DisplayName = (uint)Property.Id.PersonDisplayName;
/// <summary>
- /// 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).
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint DisplayNameIndex = (uint)Property.Id.PersonDisplayNameIndex;
/// <summary>
- /// Display contact ID that the person belongs to (projection)
+ /// Display contact ID that the person belongs to (projection).
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint DisplayContactId = (uint)Property.Id.PersonDisplayContactId;
/// <summary>
- /// Ringtone path of the person (projection)
+ /// Ringtone path of the person (projection).
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint RingtonePath = (uint)Property.Id.PersonRingtone;
/// <summary>
- /// Image thumbnail path of the person (projection)
+ /// Image thumbnail path of the person (projection).
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint ThumbnailPath = (uint)Property.Id.PersonThumbnail;
/// <summary>
- /// Vibration path of the person (projection)
+ /// Vibration path of the person (projection).
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Vibration = (uint)Property.Id.PersonVibration;
/// <summary>
- /// Message alert path of the person (projection)
+ /// Message alert path of the person (projection).
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint MessageAlert = (uint)Property.Id.PersonMessageAlert;
/// <summary>
- /// Status of social account (projection)
+ /// Status of social account (projection).
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Status = (uint)Property.Id.PersonStatus;
/// <summary>
- /// The person is favorite or not
+ /// The person is a favorite or not.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint IsFavorite = (uint)Property.Id.PersonIsFavorite;
/// <summary>
- /// The person has phone number or not
+ /// The person has a phone number or not.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint HasPhoneNumber = (uint)Property.Id.PersonHasPhoneNumber;
/// <summary>
- /// The person has email or not
+ /// The person has an email or not.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint HasEmail = (uint)Property.Id.PersonHasEmail;
/// <summary>
- /// Link count of contact records (projection)
+ /// Link count of the contact records (projection).
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint LinkCount = (uint)Property.Id.PersonLinkCount;
/// <summary>
- /// AddressBook IDs that the person belongs to (projection)
+ /// AddressBook IDs that the person belongs to (projection).
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint AddressBookIds = (uint)Property.Id.PersonAddressBookIds;
/// <summary>
- /// AddressBook ID that the person belongs to
+ /// AddressBook ID that the person belongs to.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint AddressBookId = (uint)Property.Id.ContactAddressBookId;
/// <summary>
- /// AddressBook name that the person belongs to
+ /// AddressBook name that the person belongs to.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint AddressBookName = (uint)Property.Id.AddressBookName;
/// <summary>
- /// AddressBook mode, refer to the AddressBook.Mode
+ /// AddressBook mode, refer to the AddressBook.Mode.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint AddressBookMode = (uint)Property.Id.AddressBookMode;
/// <summary>
- /// Group ID that the person belongs to
+ /// Group ID that the person belongs to.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint GroupId = (uint)Property.Id.GroupRelationGroupId;
/// <summary>
- /// Contact ID that the person belongs to (projection)
+ /// Contact ID that the person belongs to (projection).
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint ContactId = (uint)Property.Id.GroupRelationContactId;
/// <summary>
- /// keyword matched data type, refer to they Contact.DataType
+ /// Keyword matched data type, refer to they Contact.DataType.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint SnippetType = (uint)Property.Id.PersonSnippetType;
/// <summary>
- /// keyword matched data string
+ /// Keyword matched data string.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint SnippetString = (uint)Property.Id.PersonSnippetString;
};
/// <summary>
- /// Describes properties of a PersonGroupAssigned record.
+ /// Describes the properties of a PersonGroupAssigned record.
/// </summary>
/// <remarks>Read only view</remarks>
/// <since_tizen> 4 </since_tizen>
public static class PersonGroupAssigned
{
/// <summary>
- /// Identifier of this person group assigned view
+ /// Identifier of this person's group assigned view.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const string Uri = "tizen.contacts_view.person/simple_contact/group_assigned";
/// <summary>
- /// DB record ID of the person
+ /// Database record ID of the person.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint PersonId = (uint)Property.Id.PersonId;
/// <summary>
- /// Display name of the person
+ /// Display name of the person.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint DisplayName = (uint)Property.Id.PersonDisplayName;
/// <summary>
- /// 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).
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint DisplayNameIndex = (uint)Property.Id.PersonDisplayNameIndex;
/// <summary>
- /// Display contact ID that the person belongs to (projection)
+ /// Display contact ID that the person belongs to (projection).
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint DisplayContactId = (uint)Property.Id.PersonDisplayContactId;
/// <summary>
- /// Ringtone path of the person (projection)
+ /// Ringtone path of the person (projection).
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint RingtonePath = (uint)Property.Id.PersonRingtone;
/// <summary>
- /// Image thumbnail path of the person (projection)
+ /// Image thumbnail path of the person (projection).
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint ThumbnailPath = (uint)Property.Id.PersonThumbnail;
/// <summary>
- /// Vibration path of the person (projection)
+ /// Vibration path of the person (projection).
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Vibration = (uint)Property.Id.PersonVibration;
/// <summary>
- /// Message alert path of the person (projection)
+ /// Message alert path of the person (projection).
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint MessageAlert = (uint)Property.Id.PersonMessageAlert;
/// <summary>
- /// Status of social account (projection)
+ /// Status of the social account (projection).
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Status = (uint)Property.Id.PersonStatus;
/// <summary>
- /// The person is favorite or not
+ /// The person is a favorite or not.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint IsFavorite = (uint)Property.Id.PersonIsFavorite;
/// <summary>
- /// The person has phone number or not
+ /// The person has a phone number or not.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint HasPhoneNumber = (uint)Property.Id.PersonHasPhoneNumber;
/// <summary>
- /// The person has email or not
+ /// The person has an email or not.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint HasEmail = (uint)Property.Id.PersonHasEmail;
/// <summary>
- /// Link count of contact records (projection)
+ /// Link count of the contact records (projection).
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint LinkCount = (uint)Property.Id.PersonLinkCount;
/// <summary>
- /// AddressBook IDs that the linked person belongs to (projection)
+ /// AddressBook IDs that the linked person belongs to (projection).
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint AddressBookIds = (uint)Property.Id.PersonAddressBookIds;
/// <summary>
- /// AddressBook ID that the person belongs to
+ /// AddressBook ID that the person belongs to.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint AddressBookId = (uint)Property.Id.ContactAddressBookId;
/// <summary>
- /// AddressBook mode, refer to the AddressBook.Mode
+ /// AddressBook mode, refer to the AddressBook.Mode.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint AddressBookMode = (uint)Property.Id.AddressBookMode;
/// <summary>
- /// Group ID that the person belongs to
+ /// Group ID that the person belongs to.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint GroupId = (uint)Property.Id.GroupRelationGroupId;
/// <summary>
- /// Contact ID that the person belongs to (projection)
+ /// Contact ID that the person belongs to (projection).
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint ContactId = (uint)Property.Id.GroupRelationContactId;
/// <summary>
- /// keyword matched data type, refer to they Contact.DataType
+ /// Keyword matched data type, refer to they Contact.DataType.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint SnippetType = (uint)Property.Id.PersonSnippetType;
/// <summary>
- /// keyword matched data string
+ /// Keyword matched data string.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint SnippetString = (uint)Property.Id.PersonSnippetString;
};
/// <summary>
- /// Describes properties of a PersonGroupNotAssigned record.
+ /// Describes the properties of a PersonGroupNotAssigned record.
/// </summary>
/// <remarks>Read only view</remarks>
/// <since_tizen> 4 </since_tizen>
public static class PersonGroupNotAssigned
{
/// <summary>
- /// Identifier of this person group not assigned view
+ /// Identifier of this person's group not assigned view.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const string Uri = "tizen.contacts_view.person/simple_contact/group_not_assigned";
/// <summary>
- /// DB record ID of the person
+ /// Database record ID of the person.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint PersonId = (uint)Property.Id.PersonId;
/// <summary>
- /// Display name of the person
+ /// Display name of the person.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint DisplayName = (uint)Property.Id.PersonDisplayName;
/// <summary>
- /// 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).
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint DisplayNameIndex = (uint)Property.Id.PersonDisplayNameIndex;
/// <summary>
- /// Display contact ID that the person belongs to (projection)
+ /// Display contact ID that the person belongs to (projection).
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint DisplayContactId = (uint)Property.Id.PersonDisplayContactId;
/// <summary>
- /// Ringtone path of the person (projection)
+ /// Ringtone path of the person (projection).
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint RingtonePath = (uint)Property.Id.PersonRingtone;
/// <summary>
- /// Image thumbnail path of the person (projection)
+ /// Image thumbnail path of the person (projection).
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint ThumbnailPath = (uint)Property.Id.PersonThumbnail;
/// <summary>
- /// Vibration path of the person (projection)
+ /// Vibration path of the person (projection).
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Vibration = (uint)Property.Id.PersonVibration;
/// <summary>
- /// Message alert path of the person (projection)
+ /// Message alert path of the person (projection).
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint MessageAlert = (uint)Property.Id.PersonMessageAlert;
/// <summary>
- /// Status of social account (projection)
+ /// Status of the social account (projection).
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Status = (uint)Property.Id.PersonStatus;
/// <summary>
- /// The person is favorite or not
+ /// The person is a favorite or not.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint IsFavorite = (uint)Property.Id.PersonIsFavorite;
/// <summary>
- /// The person has phone number or not
+ /// The person has a phone number or not.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint HasPhoneNumber = (uint)Property.Id.PersonHasPhoneNumber;
/// <summary>
- /// The person has email or not
+ /// The person has an email or not.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint HasEmail = (uint)Property.Id.PersonHasEmail;
/// <summary>
- /// Link count of contact records (projection)
+ /// Link count of the contact records (projection).
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint LinkCount = (uint)Property.Id.PersonLinkCount;
/// <summary>
- /// AddressBook IDs that the linked person belongs to (projection)
+ /// AddressBook IDs that the linked person belongs to (projection).
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint AddressBookIds = (uint)Property.Id.PersonAddressBookIds;
/// <summary>
- /// AddressBook ID that the person belongs to
+ /// AddressBook ID that the person belongs to.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint AddressBookId = (uint)Property.Id.ContactAddressBookId;
/// <summary>
- /// AddressBook mode, refer to the AddressBook.Mode
+ /// AddressBook mode, refer to the AddressBook.Mode.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint AddressBookMode = (uint)Property.Id.AddressBookMode;
/// <summary>
- /// Contact ID that the person belongs to (projection)
+ /// Contact ID that the person belongs to (projection).
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint ContactId = (uint)Property.Id.ContactId;
/// <summary>
- /// keyword matched data type, refer to they Contact.DataType
+ /// Keyword matched data type, refer to they Contact.DataType.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint SnippetType = (uint)Property.Id.PersonSnippetType;
/// <summary>
- /// keyword matched data string
+ /// Keyword matched data string.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint SnippetString = (uint)Property.Id.PersonSnippetString;
};
/// <summary>
- /// Describes properties of a PersonPhoneLog record.
+ /// Describes the properties of a PersonPhoneLog record.
/// </summary>
/// <remarks>Read only view</remarks>
/// <since_tizen> 4 </since_tizen>
public static class PersonPhoneLog
{
/// <summary>
- /// Identifier of this phone log view
+ /// Identifier of this phone log view.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const string Uri = "tizen.contacts_view.person/simple_contact/phonelog";
/// <summary>
- /// DB record ID of the person
+ /// Database record ID of the person.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint PersonId = (uint)Property.Id.PersonId;
/// <summary>
- /// Display name of the person
+ /// Display name of the person.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint DisplayName = (uint)Property.Id.PersonDisplayName;
/// <summary>
- /// Image thumbnail path of the person (projection)
+ /// Image thumbnail path of the person (projection).
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint ThumbnailPath = (uint)Property.Id.PersonThumbnail;
/// <summary>
- /// DB record ID of phone log
+ /// Database record ID of phone log.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint LogId = (uint)Property.Id.PhonelogId;
/// <summary>
- /// Number or Email that the phone log displays
+ /// Number or email that the phone log displays.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Address = (uint)Property.Id.PhonelogAddress;
/// <summary>
- /// Number or Email type (projection)
+ /// Number or email type (projection).
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint AddressType = (uint)Property.Id.DataData1;
/// <summary>
- /// 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).
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint LogTime = (uint)Property.Id.PhonelogLogTime;
/// <summary>
- /// Log type, refer to the PhoneLog.Types
+ /// Log type, refer to the PhoneLog.Types.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint LogType = (uint)Property.Id.PhonelogLogType;
/// <summary>
- /// 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).
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint ExtraData1 = (uint)Property.Id.PhonelogExtraData1;
/// <summary>
- /// 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).
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint ExtraData2 = (uint)Property.Id.PhonelogExtraData2;
/// <summary>
- /// You can only use this property for search filter
+ /// You can only use this property for the search filter.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint NormalizedAddress = (uint)Property.Id.PhonelogNormalizedAddress;
/// <summary>
- /// You can only use this property for search filter
+ /// You can only use this property for the search filter.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint CleanedAddress = (uint)Property.Id.PhonelogCleanedAddress;
/// <summary>
- /// You can only use this property for search filter
+ /// You can only use this property for the search filter.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint AddressFilter = (uint)Property.Id.PhonelogAddressFilter;
/// <summary>
- /// 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.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint SimSlotNo = (uint)Property.Id.PhonelogSimSlotNo;
};
/// <summary>
- /// Describes properties of a Person Usage record.
+ /// Describes the properties of a Person Usage record.
/// </summary>
/// <remarks>Read only view</remarks>
/// <since_tizen> 4 </since_tizen>
public static class PersonUsage
{
/// <summary>
- /// Identifier of this person usage view
+ /// Identifier of this person's usage view.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const string Uri = "tizen.contacts_view.person/usag";
/// <summary>
- /// DB record ID of the person
+ /// Database record ID of the person.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint PersonId = (uint)Property.Id.PersonId;
/// <summary>
- /// Display name of the person
+ /// Display name of the person.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint DisplayName = (uint)Property.Id.PersonDisplayName;
/// <summary>
- /// 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).
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint DisplayNameIndex = (uint)Property.Id.PersonDisplayNameIndex;
/// <summary>
- /// Display contact ID that the person belongs to (projection)
+ /// Display contact ID that the person belongs to (projection).
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint DisplayContactId = (uint)Property.Id.PersonDisplayContactId;
/// <summary>
- /// Ringtone path of the person (projection)
+ /// Ringtone path of the person (projection).
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint RingtonePath = (uint)Property.Id.PersonRingtone;
/// <summary>
- /// Image thumbnail path of the person (projection)
+ /// Image thumbnail path of the person (projection).
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint ThumbnailPath = (uint)Property.Id.PersonThumbnail;
/// <summary>
- /// Vibration path of the person (projection)
+ /// Vibration path of the person (projection).
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Vibration = (uint)Property.Id.PersonVibration;
/// <summary>
- /// Message alert path of the person (projection)
+ /// Message alert path of the person (projection).
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint MessageAlert = (uint)Property.Id.PersonMessageAlert;
/// <summary>
- /// The person is favorite or not
+ /// The person is a favorite or not.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint IsFavorite = (uint)Property.Id.PersonIsFavorite;
/// <summary>
- /// The person has phone number or not
+ /// The person has a phone number or not.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint HasPhoneNumber = (uint)Property.Id.PersonHasPhoneNumber;
/// <summary>
- /// The person has email or not
+ /// The person has an email or not.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint HasEmail = (uint)Property.Id.PersonHasEmail;
/// <summary>
- /// Usage type, refer to the Type
+ /// Usage type, refer to the Type.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint UsageType = (uint)Property.Id.PersonUsageType;
/// <summary>
- /// Usage number of person
+ /// Usage number of the person.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint TimesUsed = (uint)Property.Id.PersonTimesUsed;
/// <summary>
- /// Enumeration for Person usage type.
+ /// Enumeration for the person usage types.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public enum Type
{
/// <summary>
- /// None
+ /// None.
/// </summary>
/// <since_tizen> 4 </since_tizen>
None,
/// <summary>
- /// Outgoing call
+ /// Outgoing call.
/// </summary>
/// <since_tizen> 4 </since_tizen>
OutgoingCall,
/// <summary>
- /// Outgoing message
+ /// Outgoing message.
/// </summary>
/// <since_tizen> 4 </since_tizen>
OutgoingMessage,
/// <summary>
- /// Outgoing email
+ /// Outgoing email.
/// </summary>
/// <since_tizen> 4 </since_tizen>
OutgoingEmail,
/// <summary>
- /// Incoming call
+ /// Incoming call.
/// </summary>
/// <since_tizen> 4 </since_tizen>
IncomingCall,
/// <summary>
- /// Incoming message
+ /// Incoming message.
/// </summary>
/// <since_tizen> 4 </since_tizen>
IncomingMessage,
/// <summary>
- /// Incoming email
+ /// Incoming email.
/// </summary>
/// <since_tizen> 4 </since_tizen>
IncomingEmail,
/// <summary>
- /// Missed call
+ /// Missed call.
/// </summary>
/// <since_tizen> 4 </since_tizen>
MissedCall,
/// <summary>
- /// Rejected call
+ /// Rejected call.
/// </summary>
/// <since_tizen> 4 </since_tizen>
RejectedCall,
/// <summary>
- /// Blocked call
+ /// Blocked call.
/// </summary>
/// <since_tizen> 4 </since_tizen>
BlockedCall,
/// <summary>
- /// Blocked message
+ /// Blocked message.
/// </summary>
/// <since_tizen> 4 </since_tizen>
BlockedMessage
};
/// <summary>
- /// Describes properties of a ContactNumber record.
+ /// Describes the properties of a ContactNumber record.
/// </summary>
- /// <remarks>Read only view</remarks>
+ /// <remarks>Read-only view.</remarks>
/// <since_tizen> 4 </since_tizen>
public static class ContactNumber
{
/// <summary>
- /// Identifier of this contacts number view
+ /// Identifier of this contacts number view.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const string Uri = "tizen.contacts_view.simple_contact/number";
/// <summary>
- /// Contact ID that the number belongs to
+ /// Contact ID that the number belongs to.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint ContactId = (uint)Property.Id.ContactId;
/// <summary>
- /// Display name of contact that the number belongs to
+ /// Display name of the contact that the number belongs to.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint DisplayName = (uint)Property.Id.ContactDisplayName;
/// <summary>
- /// 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).
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint DisplaySourceType = (uint)Property.Id.ContactDisplaySourceDataId;
/// <summary>
- /// AddressBook ID that the number belongs to
+ /// AddressBook ID that the number belongs to.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint AddressBookId = (uint)Property.Id.ContactAddressBookId;
/// <summary>
- /// Person ID that the number belongs to
+ /// Person ID that the number belongs to.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint PersonId = (uint)Property.Id.ContactPersonId;
/// <summary>
- /// Ringtone path that the number belongs to (projection)
+ /// Ringtone path that the number belongs to (projection).
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint RingtonePath = (uint)Property.Id.ContactRingtone;
/// <summary>
- /// Image thumbnail path that the number belongs to (projection)
+ /// Image thumbnail path that the number belongs to (projection).
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint ThumbnailPath = (uint)Property.Id.ContactThumbnail;
/// <summary>
- /// DB record ID of the number
+ /// Database record ID of the number.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint NumberId = (uint)Property.Id.NumberId;
/// <summary>
- /// Number type, refer to the Number.Types (projection)
+ /// Number type, refer to the Number.Types (projection).
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Type = (uint)Property.Id.NumberType;
/// <summary>
- /// 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).
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Label = (uint)Property.Id.NumberLabel;
/// <summary>
- /// The number is default number or not
+ /// The number is the default number or not.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint IsDefault = (uint)Property.Id.NumberIsDefault;
/// <summary>
- /// Number
+ /// Number.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Number = (uint)Property.Id.NumberNumber;
/// <summary>
- /// 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.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint NumberFilter = (uint)Property.Id.NumberNumberFilter;
/// <summary>
- /// You can only use this property for search filter
+ /// You can only use this property for the search filter.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint NormalizedNumber = (uint)Property.Id.NumberNormalizedNumber;
/// <summary>
- /// You can only use this property for search filter
+ /// You can only use this property for the search filter.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint CleanedNumber = (uint)Property.Id.NumberCleanedNumber;
};
/// <summary>
- /// Describes properties of a ContactEmail record.
+ /// Describes the properties of a ContactEmail record.
/// </summary>
/// <remarks>Read only view</remarks>
/// <since_tizen> 4 </since_tizen>
public static class ContactEmail
{
/// <summary>
- /// Identifier of this contacts email view
+ /// Identifier of this contacts email view.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const string Uri = "tizen.contacts_view.simple_contact/email";
/// <summary>
- /// Contact ID that the number belongs to
+ /// Contact ID that the number belongs to.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint ContactId = (uint)Property.Id.ContactId;
/// <summary>
- /// Display name of contact that the number belongs to
+ /// Display name of the contact that the number belongs to.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint DisplayName = (uint)Property.Id.ContactDisplayName;
/// <summary>
- /// 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).
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint DisplaySourceType = (uint)Property.Id.ContactDisplaySourceDataId;
/// <summary>
- /// AddressBook ID that the number belongs to
+ /// AddressBook ID that the number belongs to.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint AddressBookId = (uint)Property.Id.ContactAddressBookId;
/// <summary>
- /// Person ID that the number belongs to
+ /// Person ID that the number belongs to.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint PersonId = (uint)Property.Id.ContactPersonId;
/// <summary>
- /// Ringtone path that the number belongs to (projection)
+ /// Ringtone path that the number belongs to (projection).
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint RingtonePath = (uint)Property.Id.ContactRingtone;
/// <summary>
- /// Image thumbnail path that the number belongs to (projection)
+ /// Image thumbnail path that the number belongs to (projection).
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint ThumbnailPath = (uint)Property.Id.ContactThumbnail;
/// <summary>
- /// DB record ID of the email
+ /// Database record ID of the email.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint EmailId = (uint)Property.Id.EmailId;
/// <summary>
- /// Email type, refer to the Email.Types (projection)
+ /// Email type, refer to the Email.Types (projection).
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Type = (uint)Property.Id.EmailType;
/// <summary>
- /// 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).
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Label = (uint)Property.Id.EmailLabel;
/// <summary>
- /// Email is default email or not
+ /// The email is the default email or not.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint IsDefault = (uint)Property.Id.EmailIsDefault;
/// <summary>
- /// Email address
+ /// Email address.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint Email = (uint)Property.Id.EmailEmail;
};
/// <summary>
- /// Describes properties of a ContactGroupRelation record.
+ /// Describes the properties of a ContactGroupRelation record.
/// </summary>
/// <remarks>Read only view</remarks>
/// <since_tizen> 4 </since_tizen>
public static class ContactGroupRelation
{
/// <summary>
- /// Identifier of this contact group relation view
+ /// Identifier of this contacts group relation view.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const string Uri = "tizen.contacts_view.simple_contact/group";
/// <summary>
- /// Contact ID that the number belongs to
+ /// Contact ID that the number belongs to.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint ContactId = (uint)Property.Id.ContactId;
/// <summary>
- /// Display name of contact that the number belongs to
+ /// Display name of the contact that the number belongs to.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint DisplayName = (uint)Property.Id.ContactDisplayName;
/// <summary>
- /// 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).
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint DisplaySourceType = (uint)Property.Id.ContactDisplaySourceDataId;
/// <summary>
- /// AddressBook ID that the number belongs to
+ /// AddressBook ID that the number belongs to.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint AddressBookId = (uint)Property.Id.ContactAddressBookId;
/// <summary>
- /// Person ID that the number belongs to
+ /// Person ID that the number belongs to.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint PersonId = (uint)Property.Id.ContactPersonId;
/// <summary>
- /// Ringtone path that the number belongs to (projection)
+ /// Ringtone path that the number belongs to (projection).
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint RingtonePath = (uint)Property.Id.ContactRingtone;
/// <summary>
- /// Image thumbnail path that the number belongs to (projection)
+ /// Image thumbnail path that the number belongs to (projection).
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint ThumbnailPath = (uint)Property.Id.ContactThumbnail;
/// <summary>
- /// DB record ID of the group relation
+ /// Database record ID of the group relation.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint GroupId = (uint)Property.Id.GroupRelationGroupId;
/// <summary>
- /// Group name (projection)
+ /// Group name (projection).
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint GroupName = (uint)Property.Id.GroupRelationGroupName;
};
/// <summary>
- /// Describes properties of a Phone Log Statistics record.
+ /// Describes the properties of a Phone Log Statistics record.
/// </summary>
- /// <remarks>Read only view</remarks>
+ /// <remarks>Read-only view.</remarks>
/// <since_tizen> 4 </since_tizen>
public static class PhoneLogStatistics
{
/// <summary>
- /// Identifier of this log statistics view
+ /// Identifier of this log statistics view.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const string Uri = "tizen.contacts_view.phonelog_stat";
/// <summary>
- /// Log count (projection)
+ /// Log count (projection).
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint LogCount = (uint)Property.Id.PhonelogStatLogCount;
/// <summary>
- /// Log type, see the contacts_phone_log_type_e
+ /// Log type, see the contacts_phone_log_type_e.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint LogType = (uint)Property.Id.PhonelogStatLogType;
/// <summary>
- /// 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().
/// </summary>
/// <since_tizen> 4 </since_tizen>
public const uint SimSlotNo = (uint)Property.Id.PhonelogStatSimSlotNo;
namespace Tizen.Pims.Contacts
{
/// <summary>
- /// Event arguments passed when contacts database is changed
+ /// Event arguments passed when the contacts database is changed.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public class DBChangedEventArgs : EventArgs
}
/// <summary>
- /// The contacts view URI changed.
+ /// The contacts view URI is changed.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public string ViewUri
namespace Tizen.Pims.Contacts
{
/// <summary>
- /// Event arguments passed when contacts database status is changed
+ /// Event arguments passed when the contacts database status is changed.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public class DBStatusChangedEventArgs : EventArgs
namespace Tizen.Pims.Contacts
{
/// <summary>
- /// 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.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public class NameDisplayOrderChangedEventArgs : EventArgs
}
/// <summary>
- /// A setting value of contacts name display order
+ /// A setting value of the contacts name display order.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public ContactDisplayOrder NameDisplayOrder
namespace Tizen.Pims.Contacts
{
/// <summary>
- /// 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.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public class NameSortingOrderChangedEventArgs : EventArgs
}
/// <summary>
- /// A setting value of contacts name sorting order
+ /// A setting value of the contacts name sorting order.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public ContactSortingOrder NameSortingOrder
projects / platform / core / csapi / tizenfx.git / commitdiff