Struct CreateSessionOptions 

pub struct CreateSessionOptions {
    pub profile_id: Option<String>,
    pub recording: bool,
    pub stealth: bool,
    pub captcha: bool,
    pub proxy: Option<ProxySpec>,
    pub session_timeout_ms: Option<u64>,
    pub timeout_seconds: Option<u32>,
    pub keep_alive: bool,
    pub user_metadata: Option<Map<String, Value>>,
}

Options accepted by POST /sessions.

Falsy fields are omitted from the request body; if every field is falsy the request is sent with no body at all.

Fields

profile_id: Option<String>

Attach a stored browser profile (cookies + localStorage).

recording: bool

Enable session recording. Off by default.

stealth: bool

Enable the runtime stealth shim. Off by default.

captcha: bool

Enable managed captcha solving. Requires stealth.

proxy: Option<ProxySpec>

Request managed proxy egress. Requires stealth.

session_timeout_ms: Option<u64>

End the session earlier than the plan maximum, in milliseconds. None (or zero) leaves the plan maximum. The gateway counts whole seconds, so the value is rounded up (1001 ms is 2 s), and it refuses anything under 60 s.

timeout_seconds: Option<u32>

👎Deprecated since 0.5.0:

use session_timeout_ms; it wins when both are set

The same limit in seconds.

keep_alive: bool

Hold the session after the client disconnects, until its deadline (session_timeout_ms, else an hour, never past the plan maximum) or until it is released, so a dropped client can reconnect.

user_metadata: Option<Map<String, Value>>

Free-form JSON stored with the session and returned by get and list.

Implementations

impl CreateSessionOptions

pub fn new() -> Self

pub fn profile_id(self, id: impl Into<String>) -> Self

pub fn recording(self, on: bool) -> Self

pub fn stealth(self, on: bool) -> Self

pub fn captcha(self, on: bool) -> Self

pub fn proxy(self, spec: impl Into<ProxySpec>) -> Self

pub fn session_timeout_ms(self, ms: u64) -> Self

Session lifetime in milliseconds; see CreateSessionOptions::session_timeout_ms.

pub fn timeout_seconds(self, seconds: u32) -> Self

👎Deprecated since 0.5.0:

use session_timeout_ms

Session lifetime in seconds.

pub fn keep_alive(self, on: bool) -> Self

pub fn user_metadata(self, metadata: Map<String, Value>) -> Self

Trait Implementations

impl Clone for CreateSessionOptions

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CreateSessionOptions

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for CreateSessionOptions

fn default() -> Self

Returns the “default value” for a type.