@types/chrome 0.0.286 → 0.0.288
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- chrome/README.md +1 -1
- chrome/index.d.ts +262 -331
- chrome/package.json +2 -2
chrome/README.md
CHANGED
@@ -8,7 +8,7 @@ This package contains type definitions for chrome (http://developer.chrome.com/e
|
|
8
8
|
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/chrome.
|
9
9
|
|
10
10
|
### Additional Details
|
11
|
-
* Last updated:
|
11
|
+
* Last updated: Thu, 02 Jan 2025 18:37:07 GMT
|
12
12
|
* Dependencies: [@types/filesystem](https://npmjs.com/package/@types/filesystem), [@types/har-format](https://npmjs.com/package/@types/har-format)
|
13
13
|
|
14
14
|
# Credits
|
chrome/index.d.ts
CHANGED
@@ -21,53 +21,53 @@ declare namespace chrome {
|
|
21
21
|
*/
|
22
22
|
export namespace accessibilityFeatures {
|
23
23
|
/** **ChromeOS only.** Spoken feedback (text-to-speech). */
|
24
|
-
export var spokenFeedback: chrome.types.ChromeSetting
|
24
|
+
export var spokenFeedback: chrome.types.ChromeSetting<boolean>;
|
25
25
|
/** **ChromeOS only.** Enlarged cursor. */
|
26
|
-
export var largeCursor: chrome.types.ChromeSetting
|
26
|
+
export var largeCursor: chrome.types.ChromeSetting<boolean>;
|
27
27
|
/** **ChromeOS only.** Sticky modifier keys (like shift or alt). */
|
28
|
-
export var stickyKeys: chrome.types.ChromeSetting
|
28
|
+
export var stickyKeys: chrome.types.ChromeSetting<boolean>;
|
29
29
|
/** **ChromeOS only.** High contrast rendering mode. */
|
30
|
-
export var highContrast: chrome.types.ChromeSetting
|
30
|
+
export var highContrast: chrome.types.ChromeSetting<boolean>;
|
31
31
|
/** **ChromeOS only.** Full screen magnification. */
|
32
|
-
export var screenMagnifier: chrome.types.ChromeSetting
|
32
|
+
export var screenMagnifier: chrome.types.ChromeSetting<boolean>;
|
33
33
|
/** **ChromeOS only.** Auto mouse click after mouse stops moving. */
|
34
|
-
export var autoclick: chrome.types.ChromeSetting
|
34
|
+
export var autoclick: chrome.types.ChromeSetting<boolean>;
|
35
35
|
/** **ChromeOS only.** Virtual on-screen keyboard. */
|
36
|
-
export var virtualKeyboard: chrome.types.ChromeSetting
|
36
|
+
export var virtualKeyboard: chrome.types.ChromeSetting<boolean>;
|
37
37
|
/**
|
38
38
|
* **ChromeOS only.**
|
39
39
|
* Caret highlighting.
|
40
40
|
* @since Chrome 51
|
41
41
|
*/
|
42
|
-
export var caretHighlight: chrome.types.ChromeSetting
|
42
|
+
export var caretHighlight: chrome.types.ChromeSetting<boolean>;
|
43
43
|
/**
|
44
44
|
* **ChromeOS only.**
|
45
45
|
* Cursor highlighting.
|
46
46
|
* @since Chrome 51
|
47
47
|
*/
|
48
|
-
export var cursorHighlight: chrome.types.ChromeSetting
|
48
|
+
export var cursorHighlight: chrome.types.ChromeSetting<boolean>;
|
49
49
|
/**
|
50
50
|
* **ChromeOS only.**
|
51
51
|
* Focus highlighting.
|
52
52
|
* @since Chrome 51
|
53
53
|
*/
|
54
|
-
export var focusHighlight: chrome.types.ChromeSetting
|
54
|
+
export var focusHighlight: chrome.types.ChromeSetting<boolean>;
|
55
55
|
/**
|
56
56
|
* **ChromeOS only.**
|
57
57
|
* Select-to-speak.
|
58
58
|
* @since Chrome 51
|
59
59
|
*/
|
60
|
-
export var selectToSpeak: chrome.types.ChromeSetting
|
60
|
+
export var selectToSpeak: chrome.types.ChromeSetting<boolean>;
|
61
61
|
/**
|
62
62
|
* **ChromeOS only.**
|
63
63
|
* Switch Access.
|
64
64
|
* @since Chrome 51
|
65
65
|
*/
|
66
|
-
export var switchAccess: chrome.types.ChromeSetting
|
66
|
+
export var switchAccess: chrome.types.ChromeSetting<boolean>;
|
67
67
|
/**
|
68
68
|
* @since Chrome 42
|
69
69
|
*/
|
70
|
-
export var animationPolicy: chrome.types.ChromeSetting
|
70
|
+
export var animationPolicy: chrome.types.ChromeSetting<"allowed" | "once" | "none">;
|
71
71
|
}
|
72
72
|
|
73
73
|
////////////////////
|
@@ -7237,46 +7237,49 @@ declare namespace chrome {
|
|
7237
7237
|
* @since Chrome 18
|
7238
7238
|
*/
|
7239
7239
|
export namespace privacy {
|
7240
|
+
/**
|
7241
|
+
* The IP handling policy of WebRTC.
|
7242
|
+
* @since Chrome 48
|
7243
|
+
*/
|
7244
|
+
export type IPHandlingPolicy =
|
7245
|
+
| "default"
|
7246
|
+
| "default_public_and_private_interfaces"
|
7247
|
+
| "default_public_interface_only"
|
7248
|
+
| "disable_non_proxied_udp";
|
7249
|
+
|
7240
7250
|
export interface Services {
|
7241
7251
|
/** @since Chrome 20 */
|
7242
|
-
spellingServiceEnabled: chrome.types.ChromeSetting
|
7243
|
-
searchSuggestEnabled: chrome.types.ChromeSetting
|
7244
|
-
|
7245
|
-
|
7246
|
-
safeBrowsingEnabled: chrome.types.ChromeSetting;
|
7252
|
+
spellingServiceEnabled: chrome.types.ChromeSetting<boolean>;
|
7253
|
+
searchSuggestEnabled: chrome.types.ChromeSetting<boolean>;
|
7254
|
+
alternateErrorPagesEnabled: chrome.types.ChromeSetting<boolean>;
|
7255
|
+
safeBrowsingEnabled: chrome.types.ChromeSetting<boolean>;
|
7247
7256
|
/** @deprecated since Chrome 70. Please use privacy.services.autofillAddressEnabled and privacy.services.autofillCreditCardEnabled. */
|
7248
|
-
autofillEnabled: chrome.types.ChromeSetting
|
7249
|
-
translationServiceEnabled: chrome.types.ChromeSetting
|
7257
|
+
autofillEnabled: chrome.types.ChromeSetting<boolean>;
|
7258
|
+
translationServiceEnabled: chrome.types.ChromeSetting<boolean>;
|
7250
7259
|
/** @since Chrome 38 */
|
7251
|
-
passwordSavingEnabled: chrome.types.ChromeSetting
|
7260
|
+
passwordSavingEnabled: chrome.types.ChromeSetting<boolean>;
|
7252
7261
|
/** @since Chrome 42 */
|
7253
|
-
|
7254
|
-
/** @since Chrome 42 */
|
7255
|
-
safeBrowsingExtendedReportingEnabled: chrome.types.ChromeSetting;
|
7262
|
+
safeBrowsingExtendedReportingEnabled: chrome.types.ChromeSetting<boolean>;
|
7256
7263
|
/** @since Chrome 70 */
|
7257
|
-
autofillAddressEnabled: chrome.types.ChromeSetting
|
7264
|
+
autofillAddressEnabled: chrome.types.ChromeSetting<boolean>;
|
7258
7265
|
/** @since Chrome 70 */
|
7259
|
-
autofillCreditCardEnabled: chrome.types.ChromeSetting
|
7266
|
+
autofillCreditCardEnabled: chrome.types.ChromeSetting<boolean>;
|
7260
7267
|
}
|
7261
7268
|
|
7262
7269
|
export interface Network {
|
7263
|
-
networkPredictionEnabled: chrome.types.ChromeSetting
|
7264
|
-
/** @deprecated since Chrome 48. Please use privacy.network.webRTCIPHandlingPolicy. */
|
7265
|
-
webRTCMultipleRoutesEnabled: chrome.types.ChromeSetting;
|
7266
|
-
/** @deprecated since Chrome 48. Please use privacy.network.webRTCIPHandlingPolicy. */
|
7267
|
-
webRTCNonProxiedUdpEnabled: chrome.types.ChromeSetting;
|
7270
|
+
networkPredictionEnabled: chrome.types.ChromeSetting<boolean>;
|
7268
7271
|
/** @since Chrome 48 */
|
7269
|
-
webRTCIPHandlingPolicy: chrome.types.ChromeSetting
|
7272
|
+
webRTCIPHandlingPolicy: chrome.types.ChromeSetting<IPHandlingPolicy>;
|
7270
7273
|
}
|
7271
7274
|
|
7272
7275
|
export interface Websites {
|
7273
|
-
thirdPartyCookiesAllowed: chrome.types.ChromeSetting
|
7274
|
-
referrersEnabled: chrome.types.ChromeSetting
|
7275
|
-
hyperlinkAuditingEnabled: chrome.types.ChromeSetting
|
7276
|
+
thirdPartyCookiesAllowed: chrome.types.ChromeSetting<boolean>;
|
7277
|
+
referrersEnabled: chrome.types.ChromeSetting<boolean>;
|
7278
|
+
hyperlinkAuditingEnabled: chrome.types.ChromeSetting<boolean>;
|
7276
7279
|
/** @since Chrome 21. Available on Windows and ChromeOS only. */
|
7277
|
-
protectedContentEnabled: chrome.types.ChromeSetting
|
7280
|
+
protectedContentEnabled: chrome.types.ChromeSetting<boolean>;
|
7278
7281
|
/** @since Chrome 65 */
|
7279
|
-
doNotTrackEnabled: chrome.types.ChromeSetting
|
7282
|
+
doNotTrackEnabled: chrome.types.ChromeSetting<boolean>;
|
7280
7283
|
}
|
7281
7284
|
|
7282
7285
|
/** Settings that enable or disable features that require third-party network services provided by Google and your default search provider. */
|
@@ -7359,7 +7362,7 @@ declare namespace chrome {
|
|
7359
7362
|
|
7360
7363
|
export interface ProxyErrorEvent extends chrome.events.Event<(details: ErrorDetails) => void> {}
|
7361
7364
|
|
7362
|
-
export var settings: chrome.types.ChromeSetting
|
7365
|
+
export var settings: chrome.types.ChromeSetting<ProxyConfig>;
|
7363
7366
|
/** Notifies about proxy errors. */
|
7364
7367
|
export var onProxyError: ProxyErrorEvent;
|
7365
7368
|
}
|
@@ -9368,21 +9371,33 @@ declare namespace chrome {
|
|
9368
9371
|
////////////////////
|
9369
9372
|
/**
|
9370
9373
|
* Use the system.display API to query display metadata.
|
9371
|
-
* Permissions:
|
9374
|
+
* Permissions: "system.display"
|
9372
9375
|
* @since Chrome 30
|
9373
9376
|
*/
|
9374
9377
|
export namespace system.display {
|
9375
|
-
export
|
9376
|
-
TOP
|
9377
|
-
RIGHT
|
9378
|
-
BOTTOM
|
9379
|
-
LEFT
|
9380
|
-
}
|
9381
|
-
|
9382
|
-
|
9383
|
-
|
9384
|
-
|
9385
|
-
|
9378
|
+
export enum LayoutPosition {
|
9379
|
+
TOP = "top",
|
9380
|
+
RIGHT = "right",
|
9381
|
+
BOTTOM = "bottom",
|
9382
|
+
LEFT = "left",
|
9383
|
+
}
|
9384
|
+
|
9385
|
+
/**
|
9386
|
+
* Mirror mode, i.e. different ways of how a display is mirrored to other displays.
|
9387
|
+
* @since Chrome 65
|
9388
|
+
*/
|
9389
|
+
export enum MirrorMode {
|
9390
|
+
/** Specifies the default mode (extended or unified desktop). */
|
9391
|
+
OFF = "off",
|
9392
|
+
/** Specifies that the default source display will be mirrored to all other displays. */
|
9393
|
+
NORMAL = "normal",
|
9394
|
+
/**
|
9395
|
+
* Specifies that the specified source display will be mirrored to the provided destination displays.
|
9396
|
+
* All other connected displays will be extended.
|
9397
|
+
*/
|
9398
|
+
MIXED = "mixed",
|
9399
|
+
}
|
9400
|
+
|
9386
9401
|
export interface Bounds {
|
9387
9402
|
/** The x-coordinate of the upper-left corner. */
|
9388
9403
|
left: number;
|
@@ -9405,9 +9420,7 @@ declare namespace chrome {
|
|
9405
9420
|
bottom: number;
|
9406
9421
|
}
|
9407
9422
|
|
9408
|
-
/**
|
9409
|
-
* @since Chrome 57
|
9410
|
-
*/
|
9423
|
+
/** @since Chrome 57 */
|
9411
9424
|
export interface Point {
|
9412
9425
|
/** The x-coordinate of the point. */
|
9413
9426
|
x: number;
|
@@ -9415,9 +9428,7 @@ declare namespace chrome {
|
|
9415
9428
|
y: number;
|
9416
9429
|
}
|
9417
9430
|
|
9418
|
-
/**
|
9419
|
-
* @since Chrome 57
|
9420
|
-
*/
|
9431
|
+
/** @since Chrome 57 */
|
9421
9432
|
export interface TouchCalibrationPair {
|
9422
9433
|
/** The coordinates of the display point. */
|
9423
9434
|
displayPoint: Point;
|
@@ -9425,47 +9436,40 @@ declare namespace chrome {
|
|
9425
9436
|
touchPoint: Point;
|
9426
9437
|
}
|
9427
9438
|
|
9428
|
-
/**
|
9429
|
-
* @since Chrome 52
|
9430
|
-
*/
|
9439
|
+
/** @since Chrome 52 */
|
9431
9440
|
export interface DisplayMode {
|
9432
9441
|
/** The display mode width in device independent (user visible) pixels. */
|
9433
9442
|
width: number;
|
9434
|
-
|
9435
9443
|
/** The display mode height in device independent (user visible) pixels. */
|
9436
9444
|
height: number;
|
9437
|
-
|
9438
9445
|
/** The display mode width in native pixels. */
|
9439
9446
|
widthInNativePixels: number;
|
9440
|
-
|
9441
9447
|
/** The display mode height in native pixels. */
|
9442
9448
|
heightInNativePixels: number;
|
9443
|
-
|
9444
9449
|
/**
|
9450
|
+
* True if this mode is interlaced, false if not provided.
|
9451
|
+
* @since Chrome 74
|
9452
|
+
*/
|
9453
|
+
isInterlaced?: boolean;
|
9454
|
+
/**
|
9455
|
+
* The display mode UI scale factor.
|
9445
9456
|
* @deprecated Deprecated since Chrome 70. Use `displayZoomFactor`
|
9446
|
-
* @description The display mode UI scale factor.
|
9447
9457
|
*/
|
9448
|
-
uiScale
|
9449
|
-
|
9458
|
+
uiScale?: number;
|
9450
9459
|
/** The display mode device scale factor. */
|
9451
9460
|
deviceScaleFactor: number;
|
9452
|
-
|
9453
9461
|
/**
|
9454
9462
|
* The display mode refresh rate in hertz.
|
9455
9463
|
* @since Chrome 67
|
9456
9464
|
*/
|
9457
9465
|
refreshRate: number;
|
9458
|
-
|
9459
9466
|
/** True if the mode is the display's native mode. */
|
9460
9467
|
isNative: boolean;
|
9461
|
-
|
9462
9468
|
/** True if the display mode is currently selected. */
|
9463
9469
|
isSelected: boolean;
|
9464
9470
|
}
|
9465
9471
|
|
9466
|
-
/**
|
9467
|
-
* @since Chrome 53
|
9468
|
-
*/
|
9472
|
+
/** @since Chrome 53 */
|
9469
9473
|
export interface DisplayLayout {
|
9470
9474
|
/** The unique identifier of the display. */
|
9471
9475
|
id: string;
|
@@ -9474,17 +9478,14 @@ declare namespace chrome {
|
|
9474
9478
|
/**
|
9475
9479
|
* The layout position of this display relative to the parent.
|
9476
9480
|
* This will be ignored for the root.
|
9477
|
-
* @see enum
|
9478
9481
|
*/
|
9479
|
-
position:
|
9482
|
+
position: `${LayoutPosition}`;
|
9480
9483
|
/** The offset of the display along the connected edge. 0 indicates that the topmost or leftmost corners are aligned. */
|
9481
9484
|
offset: number;
|
9482
9485
|
}
|
9483
9486
|
|
9484
|
-
/**
|
9485
|
-
|
9486
|
-
*/
|
9487
|
-
export interface TouchCalibrationPairs {
|
9487
|
+
/** The pairs of point used to calibrate the display. */
|
9488
|
+
export interface TouchCalibrationPairQuad {
|
9488
9489
|
/** First pair of touch and display point required for touch calibration. */
|
9489
9490
|
pair1: TouchCalibrationPair;
|
9490
9491
|
/** Second pair of touch and display point required for touch calibration. */
|
@@ -9495,49 +9496,38 @@ declare namespace chrome {
|
|
9495
9496
|
pair4: TouchCalibrationPair;
|
9496
9497
|
}
|
9497
9498
|
|
9498
|
-
|
9499
|
-
* Representation of info data to be used in chrome.system.display.setDisplayProperties()
|
9500
|
-
*/
|
9501
|
-
export interface DisplayPropertiesInfo {
|
9499
|
+
export interface DisplayProperties {
|
9502
9500
|
/**
|
9503
|
-
*
|
9504
|
-
* @description
|
9505
|
-
* If set to true, changes the display mode to unified desktop.
|
9501
|
+
* If set to true, changes the display mode to unified desktop (see `enableUnifiedDesktop` for details).
|
9506
9502
|
* If set to false, unified desktop mode will be disabled.
|
9507
9503
|
* This is only valid for the primary display.
|
9508
|
-
* If provided, mirroringSourceId must not be provided and other properties
|
9504
|
+
* If provided, mirroringSourceId must not be provided and other properties will be ignored.
|
9509
9505
|
* This is has no effect if not provided.
|
9510
|
-
* @
|
9506
|
+
* @platform ChromeOS only
|
9511
9507
|
* @since Chrome 59
|
9512
9508
|
*/
|
9513
9509
|
isUnified?: boolean | undefined;
|
9514
|
-
|
9515
9510
|
/**
|
9516
|
-
*
|
9517
|
-
*
|
9518
|
-
*
|
9519
|
-
* @description
|
9520
|
-
* If set and not empty, enables mirroring for this display.
|
9521
|
-
* Otherwise disables mirroring for this display.
|
9522
|
-
* This value should indicate the id of the source display to mirror,
|
9523
|
-
* which must not be the same as the id passed to setDisplayProperties.
|
9511
|
+
* If set and not empty, enables mirroring for this display only.
|
9512
|
+
* Otherwise disables mirroring for all displays.
|
9513
|
+
* This value should indicate the id of the source display to mirror, which must not be the same as the id passed to setDisplayProperties.
|
9524
9514
|
* If set, no other property may be set.
|
9515
|
+
* @platform ChromeOS only
|
9516
|
+
* @deprecated Deprecated since Chrome 68. Use ´setMirrorMode´
|
9525
9517
|
*/
|
9526
9518
|
mirroringSourceId?: string | undefined;
|
9527
|
-
|
9528
9519
|
/**
|
9529
9520
|
* If set to true, makes the display primary.
|
9530
9521
|
* No-op if set to false.
|
9522
|
+
* Note: If set, the display is considered primary for all other properties (i.e. `isUnified` may be set and bounds origin may not).
|
9531
9523
|
*/
|
9532
9524
|
isPrimary?: boolean | undefined;
|
9533
|
-
|
9534
9525
|
/**
|
9535
9526
|
* If set, sets the display's overscan insets to the provided values.
|
9536
9527
|
* Note that overscan values may not be negative or larger than a half of the screen's size.
|
9537
|
-
* Overscan cannot be changed on the internal monitor.
|
9528
|
+
* Overscan cannot be changed on the internal monitor.
|
9538
9529
|
*/
|
9539
9530
|
overscan?: Insets | undefined;
|
9540
|
-
|
9541
9531
|
/**
|
9542
9532
|
* If set, updates the display's rotation.
|
9543
9533
|
* Legal values are [0, 90, 180, 270].
|
@@ -9545,38 +9535,31 @@ declare namespace chrome {
|
|
9545
9535
|
* It's applied after overscan parameter.
|
9546
9536
|
*/
|
9547
9537
|
rotation?: 0 | 90 | 180 | 270 | undefined;
|
9548
|
-
|
9549
9538
|
/**
|
9550
|
-
* If set, updates the display's logical bounds origin along x-axis.
|
9551
|
-
* Applied together with boundsOriginY
|
9552
|
-
*
|
9553
|
-
* so the final bounds origin may be different than the one set.
|
9554
|
-
* The final bounds can be retrieved using getInfo
|
9555
|
-
*
|
9556
|
-
* Note that is also invalid to set bounds origin values if isPrimary is also set
|
9557
|
-
* (as isPrimary parameter is applied first).
|
9539
|
+
* If set, updates the display's logical bounds origin along the x-axis.
|
9540
|
+
* Applied together with `boundsOriginY`.
|
9541
|
+
* Defaults to the current value if not set and `boundsOriginY` is set.
|
9542
|
+
* Note that when updating the display origin, some constraints will be applied, so the final bounds origin may be different than the one set.
|
9543
|
+
* The final bounds can be retrieved using `getInfo`.
|
9544
|
+
* The bounds origin cannot be changed on the primary display.
|
9558
9545
|
*/
|
9559
9546
|
boundsOriginX?: number | undefined;
|
9560
|
-
|
9561
9547
|
/**
|
9562
|
-
* If set, updates the display's logical bounds origin along y-axis.
|
9563
|
-
*
|
9548
|
+
* If set, updates the display's logical bounds origin along the y-axis.
|
9549
|
+
* See documentation for `boundsOriginX` parameter.
|
9564
9550
|
*/
|
9565
9551
|
boundsOriginY?: number | undefined;
|
9566
|
-
|
9567
9552
|
/**
|
9568
9553
|
* If set, updates the display mode to the mode matching this value.
|
9554
|
+
* If other parameters are invalid, this will not be applied.
|
9555
|
+
* If the display mode is invalid, it will not be applied and an error will be set, but other properties will still be applied.
|
9569
9556
|
* @since Chrome 52
|
9570
9557
|
*/
|
9571
9558
|
displayMode?: DisplayMode | undefined;
|
9572
|
-
|
9573
9559
|
/**
|
9574
|
-
* @since Chrome 65
|
9575
|
-
* @description
|
9576
9560
|
* If set, updates the zoom associated with the display.
|
9577
|
-
* This zoom performs re-layout and repaint thus resulting
|
9578
|
-
*
|
9579
|
-
* a pixel by pixel stretch enlargement.
|
9561
|
+
* This zoom performs re-layout and repaint thus resulting in a better quality zoom than just performing a pixel by pixel stretch enlargement.
|
9562
|
+
* @since Chrome 65
|
9580
9563
|
*/
|
9581
9564
|
displayZoomFactor?: number | undefined;
|
9582
9565
|
}
|
@@ -9585,10 +9568,9 @@ declare namespace chrome {
|
|
9585
9568
|
* Options affecting how the information is returned.
|
9586
9569
|
* @since Chrome 59
|
9587
9570
|
*/
|
9588
|
-
export interface
|
9571
|
+
export interface GetInfoFlags {
|
9589
9572
|
/**
|
9590
|
-
* If set to true, only a single DisplayUnitInfo will be returned by getInfo when in unified desktop mode.
|
9591
|
-
* @see enableUnifiedDesktop
|
9573
|
+
* If set to true, only a single `DisplayUnitInfo` will be returned by `getInfo` when in unified desktop mode (see `enableUnifiedDesktop`).
|
9592
9574
|
* @default false
|
9593
9575
|
*/
|
9594
9576
|
singleUnified?: boolean | undefined;
|
@@ -9600,51 +9582,37 @@ declare namespace chrome {
|
|
9600
9582
|
* This state is used to keep existing display when the all displays are disconnected, for example.
|
9601
9583
|
* @since Chrome 117
|
9602
9584
|
*/
|
9603
|
-
export
|
9585
|
+
export enum ActiveState {
|
9586
|
+
ACTIVE = "active",
|
9587
|
+
INACTIVE = "inactive",
|
9588
|
+
}
|
9604
9589
|
|
9605
|
-
|
9606
|
-
export interface DisplayInfo {
|
9590
|
+
export interface DisplayUnitInfo {
|
9607
9591
|
/**
|
9608
9592
|
* Active if the display is detected and used by the system.
|
9609
9593
|
* @since Chrome 117
|
9610
9594
|
*/
|
9611
|
-
activeState:
|
9595
|
+
activeState: `${ActiveState}`;
|
9612
9596
|
/** The unique identifier of the display. */
|
9613
9597
|
id: string;
|
9614
9598
|
/** The user-friendly name (e.g. 'HP LCD monitor'). */
|
9615
9599
|
name: string;
|
9616
9600
|
/**
|
9617
|
-
*
|
9601
|
+
* @platform ChromeOS and Web UI only
|
9618
9602
|
* @since Chrome 67
|
9619
9603
|
*/
|
9620
|
-
edid?:
|
9621
|
-
/**
|
9622
|
-
* 3 character manufacturer code.
|
9623
|
-
*/
|
9624
|
-
manufacturerId: string;
|
9625
|
-
/**
|
9626
|
-
* 2 byte manufacturer-assigned code.
|
9627
|
-
*/
|
9628
|
-
productId: string;
|
9629
|
-
/**
|
9630
|
-
* Year of manufacturer.
|
9631
|
-
*/
|
9632
|
-
yearOfManufacture?: string | undefined;
|
9633
|
-
} | undefined;
|
9604
|
+
edid?: Edid;
|
9634
9605
|
/**
|
9635
|
-
*
|
9636
|
-
*
|
9637
|
-
*
|
9638
|
-
* Currently exposed only on ChromeOS.
|
9639
|
-
* Will be empty string on other platforms.
|
9606
|
+
* Identifier of the display that is being mirrored if mirroring is enabled, otherwise empty.
|
9607
|
+
* This will be set for all displays (including the display being mirrored).
|
9608
|
+
* @platform ChromeOS only
|
9640
9609
|
*/
|
9641
9610
|
mirroringSourceId: string;
|
9642
9611
|
/**
|
9643
|
-
* requires(CrOS) Only available on Chrome OS.
|
9644
9612
|
* Identifiers of the displays to which the source display is being mirrored.
|
9645
|
-
* Empty if no displays are being mirrored.
|
9646
|
-
*
|
9647
|
-
*
|
9613
|
+
* Empty if no displays are being mirrored.
|
9614
|
+
* This must not include `mirroringSourceId`.
|
9615
|
+
* @platform ChromeOS only
|
9648
9616
|
* @since Chrome 64
|
9649
9617
|
*/
|
9650
9618
|
mirroringDestinationIds: string[];
|
@@ -9655,7 +9623,7 @@ declare namespace chrome {
|
|
9655
9623
|
/** True if this display is enabled. */
|
9656
9624
|
isEnabled: boolean;
|
9657
9625
|
/**
|
9658
|
-
* True for all displays when in unified desktop mode
|
9626
|
+
* True for all displays when in unified desktop mode. See documentation for `enableUnifiedDesktop`.
|
9659
9627
|
* @since Chrome 59
|
9660
9628
|
*/
|
9661
9629
|
isUnified: boolean;
|
@@ -9663,24 +9631,37 @@ declare namespace chrome {
|
|
9663
9631
|
dpiX: number;
|
9664
9632
|
/** The number of pixels per inch along the y-axis. */
|
9665
9633
|
dpiY: number;
|
9666
|
-
/** The display's clockwise rotation in degrees relative to the vertical position.
|
9634
|
+
/** The display's clockwise rotation in degrees relative to the vertical position.
|
9635
|
+
* Currently exposed only on ChromeOS. Will be set to 0 on other platforms.
|
9636
|
+
* A value of -1 will be interpreted as auto-rotate when the device is in a physical tablet state.
|
9637
|
+
* @platform ChromeOS only
|
9638
|
+
*/
|
9667
9639
|
rotation: number;
|
9668
9640
|
/** The display's logical bounds. */
|
9669
9641
|
bounds: Bounds;
|
9670
|
-
/**
|
9642
|
+
/**
|
9643
|
+
* The display's insets within its screen's bounds.
|
9644
|
+
* Currently exposed only on ChromeOS. Will be set to empty insets on other platforms.
|
9645
|
+
* @platform ChromeOS only
|
9646
|
+
*/
|
9671
9647
|
overscan: Insets;
|
9672
|
-
/**
|
9648
|
+
/**
|
9649
|
+
* The usable work area of the display within the display bounds.
|
9650
|
+
* The work area excludes areas of the display reserved for OS, for example taskbar and launcher.
|
9651
|
+
*/
|
9673
9652
|
workArea: Bounds;
|
9674
9653
|
/**
|
9675
|
-
* requires(CrOS) Only available on Chrome OS.
|
9676
9654
|
* The list of available display modes.
|
9677
9655
|
* The current mode will have isSelected=true.
|
9678
|
-
* Only available on Chrome OS.
|
9679
9656
|
* Will be set to an empty array on other platforms.
|
9657
|
+
* @platform ChromeOS only
|
9680
9658
|
* @since Chrome 52
|
9681
9659
|
*/
|
9682
9660
|
modes: DisplayMode[];
|
9683
|
-
/**
|
9661
|
+
/**
|
9662
|
+
* True if this display has a touch input device associated with it.
|
9663
|
+
* @since Chrome 57
|
9664
|
+
*/
|
9684
9665
|
hasTouchSupport: boolean;
|
9685
9666
|
/**
|
9686
9667
|
* A list of zoom factor values that can be set for the display.
|
@@ -9695,20 +9676,25 @@ declare namespace chrome {
|
|
9695
9676
|
displayZoomFactor: number;
|
9696
9677
|
}
|
9697
9678
|
|
9679
|
+
/** @since Chrome 67 */
|
9680
|
+
export interface Edid {
|
9681
|
+
/** 3 character manufacturer code. */
|
9682
|
+
manufacturerId: string;
|
9683
|
+
/** 2 byte manufacturer-assigned code. */
|
9684
|
+
productId: string;
|
9685
|
+
/** Year of manufacturer. */
|
9686
|
+
yearOfManufacture: number;
|
9687
|
+
}
|
9688
|
+
|
9698
9689
|
export interface MirrorModeInfo {
|
9699
|
-
/**
|
9700
|
-
|
9701
|
-
* **off**
|
9702
|
-
* Use the default mode (extended or unified desktop).
|
9703
|
-
* **normal**
|
9704
|
-
* The default source display will be mirrored to all other displays.
|
9705
|
-
* **mixed**
|
9706
|
-
* The specified source display will be mirrored to the provided destination displays. All other connected displays will be extended.
|
9707
|
-
*/
|
9708
|
-
mode?: "off" | "normal" | "mixed" | undefined;
|
9690
|
+
/** The mirror mode that should be set. */
|
9691
|
+
mode?: `${MirrorMode}`;
|
9709
9692
|
}
|
9693
|
+
|
9710
9694
|
export interface MirrorModeInfoMixed extends MirrorModeInfo {
|
9695
|
+
/** The mirror mode that should be set. */
|
9711
9696
|
mode: "mixed";
|
9697
|
+
/** The id of the mirroring source display. */
|
9712
9698
|
mirroringSourceId?: string | undefined;
|
9713
9699
|
/** The ids of the mirroring destination displays. */
|
9714
9700
|
mirroringDestinationIds?: string[] | undefined;
|
@@ -9716,116 +9702,71 @@ declare namespace chrome {
|
|
9716
9702
|
|
9717
9703
|
/**
|
9718
9704
|
* Requests the information for all attached display devices.
|
9719
|
-
*
|
9720
|
-
*/
|
9721
|
-
export function getInfo(callback: (info: DisplayInfo[]) => void): void;
|
9722
|
-
/**
|
9723
|
-
* Requests the information for all attached display devices.
|
9724
|
-
* @return The `getInfo` method provides its result via callback or returned as a `Promise` (MV3 only).
|
9725
|
-
*/
|
9726
|
-
export function getInfo(): Promise<DisplayInfo[]>;
|
9727
|
-
/**
|
9728
|
-
* Requests the information for all attached display devices.
|
9729
|
-
* @since Chrome 59
|
9730
|
-
* @param flags Options affecting how the information is returned.
|
9731
|
-
* @param callback The callback to invoke with the results.
|
9732
|
-
*/
|
9733
|
-
export function getInfo(flags: DisplayInfoFlags, callback: (info: DisplayInfo[]) => void): void;
|
9734
|
-
/**
|
9735
|
-
* Requests the information for all attached display devices.
|
9736
|
-
* @since Chrome 59
|
9705
|
+
* Can return its result via Promise in Manifest V3 or later since Chrome 91.
|
9737
9706
|
* @param flags Options affecting how the information is returned.
|
9738
|
-
* @return The `getInfo` method provides its result via callback or returned as a `Promise` (MV3 only).
|
9739
9707
|
*/
|
9740
|
-
export function getInfo(
|
9708
|
+
export function getInfo(callback: (displayInfo: DisplayUnitInfo[]) => void): void;
|
9709
|
+
export function getInfo(flags: GetInfoFlags, callback: (displayInfo: DisplayUnitInfo[]) => void): void;
|
9710
|
+
export function getInfo(): Promise<DisplayUnitInfo[]>;
|
9711
|
+
export function getInfo(flags: GetInfoFlags): Promise<DisplayUnitInfo[]>;
|
9741
9712
|
|
9742
9713
|
/**
|
9743
|
-
*
|
9744
|
-
*
|
9714
|
+
* Requests the layout info for all displays
|
9715
|
+
* Can return its result via Promise in Manifest V3 or later since Chrome 91.
|
9716
|
+
* @platform ChromeOS and Web UI only
|
9745
9717
|
* @since Chrome 53
|
9746
|
-
* @param callback The callback to invoke with the results.
|
9747
9718
|
*/
|
9748
9719
|
export function getDisplayLayout(callback: (layouts: DisplayLayout[]) => void): void;
|
9749
|
-
|
9750
|
-
/**
|
9751
|
-
* requires(CrOS Kiosk apps | WebUI) This is only available to Chrome OS Kiosk apps and Web UI.
|
9752
|
-
* @description Requests the layout info for all displays.
|
9753
|
-
* @since Chrome 53
|
9754
|
-
* @return The getDisplayLayout method provides its result via callback or returned as a Promise (MV3 only).
|
9755
|
-
*/
|
9756
9720
|
export function getDisplayLayout(): Promise<DisplayLayout[]>;
|
9757
9721
|
|
9758
9722
|
/**
|
9759
9723
|
* requires(CrOS Kiosk apps | WebUI) This is only available to Chrome OS Kiosk apps and Web UI.
|
9760
9724
|
* @description
|
9761
|
-
* Updates the properties for the display specified by
|
9762
|
-
* according to the information provided in
|
9763
|
-
* On failure, runtime.lastError will be set.
|
9764
|
-
* @
|
9765
|
-
* @param info The information about display properties that should be changed. A property will be changed only if a new value for it is specified in |info|.
|
9766
|
-
* @return The `setDisplayProperties` method provides its result via callback or returned as a `Promise` (MV3 only). It has no parameters. To find out whether the function succeeded, runtime.lastError should be queried.
|
9767
|
-
*/
|
9768
|
-
export function setDisplayProperties(id: string, info: DisplayPropertiesInfo): Promise<void>;
|
9769
|
-
|
9770
|
-
/**
|
9771
|
-
* requires(CrOS Kiosk apps | WebUI) This is only available to Chrome OS Kiosk apps and Web UI.
|
9772
|
-
* @description
|
9773
|
-
* Updates the properties for the display specified by **id**,
|
9774
|
-
* according to the information provided in **info**.
|
9775
|
-
* On failure, runtime.lastError will be set.
|
9725
|
+
* Updates the properties for the display specified by `id`,
|
9726
|
+
* according to the information provided in `info`.
|
9727
|
+
* On failure, `runtime.lastError` will be set.
|
9728
|
+
* @platform ChromeOS and Web UI only
|
9776
9729
|
* @param id The display's unique identifier.
|
9777
|
-
* @param info The information about display properties that should be changed. A property will be changed only if a new value for it is specified in
|
9778
|
-
* @param [callback] Empty function called when the function finishes. To find out whether the function succeeded, runtime.lastError should be queried.
|
9730
|
+
* @param info The information about display properties that should be changed. A property will be changed only if a new value for it is specified in `info`.
|
9779
9731
|
*/
|
9780
|
-
export function setDisplayProperties(id: string, info:
|
9732
|
+
export function setDisplayProperties(id: string, info: DisplayProperties, callback: () => void): void;
|
9733
|
+
export function setDisplayProperties(id: string, info: DisplayProperties): Promise<void>;
|
9781
9734
|
|
9782
9735
|
/**
|
9783
|
-
* requires(CrOS Kiosk apps | WebUI) This is only available to Chrome OS Kiosk apps and Web UI.
|
9784
|
-
* @description
|
9785
9736
|
* Set the layout for all displays.
|
9786
9737
|
* Any display not included will use the default layout.
|
9787
9738
|
* If a layout would overlap or be otherwise invalid it will be adjusted to a valid layout.
|
9788
9739
|
* After layout is resolved, an onDisplayChanged event will be triggered.
|
9740
|
+
* Can return its result via Promise in Manifest V3 or later since Chrome 91.
|
9741
|
+
* @platform ChromeOS and Web UI only
|
9789
9742
|
* @since Chrome 53
|
9790
9743
|
* @param layouts The layout information, required for all displays except the primary display.
|
9791
|
-
* @return The `setDisplayLayout` method provides its result via callback or returned as a `Promise` (MV3 only). It has no parameters. To find out whether the function succeeded, runtime.lastError should be queried.
|
9792
|
-
*/
|
9793
|
-
export function setDisplayLayout(layouts: DisplayLayout[]): Promise<void>;
|
9794
|
-
|
9795
|
-
/**
|
9796
|
-
* requires(CrOS Kiosk apps | WebUI) This is only available to Chrome OS Kiosk apps and Web UI.
|
9797
|
-
* @description
|
9798
|
-
* Set the layout for all displays.
|
9799
|
-
* Any display not included will use the default layout.
|
9800
|
-
* If a layout would overlap or be otherwise invalid it will be adjusted to a valid layout.
|
9801
|
-
* After layout is resolved, an onDisplayChanged event will be triggered.
|
9802
|
-
* @since Chrome 53
|
9803
|
-
* @param layouts The layout information, required for all displays except the primary display.
|
9804
|
-
* @param callback Empty function called when the function finishes. To find out whether the function succeeded, runtime.lastError should be queried.
|
9805
9744
|
*/
|
9806
9745
|
export function setDisplayLayout(layouts: DisplayLayout[], callback: () => void): void;
|
9746
|
+
export function setDisplayLayout(layouts: DisplayLayout[]): Promise<void>;
|
9807
9747
|
|
9808
9748
|
/**
|
9809
|
-
* requires(CrOS Kiosk apps | WebUI) This is only available to Chrome OS Kiosk apps and Web UI.
|
9810
|
-
* @description
|
9811
9749
|
* Enables/disables the unified desktop feature.
|
9812
|
-
*
|
9813
|
-
*
|
9750
|
+
* If enabled while mirroring is active, the desktop mode will not change until mirroring is turned off.
|
9751
|
+
* Otherwise, the desktop mode will switch to unified immediately.
|
9814
9752
|
* @since Chrome 46
|
9753
|
+
* @platform ChromeOS and Web UI only
|
9815
9754
|
* @param enabled True if unified desktop should be enabled.
|
9816
9755
|
*/
|
9817
9756
|
export function enableUnifiedDesktop(enabled: boolean): void;
|
9757
|
+
|
9818
9758
|
/**
|
9819
9759
|
* Starts overscan calibration for a display.
|
9820
9760
|
* This will show an overlay on the screen indicating the current overscan insets.
|
9821
|
-
* If overscan calibration for display
|
9761
|
+
* If overscan calibration for display `id` is in progress this will reset calibration.
|
9822
9762
|
* @since Chrome 53
|
9823
9763
|
* @param id The display's unique identifier.
|
9824
9764
|
*/
|
9825
9765
|
export function overscanCalibrationStart(id: string): void;
|
9766
|
+
|
9826
9767
|
/**
|
9827
9768
|
* Adjusts the current overscan insets for a display.
|
9828
|
-
* Typically this should
|
9769
|
+
* Typically this should either move the display along an axis (e.g. left+right have the same value)
|
9829
9770
|
* or scale it along an axis (e.g. top+bottom have opposite values).
|
9830
9771
|
* Each Adjust call is cumulative with previous calls since Start.
|
9831
9772
|
* @since Chrome 53
|
@@ -9849,25 +9790,15 @@ declare namespace chrome {
|
|
9849
9790
|
export function overscanCalibrationComplete(id: string): void;
|
9850
9791
|
|
9851
9792
|
/**
|
9852
|
-
* Displays the native touch calibration UX for the display with
|
9793
|
+
* Displays the native touch calibration UX for the display with `id` as display id.
|
9853
9794
|
* This will show an overlay on the screen with required instructions on how to proceed.
|
9854
|
-
* The callback will be invoked in case of successful
|
9795
|
+
* The callback will be invoked in case of successful calibration only.
|
9855
9796
|
* If the calibration fails, this will throw an error.
|
9797
|
+
* Can return its result via Promise in Manifest V3 or later since Chrome 91.
|
9856
9798
|
* @since Chrome 57
|
9857
9799
|
* @param id The display's unique identifier.
|
9858
|
-
* @param callback Optional callback to inform the caller that the touch calibration has ended. The argument of the callback informs if the calibration was a success or not.
|
9859
9800
|
*/
|
9860
9801
|
export function showNativeTouchCalibration(id: string, callback: (success: boolean) => void): void;
|
9861
|
-
|
9862
|
-
/**
|
9863
|
-
* Displays the native touch calibration UX for the display with **id** as display id.
|
9864
|
-
* This will show an overlay on the screen with required instructions on how to proceed.
|
9865
|
-
* The callback will be invoked in case of successful calibraion only.
|
9866
|
-
* If the calibration fails, this will throw an error.
|
9867
|
-
* @since Chrome 57
|
9868
|
-
* @param id The display's unique identifier.
|
9869
|
-
* @return The `showNativeTouchCalibration` method provides its result via callback or returned as a `Promise` (MV3 only).
|
9870
|
-
*/
|
9871
9802
|
export function showNativeTouchCalibration(id: string): Promise<boolean>;
|
9872
9803
|
|
9873
9804
|
/**
|
@@ -9881,15 +9812,15 @@ declare namespace chrome {
|
|
9881
9812
|
|
9882
9813
|
/**
|
9883
9814
|
* Sets the touch calibration pairs for a display.
|
9884
|
-
* These
|
9885
|
-
* Always call
|
9815
|
+
* These `pairs` would be used to calibrate the touch screen for display with `id` called in startCustomTouchCalibration().
|
9816
|
+
* Always call `startCustomTouchCalibration` before calling this method.
|
9886
9817
|
* If another touch calibration is already in progress this will throw an error.
|
9887
9818
|
* @since Chrome 57
|
9888
9819
|
* @param pairs The pairs of point used to calibrate the display.
|
9889
|
-
* @param bounds Bounds of the display when the touch calibration was performed.
|
9820
|
+
* @param bounds Bounds of the display when the touch calibration was performed. `bounds.left` and `bounds.top` values are ignored.
|
9890
9821
|
* @throws Error
|
9891
9822
|
*/
|
9892
|
-
export function completeCustomTouchCalibration(pairs:
|
9823
|
+
export function completeCustomTouchCalibration(pairs: TouchCalibrationPairQuad, bounds: Bounds): void;
|
9893
9824
|
|
9894
9825
|
/**
|
9895
9826
|
* Resets the touch calibration for the display and brings it back to its default state by clearing any touch calibration data associated with the display.
|
@@ -9899,31 +9830,17 @@ declare namespace chrome {
|
|
9899
9830
|
export function clearTouchCalibration(id: string): void;
|
9900
9831
|
|
9901
9832
|
/**
|
9902
|
-
* requires(CrOS Kiosk app) Chrome OS Kiosk apps only
|
9903
|
-
* @since Chrome 65
|
9904
|
-
* @description
|
9905
9833
|
* Sets the display mode to the specified mirror mode.
|
9906
9834
|
* Each call resets the state from previous calls.
|
9907
|
-
* Calling setDisplayProperties() will fail for the
|
9908
|
-
*
|
9909
|
-
|
9910
|
-
export function setMirrorMode(info: MirrorModeInfo | MirrorModeInfoMixed, callback: () => void): void;
|
9911
|
-
|
9912
|
-
/**
|
9913
|
-
* requires(CrOS Kiosk app) Chrome OS Kiosk apps only
|
9835
|
+
* Calling setDisplayProperties() will fail for the mirroring destination displays.
|
9836
|
+
* @platform ChromeOS and Web UI only
|
9837
|
+
* @param info The information of the mirror mode that should be applied to the display mode.
|
9914
9838
|
* @since Chrome 65
|
9915
|
-
* @description
|
9916
|
-
* Sets the display mode to the specified mirror mode.
|
9917
|
-
* Each call resets the state from previous calls.
|
9918
|
-
* Calling setDisplayProperties() will fail for the
|
9919
|
-
* mirroring destination displays.
|
9920
|
-
* @return The `setMirrorMode` method provides its result via callback or returned as a `Promise` (MV3 only). It has no parameters.
|
9921
9839
|
*/
|
9840
|
+
export function setMirrorMode(info: MirrorModeInfo | MirrorModeInfoMixed, callback: () => void): void;
|
9922
9841
|
export function setMirrorMode(info: MirrorModeInfo | MirrorModeInfoMixed): Promise<void>;
|
9923
9842
|
|
9924
|
-
/**
|
9925
|
-
* Fired when anything changes to the display configuration.
|
9926
|
-
*/
|
9843
|
+
/** Fired when anything changes to the display configuration. */
|
9927
9844
|
export const onDisplayChanged: chrome.events.Event<() => void>;
|
9928
9845
|
}
|
9929
9846
|
|
@@ -11612,93 +11529,107 @@ declare namespace chrome {
|
|
11612
11529
|
* @since Chrome 13
|
11613
11530
|
*/
|
11614
11531
|
export namespace types {
|
11615
|
-
|
11532
|
+
/**
|
11533
|
+
* The scope of the ChromeSetting. One of
|
11534
|
+
* * `regular`: setting for the regular profile (which is inherited by the incognito profile if not overridden elsewhere),
|
11535
|
+
* * `regular_only`: setting for the regular profile only (not inherited by the incognito profile),
|
11536
|
+
* * `incognito_persistent`: setting for the incognito profile that survives browser restarts (overrides regular preferences)
|
11537
|
+
* * `incognito_session_only`: setting for the incognito profile that can only be set during an incognito session and is deleted when the incognito session ends (overrides regular and incognito_persistent preferences).
|
11538
|
+
* @since Chrome 44
|
11539
|
+
*/
|
11540
|
+
export type ChromeSettingScope = "regular" | "regular_only" | "incognito_persistent" | "incognito_session_only";
|
11616
11541
|
|
11617
|
-
|
11618
|
-
|
11619
|
-
|
11620
|
-
|
11621
|
-
|
11622
|
-
|
11623
|
-
|
11624
|
-
|
11625
|
-
|
11626
|
-
|
11627
|
-
|
11542
|
+
/**
|
11543
|
+
* One of
|
11544
|
+
* * `not_controllable`: cannot be controlled by any extension
|
11545
|
+
* * `controlled_by_other_extensions`: controlled by extensions with higher precedence
|
11546
|
+
* * `controllable_by_this_extension`: can be controlled by this extension
|
11547
|
+
* * `controlled_by_this_extension`: controlled by this extension
|
11548
|
+
* @since Chrome 44
|
11549
|
+
*/
|
11550
|
+
export type LevelOfControl =
|
11551
|
+
| "not_controllable"
|
11552
|
+
| "controlled_by_other_extensions"
|
11553
|
+
| "controllable_by_this_extension"
|
11554
|
+
| "controlled_by_this_extension";
|
11628
11555
|
|
11629
|
-
|
11556
|
+
/** Which setting to change. */
|
11557
|
+
export interface ChromeSettingSetDetails<T> {
|
11630
11558
|
/**
|
11631
11559
|
* The value of the setting.
|
11632
11560
|
* Note that every setting has a specific value type, which is described together with the setting. An extension should not set a value of a different type.
|
11633
11561
|
*/
|
11634
|
-
value:
|
11635
|
-
/**
|
11636
|
-
|
11637
|
-
* The scope of the ChromeSetting. One of
|
11638
|
-
* • regular: setting for the regular profile (which is inherited by the incognito profile if not overridden elsewhere),
|
11639
|
-
* • regular_only: setting for the regular profile only (not inherited by the incognito profile),
|
11640
|
-
* • incognito_persistent: setting for the incognito profile that survives browser restarts (overrides regular preferences),
|
11641
|
-
* • incognito_session_only: setting for the incognito profile that can only be set during an incognito session and is deleted when the incognito session ends (overrides regular and incognito_persistent preferences).
|
11642
|
-
*/
|
11643
|
-
scope?: settingsScope;
|
11562
|
+
value: T;
|
11563
|
+
/** Where to set the setting (default: regular). */
|
11564
|
+
scope?: ChromeSettingScope;
|
11644
11565
|
}
|
11645
11566
|
|
11567
|
+
/** Which setting to consider. */
|
11646
11568
|
export interface ChromeSettingGetDetails {
|
11647
|
-
/**
|
11648
|
-
incognito?: boolean
|
11569
|
+
/** Whether to return the value that applies to the incognito session (default false). */
|
11570
|
+
incognito?: boolean;
|
11649
11571
|
}
|
11650
11572
|
|
11651
|
-
/**
|
11652
|
-
|
11653
|
-
|
11654
|
-
|
11655
|
-
|
11656
|
-
export interface ChromeSettingGetResultDetails {
|
11657
|
-
/**
|
11658
|
-
* One of
|
11659
|
-
* • not_controllable: cannot be controlled by any extension
|
11660
|
-
* • controlled_by_other_extensions: controlled by extensions with higher precedence
|
11661
|
-
* • controllable_by_this_extension: can be controlled by this extension
|
11662
|
-
* • controlled_by_this_extension: controlled by this extension
|
11663
|
-
*/
|
11664
|
-
levelOfControl:
|
11665
|
-
| "not_controllable"
|
11666
|
-
| "controlled_by_other_extensions"
|
11667
|
-
| "controllable_by_this_extension"
|
11668
|
-
| "controlled_by_this_extension";
|
11573
|
+
/** Details of the currently effective value */
|
11574
|
+
export interface ChromeSettingGetResult<T> {
|
11575
|
+
/** The level of control of the setting. */
|
11576
|
+
levelOfControl: LevelOfControl;
|
11669
11577
|
/** The value of the setting. */
|
11670
|
-
value:
|
11578
|
+
value: T;
|
11671
11579
|
/**
|
11672
|
-
* Optional.
|
11673
11580
|
* Whether the effective value is specific to the incognito session.
|
11674
11581
|
* This property will only be present if the incognito property in the details parameter of get() was true.
|
11675
11582
|
*/
|
11676
|
-
incognitoSpecific?: boolean
|
11583
|
+
incognitoSpecific?: boolean;
|
11677
11584
|
}
|
11678
11585
|
|
11679
|
-
|
11586
|
+
/** Which setting to clear. */
|
11587
|
+
export interface ChromeSettingClearDetails {
|
11588
|
+
/** Where to clear the setting (default: regular). */
|
11589
|
+
scope?: ChromeSettingScope;
|
11590
|
+
}
|
11680
11591
|
|
11681
|
-
/**
|
11682
|
-
export interface
|
11592
|
+
/** Details of the currently effective value. */
|
11593
|
+
export interface ChromeSettingOnChangeDetails<T> {
|
11594
|
+
/**
|
11595
|
+
* Whether the effective value is specific to the incognito session. T
|
11596
|
+
* his property will only be present if the incognito property in the details parameter of get() was true.
|
11597
|
+
*/
|
11598
|
+
incognitoSpecific?: boolean;
|
11599
|
+
/** The value of the setting. */
|
11600
|
+
value: T;
|
11601
|
+
/** The level of control of the setting. */
|
11602
|
+
levelOfControl: LevelOfControl;
|
11603
|
+
}
|
11604
|
+
|
11605
|
+
/**
|
11606
|
+
* An interface that allows access to a Chrome browser setting.
|
11607
|
+
* See {@link chrome.accessibilityFeatures} for an example.
|
11608
|
+
*/
|
11609
|
+
export interface ChromeSetting<T> {
|
11683
11610
|
/**
|
11684
11611
|
* Sets the value of a setting.
|
11685
|
-
*
|
11686
|
-
* @param callback Optional. Called at the completion of the set operation.
|
11612
|
+
* Can return its result via Promise in Manifest V3 or later since Chrome 96.
|
11687
11613
|
*/
|
11688
|
-
set(details: ChromeSettingSetDetails
|
11614
|
+
set(details: ChromeSettingSetDetails<T>, callback: () => void): void;
|
11615
|
+
set(details: ChromeSettingSetDetails<T>): Promise<void>;
|
11616
|
+
|
11689
11617
|
/**
|
11690
11618
|
* Gets the value of a setting.
|
11691
|
-
*
|
11619
|
+
* Can return its result via Promise in Manifest V3 or later since Chrome 96.
|
11692
11620
|
*/
|
11693
|
-
get(details: ChromeSettingGetDetails, callback
|
11621
|
+
get(details: ChromeSettingGetDetails, callback: (details: ChromeSettingGetResult<T>) => void): void;
|
11622
|
+
get(details: ChromeSettingGetDetails): Promise<ChromeSettingGetResult<T>>;
|
11623
|
+
|
11694
11624
|
/**
|
11695
11625
|
* Clears the setting, restoring any default value.
|
11696
|
-
*
|
11697
|
-
* @param callback Optional. Called at the completion of the clear operation.
|
11626
|
+
* Can return its result via Promise in Manifest V3 or later since Chrome 96.
|
11698
11627
|
*/
|
11699
|
-
clear(details: ChromeSettingClearDetails, callback
|
11628
|
+
clear(details: ChromeSettingClearDetails, callback: () => void): void;
|
11629
|
+
clear(details: ChromeSettingClearDetails): Promise<void>;
|
11630
|
+
|
11700
11631
|
/** Fired after the setting changes. */
|
11701
|
-
onChange:
|
11632
|
+
onChange: chrome.events.Event<(details: ChromeSettingOnChangeDetails<T>) => void>;
|
11702
11633
|
}
|
11703
11634
|
}
|
11704
11635
|
|
chrome/package.json
CHANGED
@@ -1,6 +1,6 @@
|
|
1
1
|
{
|
2
2
|
"name": "@types/chrome",
|
3
|
-
"version": "0.0.
|
3
|
+
"version": "0.0.288",
|
4
4
|
"description": "TypeScript definitions for chrome",
|
5
5
|
"homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/chrome",
|
6
6
|
"license": "MIT",
|
@@ -94,6 +94,6 @@
|
|
94
94
|
"@types/har-format": "*"
|
95
95
|
},
|
96
96
|
"peerDependencies": {},
|
97
|
-
"typesPublisherContentHash": "
|
97
|
+
"typesPublisherContentHash": "115546e2b199f5d8b21729e4d49bada5c8b5d60ee6eb0fdb5688219cb24d1fe2",
|
98
98
|
"typeScriptVersion": "5.0"
|
99
99
|
}
|