Class ContactsRecord

Definition

Namespace:

Tizen.Pims.Contacts

Assembly:

Tizen.Pims.Contacts.dll

API Level:

4

A record represents an actual record in the database.

public class ContactsRecord : IDisposable

Inheritance

Object

ContactsRecord

Implements

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

ContactsRecord(String)

Creates a record.

Declaration

public ContactsRecord(string viewUri)

Parameters

Type	Name	Description
String	viewUri	The view URI.

Exceptions

Type	Condition
NotSupportedException	Thrown when the feature is not supported.
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

Uri

The URI of the record.

Declaration

public string Uri { get; }

Property Value

Type	Description
String	The URI of the record.

API Level: 4

Methods

AddChildRecord(UInt32, ContactsRecord)

Adds a child record to the parent record.

Declaration

public void AddChildRecord(uint propertyId, ContactsRecord childRecord)

Parameters

Type	Name	Description
UInt32	propertyId	The property ID.
ContactsRecord	childRecord	The child record to add to the parent record.

Exceptions

Type	Condition
NotSupportedException	Thrown when the feature is not supported.
ArgumentException	Thrown when one of the arguments provided to a method is not valid.

API Level: 4

Feature: http://tizen.org/feature/contact

Clone()

Makes a clone of a record.

Declaration

public ContactsRecord Clone()

Returns

Type	Description
ContactsRecord	A cloned record.

Exceptions

Type	Condition
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

CloneChildRecordList(UInt32)

Clones a child record list corresponding to the property ID.

Declaration

public ContactsList CloneChildRecordList(uint propertyId)

Parameters

Type	Name	Description
UInt32	propertyId	The property ID.

Returns

Type	Description
ContactsList	The record list.

Exceptions

Type	Condition
NotSupportedException	Thrown when the feature is not supported.
ArgumentException	Thrown when one of the arguments provided to a method is not valid.

API Level: 4

Feature: http://tizen.org/feature/contact

Dispose()

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

Declaration

public void Dispose()

API Level: 4

Dispose(Boolean)

Releases all the resources used by the ContactsRecord.

Declaration

protected virtual void Dispose(bool disposing)

Parameters

Type	Name	Description
Boolean	disposing	Disposing by the user.

API Level: 4

Finalize()

The destructor.

Declaration

protected void Finalize()

API Level: 4

Get<T>(UInt32)

Gets a value of the property from a record.

Declaration

public T Get<T>(uint propertyId)

Parameters

Type	Name	Description
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
NotSupportedException	Thrown when the feature is not supported.
ArgumentException	Thrown when one of the arguments provided to a method is not valid.

API Level: 4

Feature: http://tizen.org/feature/contact

GetChildRecord(UInt32, Int32)

Gets a child record from the parent record.

Declaration

public ContactsRecord GetChildRecord(uint propertyId, int index)

Parameters

Type	Name	Description
UInt32	propertyId	The property ID.
Int32	index	The index of the child record.

Returns

Type	Description
ContactsRecord	The record

Exceptions

Type	Condition
NotSupportedException	Thrown when the feature is not supported.
ArgumentException	Thrown when one of the arguments provided to a method is not valid.

API Level: 4

Feature: http://tizen.org/feature/contact

GetChildRecordCount(UInt32)

Gets the number of child records of a parent record.

Declaration

public int GetChildRecordCount(uint propertyId)

Parameters

Type	Name	Description
UInt32	propertyId	The property ID.

Returns

Type	Description
Int32	The number of child records corresponding to the property ID.

Exceptions

Type	Condition
NotSupportedException	Thrown when the feature is not supported.
ArgumentException	Thrown when one of the arguments provided to a method is not valid.

API Level: 4

Feature: http://tizen.org/feature/contact

RemoveChildRecord(UInt32, ContactsRecord)

Removes a child record from the parent record.

Declaration

public void RemoveChildRecord(uint propertyId, ContactsRecord childRecord)

Parameters

Type	Name	Description
UInt32	propertyId	The property ID.
ContactsRecord	childRecord	The child record to remove from the parent record.

Exceptions

Type	Condition
NotSupportedException	Thrown when feature is not supported.
ArgumentException	Thrown when one of the arguments provided to a method is not valid.

API Level: 4

Feature: http://tizen.org/feature/contact

Set<T>(UInt32, T)

Sets a value of the property to a record.

Declaration

public void Set<T>(uint propertyId, T value)

Parameters

Type	Name	Description
UInt32	propertyId	The property ID.
T	value	The value to set.

Type Parameters

Name	Description
T

Exceptions

Type	Condition
NotSupportedException	Thrown when the feature is not supported.
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