Interface IDataSet

Interface that defines the basic DataSet structure

Namespace: STAIExtensions.Abstractions.Data

Assembly: STAIExtensions.Abstractions.dll

Syntax

public interface IDataSet

Properties

AutoRefreshEnabled

Gets a value indicating if the DataSet is currently Auto-Refreshing

Declaration

bool AutoRefreshEnabled { get; }

Property Value

Type	Description
System.Boolean

DataSetId

Gets or sets the unique Id of the DataSet

Declaration

string DataSetId { get; set; }

Property Value

Type	Description
System.String

DataSetName

Gets or sets the Data Set Friendly name

Declaration

string DataSetName { get; set; }

Property Value

Type	Description
System.String

DataSetType

Gets the fully qualified type name of the DataSet

Declaration

string DataSetType { get; }

Property Value

Type	Description
System.String

FriendlyDataSetType

Gets the fully qualified type name of the DataSet

Declaration

string FriendlyDataSetType { get; }

Property Value

Type	Description
System.String

Methods

StartAutoRefresh(TimeSpan, Nullable<CancellationToken>)

Starts the Auto Refresh process

Declaration

void StartAutoRefresh(TimeSpan autoRefreshInterval, CancellationToken? cancellationToken = null)

Parameters

Type	Name	Description
TimeSpan	autoRefreshInterval	The Auto Refresh Interval
System.Nullable<CancellationToken>	cancellationToken	A Cancellation Token to stop the processing with

StopAutoRefresh()

Stops the DataSet Auto-Refresh processing

Declaration

void StopAutoRefresh()

UpdateDataSet()

A method that will be executed on the internal auto refresh interval

Declaration

Task UpdateDataSet()

Returns

Type	Description
Task

Events

OnDataSetUpdated

An Event that occurs once all queries has run and the dataset has updated

Declaration

event EventHandler? OnDataSetUpdated

Event Type

Type	Description
System.Nullable<EventHandler>