Class ContactsRecord
Definition
- Assembly:
- Tizen.Pims.Contacts.dll
A record represents an actual record in the database.
public class ContactsRecord : IDisposable
- Inheritance
-
objectContactsRecord
- 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 SourceContactsRecord(string)
Creates a record.
Declaration
public ContactsRecord(string viewUri)
Parameters
Type | Name | Description |
---|---|---|
string | viewUri | The view URI. |
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.
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. |
System.OutOfMemoryException | Thrown when failed due to out of memory. |
Properties
View SourceUri
The URI of the record.
Declaration
public string Uri { get; }
Property Value
Type | Description |
---|---|
string | The URI of the record. |
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.
Methods
View SourceAddChildRecord(uint, ContactsRecord)
Adds a child record to the parent record.
Declaration
public void AddChildRecord(uint propertyId, ContactsRecord childRecord)
Parameters
Type | Name | Description |
---|---|---|
uint | propertyId | The property ID. |
ContactsRecord | childRecord | The child record to add to the parent record. |
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.
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. |
Clone()
Makes a clone of a record.
Declaration
public ContactsRecord Clone()
Returns
Type | Description |
---|---|
ContactsRecord | A cloned record. |
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.
Exceptions
Type | Condition |
---|---|
System.NotSupportedException | Thrown when the feature is not supported. |
System.OutOfMemoryException | Thrown when failed due to out of memory. |
CloneChildRecordList(uint)
Clones a child record list corresponding to the property ID.
Declaration
public ContactsList CloneChildRecordList(uint propertyId)
Parameters
Type | Name | Description |
---|---|---|
uint | propertyId | The property ID. |
Returns
Type | Description |
---|---|
ContactsList | The record list. |
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.
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. |
Dispose()
Releases all the resources used by the ContactsRecord. It should be called after it has finished using the object.
Declaration
public void Dispose()
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.
Dispose(bool)
Releases all the resources used by the ContactsRecord.
Declaration
protected virtual void Dispose(bool disposing)
Parameters
Type | Name | Description |
---|---|---|
bool | disposing | Disposing by the user. |
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.
~ContactsRecord()
The destructor.
Declaration
protected ~ContactsRecord()
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.
Get<T>(uint)
Gets a value of the property from a record.
Declaration
public T Get<T>(uint propertyId)
Parameters
Type | Name | Description |
---|---|---|
uint | propertyId | The property ID. |
Returns
Type | Description |
---|---|
T | The value of the property corresponding to a property ID. |
Type Parameters
Name | Description |
---|---|
T |
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.
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. |
GetChildRecord(uint, int)
Gets a child record from the parent record.
Declaration
public ContactsRecord GetChildRecord(uint propertyId, int index)
Parameters
Type | Name | Description |
---|---|---|
uint | propertyId | The property ID. |
int | index | The index of the child record. |
Returns
Type | Description |
---|---|
ContactsRecord | The record |
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.
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. |
GetChildRecordCount(uint)
Gets the number of child records of a parent record.
Declaration
public int GetChildRecordCount(uint propertyId)
Parameters
Type | Name | Description |
---|---|---|
uint | propertyId | The property ID. |
Returns
Type | Description |
---|---|
int | The number of child records corresponding to the property ID. |
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.
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. |
RemoveChildRecord(uint, ContactsRecord)
Removes a child record from the parent record.
Declaration
public void RemoveChildRecord(uint propertyId, ContactsRecord childRecord)
Parameters
Type | Name | Description |
---|---|---|
uint | propertyId | The property ID. |
ContactsRecord | childRecord | The child record to remove from the parent record. |
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.
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. |
Set<T>(uint, T)
Sets a value of the property to a record.
Declaration
public void Set<T>(uint propertyId, T value)
Parameters
Type | Name | Description |
---|---|---|
uint | propertyId | The property ID. |
T | value | The value to set. |
Type Parameters
Name | Description |
---|---|
T |
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.
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. |