Class: Selenium::DevTools::V123::Network

Inherits:
Object
  • Object
show all
Defined in:
lib/selenium/devtools/v123/network.rb

Constant Summary collapse

EVENTS = 
{
  data_received: 'dataReceived',
  event_source_message_received: 'eventSourceMessageReceived',
  loading_failed: 'loadingFailed',
  loading_finished: 'loadingFinished',
  request_intercepted: 'requestIntercepted',
  request_served_from_cache: 'requestServedFromCache',
  request_will_be_sent: 'requestWillBeSent',
  resource_changed_priority: 'resourceChangedPriority',
  signed_exchange_received: 'signedExchangeReceived',
  response_received: 'responseReceived',
  web_socket_closed: 'webSocketClosed',
  web_socket_created: 'webSocketCreated',
  web_socket_frame_error: 'webSocketFrameError',
  web_socket_frame_received: 'webSocketFrameReceived',
  web_socket_frame_sent: 'webSocketFrameSent',
  web_socket_handshake_response_received: 'webSocketHandshakeResponseReceived',
  web_socket_will_send_handshake_request: 'webSocketWillSendHandshakeRequest',
  web_transport_created: 'webTransportCreated',
  web_transport_connection_established: 'webTransportConnectionEstablished',
  web_transport_closed: 'webTransportClosed',
  request_will_be_sent_extra_info: 'requestWillBeSentExtraInfo',
  response_received_extra_info: 'responseReceivedExtraInfo',
  trust_token_operation_done: 'trustTokenOperationDone',
  subresource_web_bundle_metadata_received: 'subresourceWebBundleMetadataReceived',
  subresource_web_bundle_metadata_error: 'subresourceWebBundleMetadataError',
  subresource_web_bundle_inner_response_parsed: 'subresourceWebBundleInnerResponseParsed',
  subresource_web_bundle_inner_response_error: 'subresourceWebBundleInnerResponseError',
  reporting_api_report_added: 'reportingApiReportAdded',
  reporting_api_report_updated: 'reportingApiReportUpdated',
  reporting_api_endpoints_changed_for_origin: 'reportingApiEndpointsChangedForOrigin',
}.freeze

Instance Method Summary collapse

Constructor Details

#initialize(devtools) ⇒ Network

Returns a new instance of Network.



58
59
60
 
# File 'lib/selenium/devtools/v123/network.rb', line 58

def initialize(devtools)
  @devtools = devtools
end

Instance Method Details

#can_clear_browser_cache ⇒ Object 



76
77
78
 
# File 'lib/selenium/devtools/v123/network.rb', line 76

def can_clear_browser_cache
  @devtools.send_cmd('Network.canClearBrowserCache')
end

#can_clear_browser_cookies ⇒ Object 



80
81
82
 
# File 'lib/selenium/devtools/v123/network.rb', line 80

def can_clear_browser_cookies
  @devtools.send_cmd('Network.canClearBrowserCookies')
end

#can_emulate_network_conditions ⇒ Object 



84
85
86
 
# File 'lib/selenium/devtools/v123/network.rb', line 84

def can_emulate_network_conditions
  @devtools.send_cmd('Network.canEmulateNetworkConditions')
end

#clear_accepted_encodings_override ⇒ Object 



72
73
74
 
# File 'lib/selenium/devtools/v123/network.rb', line 72

def clear_accepted_encodings_override
  @devtools.send_cmd('Network.clearAcceptedEncodingsOverride')
end

#clear_browser_cache ⇒ Object 



88
89
90
 
# File 'lib/selenium/devtools/v123/network.rb', line 88

def clear_browser_cache
  @devtools.send_cmd('Network.clearBrowserCache')
end

#clear_browser_cookies ⇒ Object 



92
93
94
 
# File 'lib/selenium/devtools/v123/network.rb', line 92

def clear_browser_cookies
  @devtools.send_cmd('Network.clearBrowserCookies')
end

#continue_intercepted_request(interception_id:, error_reason: nil, raw_response: nil, url: nil, method: nil, post_data: nil, headers: nil, auth_challenge_response: nil) ⇒ Object 



96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/selenium/devtools/v123/network.rb', line 96

def continue_intercepted_request(interception_id:, error_reason: nil, raw_response: nil, url: nil, method: nil, post_data: nil, headers: nil, auth_challenge_response: nil)
  @devtools.send_cmd('Network.continueInterceptedRequest',
                     interceptionId: interception_id,
                     errorReason: error_reason,
                     rawResponse: raw_response,
                     url: url,
                     method: method,
                     postData: post_data,
                     headers: headers,
                     authChallengeResponse: auth_challenge_response)
end

#delete_cookies(name:, url: nil, domain: nil, path: nil, partition_key: nil) ⇒ Object 



108
109
110
111
112
113
114
115
 
# File 'lib/selenium/devtools/v123/network.rb', line 108

def delete_cookies(name:, url: nil, domain: nil, path: nil, partition_key: nil)
  @devtools.send_cmd('Network.deleteCookies',
                     name: name,
                     url: url,
                     domain: domain,
                     path: path,
                     partitionKey: partition_key)
end

#disable ⇒ Object 



117
118
119
 
# File 'lib/selenium/devtools/v123/network.rb', line 117

def disable
  @devtools.send_cmd('Network.disable')
end

#emulate_network_conditions(offline:, latency:, download_throughput:, upload_throughput:, connection_type: nil) ⇒ Object 



121
122
123
124
125
126
127
128
 
# File 'lib/selenium/devtools/v123/network.rb', line 121

def emulate_network_conditions(offline:, latency:, download_throughput:, upload_throughput:, connection_type: nil)
  @devtools.send_cmd('Network.emulateNetworkConditions',
                     offline: offline,
                     latency: latency,
                     downloadThroughput: download_throughput,
                     uploadThroughput: upload_throughput,
                     connectionType: connection_type)
end

#enable(max_total_buffer_size: nil, max_resource_buffer_size: nil, max_post_data_size: nil) ⇒ Object 



130
131
132
133
134
135
 
# File 'lib/selenium/devtools/v123/network.rb', line 130

def enable(max_total_buffer_size: nil, max_resource_buffer_size: nil, max_post_data_size: nil)
  @devtools.send_cmd('Network.enable',
                     maxTotalBufferSize: max_total_buffer_size,
                     maxResourceBufferSize: max_resource_buffer_size,
                     maxPostDataSize: max_post_data_size)
end

#enable_reporting_api(enable:) ⇒ Object 



255
256
257
258
 
# File 'lib/selenium/devtools/v123/network.rb', line 255

def enable_reporting_api(enable:)
  @devtools.send_cmd('Network.enableReportingApi',
                     enable: enable)
end

#get_all_cookies ⇒ Object 



137
138
139
 
# File 'lib/selenium/devtools/v123/network.rb', line 137

def get_all_cookies
  @devtools.send_cmd('Network.getAllCookies')
end

#get_certificate(origin:) ⇒ Object 



141
142
143
144
 
# File 'lib/selenium/devtools/v123/network.rb', line 141

def get_certificate(origin:)
  @devtools.send_cmd('Network.getCertificate',
                     origin: origin)
end

#get_cookies(urls: nil) ⇒ Object 



146
147
148
149
 
# File 'lib/selenium/devtools/v123/network.rb', line 146

def get_cookies(urls: nil)
  @devtools.send_cmd('Network.getCookies',
                     urls: urls)
end

#get_request_post_data(request_id:) ⇒ Object 



156
157
158
159
 
# File 'lib/selenium/devtools/v123/network.rb', line 156

def get_request_post_data(request_id:)
  @devtools.send_cmd('Network.getRequestPostData',
                     requestId: request_id)
end

#get_response_body(request_id:) ⇒ Object 



151
152
153
154
 
# File 'lib/selenium/devtools/v123/network.rb', line 151

def get_response_body(request_id:)
  @devtools.send_cmd('Network.getResponseBody',
                     requestId: request_id)
end

#get_response_body_for_interception(interception_id:) ⇒ Object 



161
162
163
164
 
# File 'lib/selenium/devtools/v123/network.rb', line 161

def get_response_body_for_interception(interception_id:)
  @devtools.send_cmd('Network.getResponseBodyForInterception',
                     interceptionId: interception_id)
end

#get_security_isolation_status(frame_id: nil) ⇒ Object 



250
251
252
253
 
# File 'lib/selenium/devtools/v123/network.rb', line 250

def get_security_isolation_status(frame_id: nil)
  @devtools.send_cmd('Network.getSecurityIsolationStatus',
                     frameId: frame_id)
end

#load_network_resource(frame_id: nil, url:, options:) ⇒ Object 



260
261
262
263
264
265
 
# File 'lib/selenium/devtools/v123/network.rb', line 260

def load_network_resource(frame_id: nil, url:, options:)
  @devtools.send_cmd('Network.loadNetworkResource',
                     frameId: frame_id,
                     url: url,
                     options: options)
end

#on(event, &block) ⇒ Object 



62
63
64
65
 
# File 'lib/selenium/devtools/v123/network.rb', line 62

def on(event, &block)
  event = EVENTS[event] if event.is_a?(Symbol)
  @devtools.callbacks["Network.#{event}"] << block
end

#replay_xhr(request_id:) ⇒ Object 



171
172
173
174
 
# File 'lib/selenium/devtools/v123/network.rb', line 171

def replay_xhr(request_id:)
  @devtools.send_cmd('Network.replayXHR',
                     requestId: request_id)
end

#search_in_response_body(request_id:, query:, case_sensitive: nil, is_regex: nil) ⇒ Object 



176
177
178
179
180
181
182
 
# File 'lib/selenium/devtools/v123/network.rb', line 176

def search_in_response_body(request_id:, query:, case_sensitive: nil, is_regex: nil)
  @devtools.send_cmd('Network.searchInResponseBody',
                     requestId: request_id,
                     query: query,
                     caseSensitive: case_sensitive,
                     isRegex: is_regex)
end

#set_accepted_encodings(encodings:) ⇒ Object 



67
68
69
70
 
# File 'lib/selenium/devtools/v123/network.rb', line 67

def set_accepted_encodings(encodings:)
  @devtools.send_cmd('Network.setAcceptedEncodings',
                     encodings: encodings)
end

#set_attach_debug_stack(enabled:) ⇒ Object 



227
228
229
230
 
# File 'lib/selenium/devtools/v123/network.rb', line 227

def set_attach_debug_stack(enabled:)
  @devtools.send_cmd('Network.setAttachDebugStack',
                     enabled: enabled)
end

#set_blocked_urls(urls:) ⇒ Object 



184
185
186
187
 
# File 'lib/selenium/devtools/v123/network.rb', line 184

def set_blocked_urls(urls:)
  @devtools.send_cmd('Network.setBlockedURLs',
                     urls: urls)
end

#set_bypass_service_worker(bypass:) ⇒ Object 



189
190
191
192
 
# File 'lib/selenium/devtools/v123/network.rb', line 189

def set_bypass_service_worker(bypass:)
  @devtools.send_cmd('Network.setBypassServiceWorker',
                     bypass: bypass)
end

#set_cache_disabled(cache_disabled:) ⇒ Object 



194
195
196
197
 
# File 'lib/selenium/devtools/v123/network.rb', line 194

def set_cache_disabled(cache_disabled:)
  @devtools.send_cmd('Network.setCacheDisabled',
                     cacheDisabled: cache_disabled)
end

#set_cookie(name:, value:, url: nil, domain: nil, path: nil, secure: nil, http_only: nil, same_site: nil, expires: nil, priority: nil, same_party: nil, source_scheme: nil, source_port: nil, partition_key: nil) ⇒ Object 



199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
 
# File 'lib/selenium/devtools/v123/network.rb', line 199

def set_cookie(name:, value:, url: nil, domain: nil, path: nil, secure: nil, http_only: nil, same_site: nil, expires: nil, priority: nil, same_party: nil, source_scheme: nil, source_port: nil, partition_key: nil)
  @devtools.send_cmd('Network.setCookie',
                     name: name,
                     value: value,
                     url: url,
                     domain: domain,
                     path: path,
                     secure: secure,
                     httpOnly: http_only,
                     sameSite: same_site,
                     expires: expires,
                     priority: priority,
                     sameParty: same_party,
                     sourceScheme: source_scheme,
                     sourcePort: source_port,
                     partitionKey: partition_key)
end

#set_cookies(cookies:) ⇒ Object 



217
218
219
220
 
# File 'lib/selenium/devtools/v123/network.rb', line 217

def set_cookies(cookies:)
  @devtools.send_cmd('Network.setCookies',
                     cookies: cookies)
end

#set_extra_http_headers(headers:) ⇒ Object 



222
223
224
225
 
# File 'lib/selenium/devtools/v123/network.rb', line 222

def set_extra_http_headers(headers:)
  @devtools.send_cmd('Network.setExtraHTTPHeaders',
                     headers: headers)
end

#set_request_interception(patterns:) ⇒ Object 



232
233
234
235
 
# File 'lib/selenium/devtools/v123/network.rb', line 232

def set_request_interception(patterns:)
  @devtools.send_cmd('Network.setRequestInterception',
                     patterns: patterns)
end

#set_user_agent_override(user_agent:, accept_language: nil, platform: nil, user_agent_metadata: nil) ⇒ Object 



237
238
239
240
241
242
243
 
# File 'lib/selenium/devtools/v123/network.rb', line 237

def set_user_agent_override(user_agent:, accept_language: nil, platform: nil, user_agent_metadata: nil)
  @devtools.send_cmd('Network.setUserAgentOverride',
                     userAgent: user_agent,
                     acceptLanguage: accept_language,
                     platform: platform,
                     userAgentMetadata: user_agent_metadata)
end

#stream_resource_content(request_id:) ⇒ Object 



245
246
247
248
 
# File 'lib/selenium/devtools/v123/network.rb', line 245

def stream_resource_content(request_id:)
  @devtools.send_cmd('Network.streamResourceContent',
                     requestId: request_id)
end

#take_response_body_for_interception_as_stream(interception_id:) ⇒ Object 



166
167
168
169
 
# File 'lib/selenium/devtools/v123/network.rb', line 166

def take_response_body_for_interception_as_stream(interception_id:)
  @devtools.send_cmd('Network.takeResponseBodyForInterceptionAsStream',
                     interceptionId: interception_id)
end