AdvantageCSP Client API
AdvantageCMS.Core.Admin Namespace
AdvantageCMS.Core.Admin.BaseClasses Namespace
AdvantageCMS.Core.Admin.BaseClasses.ControlSettings Namespace
AdvantageCMS.Core.Admin.BusinessEntity Namespace
AdvantageCMS.Core.Admin.Engine Namespace
AdvantageCMS.Core.Admin.Enums Namespace
AdvantageCMS.Core.Admin.Event Namespace
AdvantageCMS.Core.Admin.Interfaces Namespace
AdvantageCMS.Core.Common Namespace
AdvantageCMS.Core.Common.AsyncJob Namespace
AdvantageCMS.Core.Common.BaseClasses Namespace
AdvantageCMS.Core.Common.BaseClasses.Handler Namespace
AdvantageCMS.Core.Common.BaseClasses.Webhook Namespace
AdvantageCMS.Core.Common.BusinessEntity Namespace
AdvantageCMS.Core.Common.Engine Namespace
AdvantageCMS.Core.Common.Enums Namespace
AdvantageCMS.Core.Common.Extension Namespace
AdvantageCMS.Core.Common.Interfaces Namespace
AdvantageCMS.Core.Common.SitemapGenerator Namespace
AdvantageCMS.Core.Keyoti Namespace
AdvantageCMS.Core.Resource Namespace
AdvantageCMS.Core.Routing Namespace
AdvantageCMS.Core.SMTP Namespace
AdvantageCMS.Core.Utils Namespace
AdvantageCMS.Core.Utils.Cache Namespace
AdvantageCMS.Core.Utils.Cache.Containers Namespace
AdvantageCMS.Core.Utils.Parser Namespace
AdvantageCMS.Data Namespace
AdvantageCMS.Data.Interfaces Namespace
AdvantageCMS.Web.UI Namespace
AdvantageCMS.Web.UI.Admin Namespace
AdvantageCMS.Web.UI.Admin.Selectors Namespace
AdvantageCMS.Web.UI.Admin.Tools Namespace
AdvantageCMS.Web.UI.Helpers Namespace
AdvantageCSP.AdvantageAPI Namespace
AdvantageCSP.API Namespace
AdvantageCSP.API.Classes Namespace
AdvantageCSP.API.Request Namespace
AdvantageCSP.Core.HierarchicalList Namespace
AdvantageCSP.HierarchicalModelDataSource Namespace
AdvantageCSP.Keyoti.SiteIndexer Namespace
AdvantageCSP.Snipcart Namespace
AdvantageCSP.Snipcart.Engine Namespace
AdvantageCSP.Snipcart.Enums Namespace
AdvantageCSP.Snipcart.Interfaces Namespace
Advantage CSP

AdvantageModule..::..Client_ObjectLock Method

Requests an object lock for a specified user and master identifier.

This will attempt to lock the record on the server and return the status. It will generate the javascript client code to poll for refresh/locking.

Successful API requests will return the status of the lock : { Status: 0, Message: '', UserName: '' }.

Status

  • Error = -1
  • Unlocked = 0
  • Locked = 0
  • LockedByOtherSession = 0

Message

  • The return message from the lock request

UserName

  • The user who currently owns the lock

Namespace:  AdvantageCMS.Core.Common.BaseClasses
Assembly:  AdvantageCMS.Core (in AdvantageCMS.Core.dll)

Syntax

public LockStatus Client_ObjectLock(
	string userLockKey,
	Guid masterId,
	string userName,
	string successFunction,
	string failureFunction,
	int refreshSeconds,
	int delayUnlockSeconds
)

Parameters

userLockKey
Type: String
The unique key identifying the user lock.
masterId
Type: Guid
The identifier of the master object to be locked.
userName
Type: String
The name of the user requesting the lock.
successFunction
Type: String

i.e. successLock(data)

The function to be executed upon successful lock acquisition. A JavaScript Object parameter with properties will be returned: { Status: 1, Message: '', UserName: '' }

failureFunction
Type: String

i.e. failedLock(data)

The function to be executed upon failure to acquire the lock. A JavaScript Object parameter with properties will be returned: { Status: 0, Message: '', UserName: '' }

refreshSeconds
Type: Int32
delayUnlockSeconds
Type: Int32
The number of seconds to delay before expiring the lock

Return Value

The status of the lock request.

See Also

AdvantageModule Class
AdvantageCMS.Core.Common.BaseClasses Namespace