Class ContactsRecord

Definition

Namespace:
Tizen.Pims.Contacts
Assembly:
Tizen.Pims.Contacts.dll
API Level:
4

A record represents an actual record in the database.

C#
Copy
public class ContactsRecord : IDisposable
Inheritance
System.Object
ContactsRecord
Implements
System.IDisposable
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. 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.

Constructors

View Source

ContactsRecord(String)

Creates a record.

Declaration
C#
Copy
public ContactsRecord(string viewUri)
Parameters
Type Name Description
System.String viewUri

The view URI.

Exceptions
Type Condition
System.NotSupportedException

Thrown when the feature is not supported.

System.ArgumentException

Thrown when one of the arguments provided to a method is not valid.

OutOfMemoryException

Thrown when failed due to out of memory.

API Level: 4
Feature: http://tizen.org/feature/contact

Properties

View Source

Uri

The URI of the record.

Declaration
C#
Copy
public string Uri { get; }
Property Value
Type Description
System.String

The URI of the record.

API Level: 4

Methods

View Source

AddChildRecord(UInt32, ContactsRecord)

Adds a child record to the parent record.

Declaration
C#
Copy
public void AddChildRecord(uint propertyId, ContactsRecord childRecord)
Parameters
Type Name Description
System.UInt32 propertyId

The property ID.

ContactsRecord childRecord

The child record to add to the parent record.

Exceptions
Type Condition
System.NotSupportedException

Thrown when the feature is not supported.

System.ArgumentException

Thrown when one of the arguments provided to a method is not valid.

API Level: 4
Feature: http://tizen.org/feature/contact
View Source

Clone()

Makes a clone of a record.

Declaration
C#
Copy
public ContactsRecord Clone()
Returns
Type Description
ContactsRecord

A cloned record.

Exceptions
Type Condition
System.NotSupportedException

Thrown when the feature is not supported.

OutOfMemoryException

Thrown when failed due to out of memory.

API Level: 4
Feature: http://tizen.org/feature/contact
View Source

CloneChildRecordList(UInt32)

Clones a child record list corresponding to the property ID.

Declaration
C#
Copy
public ContactsList CloneChildRecordList(uint propertyId)
Parameters
Type Name Description
System.UInt32 propertyId

The property ID.

Returns
Type Description
ContactsList

The record list.

Exceptions
Type Condition
System.NotSupportedException

Thrown when the feature is not supported.

System.ArgumentException

Thrown when one of the arguments provided to a method is not valid.

API Level: 4
Feature: http://tizen.org/feature/contact
View Source

Dispose()

Releases all the resources used by the ContactsRecord. It should be called after it has finished using the object.

Declaration
C#
Copy
public void Dispose()
API Level: 4
View Source

Dispose(Boolean)

Releases all the resources used by the ContactsRecord.

Declaration
C#
Copy
protected virtual void Dispose(bool disposing)
Parameters
Type Name Description
Boolean disposing

Disposing by the user.

API Level: 4
View Source

Finalize()

The destructor.

Declaration
C#
Copy
protected void Finalize()
API Level: 4
View Source

Get<T>(UInt32)

Gets a value of the property from a record.

Declaration
C#
Copy
public T Get<T>(uint propertyId)
Parameters
Type Name Description
System.UInt32 propertyId

The property ID.

Returns
Type Description
T

The value of the property corresponding to a property ID.

Type Parameters
Name Description
T
Exceptions
Type Condition
System.NotSupportedException

Thrown when the feature is not supported.

System.ArgumentException

Thrown when one of the arguments provided to a method is not valid.

API Level: 4
Feature: http://tizen.org/feature/contact
View Source

GetChildRecord(UInt32, Int32)

Gets a child record from the parent record.

Declaration
C#
Copy
public ContactsRecord GetChildRecord(uint propertyId, int index)
Parameters
Type Name Description
System.UInt32 propertyId

The property ID.

Int32 index

The index of the child record.

Returns
Type Description
ContactsRecord

The record

Exceptions
Type Condition
System.NotSupportedException

Thrown when the feature is not supported.

System.ArgumentException

Thrown when one of the arguments provided to a method is not valid.

API Level: 4
Feature: http://tizen.org/feature/contact
View Source

GetChildRecordCount(UInt32)

Gets the number of child records of a parent record.

Declaration
C#
Copy
public int GetChildRecordCount(uint propertyId)
Parameters
Type Name Description
System.UInt32 propertyId

The property ID.

Returns
Type Description
Int32

The number of child records corresponding to the property ID.

Exceptions
Type Condition
System.NotSupportedException

Thrown when the feature is not supported.

System.ArgumentException

Thrown when one of the arguments provided to a method is not valid.

API Level: 4
Feature: http://tizen.org/feature/contact
View Source

RemoveChildRecord(UInt32, ContactsRecord)

Removes a child record from the parent record.

Declaration
C#
Copy
public void RemoveChildRecord(uint propertyId, ContactsRecord childRecord)
Parameters
Type Name Description
System.UInt32 propertyId

The property ID.

ContactsRecord childRecord

The child record to remove from the parent record.

Exceptions
Type Condition
System.NotSupportedException

Thrown when feature is not supported.

System.ArgumentException

Thrown when one of the arguments provided to a method is not valid.

API Level: 4
Feature: http://tizen.org/feature/contact
View Source

Set<T>(UInt32, T)

Sets a value of the property to a record.

Declaration
C#
Copy
public void Set<T>(uint propertyId, T value)
Parameters
Type Name Description
System.UInt32 propertyId

The property ID.

T value

The value to set.

Type Parameters
Name Description
T
Exceptions
Type Condition
System.NotSupportedException

Thrown when the feature is not supported.

System.ArgumentException

Thrown when one of the arguments provided to a method is not valid.

API Level: 4
Feature: http://tizen.org/feature/contact

Implements

System.IDisposable