Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AppAction ¶ added in v0.6.4
type AppAction struct {
// Name of the action
Name string `json:"name,required"`
// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
JSON struct {
Name respjson.Field
ExtraFields map[string]respjson.Field
// contains filtered or unexported fields
} `json:"-"`
}
An action available on the app
func (*AppAction) UnmarshalJSON ¶ added in v0.6.4
type BrowserExtension ¶ added in v0.21.0
type BrowserExtension struct {
// Extension ID to load for this browser session
ID string `json:"id"`
// Extension name to load for this browser session (instead of id). Must be 1-255
// characters, using letters, numbers, dots, underscores, or hyphens.
Name string `json:"name"`
// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
JSON struct {
ID respjson.Field
Name respjson.Field
ExtraFields map[string]respjson.Field
// contains filtered or unexported fields
} `json:"-"`
}
Extension selection for the browser session. Provide either id or name of an extension uploaded to Kernel.
func (BrowserExtension) RawJSON ¶ added in v0.21.0
func (r BrowserExtension) RawJSON() string
Returns the unmodified JSON received from the API
func (BrowserExtension) ToParam ¶ added in v0.21.0
func (r BrowserExtension) ToParam() BrowserExtensionParam
ToParam converts this BrowserExtension to a BrowserExtensionParam.
Warning: the fields of the param type will not be present. ToParam should only be used at the last possible moment before sending a request. Test for this with BrowserExtensionParam.Overrides()
func (*BrowserExtension) UnmarshalJSON ¶ added in v0.21.0
func (r *BrowserExtension) UnmarshalJSON(data []byte) error
type BrowserExtensionParam ¶ added in v0.21.0
type BrowserExtensionParam struct {
// Extension ID to load for this browser session
ID param.Opt[string] `json:"id,omitzero"`
// Extension name to load for this browser session (instead of id). Must be 1-255
// characters, using letters, numbers, dots, underscores, or hyphens.
Name param.Opt[string] `json:"name,omitzero"`
// contains filtered or unexported fields
}
Extension selection for the browser session. Provide either id or name of an extension uploaded to Kernel.
func (BrowserExtensionParam) MarshalJSON ¶ added in v0.21.0
func (r BrowserExtensionParam) MarshalJSON() (data []byte, err error)
func (*BrowserExtensionParam) UnmarshalJSON ¶ added in v0.21.0
func (r *BrowserExtensionParam) UnmarshalJSON(data []byte) error
type BrowserProfile ¶ added in v0.21.0
type BrowserProfile struct {
// Profile ID to load for this browser session
ID string `json:"id"`
// Profile name to load for this browser session (instead of id). Must be 1-255
// characters, using letters, numbers, dots, underscores, or hyphens.
Name string `json:"name"`
// If true, save changes made during the session back to the profile when the
// session ends.
SaveChanges bool `json:"save_changes"`
// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
JSON struct {
ID respjson.Field
Name respjson.Field
SaveChanges respjson.Field
ExtraFields map[string]respjson.Field
// contains filtered or unexported fields
} `json:"-"`
}
Profile selection for the browser session. Provide either id or name. If specified, the matching profile will be loaded into the browser session. Profiles must be created beforehand.
func (BrowserProfile) RawJSON ¶ added in v0.21.0
func (r BrowserProfile) RawJSON() string
Returns the unmodified JSON received from the API
func (BrowserProfile) ToParam ¶ added in v0.21.0
func (r BrowserProfile) ToParam() BrowserProfileParam
ToParam converts this BrowserProfile to a BrowserProfileParam.
Warning: the fields of the param type will not be present. ToParam should only be used at the last possible moment before sending a request. Test for this with BrowserProfileParam.Overrides()
func (*BrowserProfile) UnmarshalJSON ¶ added in v0.21.0
func (r *BrowserProfile) UnmarshalJSON(data []byte) error
type BrowserProfileParam ¶ added in v0.21.0
type BrowserProfileParam struct {
// Profile ID to load for this browser session
ID param.Opt[string] `json:"id,omitzero"`
// Profile name to load for this browser session (instead of id). Must be 1-255
// characters, using letters, numbers, dots, underscores, or hyphens.
Name param.Opt[string] `json:"name,omitzero"`
// If true, save changes made during the session back to the profile when the
// session ends.
SaveChanges param.Opt[bool] `json:"save_changes,omitzero"`
// contains filtered or unexported fields
}
Profile selection for the browser session. Provide either id or name. If specified, the matching profile will be loaded into the browser session. Profiles must be created beforehand.
func (BrowserProfileParam) MarshalJSON ¶ added in v0.21.0
func (r BrowserProfileParam) MarshalJSON() (data []byte, err error)
func (*BrowserProfileParam) UnmarshalJSON ¶ added in v0.21.0
func (r *BrowserProfileParam) UnmarshalJSON(data []byte) error
type BrowserViewport ¶ added in v0.21.0
type BrowserViewport struct {
// Browser window height in pixels.
Height int64 `json:"height,required"`
// Browser window width in pixels.
Width int64 `json:"width,required"`
// Display refresh rate in Hz. If omitted, automatically determined from width and
// height.
RefreshRate int64 `json:"refresh_rate"`
// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
JSON struct {
Height respjson.Field
Width respjson.Field
RefreshRate respjson.Field
ExtraFields map[string]respjson.Field
// contains filtered or unexported fields
} `json:"-"`
}
Initial browser window size in pixels with optional refresh rate. If omitted, image defaults apply (commonly 1024x768@60). Only specific viewport configurations are supported. The server will reject unsupported combinations. Supported resolutions are: 2560x1440@10, 1920x1080@25, 1920x1200@25, 1440x900@25, 1024x768@60, 1200x800@60 If refresh_rate is not provided, it will be automatically determined from the width and height if they match a supported configuration exactly. Note: Higher resolutions may affect the responsiveness of live view browser
func (BrowserViewport) RawJSON ¶ added in v0.21.0
func (r BrowserViewport) RawJSON() string
Returns the unmodified JSON received from the API
func (BrowserViewport) ToParam ¶ added in v0.21.0
func (r BrowserViewport) ToParam() BrowserViewportParam
ToParam converts this BrowserViewport to a BrowserViewportParam.
Warning: the fields of the param type will not be present. ToParam should only be used at the last possible moment before sending a request. Test for this with BrowserViewportParam.Overrides()
func (*BrowserViewport) UnmarshalJSON ¶ added in v0.21.0
func (r *BrowserViewport) UnmarshalJSON(data []byte) error
type BrowserViewportParam ¶ added in v0.21.0
type BrowserViewportParam struct {
// Browser window height in pixels.
Height int64 `json:"height,required"`
// Browser window width in pixels.
Width int64 `json:"width,required"`
// Display refresh rate in Hz. If omitted, automatically determined from width and
// height.
RefreshRate param.Opt[int64] `json:"refresh_rate,omitzero"`
// contains filtered or unexported fields
}
Initial browser window size in pixels with optional refresh rate. If omitted, image defaults apply (commonly 1024x768@60). Only specific viewport configurations are supported. The server will reject unsupported combinations. Supported resolutions are: 2560x1440@10, 1920x1080@25, 1920x1200@25, 1440x900@25, 1024x768@60, 1200x800@60 If refresh_rate is not provided, it will be automatically determined from the width and height if they match a supported configuration exactly. Note: Higher resolutions may affect the responsiveness of live view browser
The properties Height, Width are required.
func (BrowserViewportParam) MarshalJSON ¶ added in v0.21.0
func (r BrowserViewportParam) MarshalJSON() (data []byte, err error)
func (*BrowserViewportParam) UnmarshalJSON ¶ added in v0.21.0
func (r *BrowserViewportParam) UnmarshalJSON(data []byte) error
type ErrorDetail ¶
type ErrorDetail struct {
// Lower-level error code providing more specific detail
Code string `json:"code"`
// Further detail about the error
Message string `json:"message"`
// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
JSON struct {
Code respjson.Field
Message respjson.Field
ExtraFields map[string]respjson.Field
// contains filtered or unexported fields
} `json:"-"`
}
func (ErrorDetail) RawJSON ¶
func (r ErrorDetail) RawJSON() string
Returns the unmodified JSON received from the API
func (*ErrorDetail) UnmarshalJSON ¶
func (r *ErrorDetail) UnmarshalJSON(data []byte) error
type ErrorEvent ¶
type ErrorEvent struct {
Error ErrorModel `json:"error,required"`
// Event type identifier (always "error").
Event constant.Error `json:"event,required"`
// Time the error occurred.
Timestamp time.Time `json:"timestamp,required" format:"date-time"`
// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
JSON struct {
Error respjson.Field
Event respjson.Field
Timestamp respjson.Field
ExtraFields map[string]respjson.Field
// contains filtered or unexported fields
} `json:"-"`
}
An error event from the application.
func (ErrorEvent) ImplInvocationFollowResponseUnion ¶
func (ErrorEvent) ImplInvocationFollowResponseUnion()
func (ErrorEvent) RawJSON ¶
func (r ErrorEvent) RawJSON() string
Returns the unmodified JSON received from the API
func (*ErrorEvent) UnmarshalJSON ¶
func (r *ErrorEvent) UnmarshalJSON(data []byte) error
type ErrorModel ¶
type ErrorModel struct {
// Application-specific error code (machine-readable)
Code string `json:"code,required"`
// Human-readable error description for debugging
Message string `json:"message,required"`
// Additional error details (for multiple errors)
Details []ErrorDetail `json:"details"`
InnerError ErrorDetail `json:"inner_error"`
// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
JSON struct {
Code respjson.Field
Message respjson.Field
Details respjson.Field
InnerError respjson.Field
ExtraFields map[string]respjson.Field
// contains filtered or unexported fields
} `json:"-"`
}
func (ErrorModel) RawJSON ¶
func (r ErrorModel) RawJSON() string
Returns the unmodified JSON received from the API
func (*ErrorModel) UnmarshalJSON ¶
func (r *ErrorModel) UnmarshalJSON(data []byte) error
type HeartbeatEvent ¶ added in v0.6.2
type HeartbeatEvent struct {
// Event type identifier (always "sse_heartbeat").
Event constant.SseHeartbeat `json:"event,required"`
// Time the heartbeat was sent.
Timestamp time.Time `json:"timestamp,required" format:"date-time"`
// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
JSON struct {
Event respjson.Field
Timestamp respjson.Field
ExtraFields map[string]respjson.Field
// contains filtered or unexported fields
} `json:"-"`
}
Heartbeat event sent periodically to keep SSE connection alive.
func (HeartbeatEvent) ImplInvocationFollowResponseUnion ¶ added in v0.6.2
func (HeartbeatEvent) ImplInvocationFollowResponseUnion()
func (HeartbeatEvent) RawJSON ¶ added in v0.6.2
func (r HeartbeatEvent) RawJSON() string
Returns the unmodified JSON received from the API
func (*HeartbeatEvent) UnmarshalJSON ¶ added in v0.6.2
func (r *HeartbeatEvent) UnmarshalJSON(data []byte) error
type LogEvent ¶
type LogEvent struct {
// Event type identifier (always "log").
Event constant.Log `json:"event,required"`
// Log message text.
Message string `json:"message,required"`
// Time the log entry was produced.
Timestamp time.Time `json:"timestamp,required" format:"date-time"`
// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
JSON struct {
Event respjson.Field
Message respjson.Field
Timestamp respjson.Field
ExtraFields map[string]respjson.Field
// contains filtered or unexported fields
} `json:"-"`
}
A log entry from the application.
func (LogEvent) ImplInvocationFollowResponseUnion ¶
func (LogEvent) ImplInvocationFollowResponseUnion()