Class WebApiDataStoreClient

Namespace

DevExpress.Xpo.DB

Assembly

DevExpress.Xpo.v24.1.dll

A data store provider (an DevExpress.Xpo.DB.IDataStore implementation) for client applications that use Web API to transfer data.

public class WebApiDataStoreClient : IDataStore, IDataStoreAsync, ICacheToCacheCommunicationCore, ICacheToCacheCommunicationCoreAsync

Inheritance

object

WebApiDataStoreClient

Implements

IDataStore

IDataStoreAsync

ICacheToCacheCommunicationCore

ICacheToCacheCommunicationCoreAsync

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

WebApiDataStoreClient(HttpClient, AutoCreateOption)

Initializes a new instance of the WebApiDataStoreClient class with specified settings.

public WebApiDataStoreClient(HttpClient httpClient, AutoCreateOption autoCreateOption)

Parameters

httpClient HttpClient

autoCreateOption AutoCreateOption

Specifies the action performed when connecting to a data store. This parameter has no effect on the WebApiDataStoreClient.

Fields

XpoProviderTypeString

Gets the name of the current connection provider. This name is used internally when the WebApiDataStoreClient.GetConnectionString method is used to generate a connection string.

public const string XpoProviderTypeString = "WebApi"

Field Value

string

The name of the current connection provider.

Properties

Formatter

protected IWebApiDataFormatter Formatter { get; }

Property Value

IWebApiDataFormatter

HttpClient

public HttpClient HttpClient { get; }

Property Value

HttpClient

HttpHelper

protected HttpClientHelper HttpHelper { get; }

Property Value

HttpClientHelper

Methods

CreateDataFormatter()

protected virtual IWebApiDataFormatter CreateDataFormatter()

Returns

IWebApiDataFormatter

CreateProviderFromString(string, AutoCreateOption, out IDisposable[])

This member supports the internal infrastructure and is not intended to be used directly from your code.

public static IDataStore CreateProviderFromString(string connectionString, AutoCreateOption autoCreateOption, out IDisposable[] objectsToDisposeOnDisconnect)

Parameters

connectionString string

autoCreateOption AutoCreateOption

objectsToDisposeOnDisconnect IDisposable[]

Returns

IDataStore

GetConnectionString(string)

Returns a connection string that can be passed to the XpoDefault.GetDataLayer and XpoDefault.GetConnectionProvider methods.

public static string GetConnectionString(string url)

Parameters

url string

A web service address that includes the controller name.

Returns

string

A string that contains the connection string for a WebApiDataStoreClient instance.

ModifyData(DataCacheCookie, ModificationStatement[])

public DataCacheModificationResult ModifyData(DataCacheCookie cookie, ModificationStatement[] dmlStatements)

Parameters

cookie DataCacheCookie

dmlStatements ModificationStatement[]

Returns

DataCacheModificationResult

ModifyDataAsync(CancellationToken, DataCacheCookie, ModificationStatement[])

public Task<DataCacheModificationResult> ModifyDataAsync(CancellationToken cancellationToken, DataCacheCookie cookie, ModificationStatement[] dmlStatements)

Parameters

cancellationToken CancellationToken

cookie DataCacheCookie

dmlStatements ModificationStatement[]

Returns

Task<DataCacheModificationResult>

NotifyDirtyTables(DataCacheCookie, params string[])

public DataCacheResult NotifyDirtyTables(DataCacheCookie cookie, params string[] dirtyTablesNames)

Parameters

cookie DataCacheCookie

dirtyTablesNames string[]

Returns

DataCacheResult

NotifyDirtyTablesAsync(CancellationToken, DataCacheCookie, params string[])

public Task<DataCacheResult> NotifyDirtyTablesAsync(CancellationToken cancellationToken, DataCacheCookie cookie, params string[] dirtyTablesNames)

Parameters

cancellationToken CancellationToken

cookie DataCacheCookie

dirtyTablesNames string[]

Returns

Task<DataCacheResult>

ProcessCookie(DataCacheCookie)

public DataCacheResult ProcessCookie(DataCacheCookie cookie)

Parameters

cookie DataCacheCookie

Returns

DataCacheResult

ProcessCookieAsync(CancellationToken, DataCacheCookie)

public Task<DataCacheResult> ProcessCookieAsync(CancellationToken cancellationToken, DataCacheCookie cookie)

Parameters

cancellationToken CancellationToken

cookie DataCacheCookie

Returns

Task<DataCacheResult>

Register()

Registers the provider for use with XPO.

public static void Register()

SelectData(DataCacheCookie, SelectStatement[])

public DataCacheSelectDataResult SelectData(DataCacheCookie cookie, SelectStatement[] selects)

Parameters

cookie DataCacheCookie

selects SelectStatement[]

Returns

DataCacheSelectDataResult

SelectDataAsync(CancellationToken, DataCacheCookie, SelectStatement[])

public Task<DataCacheSelectDataResult> SelectDataAsync(CancellationToken cancellationToken, DataCacheCookie cookie, SelectStatement[] selects)

Parameters

cancellationToken CancellationToken

cookie DataCacheCookie

selects SelectStatement[]

Returns

Task<DataCacheSelectDataResult>

UpdateSchema(DataCacheCookie, DBTable[], bool)

public DataCacheUpdateSchemaResult UpdateSchema(DataCacheCookie cookie, DBTable[] tables, bool doNotCreateIfFirstTableNotExist)

Parameters

cookie DataCacheCookie

tables DBTable[]

doNotCreateIfFirstTableNotExist bool

Returns

DataCacheUpdateSchemaResult

UpdateSchemaAsync(CancellationToken, DataCacheCookie, DBTable[], bool)

public Task<DataCacheUpdateSchemaResult> UpdateSchemaAsync(CancellationToken cancellationToken, DataCacheCookie cookie, DBTable[] tables, bool doNotCreateIfFirstTableNotExist)

Parameters

cancellationToken CancellationToken

cookie DataCacheCookie

tables DBTable[]

doNotCreateIfFirstTableNotExist bool

Returns

Task<DataCacheUpdateSchemaResult>