WorkContext.NeedsSession Method

WorkContext NeedsSession Method

NFX Class Library

[This is preliminary documentation and is subject to change.]

Ensures that session is injected if session filter is present in processing chain. If session is already available (Session!=null) then does nothing, otherwise fills Session poroperty with either NEW session (if onlyExisting=false(default)) if user supplied no session token, OR gets session from session store as defined by the first SessionFilter in the chain

Namespace: NFX.Wave
Assembly: NFX.Wave (in NFX.Wave.dll) Version: 3.0.0.1 (3.0.0.1)

Syntax

C++

Copy to Clipboard Print

public WaveSession NeedsSession(
	bool onlyExisting = false
)

public WaveSession NeedsSession(
	bool onlyExisting = false
)

Public Function NeedsSession ( 
	Optional onlyExisting As Boolean = false
) As WaveSession

Public Function NeedsSession ( 
	Optional onlyExisting As Boolean = false
) As WaveSession

public:
WaveSession^ NeedsSession(
	bool onlyExisting = false
)

public:
WaveSession^ NeedsSession(
	bool onlyExisting = false
)

member NeedsSession : 
        ?onlyExisting : bool 
(* Defaults:
        let _onlyExisting = defaultArg onlyExisting false
*)
-> WaveSession

member NeedsSession : 
        ?onlyExisting : bool 
(* Defaults:
        let _onlyExisting = defaultArg onlyExisting false
*)
-> WaveSession

Parameters

onlyExisting (Optional): Type: System Boolean

Return Value

Type: WaveSession