@vertigis/viewer-spec 61.14.0 → 61.14.1

package/messaging/registry/edit.d.ts

@@ -193,15 +193,32 @@ export interface DisplayAddFeatureArgs extends CreateFeatureArgs, HasMaps, EditO
 }
 /**
  * Arguments for the "edit.display-add-related-feature" command. A feature and a
- * relationship ID are supplied as inputs instead of a layer.
+ * relationship ID are supplied as inputs instead of a layer. Web only.
+ *
+ * @webOnly
  */
 export interface DisplayAddRelatedFeatureArgs extends Omit<DisplayAddFeatureArgs, "layers">, HasFeatures {
     /**
      * The ID of the relationship to add a feature to.
      */
     relationshipId: string;
+}
+/**
+ * Arguments for the "edit.display-add-related-feature" command. Mobile only.
+ *
+ * @mobileOnly
+ */
+export interface DisplayAddRelatedFeatureMobileArgs {
     /**
-     * The feature source for the related feature to create. Mobile only.
+     * The original feature to add a related feature to.
+     */
+    feature: Feature;
+    /**
+     * The ID of the relationship to add a feature to.
+     */
+    relationshipId: string;
+    /**
+     * The feature source the related feature belongs to.
      */
     relatedFeatureSource: FeatureSource;
 }
@@ -391,16 +408,16 @@ export declare class EditCommands extends CommandRegistry {
      * The specified feature will be the original feature that the new related
      * feature will be added to in the relationship.
      *
-     * **Example:** Create and edit a new record on a related table, with the
-     * option to add attachments. Make sure the 'COMMENTS' field is included in
-     * the editable attributes and make it required.
+     * **Example (Web):** Create and edit a new record on a related table, with
+     * the option to add attachments. Make sure the 'COMMENTS' field is included
+     * in the editable attributes and make it required.
      *
      * _Notes:_.
      *
      * 1. The feature used here must come from the running viewer, and cannot be an
      *    ad-hoc feature created from a JSON object. For example, you can use
-     *    the output of `results.get-active-features`, or the feature provided
-     *    in a command chain context.
+     *    the output of `results.get-active-features` (Web only), or the feature
+     *    provided in a command chain context.
      * 2. `editableExpression` and `requiredExpression` both take an Arcade
      *    expression, and here the string "true" is just a simple Arcade
      *    expression that always returns true. You can also use a more complex
@@ -420,8 +437,28 @@ export declare class EditCommands extends CommandRegistry {
      *     ]
      * }
      * ```
+     *
+     * **Example (Mobile):** Create and edit a new record on a feature.
+     *
+     * _Notes:_.
+     *
+     * 1. The feature used here must come from the running viewer, and cannot be an
+     *    ad-hoc feature created from a JSON object. For example, the feature
+     *    provided to a Workflow from a Feature Action context (as in this
+     *    example), or from a query.
+     * 2. The relatedFeatureSource in this example is a table passed in to the
+     *    Workflow as an input like so: `{ "tableSource":
+     *    "item://table-extension/your-table-extension-id" }`
+     *
+     * ```
+     * {
+     *     "feature": $getWorkflowInputs.inputs.context[0]
+     *     "relationshipId": "1",
+     *     "relatedFeatureSource": $getWorkflowInputs.inputs.tableSource
+     * }
+     * ```
      */
-    get displayAddRelatedFeature(): Command<DisplayAddRelatedFeatureArgs>;
+    get displayAddRelatedFeature(): Command<DisplayAddRelatedFeatureArgs | DisplayAddRelatedFeatureMobileArgs>;
     /**
      * Begin an interactive feature editing session with an existing feature.
      * `DisplayUpdateFeatureArgs` is not supported on Mobile.