Class: Stagehand::Models::SessionNavigateParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/stagehand/models/session_navigate_params.rb,
sig/stagehand/models/session_navigate_params.rbs

Overview

See Also:

  • Stagehand::Resources::Sessions#navigate

Defined Under Namespace

Modules: XStreamResponse Classes: Options

Constant Summary

Constants included from Internal::Type::RequestParameters

Internal::Type::RequestParameters::Stagehand

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Internal::Type::RequestParameters::Converter

dump_request

Methods included from Internal::Type::RequestParameters

included

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 ⇒ Object 



40
 
# File 'sig/stagehand/models/session_navigate_params.rbs', line 40

def initialize: (

Instance Attribute Details

#frame_id ⇒ String?

Target frame ID for the navigation

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


26
 
# File 'lib/stagehand/models/session_navigate_params.rb', line 26

optional :frame_id, String, api_name: :frameId, nil?: true

#id ⇒ String

Unique session identifier

Parameters:

  • value (String)

Returns:

  • (String) 


14
 
# File 'lib/stagehand/models/session_navigate_params.rb', line 14

required :id, String

#options ⇒ Stagehand::Models::SessionNavigateParams::Options?

Returns:



31
 
# File 'lib/stagehand/models/session_navigate_params.rb', line 31

optional :options, -> { Stagehand::SessionNavigateParams::Options }

#stream_response ⇒ Boolean?

Whether to stream the response via SSE

Parameters:

  • (Boolean)

Returns:

  • (Boolean, nil) 


37
 
# File 'lib/stagehand/models/session_navigate_params.rb', line 37

optional :stream_response, Stagehand::Internal::Type::Boolean, api_name: :streamResponse

#url ⇒ String

URL to navigate to

Parameters:

  • value (String)

Returns:

  • (String) 


20
 
# File 'lib/stagehand/models/session_navigate_params.rb', line 20

required :url, String

#x_stream_response ⇒ Symbol, ...

Whether to stream the response via SSE

Returns:



43
 
# File 'lib/stagehand/models/session_navigate_params.rb', line 43

optional :x_stream_response, enum: -> { Stagehand::SessionNavigateParams::XStreamResponse }

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/stagehand/models/session_navigate_params.rb', line 98

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


50
 
# File 'sig/stagehand/models/session_navigate_params.rbs', line 50

def to_hash: -> {