Show / Hide Table of Contents

    Class CalendarRecord

    Definition

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

    A record represents an actual record in the database.

    public class CalendarRecord : IDisposable
    Inheritance
    Object
    CalendarRecord
    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 alarm, attendee, and extended. A record can be a complex set of data, containing other data. For example, a calendar record contains the alarm property, which is a reference to an alarm record. An alarm record could belong to a event record, and its alarm ID property is set to the identifier of the corresponding event. In this case, the alarm is the child record of the event, and the event is the parent record.

    Constructors

    View Source

    CalendarRecord(String)

    Creates a record.

    Declaration
    public CalendarRecord(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/calendar

    Properties

    View Source

    Uri

    Get record URI.

    Declaration
    public string Uri { get; }
    Property Value
    Type Description
    String

    The URI of the record

    API Level: 4

    Methods

    View Source

    AddChildRecord(UInt32, CalendarRecord)

    Adds a child record to the parent record.

    Declaration
    public void AddChildRecord(uint propertyId, CalendarRecord childRecord)
    Parameters
    Type Name Description
    UInt32 propertyId

    The property ID.

    CalendarRecord childRecord

    The child 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/calendar
    View Source

    Clone()

    Makes a clone of a record.

    Declaration
    public CalendarRecord Clone()
    Returns
    Type Description
    CalendarRecord

    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/calendar
    View Source

    CloneChildRecordList(UInt32)

    Clones a child record list corresponding to property ID.

    Declaration
    public CalendarList CloneChildRecordList(uint propertyId)
    Parameters
    Type Name Description
    UInt32 propertyId

    The property ID.

    Returns
    Type Description
    CalendarList

    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/calendar
    View Source

    Dispose()

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

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

    Dispose(Boolean)

    Disposes of the resources (other than memory) used by the CalendarRecord.

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

    true to release both managed and unmanaged resources, false to release only unmanaged resources.

    API Level: 4
    View Source

    Finalize()

    Destructor.

    Declaration
    protected void Finalize()
    View Source

    Get<T>(UInt32)

    Gets a object 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 property id.

    Type Parameters
    Name Description
    T
    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/calendar
    View Source

    GetChildRecord(UInt32, Int32)

    Gets a child record from the parent record.

    Declaration
    public CalendarRecord GetChildRecord(uint propertyId, int index)
    Parameters
    Type Name Description
    UInt32 propertyId

    The property ID.

    Int32 index

    The child record index.

    Returns
    Type Description
    CalendarRecord

    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/calendar
    View Source

    GetChildRecordCount(UInt32)

    Gets a child record from the 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 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/calendar
    View Source

    RemoveChildRecord(UInt32, CalendarRecord)

    Removes a child record from the parent record.

    Declaration
    public void RemoveChildRecord(uint propertyId, CalendarRecord childRecord)
    Parameters
    Type Name Description
    UInt32 propertyId

    The property ID.

    CalendarRecord childRecord

    The child 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/calendar
    View Source

    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

    value

    Type Parameters
    Name Description
    T
    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/calendar

    Implements

    System.IDisposable
    • View Source
    Back to top Copyright © 2016-2020 Samsung
    Generated by DocFX