View Source

Interface ICoreScope

Represents a scope.

Namespace: Umbraco.Cms.Core.Scoping

Assembly: Umbraco.Core.dll

Syntax

public interface ICoreScope : IInstanceIdentifiable

Properties

Depth

Gets the distance from the root scope.

Declaration

int Depth { get; }

Property Value

Type	Description
int

Remarks

A zero represents a root scope, any value greater than zero represents a child scope.

IsolatedCaches

Gets the scope isolated cache.

Declaration

IsolatedCaches IsolatedCaches { get; }

Property Value

Type	Description
IsolatedCaches

Locks

Declaration

ILockingMechanism Locks { get; }

Property Value

Type	Description
ILockingMechanism

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

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[])

Declaration

void EagerReadLock(params int[] lockIds)

Parameters

Type	Name	Description
int[]	lockIds

EagerReadLock(TimeSpan, int)

Declaration

void EagerReadLock(TimeSpan timeout, int lockId)

Parameters

Type	Name	Description
TimeSpan	timeout
int	lockId

EagerWriteLock(params int[])

Declaration

void EagerWriteLock(params int[] lockIds)

Parameters

Type	Name	Description
int[]	lockIds

EagerWriteLock(TimeSpan, int)

Declaration

void EagerWriteLock(TimeSpan timeout, int lockId)

Parameters

Type	Name	Description
TimeSpan	timeout
int	lockId

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.