UserFilterStore

Provides storage services for user filter.

Namespace:
Inetdev.Multitenancy
Type:
Class
Public:
Yes
Protected:
No
Sealed:
No
Abstract:
No
Inherits from:
System.Object

Constructors

UserFilterStore

Default constructor

Signature:
public Void UserFilterStore()

Methods

ClearFilterAsync

Clears a filter for a page and a user.

Signature:
public Task<Int32> ClearFilterAsync(currentTenantId, pageId, userId)
Returns

Quantity of record effectively deleted.

Parameters
Name Type Summary
currentTenantId Int32 Identification of the current Tenant.
pageId String Page id.
userId String User id.
Exceptions
Type Summary
ArgumentNullOrEmptyException

Thrown when pageId is null or empty.

-or-

When userId is null or empty.

LoadAndMergeFilterAsync

Loads a stored filter and merge it data into listing.

Signature:
public Task LoadAndMergeFilterAsync(currentTenantId, pageId, userId, listing)
Parameters
Name Type Summary
currentTenantId Int32 Identification of the current Tenant.
pageId String Page id.
userId String User id.
listing Listing<T> A Listing into which the filter is merged.
Exceptions
Type Summary
ArgumentNullOrEmptyException

Thrown when pageId is null or empty.

-or-

When userId is null or empty.

ArgumentNullException Thrown when listing is null.

SaveFilterAsync

Store filter data.

Signature:
public Task SaveFilterAsync(currentTenantId, pageId, userId, data)
Parameters
Name Type Summary
currentTenantId Int32 Identification of the current Tenant.
pageId String Page id.
userId String User id.
data Object Data to be stored.
Exceptions
Type Summary
ArgumentNullOrEmptyException

Thrown when pageId is null or empty.

-or-

When userId is null or empty.

ArgumentNullException Thrown when data is null.