browser_commander/puppeteer/api/
browser_context.rs

1// @generated by scripts/generate-puppeteer-bindings.mjs from
2// rust/protocol/puppeteer/api.json. Do not edit by hand.
3
4#![allow(clippy::all, missing_docs, unused_imports, non_snake_case)]
5
6use serde_json::Value;
7
8use super::*;
9use crate::puppeteer::bridge::{binary, remote_type, BridgeError, JsFunction, Remote};
10
11remote_type!(
12    /// Puppeteer's `BrowserContext` (puppeteer-core 25.10.0), a remote object
13    /// served by `browser-commander serve --stdio`.
14    ///
15    /// Extends [`EventEmitter`]; the inherited methods are repeated here.
16    BrowserContext
17);
18
19impl BrowserContext {
20    /// `EventEmitter.on`
21    ///
22    /// ```text
23    /// on<Key extends keyof EventsWithWildcard<Events>>(type: Key, handler: Handler<EventsWithWildcard<Events>[Key]>): this
24    /// ```
25    pub async fn on(&self, type_: Value, handler: impl Into<JsFunction>) -> Result<BrowserContext, BridgeError> {
26        self.remote.call("on", vec![Some(type_), Some(handler.into().to_wire())]).await
27    }
28
29    /// `EventEmitter.off`
30    ///
31    /// ```text
32    /// off<Key extends keyof EventsWithWildcard<Events>>(type: Key, handler?: Handler<EventsWithWildcard<Events>[Key]>): this
33    /// ```
34    pub async fn off(&self, type_: Value, handler: Option<JsFunction>) -> Result<BrowserContext, BridgeError> {
35        self.remote.call("off", vec![Some(type_), handler.map(|x| x.to_wire())]).await
36    }
37
38    /// `EventEmitter.emit`
39    ///
40    /// ```text
41    /// emit<Key extends keyof EventsWithWildcard<Events>>(type: Key, event: EventsWithWildcard<Events>[Key]): boolean
42    /// ```
43    pub async fn emit(&self, type_: Value, event: Value) -> Result<bool, BridgeError> {
44        self.remote.call("emit", vec![Some(type_), Some(event)]).await
45    }
46
47    /// `EventEmitter.once`
48    ///
49    /// ```text
50    /// once<Key extends keyof EventsWithWildcard<Events>>(type: Key, handler: Handler<EventsWithWildcard<Events>[Key]>): this
51    /// ```
52    pub async fn once(&self, type_: Value, handler: impl Into<JsFunction>) -> Result<BrowserContext, BridgeError> {
53        self.remote.call("once", vec![Some(type_), Some(handler.into().to_wire())]).await
54    }
55
56    /// `EventEmitter.listenerCount`
57    ///
58    /// ```text
59    /// listenerCount(type: keyof EventsWithWildcard<Events>): number
60    /// ```
61    pub async fn listener_count(&self, type_: Value) -> Result<f64, BridgeError> {
62        self.remote.call("listenerCount", vec![Some(type_)]).await
63    }
64
65    /// `EventEmitter.removeAllListeners`
66    ///
67    /// ```text
68    /// removeAllListeners(type?: keyof EventsWithWildcard<Events>): this
69    /// ```
70    pub async fn remove_all_listeners(&self, type_: Option<Value>) -> Result<BrowserContext, BridgeError> {
71        self.remote.call("removeAllListeners", vec![type_]).await
72    }
73
74    /// `BrowserContext.targets`
75    ///
76    /// ```text
77    /// targets(): Target[]
78    /// ```
79    pub async fn targets(&self) -> Result<Vec<Target>, BridgeError> {
80        self.remote.call("targets", vec![]).await
81    }
82
83    /// `BrowserContext.waitForTarget`
84    ///
85    /// ```text
86    /// waitForTarget(predicate: (x: Target) => boolean | Promise<boolean>, options?: WaitForTargetOptions): Promise<Target>
87    /// ```
88    pub async fn wait_for_target(&self, predicate: impl Into<JsFunction>, options: Option<Value>) -> Result<Target, BridgeError> {
89        self.remote.call("waitForTarget", vec![Some(predicate.into().to_wire()), options]).await
90    }
91
92    /// `BrowserContext.pages`
93    ///
94    /// ```text
95    /// pages(includeAll?: boolean): Promise<Page[]>
96    /// ```
97    pub async fn pages(&self, include_all: Option<bool>) -> Result<Vec<Page>, BridgeError> {
98        self.remote.call("pages", vec![include_all.map(|x| Value::from(x))]).await
99    }
100
101    /// `BrowserContext.overridePermissions`
102    ///
103    /// ```text
104    /// overridePermissions(origin: string, permissions: Permission[]): Promise<void>
105    /// ```
106    pub async fn override_permissions(&self, origin: &str, permissions: &[&str]) -> Result<(), BridgeError> {
107        self.remote.call("overridePermissions", vec![Some(Value::from(origin)), Some(Value::Array(permissions.iter().map(|v| Value::from(*v)).collect()))]).await
108    }
109
110    /// `BrowserContext.setPermission`
111    ///
112    /// ```text
113    /// setPermission(origin: string | '*', ...permissions: Array<{ permission: PermissionDescriptor_2; state: PermissionState_2; }> ): Promise<void>
114    /// ```
115    pub async fn set_permission(&self, origin: &str, permissions: &[Value]) -> Result<(), BridgeError> {
116        let mut call_args: Vec<Option<Value>> = vec![Some(Value::from(origin))];
117        call_args.extend(permissions.iter().map(|v| Some(v.clone())));
118        self.remote.call("setPermission", call_args).await
119    }
120
121    /// `BrowserContext.clearPermissionOverrides`
122    ///
123    /// ```text
124    /// clearPermissionOverrides(): Promise<void>
125    /// ```
126    pub async fn clear_permission_overrides(&self) -> Result<(), BridgeError> {
127        self.remote.call("clearPermissionOverrides", vec![]).await
128    }
129
130    /// `BrowserContext.newPage`
131    ///
132    /// ```text
133    /// newPage(options?: CreatePageOptions): Promise<Page>
134    /// ```
135    pub async fn new_page(&self, options: Option<Value>) -> Result<Page, BridgeError> {
136        self.remote.call("newPage", vec![options]).await
137    }
138
139    /// `BrowserContext.browser`
140    ///
141    /// ```text
142    /// browser(): Browser
143    /// ```
144    pub async fn browser(&self) -> Result<Browser, BridgeError> {
145        self.remote.call("browser", vec![]).await
146    }
147
148    /// `BrowserContext.close`
149    ///
150    /// ```text
151    /// close(): Promise<void>
152    /// ```
153    pub async fn close(&self) -> Result<(), BridgeError> {
154        self.remote.call("close", vec![]).await
155    }
156
157    /// `BrowserContext.cookies`
158    ///
159    /// ```text
160    /// cookies(): Promise<Cookie[]>
161    /// ```
162    pub async fn cookies(&self) -> Result<Vec<Value>, BridgeError> {
163        self.remote.call("cookies", vec![]).await
164    }
165
166    /// `BrowserContext.setCookie`
167    ///
168    /// ```text
169    /// setCookie(...cookies: CookieData[]): Promise<void>
170    /// ```
171    pub async fn set_cookie(&self, cookies: &[Value]) -> Result<(), BridgeError> {
172        let mut call_args: Vec<Option<Value>> = vec![];
173        call_args.extend(cookies.iter().map(|v| Some(v.clone())));
174        self.remote.call("setCookie", call_args).await
175    }
176
177    /// `BrowserContext.deleteCookie`
178    ///
179    /// ```text
180    /// deleteCookie(...cookies: Cookie[]): Promise<void>
181    /// ```
182    pub async fn delete_cookie(&self, cookies: &[Value]) -> Result<(), BridgeError> {
183        let mut call_args: Vec<Option<Value>> = vec![];
184        call_args.extend(cookies.iter().map(|v| Some(v.clone())));
185        self.remote.call("deleteCookie", call_args).await
186    }
187
188    /// `BrowserContext.deleteMatchingCookies`
189    ///
190    /// ```text
191    /// deleteMatchingCookies(...filters: DeleteCookiesRequest[]): Promise<void>
192    /// ```
193    pub async fn delete_matching_cookies(&self, filters: &[Value]) -> Result<(), BridgeError> {
194        let mut call_args: Vec<Option<Value>> = vec![];
195        call_args.extend(filters.iter().map(|v| Some(v.clone())));
196        self.remote.call("deleteMatchingCookies", call_args).await
197    }
198
199    /// `BrowserContext.closed`
200    ///
201    /// ```text
202    /// get closed(): boolean
203    /// ```
204    pub async fn closed(&self) -> Result<bool, BridgeError> {
205        self.remote.get("closed").await
206    }
207
208    /// `BrowserContext.id`
209    ///
210    /// ```text
211    /// get id(): string | undefined
212    /// ```
213    pub async fn id(&self) -> Result<Option<String>, BridgeError> {
214        self.remote.get("id").await
215    }
216}
browser_commander/puppeteer/api/browser_context.rs

browser_commander/puppeteer/api/
browser_context.rs
