View Source

Interface IScope

Represents a scope for database operations and event handling.

Namespace: Umbraco.Cms.Core.Scoping

Assembly: Umbraco.Infrastructure.dll

Syntax

[Obsolete("Please use Umbraco.Cms.Infrastructure.Scoping.IScope or Umbraco.Cms.Core.Scoping.ICoreScope instead.")]
public interface IScope : IScope, ICoreScope, IInstanceIdentifiable

Remarks

This interface is obsolete. Please use IScope or ICoreScope instead.

Properties

Database

Gets the scope database.

Declaration

IUmbracoDatabase Database { get; }

Property Value

Type	Description
IUmbracoDatabase

Events

Gets the scope event dispatcher.

Declaration

IEventDispatcher Events { get; }

Property Value

Type	Description
IEventDispatcher

IsolatedCaches

Gets the scope isolated cache.

Declaration

IsolatedCaches IsolatedCaches { get; }

Property Value

Type	Description
IsolatedCaches

Messages

Gets the scope event messages.

Declaration

EventMessages Messages { get; }

Property Value

Type	Description
EventMessages

Notifications

Gets the scope notification publisher

Declaration

IScopedNotificationPublisher Notifications { get; }

Property Value

Type	Description
IScopedNotificationPublisher

RepositoryCacheMode

Gets the repositories cache mode.

Declaration

RepositoryCacheMode RepositoryCacheMode { get; }

Property Value

Type	Description
RepositoryCacheMode

SqlContext

Gets the Sql context.

Declaration

ISqlContext SqlContext { get; }

Property Value

Type	Description
ISqlContext

Methods

Complete()

Completes the scope.

Declaration

bool Complete()

Returns

Type	Description
bool	A value indicating whether the scope has been successfully completed.

Remarks

Can return false if any child scope has not completed.

EagerReadLock(params int[])

Eagerly acquires read locks on the specified lock objects.

Declaration

void EagerReadLock(params int[] lockIds)

Parameters

Type	Name	Description
int[]	lockIds	Array of lock object identifiers.

EagerReadLock(TimeSpan, int)

Eagerly acquires a read lock on the specified lock object with a timeout.

Declaration

void EagerReadLock(TimeSpan timeout, int lockId)

Parameters

Type	Name	Description
TimeSpan	timeout	The database timeout.
int	lockId	The lock object identifier.

EagerWriteLock(params int[])

Eagerly acquires write locks on the specified lock objects.

Declaration

void EagerWriteLock(params int[] lockIds)

Parameters

Type	Name	Description
int[]	lockIds	Array of lock object identifiers.

EagerWriteLock(TimeSpan, int)

Eagerly acquires a write lock on the specified lock object with a timeout.

Declaration

void EagerWriteLock(TimeSpan timeout, int lockId)

Parameters

Type	Name	Description
TimeSpan	timeout	The database timeout.
int	lockId	The lock object identifier.

ReadLock(params int[])

Read-locks some lock objects.

Declaration

void ReadLock(params int[] lockIds)

Parameters

Type	Name	Description
int[]	lockIds	Array of lock object identifiers.

ReadLock(TimeSpan, int)

Read-locks some lock objects.

Declaration

void ReadLock(TimeSpan timeout, int lockId)

Parameters

Type	Name	Description
TimeSpan	timeout	The database timeout in milliseconds
int	lockId	The lock object identifier.

WriteLock(params int[])

Write-locks some lock objects.

Declaration

void WriteLock(params int[] lockIds)

Parameters

Type	Name	Description
int[]	lockIds	Array of object identifiers.

WriteLock(TimeSpan, int)

Write-locks some lock objects.

Declaration

void WriteLock(TimeSpan timeout, int lockId)

Parameters

Type	Name	Description
TimeSpan	timeout	The database timeout in milliseconds
int	lockId	The lock object identifier.