blob: d1f3f5d2fa08824939b38e478ff6e67a5c5ff201 [file] [log] [blame]
/*
* Copyright (C) 2021, Apple Inc. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS'' AND ANY
* EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS BE LIABLE FOR ANY
* DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
* ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
[
EnabledAtRuntime=WebLocksAPIEnabled,
Exposed=(Window,Worker),
InterfaceName=LockManager,
ImplementationLacksVTable,
SecureContext
] interface WebLockManager {
Promise<any> request(DOMString name, WebLockGrantedCallback grantedCallback);
Promise<any> request(DOMString name, WebLockOptions options, WebLockGrantedCallback grantedCallback);
Promise<WebLockManagerSnapshot> query();
};
dictionary WebLockOptions {
WebLockMode mode = "exclusive";
boolean ifAvailable = false;
boolean steal = false;
AbortSignal signal;
};
dictionary WebLockManagerSnapshot {
sequence<WebLockInfo> held;
sequence<WebLockInfo> pending;
};
dictionary WebLockInfo {
DOMString name;
WebLockMode mode;
DOMString clientId;
};