Class: Stagehand::Models::SessionStartParams::Browser

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/stagehand/models/session_start_params.rb

Defined Under Namespace

Modules: Type Classes: LaunchOptions

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, #inspect, inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(height:, width:) ⇒ Object

Parameters:

  • height (Float)
  • width (Float) 


108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
 
# File 'lib/stagehand/models/session_start_params.rb', line 108

class Browser < Stagehand::Internal::Type::BaseModel
  # @!attribute cdp_url
  #   Chrome DevTools Protocol URL for connecting to existing browser
  #
  #   @return [String, nil]
  optional :cdp_url, String, api_name: :cdpUrl

  # @!attribute launch_options
  #
  #   @return [Stagehand::Models::SessionStartParams::Browser::LaunchOptions, nil]
  optional :launch_options,
           -> { Stagehand::SessionStartParams::Browser::LaunchOptions },
           api_name: :launchOptions

  # @!attribute type
  #   Browser type to use
  #
  #   @return [Symbol, Stagehand::Models::SessionStartParams::Browser::Type, nil]
  optional :type, enum: -> { Stagehand::SessionStartParams::Browser::Type }

  # @!method initialize(cdp_url: nil, launch_options: nil, type: nil)
  #   @param cdp_url [String] Chrome DevTools Protocol URL for connecting to existing browser
  #
  #   @param launch_options [Stagehand::Models::SessionStartParams::Browser::LaunchOptions]
  #
  #   @param type [Symbol, Stagehand::Models::SessionStartParams::Browser::Type] Browser type to use

  # @see Stagehand::Models::SessionStartParams::Browser#launch_options
  class LaunchOptions < Stagehand::Internal::Type::BaseModel
    # @!attribute accept_downloads
    #
    #   @return [Boolean, nil]
    optional :accept_downloads, Stagehand::Internal::Type::Boolean, api_name: :acceptDownloads

    # @!attribute args
    #
    #   @return [Array<String>, nil]
    optional :args, Stagehand::Internal::Type::ArrayOf[String]

    # @!attribute cdp_headers
    #
    #   @return [Hash{Symbol=>String}, nil]
    optional :cdp_headers, Stagehand::Internal::Type::HashOf[String], api_name: :cdpHeaders

    # @!attribute cdp_url
    #
    #   @return [String, nil]
    optional :cdp_url, String, api_name: :cdpUrl

    # @!attribute chromium_sandbox
    #
    #   @return [Boolean, nil]
    optional :chromium_sandbox, Stagehand::Internal::Type::Boolean, api_name: :chromiumSandbox

    # @!attribute connect_timeout_ms
    #
    #   @return [Float, nil]
    optional :connect_timeout_ms, Float, api_name: :connectTimeoutMs

    # @!attribute device_scale_factor
    #
    #   @return [Float, nil]
    optional :device_scale_factor, Float, api_name: :deviceScaleFactor

    # @!attribute devtools
    #
    #   @return [Boolean, nil]
    optional :devtools, Stagehand::Internal::Type::Boolean

    # @!attribute downloads_path
    #
    #   @return [String, nil]
    optional :downloads_path, String, api_name: :downloadsPath

    # @!attribute executable_path
    #
    #   @return [String, nil]
    optional :executable_path, String, api_name: :executablePath

    # @!attribute has_touch
    #
    #   @return [Boolean, nil]
    optional :has_touch, Stagehand::Internal::Type::Boolean, api_name: :hasTouch

    # @!attribute headless
    #
    #   @return [Boolean, nil]
    optional :headless, Stagehand::Internal::Type::Boolean

    # @!attribute ignore_default_args
    #
    #   @return [Boolean, Array<String>, nil]
    optional :ignore_default_args,
             union: -> { Stagehand::SessionStartParams::Browser::LaunchOptions::IgnoreDefaultArgs },
             api_name: :ignoreDefaultArgs

    # @!attribute ignore_https_errors
    #
    #   @return [Boolean, nil]
    optional :ignore_https_errors, Stagehand::Internal::Type::Boolean, api_name: :ignoreHTTPSErrors

    # @!attribute locale
    #
    #   @return [String, nil]
    optional :locale, String

    # @!attribute port
    #
    #   @return [Float, nil]
    optional :port, Float

    # @!attribute preserve_user_data_dir
    #
    #   @return [Boolean, nil]
    optional :preserve_user_data_dir, Stagehand::Internal::Type::Boolean, api_name: :preserveUserDataDir

    # @!attribute proxy
    #
    #   @return [Stagehand::Models::SessionStartParams::Browser::LaunchOptions::Proxy, nil]
    optional :proxy, -> { Stagehand::SessionStartParams::Browser::LaunchOptions::Proxy }

    # @!attribute user_data_dir
    #
    #   @return [String, nil]
    optional :user_data_dir, String, api_name: :userDataDir

    # @!attribute viewport
    #
    #   @return [Stagehand::Models::SessionStartParams::Browser::LaunchOptions::Viewport, nil]
    optional :viewport, -> { Stagehand::SessionStartParams::Browser::LaunchOptions::Viewport }

    # @!method initialize(accept_downloads: nil, args: nil, cdp_headers: nil, cdp_url: nil, chromium_sandbox: nil, connect_timeout_ms: nil, device_scale_factor: nil, devtools: nil, downloads_path: nil, executable_path: nil, has_touch: nil, headless: nil, ignore_default_args: nil, ignore_https_errors: nil, locale: nil, port: nil, preserve_user_data_dir: nil, proxy: nil, user_data_dir: nil, viewport: nil)
    #   @param accept_downloads [Boolean]
    #   @param args [Array<String>]
    #   @param cdp_headers [Hash{Symbol=>String}]
    #   @param cdp_url [String]
    #   @param chromium_sandbox [Boolean]
    #   @param connect_timeout_ms [Float]
    #   @param device_scale_factor [Float]
    #   @param devtools [Boolean]
    #   @param downloads_path [String]
    #   @param executable_path [String]
    #   @param has_touch [Boolean]
    #   @param headless [Boolean]
    #   @param ignore_default_args [Boolean, Array<String>]
    #   @param ignore_https_errors [Boolean]
    #   @param locale [String]
    #   @param port [Float]
    #   @param preserve_user_data_dir [Boolean]
    #   @param proxy [Stagehand::Models::SessionStartParams::Browser::LaunchOptions::Proxy]
    #   @param user_data_dir [String]
    #   @param viewport [Stagehand::Models::SessionStartParams::Browser::LaunchOptions::Viewport]

    # @see Stagehand::Models::SessionStartParams::Browser::LaunchOptions#ignore_default_args
    module IgnoreDefaultArgs
      extend Stagehand::Internal::Type::Union

      variant Stagehand::Internal::Type::Boolean

      variant -> { Stagehand::Models::SessionStartParams::Browser::LaunchOptions::IgnoreDefaultArgs::StringArray }

      # @!method self.variants
      #   @return [Array(Boolean, Array<String>)]

      # @type [Stagehand::Internal::Type::Converter]
      StringArray = Stagehand::Internal::Type::ArrayOf[String]
    end

    # @see Stagehand::Models::SessionStartParams::Browser::LaunchOptions#proxy
    class Proxy < Stagehand::Internal::Type::BaseModel
      # @!attribute server
      #
      #   @return [String]
      required :server, String

      # @!attribute bypass
      #
      #   @return [String, nil]
      optional :bypass, String

      # @!attribute password
      #
      #   @return [String, nil]
      optional :password, String

      # @!attribute username
      #
      #   @return [String, nil]
      optional :username, String

      # @!method initialize(server:, bypass: nil, password: nil, username: nil)
      #   @param server [String]
      #   @param bypass [String]
      #   @param password [String]
      #   @param username [String]
    end

    # @see Stagehand::Models::SessionStartParams::Browser::LaunchOptions#viewport
    class Viewport < Stagehand::Internal::Type::BaseModel
      # @!attribute height
      #
      #   @return [Float]
      required :height, Float

      # @!attribute width
      #
      #   @return [Float]
      required :width, Float

      # @!method initialize(height:, width:)
      #   @param height [Float]
      #   @param width [Float]
    end
  end

  # Browser type to use
  #
  # @see Stagehand::Models::SessionStartParams::Browser#type
  module Type
    extend Stagehand::Internal::Type::Enum

    LOCAL = :local
    BROWSERBASE = :browserbase

    # @!method self.values
    #   @return [Array<Symbol>]
  end
end

Instance Attribute Details

#cdp_url ⇒ String?

Chrome DevTools Protocol URL for connecting to existing browser

Returns:

  • (String, nil) 


113
 
# File 'lib/stagehand/models/session_start_params.rb', line 113

optional :cdp_url, String, api_name: :cdpUrl

#launch_options ⇒ Stagehand::Models::SessionStartParams::Browser::LaunchOptions?

Returns:



118
119
120
 
# File 'lib/stagehand/models/session_start_params.rb', line 118

optional :launch_options,
-> { Stagehand::SessionStartParams::Browser::LaunchOptions },
api_name: :launchOptions

#type ⇒ Symbol, ...

Browser type to use

Returns:



126
 
# File 'lib/stagehand/models/session_start_params.rb', line 126

optional :type, enum: -> { Stagehand::SessionStartParams::Browser::Type }