SP.File.lockedByUser property (sp.js)

Gets a value that returns the user that owns the current lock on the file.

Applies to: apps for SharePoint | SharePoint Foundation 2013 | SharePoint Server 2013

var value = SP.File.get_lockedByUser ()

Return value

Type: SP.User


It must return null if there is no lock. It must return null if there is no lock.

REST resource endpoint

See File resource for more information.

Endpoint URI structure


HTTP requests

This resource supports the following HTTP commands:

  • POST

POST syntax

POST http://<sitecollection>/<site>/_api/web/folders/getbyurl(folderrelativeurl)/files/getbyurl(filerelativeurl)/lockedByUser

GET syntax

GET http://<sitecollection>/<site>/_api/web/folders/getbyurl(folderrelativeurl)/files/getbyurl(filerelativeurl)/lockedByUser