method

App.DocumentLock

func (application *App) DocumentLock(
	ctx context.Context,
	collection,
	documentID string,
	identity *AuthIdentity,
) (DocumentLockState, error)

Read one document lock after read authorization.

Source core/locks.go:22

@param ctx: The ctx value.
@param collection: The collection value.
@param documentID: The documentID value.
@param identity: The identity value.
@returns: The declared result.

Related types

App
A resolved application bound to operation services.
AuthIdentity
An exact authenticated collection and actor document.
DocumentLockState
Safe current lock metadata and actor capabilities.