selenium-webdriver/bidi/generated/user_agent_client_hints.js

The official WebDriver JavaScript bindings from the Selenium project

"use strict";
// Licensed to the Software Freedom Conservancy (SFC) under one
// or more contributor license agreements.  See the NOTICE file
// distributed with this work for additional information
// regarding copyright ownership.  The SFC licenses this file
// to you under the Apache License, Version 2.0 (the
// "License"); you may not use this file except in compliance
// with the License.  You may obtain a copy of the License at
//
//   http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing,
// software distributed under the License is distributed on an
// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied.  See the License for the
// specific language governing permissions and limitations
// under the License.
Object.defineProperty(exports, "__esModule", { value: true });
exports.UserAgentClientHints = void 0;
// DO NOT EDIT! This file is generated by javascript/selenium-webdriver/generate_bidi.mjs.
// Regenerate with: `bazel build //javascript/selenium-webdriver:create-bidi-src`
// Built from the WebDriver BiDi CDDL spec (v1.0).
// Source: https://github.com/w3c/webref/tree/main/ed/cddl
const record_js_1 = require("../serialization/record.js");
const domain_js_1 = require("../domain.js");
const UserAgentClientHintsSetClientHintsOverrideCommand = (0, record_js_1.defineRecord)('userAgentClientHints.SetClientHintsOverrideCommand', [{ "name": "method", "wire": "method", "required": true, "type": { "const": "userAgentClientHints.setClientHintsOverride" } }, { "name": "params", "wire": "params", "required": true, "type": { "ref": "userAgentClientHints.SetClientHintsOverrideCommandParams" } }]);
const UserAgentClientHintsClientHintsMetadata = (0, record_js_1.defineRecord)('userAgentClientHints.ClientHintsMetadata', [{ "name": "brands", "wire": "brands", "required": false, "type": { "list": { "ref": "userAgentClientHints.BrandVersion" } } }, { "name": "fullVersionList", "wire": "fullVersionList", "required": false, "type": { "list": { "ref": "userAgentClientHints.BrandVersion" } } }, { "name": "platform", "wire": "platform", "required": false, "type": { "primitive": "string" } }, { "name": "platformVersion", "wire": "platformVersion", "required": false, "type": { "primitive": "string" } }, { "name": "architecture", "wire": "architecture", "required": false, "type": { "primitive": "string" } }, { "name": "model", "wire": "model", "required": false, "type": { "primitive": "string" } }, { "name": "mobile", "wire": "mobile", "required": false, "type": { "primitive": "boolean" } }, { "name": "bitness", "wire": "bitness", "required": false, "type": { "primitive": "string" } }, { "name": "wow64", "wire": "wow64", "required": false, "type": { "primitive": "boolean" } }, { "name": "formFactors", "wire": "formFactors", "required": false, "type": { "list": { "primitive": "string" } } }]);
const UserAgentClientHintsBrandVersion = (0, record_js_1.defineRecord)('userAgentClientHints.BrandVersion', [{ "name": "brand", "wire": "brand", "required": true, "type": { "primitive": "string" } }, { "name": "version", "wire": "version", "required": true, "type": { "primitive": "string" } }]);
const UserAgentClientHintsSetClientHintsOverrideResult = (0, record_js_1.defineRecord)('userAgentClientHints.SetClientHintsOverrideResult', []);
const UserAgentClientHintsSetClientHintsOverrideCommandParams = (0, record_js_1.defineRecord)('userAgentClientHints.SetClientHintsOverrideCommandParams', [{ "name": "clientHints", "wire": "clientHints", "required": true, "type": { "ref": "userAgentClientHints.ClientHintsMetadata", "nullable": true } }, { "name": "contexts", "wire": "contexts", "required": false, "type": { "list": { "primitive": "string" } } }, { "name": "userContexts", "wire": "userContexts", "required": false, "type": { "list": { "primitive": "string" } } }]);
// --- Implementation ---
/**
 * This is an unsupported API. No compatibility guarantees are provided.
 * It tracks the W3C WebDriver BiDi specification directly. As the specification
 * evolves, this API will change or be removed without prior notice.
 */
class UserAgentClientHints extends domain_js_1.Domain {
    static async create(driver) {
        return new UserAgentClientHints(await domain_js_1.Domain.connect(driver), domain_js_1.DOMAIN_TOKEN);
    }
    /**
     * @param {UserAgentClientHintsSetClientHintsOverrideCommandParams} params
     * @param {UserAgentClientHintsClientHintsMetadata | null} params.clientHints
     * @param {Array<string>} [params.contexts]
     * @param {Array<string>} [params.userContexts]
     * @returns {Promise<void>}
     * @see https://w3c.github.io/webdriver-bidi/#command-userAgentClientHints-setClientHintsOverride
     */
    async setClientHintsOverride(params) {
        const validatedParams = new UserAgentClientHintsSetClientHintsOverrideCommandParams(params);
        await this.send('userAgentClientHints.setClientHintsOverride', validatedParams);
    }
}
exports.UserAgentClientHints = UserAgentClientHints;