/// <remarks>
/// This class allows user to access/create/update db operations for contacts information.
/// </remarks>
+ /// <since_tizen> 4 </since_tizen>
public class ContactsDatabase
{
private Object thisLock = new Object();
/// <summary>
/// Enumeration for contacts database status.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public enum DBStatus
{
/// <summary>
/// <summary>
/// Enumeration for Contacts search range.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
[Flags]
public enum SearchRanges
{
/// <summary>
/// Occurs when contacts database status is changed.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public event EventHandler<DBStatusChangedEventArgs> DBStatusChanged
{
add
/// The current contacts database version.
/// </summary>
/// <value>The current contacts database version.</value>
+ /// <since_tizen> 4 </since_tizen>
[SuppressMessage("Microsoft.Performance", "CA1822:MarkMembersAsStatic")]
public int Version
{
/// The last successful changed contacts database version on the current connection.
/// </summary>
/// <value>The last successful changed contacts database version on the current connection.</value>
+ /// <since_tizen> 4 </since_tizen>
[SuppressMessage("Microsoft.Performance", "CA1822:MarkMembersAsStatic")]
public int LastChangeVersion
{
/// The contacts database status.
/// </summary>
/// <value>The contacts database status.</value>
+ /// <since_tizen> 4 </since_tizen>
[SuppressMessage("Microsoft.Performance", "CA1822:MarkMembersAsStatic")]
public DBStatus Status
{
/// <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 an invoked method is not supported</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>
+ /// <since_tizen> 4 </since_tizen>
[SuppressMessage("Microsoft.Performance", "CA1822:MarkMembersAsStatic")]
public int Insert(ContactsRecord record)
{
/// <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 an invoked method is not supported</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>
+ /// <since_tizen> 4 </since_tizen>
[SuppressMessage("Microsoft.Performance", "CA1822:MarkMembersAsStatic")]
public int[] Insert(ContactsList list)
{
/// <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 an invoked method is not supported</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>
+ /// <since_tizen> 4 </since_tizen>
[SuppressMessage("Microsoft.Performance", "CA1822:MarkMembersAsStatic")]
[SuppressMessage("Microsoft.Design", "CA1054:UriParametersShouldNotBeStrings")]
public ContactsRecord Get(string viewUri, int recordId)
/// <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 an invoked method is not supported</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>
+ /// <since_tizen> 4 </since_tizen>
[SuppressMessage("Microsoft.Performance", "CA1822:MarkMembersAsStatic")]
public void Update(ContactsRecord record)
{
/// <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 an invoked method is not supported</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>
+ /// <since_tizen> 4 </since_tizen>
[SuppressMessage("Microsoft.Performance", "CA1822:MarkMembersAsStatic")]
public void Update(ContactsList list)
{
/// <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 an invoked method is not supported</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>
+ /// <since_tizen> 4 </since_tizen>
[SuppressMessage("Microsoft.Performance", "CA1822:MarkMembersAsStatic")]
[SuppressMessage("Microsoft.Design", "CA1054:UriParametersShouldNotBeStrings")]
public void Delete(string viewUri, int recordId)
/// <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 an invoked method is not supported</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>
+ /// <since_tizen> 4 </since_tizen>
[SuppressMessage("Microsoft.Performance", "CA1822:MarkMembersAsStatic")]
[SuppressMessage("Microsoft.Design", "CA1054:UriParametersShouldNotBeStrings")]
public void Delete(string viewUri, int[] idArray)
/// <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 an invoked method is not supported</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>
+ /// <since_tizen> 4 </since_tizen>
[SuppressMessage("Microsoft.Performance", "CA1822:MarkMembersAsStatic")]
public void Replace(ContactsRecord record, int recordId)
{
/// <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 an invoked method is not supported</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>
+ /// <since_tizen> 4 </since_tizen>
[SuppressMessage("Microsoft.Performance", "CA1822:MarkMembersAsStatic")]
public void Replace(ContactsList list, int[] idArray)
{
/// </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 an invoked method is not supported</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>
+ /// <since_tizen> 4 </since_tizen>
[SuppressMessage("Microsoft.Performance", "CA1822:MarkMembersAsStatic")]
[SuppressMessage("Microsoft.Design", "CA1054:UriParametersShouldNotBeStrings")]
public ContactsList GetAll(string viewUri, int offset, int limit)
/// </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 an invoked method is not supported</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>
+ /// <since_tizen> 4 </since_tizen>
[SuppressMessage("Microsoft.Performance", "CA1822:MarkMembersAsStatic")]
public ContactsList GetRecordsWithQuery(ContactsQuery query, int offset, int limit)
{
/// 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 an invoked method is not supported</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>
+ /// <since_tizen> 4 </since_tizen>
[SuppressMessage("Microsoft.Performance", "CA1822:MarkMembersAsStatic")]
[SuppressMessage("Microsoft.Design", "CA1054:UriParametersShouldNotBeStrings")]
public ContactsList GetChangesByVersion(string viewUri, int addressBookId, int contactsDBVersion, out int currentDBVersion)
/// <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>
+ /// <since_tizen> 4 </since_tizen>
[SuppressMessage("Microsoft.Performance", "CA1822:MarkMembersAsStatic")]
[SuppressMessage("Microsoft.Design", "CA1054:UriParametersShouldNotBeStrings")]
public ContactsList Search(string viewUri, string keyword, int offset, int limit)
/// <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>
+ /// <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>
+ /// <since_tizen> 4 </since_tizen>
[SuppressMessage("Microsoft.Performance", "CA1822:MarkMembersAsStatic")]
public ContactsList Search(ContactsQuery query, string keyword, int offset, int limit)
{
/// <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>
+ /// <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>
+ /// <since_tizen> 4 </since_tizen>
[SuppressMessage("Microsoft.Performance", "CA1822:MarkMembersAsStatic")]
[SuppressMessage("Microsoft.Design", "CA1054:UriParametersShouldNotBeStrings")]
public ContactsList Search(string viewUri, string keyword, int offset, int limit, int range)
/// <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>
+ /// <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>
+ /// <since_tizen> 4 </since_tizen>
[SuppressMessage("Microsoft.Performance", "CA1822:MarkMembersAsStatic")]
[SuppressMessage("Microsoft.Design", "CA1054:UriParametersShouldNotBeStrings")]
public ContactsList Search(string viewUri, string keyword, int offset, int limit, string startMatch, string endMatch, int tokenNumber)
/// <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>
+ /// <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>
+ /// <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)
{
/// <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>
+ /// <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>
+ /// <since_tizen> 4 </since_tizen>
[SuppressMessage("Microsoft.Performance", "CA1822:MarkMembersAsStatic")]
[SuppressMessage("Microsoft.Design", "CA1054:UriParametersShouldNotBeStrings")]
public ContactsList Search(string viewUri, string keyword, int offset, int limit, int range, string startMatch, string endMatch, int tokenNumber)
/// </summary>
/// <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")]
public int GetCount(string viewUri)
/// </summary>
/// <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>
/// <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>
+ /// <since_tizen> 4 </since_tizen>
[SuppressMessage("Microsoft.Design", "CA1054:UriParametersShouldNotBeStrings")]
public void AddDBChangedEventHandler(string viewUri, EventHandler<DBChangedEventArgs> DBChanged)
{
}
EventHandler<DBChangedEventArgs> handler = null;
- if (!_eventHandlerMap.TryGetValue(viewUri, out handler))
+ if (!_eventHandlerMap.TryGetValue(viewUri, out handler))
_eventHandlerMap.Add(viewUri, null);
_eventHandlerMap[viewUri] = handler + DBChanged;
/// </summary>
/// <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>
+ /// <since_tizen> 4 </since_tizen>
[SuppressMessage("Microsoft.Design", "CA1054:UriParametersShouldNotBeStrings")]
public void RemoveDBChangedEventHandler(string viewUri, EventHandler<DBChangedEventArgs> DBChanged)
{
/// <summary>
/// A filter includes the conditions for the search
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public class ContactsFilter:IDisposable
{
internal IntPtr _filterHandle;
/// <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 an invoked method is not supported</exception>
+ /// <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>
+ /// <since_tizen> 4 </since_tizen>
[SuppressMessage("Microsoft.Design", "CA1054:UriParametersShouldNotBeStrings")]
public ContactsFilter(string viewUri, uint propertyId, StringMatchType matchType, string matchValue)
{
/// <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 an invoked method is not supported</exception>
+ /// <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>
+ /// <since_tizen> 4 </since_tizen>
[SuppressMessage("Microsoft.Design", "CA1054:UriParametersShouldNotBeStrings")]
public ContactsFilter(string viewUri, uint propertyId, IntegerMatchType matchType, int matchValue)
{
/// <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 an invoked method is not supported</exception>
+ /// <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>
+ /// <since_tizen> 4 </since_tizen>
[SuppressMessage("Microsoft.Design", "CA1054:UriParametersShouldNotBeStrings")]
public ContactsFilter(string viewUri, uint propertyId, IntegerMatchType matchType, long matchValue)
{
/// <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 an invoked method is not supported</exception>
+ /// <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>
+ /// <since_tizen> 4 </since_tizen>
[SuppressMessage("Microsoft.Design", "CA1054:UriParametersShouldNotBeStrings")]
public ContactsFilter(string viewUri, uint propertyId, IntegerMatchType matchType, double matchValue)
{
/// <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>
- /// <exception cref="NotSupportedException">Thrown when an invoked method is not supported</exception>
+ /// <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>
+ /// <since_tizen> 4 </since_tizen>
[SuppressMessage("Microsoft.Design", "CA1054:UriParametersShouldNotBeStrings")]
public ContactsFilter(string viewUri, uint propertyId, bool matchValue)
{
/// <summary>
/// Destructor
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
~ContactsFilter()
{
Dispose(false);
/// <summary>
/// Enumeration for the filter match type of a string.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public enum StringMatchType
{
/// <summary>
/// <summary>
/// Enumeration for the filter match type of an integer.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public enum IntegerMatchType
{
/// <summary>
/// <summary>
/// Enumeration for a filter operator.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public enum LogicalOperator
{
/// <summary>
/// Releases all resources used by the ContactsFilter.
/// </summary>
/// <param name="disposing">Disposing by User</param>
+ /// <since_tizen> 4 </since_tizen>
protected virtual void Dispose(bool disposing)
{
if (disposing)
/// Releases all resources used by the ContactsFilter.
/// It should be called after finished using of the object.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public void Dispose()
{
Dispose(true);
/// <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 an invoked method is not supported</exception>
+ /// <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>
+ /// <since_tizen> 4 </since_tizen>
public void AddCondition(LogicalOperator logicalOperator, uint propertyId, StringMatchType matchType, string matchValue)
{
int error = Interop.Filter.ContactsFilterAddOperator(_filterHandle, logicalOperator);
/// <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 an invoked method is not supported</exception>
+ /// <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>
+ /// <since_tizen> 4 </since_tizen>
public void AddCondition(LogicalOperator logicalOperator, uint propertyId, IntegerMatchType matchType, int matchValue)
{
int error = Interop.Filter.ContactsFilterAddOperator(_filterHandle, logicalOperator);
/// <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 an invoked method is not supported</exception>
+ /// <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>
+ /// <since_tizen> 4 </since_tizen>
public void AddCondition(LogicalOperator logicalOperator, uint propertyId, IntegerMatchType matchType, long matchValue)
{
int error = Interop.Filter.ContactsFilterAddOperator(_filterHandle, logicalOperator);
/// <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 an invoked method is not supported</exception>
+ /// <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>
+ /// <since_tizen> 4 </since_tizen>
public void AddCondition(LogicalOperator logicalOperator, uint propertyId, IntegerMatchType matchType, double matchValue)
{
int error = Interop.Filter.ContactsFilterAddOperator(_filterHandle, logicalOperator);
/// <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>
- /// <exception cref="NotSupportedException">Thrown when an invoked method is not supported</exception>
+ /// <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>
+ /// <since_tizen> 4 </since_tizen>
public void AddCondition(LogicalOperator logicalOperator, uint propertyId, bool matchValue)
{
int error = Interop.Filter.ContactsFilterAddOperator(_filterHandle, logicalOperator);
/// </summary>
/// <param name="logicalOperator">The operator type</param>
/// <param name="filter">The child filter</param>
- /// <exception cref="NotSupportedException">Thrown when an invoked method is not supported</exception>
+ /// <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>
+ /// <since_tizen> 4 </since_tizen>
public void AddFilter(LogicalOperator logicalOperator, ContactsFilter filter)
{
int error = Interop.Filter.ContactsFilterAddOperator(_filterHandle, logicalOperator);
/// <summary>
/// A list of records with the same type
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public class ContactsList:IDisposable
{
private Int64 _memoryPressure = 20;
/// <summary>
/// Creates a contacts record list.
/// </summary>
- /// <exception cref="NotSupportedException">Thrown when an invoked method is not supported</exception>
+ /// <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>
+ /// <since_tizen> 4 </since_tizen>
public ContactsList()
{
int error = Interop.List.ContactsListCreate(out _listHandle);
/// <summary>
/// Destructor
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
~ContactsList()
{
Dispose(false);
/// The count of contact entity.
/// </summary>
/// <value>The count of contact entity.</value>
+ /// <since_tizen> 4 </since_tizen>
public int Count
{
get
/// Releases all resources used by the ContactsList.
/// </summary>
/// <param name="disposing">Disposing by User</param>
+ /// <since_tizen> 4 </since_tizen>
protected virtual void Dispose(bool disposing)
{
if (disposing)
/// Releases all resources used by the ContactsList.
/// It should be called after finished using of the object.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public void Dispose()
{
Dispose(true);
/// Adds a record to the contacts list.
/// </summary>
/// <param name="record">The record to add</param>
- /// <exception cref="NotSupportedException">Thrown when an invoked method is not supported</exception>
+ /// <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>
+ /// <since_tizen> 4 </since_tizen>
public void AddRecord(ContactsRecord record)
{
int error = Interop.List.ContactsListAdd(_listHandle, record._recordHandle);
/// Removes a record from the contacts list.
/// </summary>
/// <param name="record">The record to remove</param>
- /// <exception cref="NotSupportedException">Thrown when an invoked method is not supported</exception>
+ /// <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>
+ /// <since_tizen> 4 </since_tizen>
public void RemoveRecord(ContactsRecord record)
{
int error = Interop.List.ContactsListRemove(_listHandle, record._recordHandle);
/// <returns>
/// contacts record
/// </returns>
+ /// <feature>http://tizen.org/feature/contact</feature>
+ /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
+ /// <since_tizen> 4 </since_tizen>
public ContactsRecord GetCurrentRecord()
{
IntPtr handle;
/// <returns>
/// 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>
+ /// <since_tizen> 4 </since_tizen>
public bool MovePrevious()
{
int error = Interop.List.ContactsListPrev(_listHandle);
/// <returns>
/// 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>
+ /// <since_tizen> 4 </since_tizen>
public bool MoveNext()
{
int error = Interop.List.ContactsListNext(_listHandle);
/// <summary>
/// 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>
+ /// <since_tizen> 4 </since_tizen>
public void MoveFirst()
{
int error = Interop.List.ContactsListFirst(_listHandle);
/// <summary>
/// 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>
+ /// <since_tizen> 4 </since_tizen>
public void MoveLast()
{
int error = Interop.List.ContactsListLast(_listHandle);
/// <summary>
/// Enumeration for name display order.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public enum ContactDisplayOrder
{
/// <summary>
/// <summary>
/// Enumeration for name sorting order.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public enum ContactSortingOrder
{
/// <summary>
/// <summary>
/// A class for managing contact information. It allows applications to access contacts database.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public class ContactsManager : IDisposable
{
private ContactsDatabase _db = null;
/// <summary>
/// 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>
+ /// <since_tizen> 4 </since_tizen>
public ContactsManager()
{
int error = Interop.Service.Connect();
/// <summary>
/// Destructor
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
~ContactsManager()
{
Dispose(false);
/// Releases all resources used by the ContactsManager.
/// </summary>
/// <param name="disposing">Disposing by User</param>
+ /// <since_tizen> 4 </since_tizen>
protected virtual void Dispose(bool disposing)
{
if (disposing)
/// Releases all resources used by the ContactsManager.
/// It should be called after finished using of the object.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public void Dispose()
{
Dispose(true);
/// (event) NameDisplayOrderChanged is raised when changing setting value of contacts name display order
/// </summary>
/// <privilege>http://tizen.org/privilege/contact.read</privilege>
+ /// <since_tizen> 4 </since_tizen>
public event EventHandler<NameDisplayOrderChangedEventArgs> NameDisplayOrderChanged
{
add
/// (event) NameSortingOrderChanged is raised when changing setting value of contacts name sorting order
/// </summary>
/// <privilege>http://tizen.org/privilege/contact.read</privilege>
+ /// <since_tizen> 4 </since_tizen>
public event EventHandler<NameSortingOrderChangedEventArgs> NameSortingOrderChanged
{
add
/// A ContactsDatabase
/// </summary>
/// <value>A ContactsDatabase</value>
+ /// <since_tizen> 4 </since_tizen>
public ContactsDatabase Database
{
get
/// </remarks>
/// <privilege>http://tizen.org/privilege/contact.read</privilege>
/// <privilege>http://tizen.org/privilege/contact.write</privilege>
+ /// <since_tizen> 4 </since_tizen>
[SuppressMessage("Microsoft.Performance", "CA1822:MarkMembersAsStatic")]
public ContactDisplayOrder NameDisplayOrder
{
/// </remarks>
/// <privilege>http://tizen.org/privilege/contact.read</privilege>
/// <privilege>http://tizen.org/privilege/contact.write</privilege>
+ /// <since_tizen> 4 </since_tizen>
[SuppressMessage("Microsoft.Performance", "CA1822:MarkMembersAsStatic")]
public ContactSortingOrder NameSortingOrder
{
/// 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 needs a filter which can set the conditions for the search.
/// </remarks>
+ /// <since_tizen> 4 </since_tizen>
public class ContactsQuery : IDisposable
{
internal IntPtr _queryHandle;
/// Creates a query.
/// </summary>
/// <param name="viewUri">The view URI of a query</param>
- /// <exception cref="NotSupportedException">Thrown when an invoked method is not supported</exception>
+ /// <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>
+ /// <since_tizen> 4 </since_tizen>
[SuppressMessage("Microsoft.Design", "CA1054:UriParametersShouldNotBeStrings")]
public ContactsQuery(string viewUri)
{
/// <summary>
/// Destructor
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
~ContactsQuery()
{
Dispose(false);
/// Releases all resources used by the ContactsQuery.
/// </summary>
/// <param name="disposing">Disposing by User</param>
+ /// <since_tizen> 4 </since_tizen>
protected virtual void Dispose(bool disposing)
{
if (disposing)
/// Releases all resources used by the ContactsQuery.
/// It should be called after finished using of the object.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public void Dispose()
{
Dispose(true);
/// Adds property IDs for projection.
/// </summary>
/// <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>
+ /// <since_tizen> 4 </since_tizen>
public void SetProjection(uint[] propertyIdArray)
{
if (propertyIdArray == null)
/// Sets the "distinct" option for projection.
/// </summary>
/// <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>
+ /// <since_tizen> 4 </since_tizen>
public void SetDistinct(bool set)
{
int error = Interop.Query.ContactsQuerySetDistinct(_queryHandle, set);
/// Sets the filter for a query.
/// </summary>
/// <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>
+ /// <since_tizen> 4 </since_tizen>
public void SetFilter(ContactsFilter filter)
{
int error = Interop.Query.ContactsQuerySetFilter(_queryHandle, filter._filterHandle);
/// </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>
+ /// <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>
+ /// <since_tizen> 4 </since_tizen>
public void SetSort(uint propertyId, bool isAscending)
{
int error = Interop.Query.ContactsQuerySetSort(_queryHandle, propertyId, isAscending);
/// A record can be a complex set of data, containing other data. For example, a contact record contains the address property, which is a reference to an address record.
/// An address record belongs to a contact record, and its ContactId property is set to the identifier of the corresponding contact. In this case, the address is the child record of the contact and the contact is the parent record.
/// </remarks>
+ /// <since_tizen> 4 </since_tizen>
public class ContactsRecord : IDisposable
{
private string _uri = null;
/// Creates a record.
/// </summary>
/// <param name="viewUri">The view URI</param>
- /// <exception cref="NotSupportedException">Thrown when an invoked method is not supported</exception>
+ /// <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>
+ /// <since_tizen> 4 </since_tizen>
[SuppressMessage("Microsoft.Design", "CA1054:UriParametersShouldNotBeStrings")]
public ContactsRecord(string viewUri)
{
/// <summary>
/// Destructor
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
~ContactsRecord()
{
Dispose(false);
/// The URI of the record
/// </summary>
/// <value>The URI of the record</value>
+ /// <since_tizen> 4 </since_tizen>
[SuppressMessage("Microsoft.Design", "CA1056:UriPropertiesShouldNotBeStrings")]
public string Uri
{
/// Releases all resources used by the ContactsRecord.
/// </summary>
/// <param name="disposing">Disposing by User</param>
+ /// <since_tizen> 4 </since_tizen>
protected virtual void Dispose(bool disposing)
{
if (disposing)
/// Releases all resources used by the ContactsRecord.
/// It should be called after finished using of the object.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public void Dispose()
{
Dispose(true);
/// Makes a clone of a record.
/// </summary>
/// <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>
+ /// <since_tizen> 4 </since_tizen>
public ContactsRecord Clone()
{
IntPtr _clonedRecordHandle;
/// <returns>
/// The value of the property corresponding to 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>
+ /// <since_tizen> 4 </since_tizen>
public T Get<T>(uint propertyId)
{
object parsedValue = null;
/// <summary>
/// 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>
+ /// <since_tizen> 4 </since_tizen>
public void Set<T>(uint propertyId, T value)
{
if (typeof(T) == typeof(string))
/// </summary>
/// <param name="propertyId">The property ID</param>
/// <param name="childRecord">The child record to add to 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>
+ /// <since_tizen> 4 </since_tizen>
public void AddChildRecord(uint propertyId, ContactsRecord childRecord)
{
int error = Interop.Record.AddChildRecord(_recordHandle, propertyId, childRecord._recordHandle);
/// </summary>
/// <param name="propertyId">The property ID</param>
/// <param name="childRecord">The child record to remove from 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>
+ /// <since_tizen> 4 </since_tizen>
public void RemoveChildRecord(uint propertyId, ContactsRecord childRecord)
{
int error = Interop.Record.RemoveChildRecord(_recordHandle, propertyId, childRecord._recordHandle);
/// </summary>
/// <param name="propertyId">The property ID</param>
/// <returns>The number of child records corresponding to 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>
+ /// <since_tizen> 4 </since_tizen>
public int GetChildRecordCount(uint propertyId)
{
int count = 0;
/// <param name="propertyId">The property ID</param>
/// <param name="index">The index of 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>
+ /// <since_tizen> 4 </since_tizen>
public ContactsRecord GetChildRecord(uint propertyId, int index)
{
IntPtr handle;
/// <returns>
/// 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>
+ /// <since_tizen> 4 </since_tizen>
public ContactsList CloneChildRecordList(uint propertyId)
{
IntPtr listHandle;
/// </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>
+ /// <since_tizen> 4 </since_tizen>
public delegate bool ParseCallback(ContactsRecord record);
/// <summary>
/// <remarks>
/// It's based on the vCard v3.0 specification
/// </remarks>
+ /// <since_tizen> 4 </since_tizen>
public static class ContactsVcard
{
/// <summary>
/// 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>
+ /// <since_tizen> 4 </since_tizen>
public static string Compose(ContactsRecord record)
{
int error = 0;
/// <returns>
/// 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>
+ /// <since_tizen> 4 </since_tizen>
public static ContactsList Parse(string stream)
{
IntPtr listHandle;
/// </summary>
/// <param name="path">The file path of 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>
+ /// <since_tizen> 4 </since_tizen>
public static void ParseForEach(string path, ParseCallback callback)
{
Interop.Vcard.ContactsVcardParseCallback cb = (IntPtr handle, IntPtr data) =>
/// A "record" represents a single row of the views.
/// A record can have basic properties of five types: integer, string, boolean, long, double.
/// </remarks>
+ /// <since_tizen> 4 </since_tizen>
namespace ContactsViews
{
internal static class Property
PhonelogNormalizedAddress = (Phonelog | DataTypeString | ReadOnly) + 7,
PhonelogCleanedAddress = (Phonelog | DataTypeString | ReadOnly) + 8,
PhonelogAddressFilter = (Phonelog | DataTypeString | ReadOnly) + 9,
- PhonelogSIMSlotNo = (Phonelog | DataTypeInt) + 10,
+ PhonelogSimSlotNo = (Phonelog | DataTypeInt) + 10,
/* phonelog_stat */
PhonelogStatLogCount = (PhonelogStat | DataTypeInt | ReadOnly),
PhonelogStatLogType = (PhonelogStat | DataTypeInt | ReadOnly) + 1,
- PhonelogStatSIMSlotNo = (PhonelogStat | DataTypeInt | ReadOnly) + 2,
+ PhonelogStatSimSlotNo = (PhonelogStat | DataTypeInt | ReadOnly) + 2,
/* updated_info : read only */
UpdateInfoId = (UpdateInfo | DataTypeInt),
/// <summary>
/// Enumeration for contact change state.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public enum ChangeType
{
/// <summary>
/// <summary>
/// Describes properties of a Address book record.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public static class AddressBook
{
/// <summary>
/// <summary>
/// Enumeration for Address book mode.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public enum ModeValue
{
/// <summary>
/// <summary>
/// Describes properties of a Group record.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public static class Group
{
/// <summary>
/// <summary>
/// Describes properties of a Person record.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public static class Person
{
/// <summary>
/// <summary>
/// Describes properties of a Contact record.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public static class Contact
{
/// <summary>
/// <summary>
/// Enumeration for link mode when inserting contact.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public enum LinkModeValue
{
/// <summary>
/// <summary>
/// Enumeration for Contact display name source type.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public enum DisplayNameSourceType
{
/// <summary>
/// <summary>
/// Enumeration for contacts data type.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public enum DataType
{
/// <summary>
/// <summary>
/// Describes properties of a Simple contact record.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public static class SimpleContact
{
/// <summary>
/// <summary>
/// Describes properties of a My profile record.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public static class MyProfile
{
/// <summary>
/// <summary>
/// Describes properties of a Name record.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public static class Name
{
/// <summary>
/// <summary>
/// Describes properties of a Number record.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public static class Number
{
/// <summary>
/// <summary>
/// Enumeration for number type.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
[Flags]
public enum Types
{
/// <summary>
/// Describes properties of a Email record.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public static class Email
{
/// <summary>
/// <summary>
/// Enumeration for Contact email type.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
[Flags]
public enum Types
{
/// <summary>
/// Describes properties of a Address record.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public static class Address
{
/// <summary>
/// <summary>
/// Enumeration for Contact address type.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
[Flags]
public enum Types
{
/// <summary>
/// Describes properties of a Note record.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public static class Note
{
/// <summary>
/// <summary>
/// Describes properties of a URL record.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public static class URL
{
/// <summary>
/// <summary>
/// Enumeration for Contact URL type.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public enum TypeValue
{
/// <summary>
/// <summary>
/// Describes properties of a Event record.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
[SuppressMessage("Microsoft.Naming", "CA1716:IdentifiersShouldNotMatchKeywords")]
public static class Event
{
/// <summary>
/// Enumeration for Contact event type.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public enum TypeValue
{
/// <summary>
/// <summary>
/// Enumeration for Contact event calendar type.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public enum CalendarType
{
/// <summary>
/// <summary>
/// Describes properties of a Relationship record.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public static class Relationship
{
/// <summary>
/// <summary>
/// Enumeration for Contact relationship type.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public enum TypeValue
{
/// <summary>
/// <summary>
/// Describes properties of a Image record.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public static class Image
{
/// <summary>
/// <summary>
/// Enumeration for Contact image type.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public enum TypeValue
{
/// <summary>
/// <summary>
/// Describes properties of a Company record.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public static class Company
{
/// <summary>
/// <summary>
/// Enumeration for Contact company type.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public enum TypeValue
{
/// <summary>
/// <summary>
/// Describes properties of a Nickname record.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public static class Nickname
{
/// <summary>
/// <summary>
/// Describes properties of a Messenger record.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public static class Messenger
{
/// <summary>
/// <summary>
/// Enumeration for Contact messenger type.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public enum TypeValue
{
/// <summary>
/// <summary>
/// Describes properties of a Profile record.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
[SuppressMessage("Microsoft.Naming", "CA1724:TypeNamesShouldNotMatchNamespaces")]
public static class Profile
{
/// <summary>
/// Describes properties of a Sip record.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public static class Sip
{
/// <summary>
/// <summary>
/// Enumeration for Contact SIP type.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public enum TypeValue
{
/// <summary>
/// <summary>
/// Describes properties of a Extension record.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public static class Extension
{
/// <summary>
/// <summary>
/// Describes properties of a Group relation record.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public static class GroupRelation
{
/// <summary>
/// <summary>
/// Describes properties of a Speed dial record.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public static class SpeedDial
{
/// <summary>
/// <summary>
/// Describes properties of a Phone log record.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public static class PhoneLog
{
/// <summary>
/// </summary>
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 first Sim card, SimSlotNo 1 means second Sim.
/// </summary>
- public const uint SimSlotNo = (uint)Property.Id.PhonelogSIMSlotNo;
+ public const uint SimSlotNo = (uint)Property.Id.PhonelogSimSlotNo;
/// <summary>
/// Enumeration for Phone log type.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public enum Type
{
/// <summary>
/// Describes properties of a Contact updated information record.
/// </summary>
/// <remarks>Read only view</remarks>
+ /// <since_tizen> 4 </since_tizen>
public static class ContactUpdatedInfo
{
/// <summary>
/// Describes properties of a My profile updated information record.
/// </summary>
/// <remarks>Read only view</remarks>
+ /// <since_tizen> 4 </since_tizen>
public static class MyProfileUpdatedInfo
{
/// <summary>
/// Describes properties of a Group updated information record.
/// </summary>
/// <remarks>Read only view</remarks>
+ /// <since_tizen> 4 </since_tizen>
public static class GroupUpdatedInfo
{
/// <summary>
/// Describes properties of a Group Member updated information record.
/// </summary>
/// <remarks>Read only view</remarks>
+ /// <since_tizen> 4 </since_tizen>
public static class GroupMemberUpdatedInfo
{
/// <summary>
/// Describes properties of a Relation updated information record.
/// </summary>
/// <remarks>Read only view</remarks>
+ /// <since_tizen> 4 </since_tizen>
public static class GroupRelationUpdatedInfo
{
/// <summary>
/// Describes properties of a PersonContact record.
/// </summary>
/// <remarks>Read only view</remarks>
+ /// <since_tizen> 4 </since_tizen>
public static class PersonContact
{
/// <summary>
/// Describes properties of a PersonNumber record.
/// </summary>
/// <remarks>Read only view</remarks>
+ /// <since_tizen> 4 </since_tizen>
public static class PersonNumber
{
/// <summary>
/// Describes properties of a PersonEmail record.
/// </summary>
/// <remarks>Read only view</remarks>
+ /// <since_tizen> 4 </since_tizen>
public static class PersonEmail
{
/// <summary>
/// Describes properties of a PersonGroupRelation record.
/// </summary>
/// <remarks>Read only view</remarks>
+ /// <since_tizen> 4 </since_tizen>
public static class PersonGroupRelation
{
/// <summary>
};
/// <summary>
- /// Describes properties of a PersonGroupAssignedrecord.
+ /// Describes properties of a PersonGroupAssigned record.
/// </summary>
/// <remarks>Read only view</remarks>
+ /// <since_tizen> 4 </since_tizen>
public static class PersonGroupAssigned
{
/// <summary>
/// Describes properties of a PersonGroupNotAssigned record.
/// </summary>
/// <remarks>Read only view</remarks>
+ /// <since_tizen> 4 </since_tizen>
public static class PersonGroupNotAssigned
{
/// <summary>
/// Describes properties of a PersonPhoneLog record.
/// </summary>
/// <remarks>Read only view</remarks>
+ /// <since_tizen> 4 </since_tizen>
public static class PersonPhoneLog
{
/// <summary>
/// </summary>
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 slot number. SimSlotNo 0 means first Sim card, SimSlotNo 1 means second Sim.
/// </summary>
- public const uint SIMSlotNo = (uint)Property.Id.PhonelogSIMSlotNo;
+ public const uint SimSlotNo = (uint)Property.Id.PhonelogSimSlotNo;
};
/// <summary>
/// Describes properties of a Person Usage record.
/// </summary>
/// <remarks>Read only view</remarks>
+ /// <since_tizen> 4 </since_tizen>
public static class PersonUsage
{
/// <summary>
/// <summary>
/// Enumeration for Person usage type.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public enum Type
{
/// <summary>
/// Describes properties of a ContactNumber record.
/// </summary>
/// <remarks>Read only view</remarks>
+ /// <since_tizen> 4 </since_tizen>
public static class ContactNumber
{
/// <summary>
/// Describes properties of a ContactEmail record.
/// </summary>
/// <remarks>Read only view</remarks>
+ /// <since_tizen> 4 </since_tizen>
public static class ContactEmail
{
/// <summary>
/// Describes properties of a ContactGroupRelation record.
/// </summary>
/// <remarks>Read only view</remarks>
+ /// <since_tizen> 4 </since_tizen>
public static class ContactGroupRelation
{
/// <summary>
/// Describes properties of a Phone Log Statistics record.
/// </summary>
/// <remarks>Read only view</remarks>
+ /// <since_tizen> 4 </since_tizen>
public static class PhoneLogStatistics
{
/// <summary>
/// </summary>
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 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()
/// </summary>
- public const uint SIMSlotNo = (uint)Property.Id.PhonelogStatSIMSlotNo;
+ public const uint SimSlotNo = (uint)Property.Id.PhonelogStatSimSlotNo;
};
}
}
/// <summary>
/// Event arguments passed when contacts database is changed
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public class DBChangedEventArgs : EventArgs
{
internal DBChangedEventArgs(string viewUri)
/// <summary>
/// The contacts view URI changed.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public string ViewUri
{
get;
/// <summary>
/// Event arguments passed when contacts database status is changed
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public class DBStatusChangedEventArgs : EventArgs
{
internal DBStatusChangedEventArgs(DBStatus status)
/// <summary>
/// The contacts database status.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public DBStatus Status
{
get;
/// <summary>
/// Event arguments passed when setting value of contacts name display order is changed
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public class NameDisplayOrderChangedEventArgs : EventArgs
{
internal NameDisplayOrderChangedEventArgs(ContactDisplayOrder displayOrder)
/// <summary>
/// A setting value of contacts name display order
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public ContactDisplayOrder NameDisplayOrder
{
get;
/// <summary>
/// Event arguments passed when setting value of contacts name sorting order is changed
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public class NameSortingOrderChangedEventArgs : EventArgs
{
internal NameSortingOrderChangedEventArgs(ContactSortingOrder SortingOrder)
/// <summary>
/// A setting value of contacts name sorting order
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public ContactSortingOrder NameSortingOrder
{
get;
/// <remarks>
/// The Tizen.Pims.Contacts namespace provides classes for managing contact information for people.
/// </remarks>
+/// <since_tizen> 4 </since_tizen>
namespace Tizen.Pims.Contacts {}
projects / platform / core / csapi / tizenfx.git / commitdiff