Skip to content

ImageWireframeHelper

Xavier F. Gouchet edited this page Sep 4, 2024 · 1 revision

interface ImageWireframeHelper

A Helper to handle capturing images in Session replay wireframes.

Types

ImageWireframeHelper.Companion

Functions

createCompoundDrawableWireframes

@UiThread

abstract fun createCompoundDrawableWireframes(textView: TextView, mappingContext: MappingContext, prevWireframeIndex: Int, asyncJobStatusCallback: AsyncJobStatusCallback): MutableList<MobileSegment.Wireframe>

Creates the wireframes for the compound drawables in a TextView.

Parameters

createImageWireframe

abstract fun createImageWireframe(view: View, imagePrivacy: ImagePrivacy, currentWireframeIndex: Int, x: Long, y: Long, width: Int, height: Int, usePIIPlaceholder: Boolean, drawable: Drawable, asyncJobStatusCallback: AsyncJobStatusCallback, clipping: MobileSegment.WireframeClip? = null, shapeStyle: MobileSegment.ShapeStyle? = null, border: MobileSegment.ShapeBorder? = null, prefix: String? = DRAWABLE_CHILD_NAME): MobileSegment.Wireframe?

Asks the helper to create an image wireframe, and process the provided drawable in the background.

Parameters
view the view owning the drawable
imagePrivacy defines which images should be hidden
currentWireframeIndex the index of the wireframe in the list of wireframes for the view
x the x position of the image
y the y position of the image
width the width of the image
height the width of the image
usePIIPlaceholder whether to replace the image content with a placeholder when we suspect it contains PII
drawable the drawable to capture
asyncJobStatusCallback the callback for the async capture process
clipping the bounds of the image that are actually visible
shapeStyle provides a custom shape (e.g. rounded corners) to the image wireframe
border provides a custom border to the image wireframe
prefix a prefix identifying the drawable in the parent view's context
Clone this wiki locally