IUserWriteSession Interface

Represents a communication session used not only to retrieve objects from the content store, but also to create, delete, and modify objects. It is also the place to get all manager instances.

Namespace: Ingeniux.CMS
Assembly: Ingeniux.CMS.CSAPI (in Ingeniux.CMS.CSAPI.dll) Version: 10.6.492

Syntax

C++

Copy

public interface IUserWriteSession : IUserSession, 
	IManagersHost, IInstanceLogger, IDisposable

Public Interface IUserWriteSession
	Inherits IUserSession, IManagersHost, IInstanceLogger, IDisposable

public interface class IUserWriteSession : IUserSession, 
	IManagersHost, IInstanceLogger, IDisposable

type IUserWriteSession = 
    interface
        interface IUserSession
        interface IManagersHost
        interface IInstanceLogger
        interface IDisposable
    end

The IUserWriteSession type exposes the following members.

Properties

	Name	Description
	Closed	Checks if this session was already closed. (Inherited from IUserSession)
	CompleteProgressOnClose	Obsolete. Gets/sets whether to complete the progress upon closing this session.
	ContentFreezeStartingTime	Gets the time when content freeze is about to start. Null if no content freeze looming. (Inherited from IUserSession)
	Context	Holds the user session context (Inherited from IUserSession)
	CustomMessenger	Instance of a CustomHookPushMessenger used to push messages to clients (Inherited from IUserSession)
	GlobalExports	Gets the definition of exports that will be included as attributes in every link and navigation entry. (Inherited from IManagersHost)
	GlobalVariables	Gets the collection of global variables. (Inherited from IManagersHost)
	Id	Gets the unique ID of this session. (Inherited from IUserSession)
	IP	The IP address this session was created for. Could be null if request is from http access (Inherited from IUserSession)
	IsDebugEnabled	Returns if the current logging instance has debug level enabled. (Inherited from IInstanceLogger)
	LingualMappingManager	Gets the manager of lingual maps between pages within a specific locale. (Inherited from IManagersHost)
	LocalesManager	Gets the manager of built-in locales and custom locales. (Inherited from IManagersHost)
	LoggingManager	Gets the manager of publishing logs and replication logs (Inherited from IManagersHost)
	MobileDeviceManager	Gets the manager of device bundles for mobile preview emulation. (Inherited from IManagersHost)
	OperatingUser	Gets the user who owns this session. (Inherited from IUserSession)
	PageCreationRulesManager	Gets the manager of page creation rules. (Inherited from IManagersHost)
	PresentationsManager	Gets the presentations manager for managing presentation content units (Inherited from IManagersHost)
	Progress	Gets the progress report tracker
	PublishingManager	Gets the manager of publishing targets and publishing profiles (Inherited from IManagersHost)
	ReferencesManager	Gets the manager of references between pages. (Inherited from IManagersHost)
	SchemasManager	Gets the manager of schemas. (Inherited from IManagersHost)
	Settings	Gets the CMS settings collection. (Inherited from IManagersHost)
	Site	Gets the manager of pages, page versions, and pages tree structure. (Inherited from IManagersHost)
	SiteContentLocalizationProvider	Gets the manager of translations of page creation rules, schemas, workstates and workflow definitions. (Inherited from IManagersHost)
	SiteMap	Gets the manager of branding types like sites and user agents (Inherited from IManagersHost)
	StartTime	Gets the time that this session was opened. (Inherited from IUserSession)
	TaxonomyManager	Gets the manager of category nodes as well as their structure. (Inherited from IManagersHost)
	Transactions	Gets a generic Transactional Entity to run reduced and other read-only queries. (Inherited from IManagersHost)
	UnmanagedAssetManager	Gets the unmanaged asset manager for handling legacy unmanaged assets on disk (Inherited from IManagersHost)
	UserManager	Gets the manager of users, user groups, and group roles for custom permissions collections. (Inherited from IManagersHost)
	WorkflowAdministrator	Gets the manager of workflow definitions, workstates, and workflows (Inherited from IManagersHost)

Top

Methods

	Name	Description
	AddT	Adds a new object to the content store. Objects are saved to the content store upon session closure.
	CancelSaving	Prevents session from saving any changes.
	Commit	Manually saves changes to the content store.
	CountT	Obsolete. Gets the count of query results (Inherited from IUserSession)
	Debug	Log a message at the Debug level (Inherited from IInstanceLogger)
	DeleteT	Deletes an existing object from the content store. Deletion occurs upon session closure.
	DeleteByIds	Deletes existing objects by their object IDs. Deletion occurs upon session closure.
	Error	Log a message at the Error level (Inherited from IInstanceLogger)
	Exists	Checks whether an object with given unique ids exists or not (Inherited from IUserSession)
	GetT	Retrieves an Entity object from the Content Store by its unique ID (Inherited from IUserSession)
	GetDocumentsRawT	Retrieves from the content store by unique ID a collection of documents. (Inherited from IUserSession)
	GetEntitiesT, TManager	Retrieves from the content store by unique ID a collection of entities that implements the IEntityTManager interface. (Inherited from IUserSession)
	GetEntityT, TManager	Retrieves by unique ID from the content store an entity object that implements the IEntityTManager interface. (Inherited from IUserSession)
	GetManagerT	Retrieves a transactional manager that can be used to manipulate entities in the session. (Inherited from IUserSession)
	IgnoreT	Ignore any changed to a loaded object. This will allow the object to still use its session but not commit any changes.
	Info	Log a message at the Info level (Inherited from IInstanceLogger)
	ListT	Creates a RavenDB IRavenQueryable instance of the specified collection type (Inherited from IUserSession)
	Log	Log a message at the specified log level (Inherited from IInstanceLogger)
	LuceneQueryAllT, TIndex	Queries the content store using Lucene query syntax, returning a collection of objects of the given type. The CSAPI creates indexes in the content store to expedite object lookup. The CSAPI comes with a set of indexes for its basic functionality. All strong-typed queries go through this method. Additional custom indexes can be created to provide further flexibility on fast lookup. Please refer to the Indexing topic for more information on indexes and custom indexes. (Inherited from IUserSession)
	LuceneQueryCountT, TIndex	Queries the content store using Lucene query syntax and returns the count of results. (Inherited from IUserSession)
	QueryT, TIndex	Queries the content store and returns a collection of objects of a given type. The query is based on the type of index provided. The CSAPI creates indexes in the content store to expedite object lookup. CSAPI comes with a set of indexes for its basic functionality. All strong-typed queries go through this method. Additional custom indexes can be created to provide even further flexibilities on fast lookup. Please refer to the Indexing topic for more information on indexes and custom indexes. (Inherited from IUserSession)
	StreamQueryAllT, TIndex	Queries the content store using a LINQ expression, returning a collection of objects of the given type. The CSAPI creates indexes in the content store to expedite object lookup. The CSAPI comes with a set of indexes for its basic functionality. All strong-typed queries go through this method. Additional custom indexes can be created to provide further flexibility on fast lookup. Please refer to the Indexing topic for more information on indexes and custom indexes. (Inherited from IUserSession)
	Warn	Log a message at the Warn level (Inherited from IInstanceLogger)

Top

Remarks

Objects retrieved within the session are only usable until the session is disposed. That means their methods don't work outside the session, their properties are not guaranteed to work outside the session.

UserSession objects are created from a persisting ContentStore object via the method OpenReadSession(IReadonlyUser). The best way to open and close a UserSession is with a "using" statement:

Example

Copy

using (IUserWriteSession session = store.OpenWriteSession(currentUser))
{
    ...
}

Objects retrieved via UserWriteSession are automatically tracked for their changes. The changes are saved to the content store when the sesison is disposed. However, you can always manually perform saves via Commit method at any time.

If the objects are intended to be changed, use the UserWriteSession object.

Reference

Ingeniux.CMS Namespace

OpenWriteSession(IReadonlyUser)

IUserSession

ITransactionalEntity

IUser