FileSystemSession Members

NFX Class Library

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

The FileSystemSession type exposes the following members.

Constructors

	Name	Description
	FileSystemSession	Starts new file system session

Methods

	Name	Description
	BeginTransaction	Starts a transaction returning its' transaction handle object, otherwise does nothing
	BeginTransactionAsync	Async version of BeginTransaction
	CommitTransaction	Commits active transaction, does nothing otherwise
	CommitTransactionAsync	Async version of CommitTransaction
	Destructor	(Overrides DisposableObject Destructor .)
	Dispose	Deterministically disposes object. DO NOT OVERRIDE this method, override Destructor() instead (Inherited from DisposableObject.)
	EnsureObjectNotDisposed	Checks to see whether object dispose started or has already been disposed and throws an exception if Dispose() was called (Inherited from DisposableObject.)
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	Finalize	(Inherited from DisposableObject.)
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetItemAsync	Async version of [P:Item(string)]
	GetLatestVersionAsync	Async version of [P:LatestVersion]
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	GetVersions	Returns specified number of versions going back from the specific version. This call is thread-safe
	GetVersionsAsync	Async version of GetVersions(IFileSystemVersion, Int32)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	RollbackTransaction	Cancels active transaction changes, does nothing otherwise
	RollbackTransactionAsync	Async version of RollbackTransaction
	SetFileSystemVersionAsync	Async version of [P:Version]
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	ValidateConnectParams

Extension Methods

	Name	Description
	AsBool	(Defined by ObjectValueConversion.)
	AsByte	(Defined by ObjectValueConversion.)
	AsChar	(Defined by ObjectValueConversion.)
	AsDateTime	Overloaded. (Defined by ObjectValueConversion.)
	AsDateTime(DateTime, ConvertErrorHandling)	Overloaded. (Defined by ObjectValueConversion.)
	AsDecimal	(Defined by ObjectValueConversion.)
	AsDouble	(Defined by ObjectValueConversion.)
	AsEnum TEnum	(Defined by ObjectValueConversion.)
	AsFloat	(Defined by ObjectValueConversion.)
	AsGDID	Overloaded. (Defined by ObjectValueConversion.)
	AsGDID(GDID, ConvertErrorHandling)	Overloaded. (Defined by ObjectValueConversion.)
	AsGDIDSymbol	Overloaded. (Defined by ObjectValueConversion.)
	AsGDIDSymbol(GDIDSymbol, ConvertErrorHandling)	Overloaded. (Defined by ObjectValueConversion.)
	AsGUID	(Defined by ObjectValueConversion.)
	AsInt	(Defined by ObjectValueConversion.)
	AsJSONConfig	(Defined by ObjectValueConversion.)
	AsLaconicConfig	(Defined by ObjectValueConversion.)
	AsLong	(Defined by ObjectValueConversion.)
	AsNonNullOrEmptyString	(Defined by ObjectValueConversion.)
	AsNullableBool	(Defined by ObjectValueConversion.)
	AsNullableByte	(Defined by ObjectValueConversion.)
	AsNullableChar	(Defined by ObjectValueConversion.)
	AsNullableDateTime	(Defined by ObjectValueConversion.)
	AsNullableDecimal	(Defined by ObjectValueConversion.)
	AsNullableDouble	(Defined by ObjectValueConversion.)
	AsNullableEnum TEnum	(Defined by ObjectValueConversion.)
	AsNullableFloat	(Defined by ObjectValueConversion.)
	AsNullableGDID	(Defined by ObjectValueConversion.)
	AsNullableGDIDSymbol	(Defined by ObjectValueConversion.)
	AsNullableGUID	(Defined by ObjectValueConversion.)
	AsNullableInt	(Defined by ObjectValueConversion.)
	AsNullableLong	(Defined by ObjectValueConversion.)
	AsNullableSByte	(Defined by ObjectValueConversion.)
	AsNullableShort	(Defined by ObjectValueConversion.)
	AsNullableTimeSpan	(Defined by ObjectValueConversion.)
	AsNullableUInt	(Defined by ObjectValueConversion.)
	AsNullableULong	(Defined by ObjectValueConversion.)
	AsNullableUShort	(Defined by ObjectValueConversion.)
	AsSByte	(Defined by ObjectValueConversion.)
	AsShort	(Defined by ObjectValueConversion.)
	AsString	(Defined by ObjectValueConversion.)
	AsTimeSpan	Overloaded. (Defined by ObjectValueConversion.)
	AsTimeSpan(TimeSpan, ConvertErrorHandling)	Overloaded. (Defined by ObjectValueConversion.)
	AsUInt	(Defined by ObjectValueConversion.)
	AsULong	(Defined by ObjectValueConversion.)
	AsUri	(Defined by ObjectValueConversion.)
	AsUShort	(Defined by ObjectValueConversion.)
	AsXMLConfig	(Defined by ObjectValueConversion.)
	ToErlObject	Overloaded. Try to convert .NET native object type to corresponding Erlang term. Throw exception if conversion is not possible (Defined by ErlObject.)
	ToErlObject(ErlTypeOrder, Boolean)	Overloaded. Try to convert .NET native object type to corresponding Erlang term of given type. Throw exception if conversion is not possible (Defined by ErlObject.)
	ToJSON(JSONWritingOptions)	Overloaded. Serializes object into JSON string (Defined by JSONExtensions.)
	ToJSON(TextWriter, JSONWritingOptions)	Overloaded. Serializes object into JSON format using provided TextWriter (Defined by JSONExtensions.)
	ToJSON(Stream, JSONWritingOptions, Encoding)	Overloaded. Serializes object into JSON format using provided stream and optional encoding (Defined by JSONExtensions.)

Fields

	Name	Description
	m_FileSystem
	m_Handle
	m_Items
	m_Name
	m_TransactionHandle
	m_User

Properties

	Name	Description
	Disposed	Indicates whether this object was already disposed - the Dispose() has finished (Inherited from DisposableObject.)
	DisposeStarted	Indicates whether this object Dispose() has been called and dispose started but not finished yet (Inherited from DisposableObject.)
	FileSystem	Returns file system instance that this session operates under
	Handle	Returns file system handle for this session
	Item	Navigates to the specified path
	Items	Returns file system items initialized through this session
	LatestVersion	Returns latest version for file systems that support versioning, null otherwise
	Name	Returns session name
	SecurityManager	Returns security manager that services this file system session. This may be useful in cases when file system implements its own permission structure and user directory
	TransactionHandle	Returns transaction object if transaction has been started or null
	UniqueSequenceProvider	Returns unique sequence provider for the system or null if it is not supported
	User	Returns user that this file system session is for
	Version	Gets/sets version of the file system that this session works against (a changeset that session "sees")