Package 

Interface ImageWireframeHelper


  • 
    public interface ImageWireframeHelper
    
                        

    A Helper to handle capturing images in Session replay wireframes.

    • Method Detail

      • createImageWireframeByPath

         abstract MobileSegment.Wireframe createImageWireframeByPath(Long id, GlobalBounds globalBounds, Path path, Integer strokeColor, Integer strokeWidth, Integer targetWidth, Integer targetHeight, Float density, Boolean isContextualImage, ImagePrivacy imagePrivacy, AsyncJobStatusCallback asyncJobStatusCallback, MobileSegment.WireframeClip clipping, MobileSegment.ShapeStyle shapeStyle, MobileSegment.ShapeBorder border, String customResourceIdCacheKey)

        Creates an image wireframe based on a given path.

        Parameters:
        id - the unique id for the wireframe.
        globalBounds - the global bounds of the bitmap.
        path - the path to use to create the wireframe.
        strokeColor - the color of the stroke.
        strokeWidth - the width of the stroke.
        targetWidth - the target width of the image.
        targetHeight - the target height of the image.
        density - the density of the screen.
        isContextualImage - if the image is contextual.
        imagePrivacy - defines which images should be hidden.
        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.
        border - provides a custom border to the image wireframe.
        customResourceIdCacheKey - an optional custom key with which to cache or retrieve from the resource cache.
      • createImageWireframeByDrawable

         abstract MobileSegment.Wireframe createImageWireframeByDrawable(View view, ImagePrivacy imagePrivacy, Integer currentWireframeIndex, Long x, Long y, Integer width, Integer height, Boolean usePIIPlaceholder, Drawable drawable, DrawableCopier drawableCopier, AsyncJobStatusCallback asyncJobStatusCallback, MobileSegment.WireframeClip clipping, MobileSegment.ShapeStyle shapeStyle, MobileSegment.ShapeBorder border, String prefix, String customResourceIdCacheKey)

        Creates 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
        drawableCopier - the callback to copy the original drawable to a new one.
        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.
        border - provides a custom border to the image wireframe
        prefix - a prefix identifying the drawable in the parent view's context
        customResourceIdCacheKey - an optional custom key with which to cache or retrieve from the resource cache.