com.github.kklisura.cdt.protocol.commands.Browser Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of cdt-java-client Show documentation
Show all versions of cdt-java-client Show documentation
Chrome DevTools java client
package com.github.kklisura.cdt.protocol.commands;
/*-
* #%L
* cdt-java-client
* %%
* Copyright (C) 2018 - 2021 Kenan Klisura
* %%
* Licensed 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.
* #L%
*/
import com.github.kklisura.cdt.protocol.support.annotations.Experimental;
import com.github.kklisura.cdt.protocol.support.annotations.Optional;
import com.github.kklisura.cdt.protocol.support.annotations.ParamName;
import com.github.kklisura.cdt.protocol.support.annotations.ReturnTypeParameter;
import com.github.kklisura.cdt.protocol.support.annotations.Returns;
import com.github.kklisura.cdt.protocol.types.browser.Bounds;
import com.github.kklisura.cdt.protocol.types.browser.BrowserCommandId;
import com.github.kklisura.cdt.protocol.types.browser.Histogram;
import com.github.kklisura.cdt.protocol.types.browser.PermissionDescriptor;
import com.github.kklisura.cdt.protocol.types.browser.PermissionSetting;
import com.github.kklisura.cdt.protocol.types.browser.PermissionType;
import com.github.kklisura.cdt.protocol.types.browser.SetDownloadBehaviorBehavior;
import com.github.kklisura.cdt.protocol.types.browser.Version;
import com.github.kklisura.cdt.protocol.types.browser.WindowForTarget;
import java.util.List;
/** The Browser domain defines methods and events for browser managing. */
public interface Browser {
/**
* Set permission settings for given origin.
*
* @param permission Descriptor of permission to override.
* @param setting Setting of the permission.
*/
@Experimental
void setPermission(
@ParamName("permission") PermissionDescriptor permission,
@ParamName("setting") PermissionSetting setting);
/**
* Set permission settings for given origin.
*
* @param permission Descriptor of permission to override.
* @param setting Setting of the permission.
* @param origin Origin the permission applies to, all origins if not specified.
* @param browserContextId Context to override. When omitted, default browser context is used.
*/
@Experimental
void setPermission(
@ParamName("permission") PermissionDescriptor permission,
@ParamName("setting") PermissionSetting setting,
@Optional @ParamName("origin") String origin,
@Optional @ParamName("browserContextId") String browserContextId);
/**
* Grant specific permissions to the given origin and reject all others.
*
* @param permissions
*/
@Experimental
void grantPermissions(@ParamName("permissions") List permissions);
/**
* Grant specific permissions to the given origin and reject all others.
*
* @param permissions
* @param origin Origin the permission applies to, all origins if not specified.
* @param browserContextId BrowserContext to override permissions. When omitted, default browser
* context is used.
*/
@Experimental
void grantPermissions(
@ParamName("permissions") List permissions,
@Optional @ParamName("origin") String origin,
@Optional @ParamName("browserContextId") String browserContextId);
/** Reset all permission management for all origins. */
@Experimental
void resetPermissions();
/**
* Reset all permission management for all origins.
*
* @param browserContextId BrowserContext to reset permissions. When omitted, default browser
* context is used.
*/
@Experimental
void resetPermissions(@Optional @ParamName("browserContextId") String browserContextId);
/**
* Set the behavior when downloading a file.
*
* @param behavior Whether to allow all or deny all download requests, or use default Chrome
* behavior if available (otherwise deny). |allowAndName| allows download and names files
* according to their dowmload guids.
*/
@Experimental
void setDownloadBehavior(@ParamName("behavior") SetDownloadBehaviorBehavior behavior);
/**
* Set the behavior when downloading a file.
*
* @param behavior Whether to allow all or deny all download requests, or use default Chrome
* behavior if available (otherwise deny). |allowAndName| allows download and names files
* according to their dowmload guids.
* @param browserContextId BrowserContext to set download behavior. When omitted, default browser
* context is used.
* @param downloadPath The default path to save downloaded files to. This is requred if behavior
* is set to 'allow' or 'allowAndName'.
*/
@Experimental
void setDownloadBehavior(
@ParamName("behavior") SetDownloadBehaviorBehavior behavior,
@Optional @ParamName("browserContextId") String browserContextId,
@Optional @ParamName("downloadPath") String downloadPath);
/** Close browser gracefully. */
void close();
/** Crashes browser on the main thread. */
@Experimental
void crash();
/** Crashes GPU process. */
@Experimental
void crashGpuProcess();
/** Returns version information. */
Version getVersion();
/**
* Returns the command line switches for the browser process if, and only if --enable-automation
* is on the commandline.
*/
@Experimental
@Returns("arguments")
@ReturnTypeParameter(String.class)
List getBrowserCommandLine();
/** Get Chrome histograms. */
@Experimental
@Returns("histograms")
@ReturnTypeParameter(Histogram.class)
List getHistograms();
/**
* Get Chrome histograms.
*
* @param query Requested substring in name. Only histograms which have query as a substring in
* their name are extracted. An empty or absent query returns all histograms.
* @param delta If true, retrieve delta since last call.
*/
@Experimental
@Returns("histograms")
@ReturnTypeParameter(Histogram.class)
List getHistograms(
@Optional @ParamName("query") String query, @Optional @ParamName("delta") Boolean delta);
/**
* Get a Chrome histogram by name.
*
* @param name Requested histogram name.
*/
@Experimental
@Returns("histogram")
Histogram getHistogram(@ParamName("name") String name);
/**
* Get a Chrome histogram by name.
*
* @param name Requested histogram name.
* @param delta If true, retrieve delta since last call.
*/
@Experimental
@Returns("histogram")
Histogram getHistogram(
@ParamName("name") String name, @Optional @ParamName("delta") Boolean delta);
/**
* Get position and size of the browser window.
*
* @param windowId Browser window id.
*/
@Experimental
@Returns("bounds")
Bounds getWindowBounds(@ParamName("windowId") Integer windowId);
/** Get the browser window that contains the devtools target. */
@Experimental
WindowForTarget getWindowForTarget();
/**
* Get the browser window that contains the devtools target.
*
* @param targetId Devtools agent host id. If called as a part of the session, associated targetId
* is used.
*/
@Experimental
WindowForTarget getWindowForTarget(@Optional @ParamName("targetId") String targetId);
/**
* Set position and/or size of the browser window.
*
* @param windowId Browser window id.
* @param bounds New window bounds. The 'minimized', 'maximized' and 'fullscreen' states cannot be
* combined with 'left', 'top', 'width' or 'height'. Leaves unspecified fields unchanged.
*/
@Experimental
void setWindowBounds(@ParamName("windowId") Integer windowId, @ParamName("bounds") Bounds bounds);
/** Set dock tile details, platform-specific. */
@Experimental
void setDockTile();
/**
* Set dock tile details, platform-specific.
*
* @param badgeLabel
* @param image Png encoded image.
*/
@Experimental
void setDockTile(
@Optional @ParamName("badgeLabel") String badgeLabel,
@Optional @ParamName("image") String image);
/**
* Invoke custom browser commands used by telemetry.
*
* @param commandId
*/
@Experimental
void executeBrowserCommand(@ParamName("commandId") BrowserCommandId commandId);
}