Class CacheUtil

Namespace: Workspace.XBR.Xperiflow.Utilities.Cache

Assembly: Xperiflow.dll

Declaration

public static class CacheUtil

Methods

GetSessionStateValue(SessionInfo, string, string)

Retrieves the value of the specified state key from the current session state.

Declaration

public static string GetSessionStateValue(SessionInfo si, string stateKey, string defaultValue)

Returns

System.String

The value of the specified state key, or the default value if the key is not found.

Parameters

Type	Name	Description
OneStream.Shared.Common.SessionInfo	si	The session info object for the current session.
System.String	stateKey	The key of the state value to retrieve.
System.String	defaultValue	The default value to return if the state key is not found.

SetSessionStateValue(SessionInfo, string, string)

Sets the value of the specified state key in the current session state.

Declaration

public static void SetSessionStateValue(SessionInfo si, string stateKey, string stateValue)

Parameters

Type	Name	Description
OneStream.Shared.Common.SessionInfo	si	The session info object for the current session.
System.String	stateKey	The key of the state value to set.
System.String	stateValue	The value to set for the specified state key.

GetSessionStateDataTable(SessionInfo, string)

Retrieves the serialized DataTable from the session state with the specified table name.

Declaration

public static DataTable GetSessionStateDataTable(SessionInfo si, string storageKey)

Returns

System.Data.DataTable

An object containing the serialized DataTable.

Parameters

Type	Name	Description
OneStream.Shared.Common.SessionInfo	si	The session info object for the current session.
System.String	storageKey	The lookup key used to retrieve the DataTable.

TryGetSessionStateDataTable(SessionInfo, string, out DataTable?)

Retrieves the serialized DataTable from the session state with the specified table name.

Declaration

public static bool TryGetSessionStateDataTable(SessionInfo si, string storageKey, out DataTable? datatable)

Returns

System.Boolean

An object containing the serialized DataTable.

Parameters

Type	Name	Description
OneStream.Shared.Common.SessionInfo	si	The session info object for the current session.
System.String	storageKey	The lookup key used to retrieve the DataTable.
System.Data.DataTable	datatable

SetSessionStateDataTable(SessionInfo, string, DataTable)

Saves the specified DataTable to the session state with the specified table name.

Declaration

public static void SetSessionStateDataTable(SessionInfo si, string storageKey, DataTable datatable)

Parameters

Type	Name	Description
OneStream.Shared.Common.SessionInfo	si	The session info object for the current session.
System.String	storageKey	The name to give the serialized DataTable in the session state.
System.Data.DataTable	datatable	The DataTable to serialize and save to the session state.

SetSessionStateDataTable(SessionInfo, DataTable)

Declaration

public static void SetSessionStateDataTable(SessionInfo si, DataTable datatable)

Parameters

Type	Name
OneStream.Shared.Common.SessionInfo	si
System.Data.DataTable	datatable

DeleteSessionStateDataTable(SessionInfo, string)

Declaration

public static void DeleteSessionStateDataTable(SessionInfo si, string storageKey)

Parameters

Type	Name
OneStream.Shared.Common.SessionInfo	si
System.String	storageKey

Inherited Members

• System.Object.Equals(System.Object)
• System.Object.Equals(System.Object,System.Object)
• System.Object.GetHashCode
• System.Object.GetType
• System.Object.MemberwiseClone
• System.Object.ReferenceEquals(System.Object,System.Object)
• System.Object.ToString