Class NCacheSessionExtensions

This class contains Extension methods for ISession.

Inheritance
System.Object
NCacheSessionExtensions
Assembly: Alachisoft.NCache.CoreSessionStoreProvider.dll
Syntax
public static class NCacheSessionExtensions : object

Methods

AddNCacheSession(IServiceCollection, Action<NCacheSessionConfiguration>)

Adds services required for application session state using NCache.

Declaration
public static IServiceCollection AddNCacheSession(this IServiceCollection services, Action<NCacheSessionConfiguration> configure)
Parameters
Type Name Description
IServiceCollection services

Specifies the contract for a collection of service descriptors.
Action<Alachisoft.NCache.Web.SessionState.Configuration.NCacheSessionConfiguration> configure

Action to configure an NCache Session Storage Service Configuration.
Returns
Type Description
IServiceCollection

The service collection container.

AddNCacheSession(IServiceCollection, IConfigurationSection)

Adds services required for application session state using NCache.

Declaration
public static IServiceCollection AddNCacheSession(this IServiceCollection services, IConfigurationSection configSection)
Parameters
Type Name Description
IServiceCollection services

Specifies the contract for a collection of service descriptors.
IConfigurationSection configSection

The configuration section that contains the configuration.
Returns
Type Description
IServiceCollection

The service collection container.

Set(ISession, String, Object)

Sets a value against the specified key in the session.

Declaration
public static void Set(this ISession session, string key, object value)
Parameters
Type Name Description
ISession session

The session object.
System.String key

Key against which the value is required.
System.Object value

The value against the key which is serialized using NCache Compact Serialization.

TryGetValue(ISession, String, out Object)

Tries to get the value against the specified key from session.

Declaration
public static bool TryGetValue(this ISession session, string key, out object value)
Parameters
Type Name Description
ISession session

The session object.
System.String key

Key against which the value is required.
System.Object value

The deserialized value against the key.
Returns
Type Description
System.Boolean

A boolean value that specifies whether the operation was successful or not.

UseNCacheSession(IApplicationBuilder)

Adds the NCache Session Middleware to automatically enable session state for the application.

Declaration
public static IApplicationBuilder UseNCacheSession(this IApplicationBuilder builder)
Parameters
Type Name Description
IApplicationBuilder builder

Provides the mechanisms to configure application's request pipeline.
Returns
Type Description
IApplicationBuilder

Provides the mechanisms to configure application's request pipeline.