-
- All Implemented Interfaces:
-
android.graphics.drawable.Drawable.Callback,android.view.KeyEvent.Callback,android.view.ViewManager,android.view.ViewParent,android.view.accessibility.AccessibilityEventSource
public final class DoorstepEmbedView extends FrameLayout
A self-contained WebView card that shows the Doorstep Go map (go.doorstep.ai) for one delivery address.
Usage: call DoorstepAI.setDoorstepGoApiKey once at startup, add the view to your layout (or wrap it in Compose
AndroidView), then load an address — the view mints a link viaGET {linkAPI}/v1/link/gowith that key and shows it.The view owns its own height: it animates
layoutParams.heightbetween inlineHeightDp (PREVIEW) and expandedHeightDp (COMPACT) over 300 ms whenever mode changes — via the built-in expand/collapse button or the mode property. Mode changes are JS-only (window.dsgo.setEmbedMode), never a page reload.Host requirements and constraints:
android.permission.INTERNETmust be declared by the host app.The map is Mapbox/WebGL: detaching the view from the window kills the GL context unrecoverably (solid-black canvas). Keep the view mounted across mode changes; if it is torn down (navigation, tab switch), create a fresh view and load again.
The map consumes drag gestures — keep the view out of scrollable containers.
Call destroy when permanently done with the view.
Location: the page's recenter button uses
navigator.geolocation, answered from the host app's own location grant. On the first expand tap without a grant the view asks for it (when its context unwraps to an Activity); the result is ignored and re-checked live on each page prompt.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public classDoorstepEmbedView.Companion
-
Field Summary
Fields Modifier and Type Field Description private FloatinlineHeightDpprivate FloatexpandedHeightDpprivate Function1<EmbedMode, Unit>onModeChangedprivate Function1<String, Unit>onErrorprivate EmbedModemode
-
Constructor Summary
Constructors Constructor Description DoorstepEmbedView(Context context, AttributeSet attrs, Integer defStyleAttr)DoorstepEmbedView(Context context, AttributeSet attrs)DoorstepEmbedView(Context context)
-
Method Summary
Modifier and Type Method Description final FloatgetInlineHeightDp()View height in dp while mode == EmbedMode.PREVIEW. final UnitsetInlineHeightDp(Float inlineHeightDp)final FloatgetExpandedHeightDp()View height in dp while mode == EmbedMode.COMPACT. final UnitsetExpandedHeightDp(Float expandedHeightDp)final Function1<EmbedMode, Unit>getOnModeChanged()Notified after the mode changes (button tap or programmatic mode set). final UnitsetOnModeChanged(Function1<EmbedMode, Unit> onModeChanged)Notified after the mode changes (button tap or programmatic mode set). final Function1<String, Unit>getOnError()Notified on link-mint failures, main-frame load failures, and blocked cross-host navigations. final UnitsetOnError(Function1<String, Unit> onError)Notified on link-mint failures, main-frame load failures, and blocked cross-host navigations. final EmbedModegetMode()Current display mode. final UnitsetMode(EmbedMode mode)final Unitload(String address, String deliveryID, String linkAPI, String baseMap, String parkingText, String markerColor, String polygonColor, String parkingColor)Mints a Doorstep Go link for address and loads it at the current mode. final Unitload(String address, String deliveryID, String linkAPI, String baseMap, String parkingText, String markerColor, String polygonColor)Mints a Doorstep Go link for address and loads it at the current mode. final Unitload(String address, String deliveryID, String linkAPI, String baseMap, String parkingText, String markerColor)Mints a Doorstep Go link for address and loads it at the current mode. final Unitload(String address, String deliveryID, String linkAPI, String baseMap, String parkingText)Mints a Doorstep Go link for address and loads it at the current mode. final Unitload(String address, String deliveryID, String linkAPI, String baseMap)Mints a Doorstep Go link for address and loads it at the current mode. final Unitload(String address, String deliveryID, String linkAPI)Mints a Doorstep Go link for address and loads it at the current mode. final Unitload(String address, String deliveryID)Mints a Doorstep Go link for address and loads it at the current mode. final Unitload(String address)Mints a Doorstep Go link for address and loads it at the current mode. final Unitreload()Re-runs the most recent load call, minting a fresh token (they expire, default 1 h) rather than reloading the stale URL. final Unitdestroy()Permanent teardown: cancels in-flight work (link mint, mode retries, height animation) and destroys the WebView. -
Methods inherited from class android.view.ViewGroup
addFocusables, addOnAttachStateChangeListener, addOnLayoutChangeListener, addOnUnhandledKeyEventListener, animate, announceForAccessibility, autofill, autofill, awakenScrollBars, awakenScrollBars, awakenScrollBars, bringToFront, buildDrawingCache, buildDrawingCache, buildLayer, callOnClick, canResolveLayoutDirection, canResolveTextAlignment, canResolveTextDirection, canScrollHorizontally, canScrollVertically, cancelDragAndDrop, cancelLongPress, cancelPendingInputEvents, checkInputConnectionProxy, clearAnimation, clearViewTranslationCallback, computeHorizontalScrollExtent, computeHorizontalScrollOffset, computeHorizontalScrollRange, computeScroll, computeSystemWindowInsets, computeVerticalScrollExtent, computeVerticalScrollOffset, computeVerticalScrollRange, createAccessibilityNodeInfo, createContextMenu, destroyDrawingCache, dispatchGenericMotionEvent, dispatchNestedFling, dispatchNestedPreFling, dispatchNestedPrePerformAccessibilityAction, dispatchNestedPreScroll, dispatchNestedScroll, dispatchPopulateAccessibilityEvent, draw, drawableHotspotChanged, findOnBackInvokedDispatcher, findViewById, findViewWithTag, fitSystemWindows, focusSearch, forceHasOverlappingRendering, forceLayout, generateDisplayHash, getAccessibilityDelegate, getAccessibilityLiveRegion, getAccessibilityNodeProvider, getAccessibilityPaneTitle, getAccessibilityTraversalAfter, getAccessibilityTraversalBefore, getAllowedHandwritingDelegatePackageName, getAllowedHandwritingDelegatorPackageName, getAlpha, getAnimation, getAnimationMatrix, getApplicationWindowToken, getAttributeResolutionStack, getAttributeSourceResourceMap, getAutofillHints, getAutofillId, getAutofillType, getAutofillValue, getBackground, getBackgroundTintBlendMode, getBackgroundTintList, getBackgroundTintMode, getBaseline, getBottom, getBottomFadingEdgeStrength, getBottomPaddingOffset, getCameraDistance, getClipBounds, getClipBounds, getClipToOutline, getContentCaptureSession, getContentDescription, getContext, getContextMenuInfo, getDefaultFocusHighlightEnabled, getDisplay, getDrawableState, getDrawingCache, getDrawingCache, getDrawingCacheBackgroundColor, getDrawingCacheQuality, getDrawingRect, getDrawingTime, getElevation, getExplicitStyle, getFilterTouchesWhenObscured, getFitsSystemWindows, getFocusable, getFocusables, getFocusedRect, getForeground, getForegroundGravity, getForegroundTintBlendMode, getForegroundTintList, getForegroundTintMode, getGlobalVisibleRect, getGlobalVisibleRect, getHandler, getHandwritingBoundsOffsetBottom, getHandwritingBoundsOffsetLeft, getHandwritingBoundsOffsetRight, getHandwritingBoundsOffsetTop, getHandwritingDelegatorCallback, getHasOverlappingRendering, getHeight, getHitRect, getHorizontalFadingEdgeLength, getHorizontalScrollbarHeight, getHorizontalScrollbarThumbDrawable, getHorizontalScrollbarTrackDrawable, getId, getImportantForAccessibility, getImportantForAutofill, getImportantForContentCapture, getKeepScreenOn, getKeyDispatcherState, getLabelFor, getLayerType, getLayoutDirection, getLayoutParams, getLeft, getLeftFadingEdgeStrength, getLeftPaddingOffset, getLocalVisibleRect, getLocationInSurface, getLocationInWindow, getLocationOnScreen, getMatrix, getMeasuredHeight, getMeasuredHeightAndState, getMeasuredState, getMeasuredWidth, getMeasuredWidthAndState, getMinimumHeight, getMinimumWidth, getNextClusterForwardId, getNextFocusDownId, getNextFocusForwardId, getNextFocusLeftId, getNextFocusRightId, getNextFocusUpId, getOnFocusChangeListener, getOutlineAmbientShadowColor, getOutlineProvider, getOutlineSpotShadowColor, getOverScrollMode, getPaddingBottom, getPaddingEnd, getPaddingLeft, getPaddingRight, getPaddingStart, getPaddingTop, getParent, getParentForAccessibility, getPivotX, getPivotY, getPointerIcon, getPreferKeepClearRects, getReceiveContentMimeTypes, getResources, getRevealOnFocusHint, getRight, getRightFadingEdgeStrength, getRightPaddingOffset, getRootSurfaceControl, getRootView, getRootWindowInsets, getRotation, getRotationX, getRotationY, getScaleX, getScaleY, getScrollBarDefaultDelayBeforeFade, getScrollBarFadeDuration, getScrollBarSize, getScrollBarStyle, getScrollCaptureHint, getScrollIndicators, getScrollX, getScrollY, getSolidColor, getSourceLayoutResId, getStateDescription, getStateListAnimator, getSuggestedMinimumHeight, getSuggestedMinimumWidth, getSystemGestureExclusionRects, getSystemUiVisibility, getTag, getTag, getTextAlignment, getTextDirection, getTooltipText, getTop, getTopFadingEdgeStrength, getTopPaddingOffset, getTouchDelegate, getTouchables, getTransitionAlpha, getTransitionName, getTranslationX, getTranslationY, getTranslationZ, getUniqueDrawingId, getVerticalFadingEdgeLength, getVerticalScrollbarPosition, getVerticalScrollbarThumbDrawable, getVerticalScrollbarTrackDrawable, getVerticalScrollbarWidth, getViewTranslationResponse, getViewTreeObserver, getVisibility, getWidth, getWindowAttachCount, getWindowId, getWindowInsetsController, getWindowSystemUiVisibility, getWindowToken, getWindowVisibility, getWindowVisibleDisplayFrame, getX, getY, getZ, hasExplicitFocusable, hasFocusable, hasNestedScrollingParent, hasOnClickListeners, hasOnLongClickListeners, hasOverlappingRendering, hasPointerCapture, hasWindowFocus, invalidate, invalidate, invalidate, invalidateDrawable, invalidateOutline, isAccessibilityDataSensitive, isAccessibilityFocused, isAccessibilityHeading, isActivated, isAttachedToWindow, isAutoHandwritingEnabled, isClickable, isContextClickable, isCredential, isDirty, isDrawingCacheEnabled, isDuplicateParentStateEnabled, isEnabled, isFocusable, isFocusableInTouchMode, isFocused, isFocusedByDefault, isForceDarkAllowed, isHandwritingDelegate, isHapticFeedbackEnabled, isHardwareAccelerated, isHorizontalFadingEdgeEnabled, isHorizontalScrollBarEnabled, isHovered, isImportantForAccessibility, isImportantForAutofill, isImportantForContentCapture, isInEditMode, isInLayout, isInTouchMode, isKeyboardNavigationCluster, isLaidOut, isLayoutDirectionResolved, isLayoutRequested, isLongClickable, isNestedScrollingEnabled, isOpaque, isPaddingOffsetRequired, isPaddingRelative, isPivotSet, isPreferKeepClear, isPressed, isSaveEnabled, isSaveFromParentEnabled, isScreenReaderFocusable, isScrollContainer, isScrollbarFadingEnabled, isSelected, isShowingLayoutBounds, isShown, isSoundEffectsEnabled, isTemporarilyDetached, isTextAlignmentResolved, isTextDirectionResolved, isVerticalFadingEdgeEnabled, isVerticalScrollBarEnabled, isVisibleToUserForAutofill, keyboardNavigationClusterSearch, measure, offsetLeftAndRight, offsetTopAndBottom, onAnimationEnd, onAnimationStart, onApplyWindowInsets, onCancelPendingInputEvents, onCapturedPointerEvent, onCheckIsTextEditor, onConfigurationChanged, onCreateContextMenu, onCreateInputConnection, onCreateViewTranslationRequest, onCreateVirtualViewTranslationRequests, onDisplayHint, onDragEvent, onDraw, onDrawForeground, onDrawScrollBars, onFilterTouchEventForSecurity, onFinishInflate, onFinishTemporaryDetach, onFocusChanged, onGenericMotionEvent, onHoverChanged, onHoverEvent, onInitializeAccessibilityEvent, onInitializeAccessibilityNodeInfo, onKeyDown, onKeyLongPress, onKeyMultiple, onKeyPreIme, onKeyShortcut, onKeyUp, onOverScrolled, onPointerCaptureChange, onPopulateAccessibilityEvent, onProvideAutofillStructure, onProvideAutofillVirtualStructure, onProvideContentCaptureStructure, onProvideStructure, onProvideVirtualStructure, onReceiveContent, onRestoreInstanceState, onRtlPropertiesChanged, onSaveInstanceState, onScreenStateChanged, onScrollCaptureSearch, onScrollChanged, onSetAlpha, onSizeChanged, onStartTemporaryDetach, onTouchEvent, onTrackballEvent, onViewTranslationResponse, onVirtualViewTranslationResponses, onVisibilityAggregated, onVisibilityChanged, onWindowFocusChanged, onWindowSystemUiVisibilityChanged, onWindowVisibilityChanged, overScrollBy, performAccessibilityAction, performClick, performContextClick, performContextClick, performHapticFeedback, performHapticFeedback, performLongClick, performLongClick, performReceiveContent, playSoundEffect, post, postDelayed, postInvalidate, postInvalidate, postInvalidateDelayed, postInvalidateDelayed, postInvalidateOnAnimation, postInvalidateOnAnimation, postOnAnimation, postOnAnimationDelayed, refreshDrawableState, releasePointerCapture, removeCallbacks, removeOnAttachStateChangeListener, removeOnLayoutChangeListener, removeOnUnhandledKeyEventListener, requestApplyInsets, requestFitSystemWindows, requestFocus, requestFocus, requestFocusFromTouch, requestLayout, requestPointerCapture, requestRectangleOnScreen, requestRectangleOnScreen, requestUnbufferedDispatch, requestUnbufferedDispatch, requireViewById, resetPivot, restoreHierarchyState, saveAttributeDataForStyleable, saveHierarchyState, scheduleDrawable, scrollBy, scrollTo, sendAccessibilityEvent, sendAccessibilityEventUnchecked, setAccessibilityDataSensitive, setAccessibilityDelegate, setAccessibilityHeading, setAccessibilityLiveRegion, setAccessibilityPaneTitle, setAccessibilityTraversalAfter, setAccessibilityTraversalBefore, setActivated, setAllowClickWhenDisabled, setAllowedHandwritingDelegatePackage, setAllowedHandwritingDelegatorPackage, setAlpha, setAnimation, setAnimationMatrix, setAutoHandwritingEnabled, setAutofillHints, setAutofillId, setBackground, setBackgroundColor, setBackgroundDrawable, setBackgroundResource, setBackgroundTintBlendMode, setBackgroundTintList, setBackgroundTintMode, setBottom, setCameraDistance, setClickable, setClipBounds, setClipToOutline, setContentCaptureSession, setContentDescription, setContextClickable, setDefaultFocusHighlightEnabled, setDrawingCacheBackgroundColor, setDrawingCacheEnabled, setDrawingCacheQuality, setDuplicateParentStateEnabled, setElevation, setEnabled, setFadingEdgeLength, setFilterTouchesWhenObscured, setFitsSystemWindows, setFocusable, setFocusable, setFocusableInTouchMode, setFocusedByDefault, setForceDarkAllowed, setForeground, setForegroundTintBlendMode, setForegroundTintList, setForegroundTintMode, setHandwritingBoundsOffsets, setHandwritingDelegatorCallback, setHapticFeedbackEnabled, setHasTransientState, setHorizontalFadingEdgeEnabled, setHorizontalScrollBarEnabled, setHorizontalScrollbarThumbDrawable, setHorizontalScrollbarTrackDrawable, setHovered, setId, setImportantForAccessibility, setImportantForAutofill, setImportantForContentCapture, setIsCredential, setIsHandwritingDelegate, setKeepScreenOn, setKeyboardNavigationCluster, setLabelFor, setLayerPaint, setLayerType, setLayoutDirection, setLayoutParams, setLeft, setLeftTopRightBottom, setLongClickable, setMeasuredDimension, setMinimumHeight, setMinimumWidth, setNestedScrollingEnabled, setNextClusterForwardId, setNextFocusDownId, setNextFocusForwardId, setNextFocusLeftId, setNextFocusRightId, setNextFocusUpId, setOnApplyWindowInsetsListener, setOnCapturedPointerListener, setOnClickListener, setOnContextClickListener, setOnCreateContextMenuListener, setOnDragListener, setOnFocusChangeListener, setOnGenericMotionListener, setOnHoverListener, setOnKeyListener, setOnLongClickListener, setOnReceiveContentListener, setOnScrollChangeListener, setOnSystemUiVisibilityChangeListener, setOnTouchListener, setOutlineAmbientShadowColor, setOutlineProvider, setOutlineSpotShadowColor, setOverScrollMode, setPadding, setPaddingRelative, setPivotX, setPivotY, setPointerIcon, setPreferKeepClear, setPreferKeepClearRects, setPressed, setRenderEffect, setRevealOnFocusHint, setRight, setRotation, setRotationX, setRotationY, setSaveEnabled, setSaveFromParentEnabled, setScaleX, setScaleY, setScreenReaderFocusable, setScrollBarDefaultDelayBeforeFade, setScrollBarFadeDuration, setScrollBarSize, setScrollBarStyle, setScrollCaptureCallback, setScrollCaptureHint, setScrollContainer, setScrollIndicators, setScrollIndicators, setScrollX, setScrollY, setScrollbarFadingEnabled, setSelected, setSoundEffectsEnabled, setStateDescription, setStateListAnimator, setSystemGestureExclusionRects, setSystemUiVisibility, setTag, setTag, setTextAlignment, setTextDirection, setTooltipText, setTop, setTouchDelegate, setTransitionAlpha, setTransitionName, setTransitionVisibility, setTranslationX, setTranslationY, setTranslationZ, setVerticalFadingEdgeEnabled, setVerticalScrollBarEnabled, setVerticalScrollbarPosition, setVerticalScrollbarThumbDrawable, setVerticalScrollbarTrackDrawable, setViewTranslationCallback, setVisibility, setWillNotCacheDrawing, setWillNotDraw, setX, setY, setZ, showContextMenu, showContextMenu, startActionMode, startActionMode, startAnimation, startDrag, startDragAndDrop, startNestedScroll, stopNestedScroll, toString, transformMatrixToGlobal, transformMatrixToLocal, unscheduleDrawable, unscheduleDrawable, updateDragShadow, verifyDrawable, willNotCacheDrawing, willNotDraw -
Methods inherited from class android.widget.FrameLayout
addChildrenForAccessibility, addExtraDataToAccessibilityNodeInfo, addFocusables, addKeyboardNavigationClusters, addStatesFromChildren, addTouchables, addView, addView, addView, addView, addView, addViewInLayout, addViewInLayout, attachLayoutAnimationParameters, attachViewToParent, bringChildToFront, canAnimate, childDrawableStateChanged, childHasTransientStateChanged, cleanupLayoutState, clearChildFocus, clearDisappearingChildren, clearFocus, debug, detachAllViewsFromParent, detachViewFromParent, detachViewFromParent, detachViewsFromParent, dispatchApplyWindowInsets, dispatchCapturedPointerEvent, dispatchConfigurationChanged, dispatchCreateViewTranslationRequest, dispatchDisplayHint, dispatchDragEvent, dispatchDraw, dispatchDrawableHotspotChanged, dispatchFinishTemporaryDetach, dispatchFreezeSelfOnly, dispatchGenericFocusedEvent, dispatchGenericPointerEvent, dispatchHoverEvent, dispatchKeyEvent, dispatchKeyEventPreIme, dispatchKeyShortcutEvent, dispatchPointerCaptureChanged, dispatchProvideAutofillStructure, dispatchProvideStructure, dispatchRestoreInstanceState, dispatchSaveInstanceState, dispatchScrollCaptureSearch, dispatchSetActivated, dispatchSetPressed, dispatchSetSelected, dispatchStartTemporaryDetach, dispatchSystemUiVisibilityChanged, dispatchThawSelfOnly, dispatchTouchEvent, dispatchTrackballEvent, dispatchUnhandledMove, dispatchVisibilityChanged, dispatchWindowFocusChanged, dispatchWindowInsetsAnimationEnd, dispatchWindowInsetsAnimationPrepare, dispatchWindowInsetsAnimationProgress, dispatchWindowInsetsAnimationStart, dispatchWindowSystemUiVisiblityChanged, dispatchWindowVisibilityChanged, drawChild, drawableStateChanged, endViewTransition, findFocus, findOnBackInvokedDispatcherForChild, findViewsWithText, focusSearch, focusableViewAvailable, gatherTransparentRegion, getChildAt, getChildCount, getChildDrawingOrder, getChildDrawingOrder, getChildStaticTransformation, getChildVisibleRect, getClipChildren, getClipToPadding, getDescendantFocusability, getFocusedChild, getLayoutAnimation, getLayoutAnimationListener, getLayoutMode, getLayoutTransition, getNestedScrollAxes, getOverlay, getPersistentDrawingCache, getTouchscreenBlocksFocus, hasFocus, hasTransientState, indexOfChild, invalidateChild, invalidateChildInParent, isAlwaysDrawnWithCacheEnabled, isAnimationCacheEnabled, isChildrenDrawingOrderEnabled, isChildrenDrawnWithCacheEnabled, isLayoutSuppressed, isMotionEventSplittingEnabled, isTransitionGroup, jumpDrawablesToCurrentState, layout, measureChild, measureChildWithMargins, measureChildren, notifySubtreeAccessibilityStateChanged, offsetDescendantRectToMyCoords, offsetRectIntoDescendantCoords, onCreateDrawableState, onDescendantInvalidated, onInterceptHoverEvent, onInterceptTouchEvent, onNestedFling, onNestedPreFling, onNestedPrePerformAccessibilityAction, onNestedPreScroll, onNestedScroll, onNestedScrollAccepted, onRequestFocusInDescendants, onRequestSendAccessibilityEvent, onResolvePointerIcon, onStartNestedScroll, onStopNestedScroll, onViewAdded, onViewRemoved, recomputeViewAttributes, removeAllViews, removeAllViewsInLayout, removeDetachedView, removeView, removeViewAt, removeViewInLayout, removeViews, removeViewsInLayout, requestChildFocus, requestChildRectangleOnScreen, requestDisallowInterceptTouchEvent, requestFocus, requestSendAccessibilityEvent, requestTransparentRegion, restoreDefaultFocus, scheduleLayoutAnimation, setAddStatesFromChildren, setAlwaysDrawnWithCacheEnabled, setAnimationCacheEnabled, setChildrenDrawingCacheEnabled, setChildrenDrawingOrderEnabled, setChildrenDrawnWithCacheEnabled, setClipChildren, setClipToPadding, setDescendantFocusability, setLayoutAnimation, setLayoutAnimationListener, setLayoutMode, setLayoutTransition, setMotionEventSplittingEnabled, setOnHierarchyChangeListener, setPersistentDrawingCache, setStaticTransformationsEnabled, setTouchscreenBlocksFocus, setTransitionGroup, setWindowInsetsAnimationCallback, showContextMenuForChild, showContextMenuForChild, startActionModeForChild, startActionModeForChild, startLayoutAnimation, startViewTransition, suppressLayout, updateViewLayout -
Methods inherited from class com.doorstepai.sdks.tracking.DoorstepEmbedView
checkLayoutParams, generateDefaultLayoutParams, generateLayoutParams, generateLayoutParams, getAccessibilityClassName, getConsiderGoneChildrenWhenMeasuring, getMeasureAllChildren, onLayout, onMeasure, setForegroundGravity, setMeasureAllChildren, shouldDelayChildPressedState -
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
-
Constructor Detail
-
DoorstepEmbedView
DoorstepEmbedView(Context context, AttributeSet attrs, Integer defStyleAttr)
-
DoorstepEmbedView
DoorstepEmbedView(Context context, AttributeSet attrs)
-
DoorstepEmbedView
DoorstepEmbedView(Context context)
-
-
Method Detail
-
getInlineHeightDp
final Float getInlineHeightDp()
View height in dp while mode == EmbedMode.PREVIEW.
-
setInlineHeightDp
final Unit setInlineHeightDp(Float inlineHeightDp)
-
getExpandedHeightDp
final Float getExpandedHeightDp()
View height in dp while mode == EmbedMode.COMPACT.
-
setExpandedHeightDp
final Unit setExpandedHeightDp(Float expandedHeightDp)
-
getOnModeChanged
final Function1<EmbedMode, Unit> getOnModeChanged()
Notified after the mode changes (button tap or programmatic mode set).
-
setOnModeChanged
final Unit setOnModeChanged(Function1<EmbedMode, Unit> onModeChanged)
Notified after the mode changes (button tap or programmatic mode set).
-
getOnError
final Function1<String, Unit> getOnError()
Notified on link-mint failures, main-frame load failures, and blocked cross-host navigations. Mint/load failures additionally show the built-in error overlay + Retry.
-
setOnError
final Unit setOnError(Function1<String, Unit> onError)
Notified on link-mint failures, main-frame load failures, and blocked cross-host navigations. Mint/load failures additionally show the built-in error overlay + Retry.
-
getMode
final EmbedMode getMode()
Current display mode. Setting it animates the view's own height and asks the page to switch (retried up to 20×150 ms until
window.dsgoconfirms). Never reloads the page.
-
load
@JvmOverloads() final Unit load(String address, String deliveryID, String linkAPI, String baseMap, String parkingText, String markerColor, String polygonColor, String parkingColor)
Mints a Doorstep Go link for address and loads it at the current mode.
The mint key comes from DoorstepAI.setDoorstepGoApiKey — call it before this view loads. When never set, the tracking SDK's collection key is used as a fallback (valid only for orgs issued a single dual-realm key); an unset/empty key surfaces as "Link API 0: API key is empty" through onError and the error overlay.
The appearance params are forwarded to the mint request but the server currently drops them — do not rely on them for theming.
-
load
@JvmOverloads() final Unit load(String address, String deliveryID, String linkAPI, String baseMap, String parkingText, String markerColor, String polygonColor)
Mints a Doorstep Go link for address and loads it at the current mode.
The mint key comes from DoorstepAI.setDoorstepGoApiKey — call it before this view loads. When never set, the tracking SDK's collection key is used as a fallback (valid only for orgs issued a single dual-realm key); an unset/empty key surfaces as "Link API 0: API key is empty" through onError and the error overlay.
The appearance params are forwarded to the mint request but the server currently drops them — do not rely on them for theming.
-
load
@JvmOverloads() final Unit load(String address, String deliveryID, String linkAPI, String baseMap, String parkingText, String markerColor)
Mints a Doorstep Go link for address and loads it at the current mode.
The mint key comes from DoorstepAI.setDoorstepGoApiKey — call it before this view loads. When never set, the tracking SDK's collection key is used as a fallback (valid only for orgs issued a single dual-realm key); an unset/empty key surfaces as "Link API 0: API key is empty" through onError and the error overlay.
The appearance params are forwarded to the mint request but the server currently drops them — do not rely on them for theming.
-
load
@JvmOverloads() final Unit load(String address, String deliveryID, String linkAPI, String baseMap, String parkingText)
Mints a Doorstep Go link for address and loads it at the current mode.
The mint key comes from DoorstepAI.setDoorstepGoApiKey — call it before this view loads. When never set, the tracking SDK's collection key is used as a fallback (valid only for orgs issued a single dual-realm key); an unset/empty key surfaces as "Link API 0: API key is empty" through onError and the error overlay.
The appearance params are forwarded to the mint request but the server currently drops them — do not rely on them for theming.
-
load
@JvmOverloads() final Unit load(String address, String deliveryID, String linkAPI, String baseMap)
Mints a Doorstep Go link for address and loads it at the current mode.
The mint key comes from DoorstepAI.setDoorstepGoApiKey — call it before this view loads. When never set, the tracking SDK's collection key is used as a fallback (valid only for orgs issued a single dual-realm key); an unset/empty key surfaces as "Link API 0: API key is empty" through onError and the error overlay.
The appearance params are forwarded to the mint request but the server currently drops them — do not rely on them for theming.
-
load
@JvmOverloads() final Unit load(String address, String deliveryID, String linkAPI)
Mints a Doorstep Go link for address and loads it at the current mode.
The mint key comes from DoorstepAI.setDoorstepGoApiKey — call it before this view loads. When never set, the tracking SDK's collection key is used as a fallback (valid only for orgs issued a single dual-realm key); an unset/empty key surfaces as "Link API 0: API key is empty" through onError and the error overlay.
The appearance params are forwarded to the mint request but the server currently drops them — do not rely on them for theming.
-
load
@JvmOverloads() final Unit load(String address, String deliveryID)
Mints a Doorstep Go link for address and loads it at the current mode.
The mint key comes from DoorstepAI.setDoorstepGoApiKey — call it before this view loads. When never set, the tracking SDK's collection key is used as a fallback (valid only for orgs issued a single dual-realm key); an unset/empty key surfaces as "Link API 0: API key is empty" through onError and the error overlay.
The appearance params are forwarded to the mint request but the server currently drops them — do not rely on them for theming.
-
load
@JvmOverloads() final Unit load(String address)
Mints a Doorstep Go link for address and loads it at the current mode.
The mint key comes from DoorstepAI.setDoorstepGoApiKey — call it before this view loads. When never set, the tracking SDK's collection key is used as a fallback (valid only for orgs issued a single dual-realm key); an unset/empty key surfaces as "Link API 0: API key is empty" through onError and the error overlay.
The appearance params are forwarded to the mint request but the server currently drops them — do not rely on them for theming.
-
reload
final Unit reload()
Re-runs the most recent load call, minting a fresh token (they expire, default 1 h) rather than reloading the stale URL. No-op before the first load.
-
-
-
-