DJI Mobile SDK Documentation

      class IRemoteViewPageManager

      interface IRemoteViewPageManager 
      Package:dji.open.pilot.client.interfaces
      Description:

      Server-side custom layout manager.

      Supported since MSDK 5.20.1

      Class Members:
      method setPageLayoutParam
      OperationResult setPageLayoutParam(ViewPageType viewPageType, LayoutParam param)
      Package:dji.open.pilot.client.interfaces
      Description:

      Sets the page layout parameters. Currently only ViewPageType.FLOATING_BOX is supported.

      Supported since MSDK 5.20.1

      Input Parameters:
      ViewPageType viewPageTypePage type.
      LayoutParam paramLayout parameters.
      Return:
      OperationResultOperation result.
      method
      method addView
      OperationResult addView(ViewPageType viewPageType, RemoteView remoteView)
      Package:dji.open.pilot.client.interfaces
      Description:

      Adds a new view to the layout.

      Supported since MSDK 5.20.1

      Input Parameters:
      ViewPageType viewPageTypePage type.
      RemoteView remoteViewRemote view object.
      Return:
      OperationResultOperation result.
      method
      method addView
      OperationResult addView(ViewPageType viewPageType, RemoteView remoteView, String parentId, WidgetLayoutParam layoutParam)
      Package:dji.open.pilot.client.interfaces
      Description:

      Adds a view to the specified parent container.

      Supported since MSDK 5.20.1

      Input Parameters:
      ViewPageType viewPageTypePage type.
      RemoteView remoteViewRemote view object.
      String parentIdParent container ID (null indicates the root layout).
      WidgetLayoutParam layoutParamLayout parameters (including margin, weight, layoutGravity, etc.).
      Return:
      OperationResultOperation result.
      method setConstraints
      OperationResult setConstraints(ViewPageType viewPageType, String viewId, String targetId, ViewSide viewDirection, ViewSide targetDirection, int margin)
      Package:dji.open.pilot.client.interfaces
      Description:

      Sets the view constraints.

      Supported since MSDK 5.20.1

      Input Parameters:
      ViewPageType viewPageTypePage type.
      String viewIdView ID.
      String targetIdTarget view ID.
      ViewSide viewDirectionView direction.
      ViewSide targetDirectionTarget direction.
      int marginMargin.
      Return:
      OperationResultOperation result.
      method setConstraints
      OperationResult setConstraints(ViewPageType viewPageType,String layoutId, String viewId, String targetId, ViewSide viewDirection, ViewSide targetDirection, int margin)
      Package:dji.open.pilot.client.interfaces
      Description:

      Sets the view constraints under the specified parent layout.

      Supported since MSDK 5.20.1

      Input Parameters:
      ViewPageType viewPageTypePage type.
      String layoutIdParent layout ID.
      String viewIdView ID.
      String targetIdTarget view ID.
      ViewSide viewDirectionView direction.
      ViewSide targetDirectionTarget direction.
      int marginMargin.
      Return:
      OperationResultOperation result.
      method updateView
      OperationResult updateView(ViewPageType viewPageType, String viewId, RemoteViewProperty property, String value)
      Package:dji.open.pilot.client.interfaces
      Description:

      Updates a view property.

      Supported since MSDK 5.20.1

      Input Parameters:
      ViewPageType viewPageTypePage type.
      String viewIdView ID.
      RemoteViewProperty propertyProperty type.
      String valueProperty value. For color properties (TEXT_COLOR / BACKGROUND_COLOR / PROGRESS_COLOR / SPINNER_DROPDOWN_BG_COLOR / SPINNER_DROPDOWN_TEXT_COLOR / SPINNER_SELECTED_TEXT_COLOR / SPINNER_ICON_COLOR), pass the decimal string of the color Int value, for example String.valueOf(Color.RED) or color.toString(). String formats such as "#RRGGBB" / "0xAARRGGBB" / "R.color.xxx" are not supported.
      Return:
      OperationResultOperation result.
      method updateView
      OperationResult updateView(ViewPageType viewPageType, String viewId, Map<RemoteViewProperty, String> propertyMap)
      Package:dji.open.pilot.client.interfaces
      Description:

      Updates view properties in batch.

      Supported since MSDK 5.20.1

      Input Parameters:
      ViewPageType viewPageTypePage type.
      String viewIdView ID.
      Map<RemoteViewProperty, String> propertyMapProperty map (key is RemoteViewProperty, value is the property value).
      Return:
      OperationResultOperation result.
      method
      method queryView
      List<RemoteView> queryView(ViewPageType viewPageType)
      Package:dji.open.pilot.client.interfaces
      Description:

      Queries all views.

      Supported since MSDK 5.20.1

      Input Parameters:
      ViewPageType viewPageTypePage type.
      Return:
      List<RemoteView>Remote view list.
      method clearLayout
      OperationResult clearLayout(ViewPageType viewPageType)
      Package:dji.open.pilot.client.interfaces
      Description:

      Clears all views.

      Supported since MSDK 5.20.1

      Input Parameters:
      ViewPageType viewPageTypePage type.
      Return:
      OperationResultOperation result.
      method clearLayout
      OperationResult clearLayout(ViewPageType viewPageType,String viewId)
      Package:dji.open.pilot.client.interfaces
      Description:

      Clears the child views under a certain layout.

      Supported since MSDK 5.20.1

      Input Parameters:
      ViewPageType viewPageTypePage type.
      String viewIdView ID.
      Return:
      OperationResultOperation result.
      method addActivityLifecycleListener
      void addActivityLifecycleListener(IRemoteActivityLifecycleListener listener)
      Package:dji.open.pilot.client.interfaces
      Description:

      Registers a Remote Activity lifecycle listener.

      Supported since MSDK 5.20.1

      Input Parameters:
      IRemoteActivityLifecycleListener listenerRemote Activity lifecycle listener.
      method removeActivityLifecycleListener
      void removeActivityLifecycleListener(IRemoteActivityLifecycleListener listener)
      Package:dji.open.pilot.client.interfaces
      Description:

      Unregisters a Remote Activity lifecycle listener.

      Supported since MSDK 5.20.1

      Input Parameters:
      IRemoteActivityLifecycleListener listenerRemote Activity lifecycle listener.
      method setActivityInfo
      OperationResult setActivityInfo(ActivityConfig activityInfo)
      Package:dji.open.pilot.client.interfaces
      Description:

      Sets the configuration information of the Remote Activity.

      Supported since MSDK 5.20.1

      Input Parameters:
      ActivityConfig activityInfoRemote Activity configuration information.
      Return:
      OperationResultOperation result.
      class ActivityConfig ↗
      class ActivityConfig implements Parcelable
      描述

      Full-screen view configuration.

      MSDK 5.20.1开始支持

      class DividerConfig ↗
      @Keep
      class DividerConfig
      描述

      List divider configuration, defining the style of the VERTICAL_LIST_VIEW divider.

      MSDK 5.20.1开始支持

      enum EllipsizeType
      enum EllipsizeType 
      Package:dji.open.pilot.base.ui.model
      Description:

      Text truncation type enumeration. When the text exceeds maxLines, it controls how the excess part is displayed.

      Supported since MSDK 5.20.1

      Enum Members:
      UNKNOWNUnknown (no truncation is set; the text is cropped directly when it overflows).
      STARTTruncate at the beginning of the text, replaced by an ellipsis (…text).
      MIDDLETruncate in the middle of the text, replaced by an ellipsis (te…xt).
      ENDTruncate at the end of the text, replaced by an ellipsis (text…).
      MARQUEEMarquee effect; the text scrolls for display.
      Class Members:
      enum FontStyleType
      enum FontStyleType 
      Package:dji.open.pilot.base.ui.model
      Description:

      Font style enumeration.

      Supported since MSDK 5.20.1

      Enum Members:
      UNKNOWNUnknown font style (default value or unrecognized value).
      NORMALNormal style (non-bold, non-italic).
      BOLDBold style.
      ITALICItalic style.
      BOLD_ITALICBold + italic style.
      Class Members:
      enum GravityType
      enum GravityType 
      Package:dji.open.pilot.base.ui.model
      Description:

      Alignment type enumeration.

      Supported since MSDK 5.20.1

      Enum Members:
      UNKNOWNUnknown alignment type (default value or unrecognized value).
      NO_GRAVITYNo alignment.
      TOPTop alignment (content at the top of the container).
      BOTTOMBottom alignment (content at the bottom of the container).
      LEFTLeft alignment (compatible with the legacy LTR layout direction).
      RIGHTRight alignment (compatible with the legacy LTR layout direction).
      CENTER_HORIZONTALHorizontally centered (content centered in the horizontal direction).
      CENTER_VERTICALVertically centered (content centered in the vertical direction).
      CENTERFully centered (horizontally + vertically centered).
      STARTStart alignment (based on the layout direction; left-aligned for LTR, right-aligned for RTL).
      ENDEnd alignment (based on the layout direction; right-aligned for LTR, left-aligned for RTL).
      Class Members:
      class IRemoteViewOnCheckedChangeListener ↗
      @Keep
      interface IRemoteViewOnCheckedChangeListener
      描述

      View checked state change listener.

      MSDK 5.20.1开始支持

      class IRemoteViewOnClickListener ↗
      @Keep
      interface IRemoteViewOnClickListener
      描述

      View click event listener.

      MSDK 5.20.1开始支持

      class IRemoteViewOnItemSelectedListener ↗
      @Keep
      interface IRemoteViewOnItemSelectedListener
      描述

      Spinner item selected event listener.

      MSDK 5.20.1开始支持

      class IRemoteViewTextWatcher ↗
      @Keep
      interface IRemoteViewTextWatcher
      描述

      View text change listener.

      MSDK 5.20.1开始支持

      enum InputType
      enum InputType 
      Package:dji.open.pilot.base.ui.model
      Description:

      EditText keyboard input type enumeration, corresponding to the Android InputType constants. It determines the type of soft keyboard popped up and the input restrictions.

      Supported since MSDK 5.20.1

      Enum Members:
      UNKNOWNUnknown (default; uses the system default input type).
      TEXTNormal text input (default text keyboard).
      TEXT_MULTI_LINEMulti-line text input.
      NUMBERInteger number input (numeric keyboard).
      NUMBER_DECIMALNumeric input with a decimal point.
      NUMBER_SIGNEDNumeric input that can include a sign (plus or minus).
      PHONEPhone number input (dial pad keyboard).
      EMAIL_ADDRESSEmail address input (text keyboard with the @ symbol).
      PASSWORDPassword input (text content masked with dots).
      NUMBER_PASSWORDNumeric password input (numbers only, masked with dots).
      Class Members:
      class LayoutParam ↗
      class LayoutParam implements Parcelable
      描述

      Server-side layout parameters.

      MSDK 5.20.1开始支持

      class ListItemData ↗
      @Keep
      class ListItemData
      描述

      List item data model, describing the content of a single item in a VERTICAL_LIST_VIEW.

      MSDK 5.20.1开始支持

      class ListItemOperation ↗
      @Keep
      class ListItemOperation
      描述

      List item incremental operation data, used for serialized transmission of INSERT / UPDATE operations.

      MSDK 5.20.1开始支持

      enum ListItemType
      enum ListItemType 
      Package:dji.open.pilot.base.ui.model
      Description:

      List item type enumeration, defining the predefined item layout types supported by VERTICAL_LIST_VIEW.

      Supported since MSDK 5.20.1

      Enum Members:
      TEXTPlain text item.
      ICON_TEXTIcon + title item.
      ICON_TWO_LINEIcon + two-line text item (title + subtitle).
      Class Members:
      enum OperationResult
      enum OperationResult 
      Package:dji.open.pilot.base.ui.model
      Description:

      Remote view operation result.

      Supported since MSDK 5.20.1

      Enum Members:
      UNKNOWNUnknown result.
      SUCCESSSuccess.
      NO_SUCH_VIEW_IDThe ID does not exist.
      EXECUTION_FAILEDExecution failed.
      SERVICE_NOT_FOUNDThe service is disconnected.
      INVALID_PROPERTYServer-side exception.
      INVALID_VIEW_PAGE_TYPEInvalid page type.
      INVALID_ACTIVITY_LIFECYCLE_STATEInvalid server-side activity state.
      NOT_SUPPORTEDNot supported for now.
      DIALOG_ALREADY_EXISTSThe dialog already exists; do not add it repeatedly.
      DIALOG_NOT_SUPPORTED_ON_CURRENT_PAGEThe current page does not support popping up a Dialog.
      NO_SUCH_PARENT_VIEW_IDThe parent ID does not exist.
      REMOTE_VIEWS_LIMIT_EXCEEDEDThe RemoteView cache of the current page has reached its limit. Please call clearLayout(viewPageType) to fully clear the page before adding views again.
      Class Members:
      enum ProgressStatusType
      enum ProgressStatusType 
      Package:dji.open.pilot.base.ui.model
      Description:

      Circular progress bar status enumeration.

      Supported since MSDK 5.20.1

      Enum Members:
      NORMALNormal state; text is shown at the center.
      SUCCESSSuccess state; a success icon is shown at the center and the text is hidden.
      FAILFailure state; a failure icon is shown at the center and the text is hidden.
      Class Members:
      class RemoteView ↗
      class RemoteView implements Parcelable
      描述

      Server-side view.

      MSDK 5.20.1开始支持

      enum RemoteViewProperty
      enum RemoteViewProperty 
      Package:dji.open.pilot.base.ui.model
      Description:

      Remote view property enumeration (defines the types of view properties that can be dynamically modified).

      Supported since MSDK 5.20.1

      Enum Members:
      UNKNOWNUnknown property type (default value or undefined property).
      TEXTText content property (applicable to text controls such as TextView / Button / EditText).
      BACKGROUND_COLORBackground color property (ARGB format color value).
      WEB_VIEW_URLWebView loading address (specifies the URL of the web page to render).
      PROGRESSProgress value property (sets the current progress percentage of components such as ProgressBar).
      IMAGEImage resource property (sets the bitmap or resource ID of an ImageView).
      TEXT_SIZEText size (unit: sp).
      TEXT_COLORText color.
      EDIT_TEXT_CURSOR_POSITIONCursor position.
      GRAVITYText alignment.
      FONT_STYLE_TYPEFont style enumeration.
      SCALE_TYPEImage fill mode.
      VERTICAL_SCROLLABLEWhether the text supports vertical scrolling. Effective only for TextView-type controls.
      EDIT_TEXT_HINTThe hint text of the EditText.
      EDIT_TEXT_GROUPINGEditText grouping.
      SPINNER_ITEMSSpinner item list (each item is separated using RemoteView.ITEMS_SEPARATOR).
      SPINNER_SELECTED_INDEXThe index of the currently selected item in the spinner.
      SPINNER_DROPDOWN_BG_COLORBackground color of the dropdown list popup layer (ARGB format).
      SPINNER_DROPDOWN_TEXT_COLORFont color of the dropdown list items (ARGB format).
      CHECKEDThe checked state (true / false) of a CompoundButton (CheckBox / Switch / ToggleButton). Effective only for CHECK_BOX / SWITCH / TOGGLE_BUTTON.
      VISIBILITYControl visibility (VISIBLE / INVISIBLE / GONE). Applicable to all controls.
      ENABLEDControl enabled/disabled state (true / false). Applicable to all controls; once disabled, the control is non-interactive and shows a disabled style.
      PADDINGControl padding, in the format "left,top,right,bottom" (unit dp). Applicable to all controls.
      MAX_LINESMaximum number of text lines to display (positive integer). Effective only for TEXT_VIEW / BUTTON / EDIT_TEXT.
      ELLIPSIZEText truncation method, effective when maxLines is exceeded. The value uses the value string of the EllipsizeType enum. Effective only for TEXT_VIEW / BUTTON / EDIT_TEXT.
      INPUT_TYPEEditText keyboard input type (text / number / password / email, etc.). The value uses the value string of the InputType enum. Effective only for EDIT_TEXT.
      MAX_LENGTHMaximum number of input characters for the EditText (positive integer). Effective only for EDIT_TEXT.
      PROGRESS_MAXThe maximum value of the ProgressBar (positive integer, default 100). Effective only for PROGRESS_BAR.
      BACKGROUND_SHAPEBackground shape style. Applicable to all controls.
      LIST_DATAFull list data (JSON array format). Effective only for VERTICAL_LIST_VIEW.
      LIST_INSERT_ITEMInsert a single item of data into the list (JSON format, containing the position and item data). Effective only for VERTICAL_LIST_VIEW.
      LIST_REMOVE_ITEMRemove a single item of data from the list (the value is the position string). Effective only for VERTICAL_LIST_VIEW.
      LIST_UPDATE_ITEMUpdate a single item of data in the list (JSON format, containing the position and item data). Effective only for VERTICAL_LIST_VIEW.
      LIST_DIVIDER_CONFIGList divider configuration (JSON format, containing height/color/paddingLeft/paddingRight/showLastDivider). Effective only for VERTICAL_LIST_VIEW.
      LIST_ITEM_CLICK_ENABLEDWhether the list item click event is enabled ("true"/"false"). Effective only for VERTICAL_LIST_VIEW.
      PROGRESS_COLORProgress bar color (ARGB format integer). Effective only for progress bars.
      PROGRESS_TEXT_SIZEThe center text size of the circular progress bar (unit: sp, positive integer). Effective only for CIRCULAR_PROGRESS_BAR.
      PROGRESS_STATUSCircular progress bar status (normal / success / failure). The value uses the value string of the ProgressStatusType enum. When in the SUCCESS / FAIL state, the center hides the text and shows the corresponding icon. Effective only for CIRCULAR_PROGRESS_BAR.
      ALPHAControl opacity (float, range 0.0 ~ 1.0; 0.0 is fully transparent, 1.0 is fully opaque). Applicable to all controls.
      SINGLE_LINESingle-line text mode ("true" / "false"). Effective only for TEXT_VIEW / BUTTON / EDIT_TEXT.
      LINE_SPACINGText line spacing, in JSON format {"extra":float,"multiplier":float}. extra is in dp (additional spacing), and multiplier is the line spacing multiple. Example: {"extra":4.0,"multiplier":1.2}. Effective only for TEXT_VIEW / BUTTON.
      TEXT_DECORATIONText decoration (underline, strikethrough). The value uses the value string of the TextDecorationType enum. Effective only for TEXT_VIEW / BUTTON.
      HINT_TEXT_COLOREditText hint text color (ARGB format integer). Effective only for EDIT_TEXT.
      SWITCH_THUMB_COLORSwitch thumb color (ARGB format integer). Effective only for SWITCH.
      SWITCH_TRACK_COLORSwitch track color (ARGB format integer). Effective only for SWITCH.
      CHECKBOX_TINTCheckBox check box tint (ARGB format integer). Unchecked state: the border changes to the target color; checked state: both the border and fill change to the target color, and the check mark remains white. Effective only for CHECK_BOX.
      MIN_SIZEControl minimum size, in the format "minWidth,minHeight" (unit dp). Applicable to all controls.
      LETTER_SPACINGText letter spacing (float, unit em; e.g. 0.1 means adding 0.1em spacing between each character). Effective only for TEXT_VIEW / BUTTON.
      IMAGE_TINTImageView image tint (ARGB format integer). Commonly used for icon color switching. Effective only for IMAGE_VIEW.
      SPINNER_SELECTED_TEXT_COLORThe text color of the currently selected item in the spinner (ARGB format).
      SPINNER_ICON_COLORSpinner icon color (ARGB format).
      Class Members:
      enum ScaleType
      enum ScaleType 
      Package:dji.open.pilot.base.ui.model
      Description:

      Image scale type enumeration (used to indicate the ScaleType mode of an ImageView).

      Supported since MSDK 5.20.1

      Enum Members:
      UNKNOWNUnknown scale type (default value or unrecognized value).
      MATRIXUses a Matrix to control scaling and position.
      FIT_XYStretches the image to match the view bounds (does not maintain the aspect ratio).
      FIT_STARTScales the image to the view size while maintaining the aspect ratio, aligned to the top.
      FIT_CENTERScales the image to the view size while maintaining the aspect ratio, centered.
      FIT_ENDScales the image to the view size while maintaining the aspect ratio, aligned to the bottom.
      CENTERDisplays the image at its original size and centered; the excess part is cropped.
      CENTER_CROPCenters and scales the image to fill the view while maintaining the aspect ratio; it may be cropped.
      CENTER_INSIDECenters and scales the image into the visible range while maintaining the aspect ratio, without cropping.
      Class Members:
      class ShapeDescriptor ↗
      class ShapeDescriptor
      描述

      Background shape descriptor that encapsulates background styles such as corner radius, stroke, and fill color.

      MSDK 5.20.1开始支持

      enum TextDecorationType
      enum TextDecorationType 
      Package:dji.open.pilot.base.ui.model
      Description:

      Text decoration type enumeration (underline, strikethrough). Used for the TEXT_DECORATION property.

      Supported since MSDK 5.20.1

      Enum Members:
      NONENo decoration (clears underline and strikethrough).
      UNDERLINEUnderline.
      STRIKE_THROUGHStrikethrough.
      UNDERLINE_AND_STRIKE_THROUGHUnderline + strikethrough.
      Class Members:
      class TextSpanSeparatorConfig ↗
      class TextSpanSeparatorConfig implements Parcelable
      描述

      Text grouping separator configuration, used to insert a separator character at fixed grouping intervals in the text.

      MSDK 5.20.1开始支持

      enum ViewPageType
      enum ViewPageType implements Parcelable 
      Package:dji.open.pilot.base.ui.model
      Description:

      View page type.

      Supported since MSDK 5.20.1

      Enum Members:
      UNKNOWNUnknown type.
      FLOATING_BOXFloating box type. The width is fixed at 140dp, and the default height is 200dp (the height can be modified via LayoutParam.setHeight(int), in dp).
      ACTIVITYFull-screen type.
      Class Members:
      enum ViewSide
      enum ViewSide 
      Package:dji.open.pilot.base.ui.model
      Description:

      Constraint layout view direction.

      Supported since MSDK 5.20.1

      Enum Members:
      UNKNOWNUnknown layout direction.
      STARTLayout start direction.
      ENDLayout end direction.
      TOPLayout top direction.
      BOTTOMLayout bottom direction.
      Class Members:
      enum ViewType
      enum ViewType 
      Package:dji.open.pilot.base.ui.model
      Description:

      View type enumeration (identifies the UI component type of a remote view).

      Supported since MSDK 5.20.1

      Enum Members:
      UNKNOWNUnknown view type (default value or unrecognized type).
      TEXT_VIEWText view (displays static text content).
      BUTTONButton control (supports click interaction operations).
      TOGGLE_BUTTONToggle button (a button with two states: on/off).
      SWITCHSwitch control (a component for visual state switching).
      WEB_VIEWWeb view (used to render web page content).
      EDIT_TEXTText edit box (supports user text input).
      CHECK_BOXCheck box (a checkbox that supports multiple selections).
      IMAGE_VIEWImage view (displays a bitmap or vector image).
      PROGRESS_BARProgress bar (shows the task progress status).
      LINEAR_LAYOUT_HORIZONTALHorizontal linear layout container (child views arranged horizontally).
      LINEAR_LAYOUT_VERTICALVertical linear layout container (child views arranged vertically).
      CONSTRAINT_LAYOUTConstraint layout container (supports complex constraint relationships).
      SPINNERSpinner control (a dropdown list that supports single selection).
      VERTICAL_LIST_VIEWVertical list view (a list control that supports vertical scrolling, with multiple built-in predefined item types).
      CIRCULAR_PROGRESS_BARCircular progress bar (shows determinate progress in an arc form, supporting the PROGRESS / PROGRESS_COLOR / TEXT / TEXT_COLOR properties).
      Class Members:
      enum VisibilityType
      enum VisibilityType 
      Package:dji.open.pilot.base.ui.model
      Description:

      View visibility enumeration, corresponding to Android View.VISIBLE / View.INVISIBLE / View.GONE.

      Supported since MSDK 5.20.1

      Enum Members:
      UNKNOWNUnknown (default value).
      VISIBLEVisible (the view is displayed normally and occupies layout space).
      INVISIBLEInvisible (the view is hidden but still occupies layout space).
      GONECompletely hidden (the view is hidden and does not occupy layout space).
      Class Members:
      class WidgetLayoutParam ↗
      class WidgetLayoutParam implements Parcelable
      描述

      Widget layout parameters (used for layout configuration of child views within a parent container).

      MSDK 5.20.1开始支持