Class Provider

    Definition

    Namespace:
    Tizen.Applications.DataControl
    Assembly:
    Tizen.Applications.DataControl.dll

    Represents the Provider class for the DataControl provider application.

    public abstract class Provider : IDisposable
    Inheritance
    object
    Provider
    Implements
    System.IDisposable

    Constructors

    View Source

    Provider(string)

    Initializes the Provider class with the dataID.

    Declaration
    public Provider(string dataID)
    Parameters
    Type Name Description
    string dataID

    The DataControl Data ID.

    Exceptions
    Type Condition
    System.ArgumentException

    Thrown in case of an invalid parameter.

    Properties

    View Source

    DataID

    Gets the data ID.

    Declaration
    public string DataID { get; }
    Property Value
    Type Description
    string

    Methods

    View Source

    Dispose()

    Releases all the resources used by the Provider class.

    Declaration
    public void Dispose()
    View Source

    Dispose(bool)

    Releases unmanaged resources used by the Provider class specifying whether to perform a normal dispose operation.

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

    true for a normal dispose operation; false to finalize the handle.

    View Source

    ~Provider()

    Destructor of the Provider class.

    Declaration
    protected ~Provider()
    View Source

    OnBulkInsert(IEnumerable<string>, BulkData)

    Overrides this method if you want to handle the behavior when the bulk insert request is received.

    Declaration
    protected virtual BulkInsertResult OnBulkInsert(IEnumerable<string> query, BulkData bulkInsertData)
    Parameters
    Type Name Description
    System.Collections.Generic.IEnumerable<T><string> query
    BulkData bulkInsertData
    Returns
    Type Description
    BulkInsertResult
    View Source

    OnDataChangeListenRequest(string)

    Overrides this method if you want to handle the behavior when the data change listen request is received.

    Declaration
    protected virtual DataChangeListenResult OnDataChangeListenRequest(string requestAppID)
    Parameters
    Type Name Description
    string requestAppID
    Returns
    Type Description
    DataChangeListenResult
    View Source

    OnDelete(string, string)

    Overrides this method if you want to handle the behavior when the delete request is received.

    Declaration
    protected abstract DeleteResult OnDelete(string query, string where)
    Parameters
    Type Name Description
    string query
    string where
    Returns
    Type Description
    DeleteResult
    View Source

    OnInsert(string, Bundle)

    Overrides this method if you want to handle the behavior when the insert request is received.

    Declaration
    protected abstract InsertResult OnInsert(string query, Bundle insertData)
    Parameters
    Type Name Description
    string query
    Bundle insertData
    Returns
    Type Description
    InsertResult
    View Source

    OnMapAdd(string, string)

    Overrides this method if you want to handle the behavior when the map add request is received.

    Declaration
    protected virtual MapAddResult OnMapAdd(string key, string value)
    Parameters
    Type Name Description
    string key
    string value
    Returns
    Type Description
    MapAddResult
    View Source

    OnMapBulkAdd(BulkData)

    Overrides this method if you want to handle the behavior when the bulk add request is received.

    Declaration
    protected virtual MapBulkAddResult OnMapBulkAdd(BulkData bulkAddData)
    Parameters
    Type Name Description
    BulkData bulkAddData
    Returns
    Type Description
    MapBulkAddResult
    View Source

    OnMapGet(string)

    Overrides this method if you want to handle the behavior when the map get request is received.

    Declaration
    protected virtual MapGetResult OnMapGet(string key)
    Parameters
    Type Name Description
    string key
    Returns
    Type Description
    MapGetResult
    View Source

    OnMapRemove(string, string)

    Overrides this method if you want to handle the behavior when the delete request is received.

    Declaration
    protected virtual MapRemoveResult OnMapRemove(string key, string value)
    Parameters
    Type Name Description
    string key
    string value
    Returns
    Type Description
    MapRemoveResult
    View Source

    OnMapSet(string, string, string)

    Overrides this method if you want to handle the behavior when the update request is received.

    Declaration
    protected virtual MapSetResult OnMapSet(string key, string oldValue, string newValue)
    Parameters
    Type Name Description
    string key
    string oldValue
    string newValue
    Returns
    Type Description
    MapSetResult
    View Source

    OnSelect(string, string, string[], int, string, int, int)

    Overrides this method if you want to handle the behavior when the select request is received.

    Declaration
    protected abstract SelectResult OnSelect(string query, string where, string[] columList, int columnCount, string order, int pageNum, int countPerPage)
    Parameters
    Type Name Description
    string query
    string where
    string[] columList
    int columnCount
    string order
    int pageNum
    int countPerPage
    Returns
    Type Description
    SelectResult
    View Source

    OnUpdate(string, string, Bundle)

    Overrides this method if you want to handle the behavior when the update request is received.

    Declaration
    protected abstract UpdateResult OnUpdate(string query, string where, Bundle updateData)
    Parameters
    Type Name Description
    string query
    string where
    Bundle updateData
    Returns
    Type Description
    UpdateResult
    View Source

    Run()

    Starts the Provider service.

    Declaration
    public void Run()
    Remarks

    Only one Provider service can be run for each process.

    Exceptions
    Type Condition
    System.UnauthorizedAccessException

    Thrown in case a permission is denied.

    System.InvalidOperationException

    Thrown in case of any internal error.

    View Source

    SendDataChange(ChangeType, Bundle)

    Sends a data change notification to consumer applications which have successfully added a data change listen.

    Declaration
    public void SendDataChange(ChangeType type, Bundle changedData)
    Parameters
    Type Name Description
    ChangeType type

    The changed data type.

    Bundle changedData

    Customized information about the changed data.

    Exceptions
    Type Condition
    System.ArgumentException

    Thrown in case of an invalid parameter.

    System.UnauthorizedAccessException

    Thrown in case a permission is denied.

    System.InvalidOperationException

    Thrown in case of any internal error.

    View Source

    Stop()

    Stops the Provider service.

    Declaration
    public void Stop()

    Implements

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