Class DataProvider

Namespace

Dynamicweb.DataPortability

Assembly

Dynamicweb.Core.dll

Base class for data providers

public abstract class DataProvider : ConfigurableAddIn

Inheritance

object

ConfigurableAddIn

DataProvider

Derived

SqlDataProviderBase

Inherited Members

ConfigurableAddIn.UpdateFromPost(NameValueCollection)

ConfigurableAddIn.GetIdSuitableString(string)

ConfigurableAddIn.LoadParametersFromXml(string)

ConfigurableAddIn.GetParametersToXml()

ConfigurableAddIn.GetParametersToXml(bool)

ConfigurableAddIn.SetValue(string, object)

ConfigurableAddIn.GetInstanceFromParameterXml<T>(string)

ConfigurableAddIn.RenderAdditionalContent(TextWriter)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Examples

using System.Collections.Generic;
using Dynamicweb.Core;
using Dynamicweb.Security.UserManagement;

namespace Dynamicweb.DataPortability.Examples;

// Implement a class which inherits from the DataProvider base class.
public class SampleDataProvider : DataProvider
{
    // Override the GetDataByUser method and return data for the given user.
    public override IEnumerable<DataItem> GetDataByUser(User user)
    {
        var dataItems = new List<DataItem>();

        // Get data related to the user
        var dataEntries = new[]
        {
            new { Id = 1, UserId = 123, TestValue = "OK" }
        };

        // Convert the data into instances of DataItem
        foreach (var dataEntry in dataEntries)
        {
            var dataItem = new DataItem(Converter.ToString(dataEntry.Id));
            dataItem.Properties.Add("TestValue", dataEntry.TestValue);

            dataItems.Add(dataItem);
        }

        return dataItems;
    }
}

Methods

GetDataByUser(User)

Gets data related to a given user.

public virtual IEnumerable<DataItem> GetDataByUser(User user)

Parameters

user User

The user to retrieve data for.

Returns

IEnumerable<DataItem>

A collection of data items found for the given user.

See Also

ConfigurableAddIn