Class WebApiAdaptor

Handles request and response to and from Web API controller.

Inheritance

object

AdaptorBase

ODataAdaptor

WebApiAdaptor

Inherited Members

AdaptorBase.BatchUpdate(DataManager, List<IDynamicMetaObjectProvider>, List<IDynamicMetaObjectProvider>, List<IDynamicMetaObjectProvider>, Utils, string, int?, Query, object)

AdaptorBase.DataManager

AdaptorBase.Insert(DataManager, IDynamicMetaObjectProvider, string, Query, int)

AdaptorBase.RunSyncOnce

AdaptorBase.SetRunSyncOnce(bool)

AdaptorBase.Update(DataManager, string, IDynamicMetaObjectProvider, string, Query, object)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

ODataAdaptor.AddParams(RequestOptions, DataManagerRequest)

ODataAdaptor.BatchUpdate(DataManager, object, object, object, Utils, string, int?, Query, object)

ODataAdaptor.CheckDate(string)

ODataAdaptor.GetModelType()

ODataAdaptor.OnCount(bool)

ODataAdaptor.OnDistinct(List<string>)

ODataAdaptor.OnEachSearch(SearchFilter)

ODataAdaptor.OnEachSort(DataManagerRequest)

ODataAdaptor.OnExpand(List<string>)

ODataAdaptor.OnExpand(List<string>, List<string>)

ODataAdaptor.OnPredicate(WhereFilter, DataManagerRequest, bool)

ODataAdaptor.OnSearch(List<WhereFilter>)

ODataAdaptor.OnSearch(List<WhereFilter>, object)

ODataAdaptor.OnSelect(List<string>)

ODataAdaptor.OnTypeCheck(string, string, Type)

ODataAdaptor.Options

ODataAdaptor.PerformDataOperation<T>(object)

ODataAdaptor.PreventOdataFilter(Query)

ODataAdaptor.ProcessBatchResponse<T>(object, DataManagerRequest)

ODataAdaptor.ResourceTableName

ODataAdaptor.SetModelType(Type)

Namespace: Syncfusion.Blazor.Data

Assembly: Syncfusion.Blazor.dll

Syntax

public class WebApiAdaptor : ODataAdaptor

Constructors

WebApiAdaptor(DataManager)

Declaration

public WebApiAdaptor(DataManager dataManager)

Parameters

Type	Name	Description
DataManager	dataManager

Methods

BeforeSend(HttpRequestMessage)

Invoked before sending server request.

Declaration

public override void BeforeSend(HttpRequestMessage request)

Parameters

Type	Name	Description
HttpRequestMessage	request	Specifies the HttpRequestMessage instance.

Overrides

ODataAdaptor.BeforeSend(HttpRequestMessage)

GetName()

Returns the adaptor name.

Declaration

public override string GetName()

Returns

Type	Description
string	string.

Overrides

ODataAdaptor.GetName()

Insert(DataManager, object, string, Query, int)

Handles the new item add operation.

Declaration

public override object Insert(DataManager dataManager, object data, string tableName = null, Query query = null, int position = 0)

Parameters

Type	Name	Description
DataManager	dataManager	DataManager instance.
object	data	New item to be added.
string	tableName	Table name to insert new item.
Query	query	Query class instance.
int	position	Position to insert the new item.

Returns

Type	Description
object	object.

Overrides

ODataAdaptor.Insert(DataManager, object, string, Query, int)

IsRemote()

Returns true if data source is remote service.

Declaration

public override bool IsRemote()

Returns

Type	Description
bool	bool.

Overrides

ODataAdaptor.IsRemote()

ProcessCrudResponse<T>(object, DataManagerRequest)

Process the CRUD operation response/result from the data source and make it understandable by user end.

Declaration

public override Task<object> ProcessCrudResponse<T>(object data, DataManagerRequest queries)

Parameters

Type	Name	Description
object	data	Specifies the data manager instance.
DataManagerRequest	queries	Specifies the query.

Returns

Type	Description
Task<object>	Task.

Type Parameters

Name	Description
T	Specifies the data source model type.

Overrides

ODataAdaptor.ProcessCrudResponse<T>(object, DataManagerRequest)

ProcessQuery(DataManagerRequest)

Read query from Query and make it understandable by data source.

Declaration

public override object ProcessQuery(DataManagerRequest queries)

Parameters

Type	Name	Description
DataManagerRequest	queries	Specifies the query.

Returns

Type	Description
object	object.

Overrides

ODataAdaptor.ProcessQuery(DataManagerRequest)

ProcessResponse<T>(object, DataManagerRequest)

Process the data operation response/result from the data source and make it understandable by user end.

Declaration

public override Task<object> ProcessResponse<T>(object data, DataManagerRequest queries)

Parameters

Type	Name	Description
object	data	Specifies the data manager instance.
DataManagerRequest	queries	Specifies the query.

Returns

Type	Description
Task<object>	Task.

Type Parameters

Name	Description
T	Specifies the data source model type.

Overrides

ODataAdaptor.ProcessResponse<T>(object, DataManagerRequest)

Remove(DataManager, string, object, string, Query)

Handles the remove operation.

Declaration

public override object Remove(DataManager dataManager, string keyField, object value, string tableName = null, Query query = null)

Parameters

Type	Name	Description
DataManager	dataManager	DataManager instance.
string	keyField	Specifies the primary key.
object	value	Specifies the primary key field value.
string	tableName	Table name of the update item.
Query	query	Query instance.

Returns

Type	Description
object	object.

Overrides

ODataAdaptor.Remove(DataManager, string, object, string, Query)

Update(DataManager, string, object, string, Query, object, IDictionary<string, object>)

Handles the item update operation.

Declaration

public override object Update(DataManager dataManager, string keyField, object data, string tableName = null, Query query = null, object original = null, IDictionary<string, object> updateProperties = null)

Parameters

Type	Name	Description
DataManager	dataManager	DataManager instance.
string	keyField	Specifies the primary key.
object	data	Specifies the updated record.
string	tableName	Table name of the update item.
Query	query	Query instance.
object	original	Specifies the original data. Uses this original data for sending change items alone to the server.
IDictionary<string, object>	updateProperties	Specifies the field names to be updated.

Returns

Type	Description
object	object.

Overrides

ODataAdaptor.Update(DataManager, string, object, string, Query, object, IDictionary<string, object>)