Class: Selenium::DevTools::V153::Network

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

Constant Summary collapse

EVENTS = 
{
  data_received: 'dataReceived',
  event_source_message_received: 'eventSourceMessageReceived',
  loading_failed: 'loadingFailed',
  loading_finished: 'loadingFinished',
  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',
  direct_tcp_socket_created: 'directTCPSocketCreated',
  direct_tcp_socket_opened: 'directTCPSocketOpened',
  direct_tcp_socket_aborted: 'directTCPSocketAborted',
  direct_tcp_socket_closed: 'directTCPSocketClosed',
  direct_tcp_socket_chunk_sent: 'directTCPSocketChunkSent',
  direct_tcp_socket_chunk_received: 'directTCPSocketChunkReceived',
  direct_udp_socket_joined_multicast_group: 'directUDPSocketJoinedMulticastGroup',
  direct_udp_socket_left_multicast_group: 'directUDPSocketLeftMulticastGroup',
  direct_udp_socket_created: 'directUDPSocketCreated',
  direct_udp_socket_opened: 'directUDPSocketOpened',
  direct_udp_socket_aborted: 'directUDPSocketAborted',
  direct_udp_socket_closed: 'directUDPSocketClosed',
  direct_udp_socket_chunk_sent: 'directUDPSocketChunkSent',
  direct_udp_socket_chunk_received: 'directUDPSocketChunkReceived',
  request_will_be_sent_extra_info: 'requestWillBeSentExtraInfo',
  response_received_extra_info: 'responseReceivedExtraInfo',
  response_received_early_hints: 'responseReceivedEarlyHints',
  trust_token_operation_done: 'trustTokenOperationDone',
  policy_updated: 'policyUpdated',
  reporting_api_report_added: 'reportingApiReportAdded',
  reporting_api_report_updated: 'reportingApiReportUpdated',
  reporting_api_endpoints_changed_for_origin: 'reportingApiEndpointsChangedForOrigin',
  device_bound_sessions_added: 'deviceBoundSessionsAdded',
  device_bound_session_event_occurred: 'deviceBoundSessionEventOccurred',
}.freeze

Instance Method Summary collapse

Constructor Details

#initialize(devtools) ⇒ Network

Returns a new instance of Network.



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

def initialize(devtools)
  @devtools = devtools
end

Instance Method Details

#can_clear_browser_cache ⇒ Object 



81
82
83
 
# File 'lib/selenium/devtools/v153/network.rb', line 81

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

#can_clear_browser_cookies ⇒ Object 



85
86
87
 
# File 'lib/selenium/devtools/v153/network.rb', line 85

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

#can_emulate_network_conditions ⇒ Object 



89
90
91
 
# File 'lib/selenium/devtools/v153/network.rb', line 89

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

#clear_browser_cache ⇒ Object 



93
94
95
 
# File 'lib/selenium/devtools/v153/network.rb', line 93

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

#clear_browser_cookies ⇒ Object 



97
98
99
 
# File 'lib/selenium/devtools/v153/network.rb', line 97

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

#configure_durable_messages(max_total_buffer_size: nil, max_resource_buffer_size: nil) ⇒ Object 



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

def configure_durable_messages(max_total_buffer_size: nil, max_resource_buffer_size: nil)
  @devtools.send_cmd('Network.configureDurableMessages',
                     maxTotalBufferSize: max_total_buffer_size,
                     maxResourceBufferSize: max_resource_buffer_size)
end

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



101
102
103
104
105
106
107
108
 
# File 'lib/selenium/devtools/v153/network.rb', line 101

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

#delete_device_bound_session(key:) ⇒ Object 



270
271
272
273
 
# File 'lib/selenium/devtools/v153/network.rb', line 270

def delete_device_bound_session(key:)
  @devtools.send_cmd('Network.deleteDeviceBoundSession',
                     key: key)
end

#disable ⇒ Object 



110
111
112
 
# File 'lib/selenium/devtools/v153/network.rb', line 110

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

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



114
115
116
117
118
119
120
121
122
123
124
 
# File 'lib/selenium/devtools/v153/network.rb', line 114

def emulate_network_conditions(offline:, latency:, download_throughput:, upload_throughput:, connection_type: nil, packet_loss: nil, packet_queue_length: nil, packet_reordering: nil)
  @devtools.send_cmd('Network.emulateNetworkConditions',
                     offline: offline,
                     latency: latency,
                     downloadThroughput: download_throughput,
                     uploadThroughput: upload_throughput,
                     connectionType: connection_type,
                     packetLoss: packet_loss,
                     packetQueueLength: packet_queue_length,
                     packetReordering: packet_reordering)
end

#emulate_network_conditions_by_rule(offline: nil, emulate_offline_service_worker: nil, matched_network_conditions:) ⇒ Object 



126
127
128
129
130
131
 
# File 'lib/selenium/devtools/v153/network.rb', line 126

def emulate_network_conditions_by_rule(offline: nil, emulate_offline_service_worker: nil, matched_network_conditions:)
  @devtools.send_cmd('Network.emulateNetworkConditionsByRule',
                     offline: offline,
                     emulateOfflineServiceWorker: emulate_offline_service_worker,
                     matchedNetworkConditions: matched_network_conditions)
end

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



142
143
144
145
146
147
148
149
 
# File 'lib/selenium/devtools/v153/network.rb', line 142

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

#enable_device_bound_sessions(enable:) ⇒ Object 



265
266
267
268
 
# File 'lib/selenium/devtools/v153/network.rb', line 265

def enable_device_bound_sessions(enable:)
  @devtools.send_cmd('Network.enableDeviceBoundSessions',
                     enable: enable)
end

#enable_reporting_api(enable:) ⇒ Object 



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

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

#fetch_schemeful_site(origin:) ⇒ Object 



275
276
277
278
 
# File 'lib/selenium/devtools/v153/network.rb', line 275

def fetch_schemeful_site(origin:)
  @devtools.send_cmd('Network.fetchSchemefulSite',
                     origin: origin)
end

#get_all_cookies ⇒ Object 



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

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

#get_certificate(origin:) ⇒ Object 



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

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

#get_cookies(urls: nil) ⇒ Object 



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

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

#get_request_post_data(request_id:) ⇒ Object 



176
177
178
179
 
# File 'lib/selenium/devtools/v153/network.rb', line 176

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

#get_response_body(request_id:) ⇒ Object 



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

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

#get_security_isolation_status(frame_id: nil) ⇒ Object 



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

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 



280
281
282
283
284
285
 
# File 'lib/selenium/devtools/v153/network.rb', line 280

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 



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

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

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



133
134
135
136
137
138
139
140
 
# File 'lib/selenium/devtools/v153/network.rb', line 133

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

#replay_xhr(request_id:) ⇒ Object 



181
182
183
184
 
# File 'lib/selenium/devtools/v153/network.rb', line 181

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 



186
187
188
189
190
191
192
 
# File 'lib/selenium/devtools/v153/network.rb', line 186

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_attach_debug_stack(enabled:) ⇒ Object 



237
238
239
240
 
# File 'lib/selenium/devtools/v153/network.rb', line 237

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

#set_blocked_urls(url_patterns: nil, urls: nil) ⇒ Object 



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

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

#set_bypass_service_worker(bypass:) ⇒ Object 



200
201
202
203
 
# File 'lib/selenium/devtools/v153/network.rb', line 200

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

#set_cache_disabled(cache_disabled:) ⇒ Object 



205
206
207
208
 
# File 'lib/selenium/devtools/v153/network.rb', line 205

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, source_scheme: nil, source_port: nil, partition_key: nil) ⇒ Object 



210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
 
# File 'lib/selenium/devtools/v153/network.rb', line 210

def set_cookie(name:, value:, url: nil, domain: nil, path: nil, secure: nil, http_only: nil, same_site: nil, expires: nil, priority: 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,
                     sourceScheme: source_scheme,
                     sourcePort: source_port,
                     partitionKey: partition_key)
end

#set_cookie_controls(enable_third_party_cookie_restriction:) ⇒ Object 



287
288
289
290
 
# File 'lib/selenium/devtools/v153/network.rb', line 287

def set_cookie_controls(enable_third_party_cookie_restriction:)
  @devtools.send_cmd('Network.setCookieControls',
                     enableThirdPartyCookieRestriction: enable_third_party_cookie_restriction)
end

#set_cookies(cookies:) ⇒ Object 



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

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

#set_extra_http_headers(headers:) ⇒ Object 



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

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

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



242
243
244
245
246
247
248
 
# File 'lib/selenium/devtools/v153/network.rb', line 242

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 



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

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