@datadog/datadog-api-client
Version:
OpenAPI client for Datadog APIs
91 lines (90 loc) • 3.06 kB
TypeScript
/**
* Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License.
* This product includes software developed at Datadog (https://www.datadoghq.com/).
* Copyright 2020-Present Datadog, Inc.
*/
import { SyntheticsCheckType } from "./SyntheticsCheckType";
import { SyntheticsMobileStepParamsDirection } from "./SyntheticsMobileStepParamsDirection";
import { SyntheticsMobileStepParamsElement } from "./SyntheticsMobileStepParamsElement";
import { SyntheticsMobileStepParamsPositionsItems } from "./SyntheticsMobileStepParamsPositionsItems";
import { SyntheticsMobileStepParamsValue } from "./SyntheticsMobileStepParamsValue";
import { SyntheticsMobileStepParamsVariable } from "./SyntheticsMobileStepParamsVariable";
import { AttributeTypeMap } from "../../datadog-api-client-common/util";
/**
* The parameters of a mobile step.
*/
export declare class SyntheticsMobileStepParams {
/**
* Type of assertion to apply in an API test.
*/
"check"?: SyntheticsCheckType;
/**
* Number of milliseconds to wait between inputs in a `typeText` step type.
*/
"delay"?: number;
/**
* The direction of the scroll for a `scrollToElement` step type.
*/
"direction"?: SyntheticsMobileStepParamsDirection;
/**
* Information about the element used for a step.
*/
"element"?: SyntheticsMobileStepParamsElement;
/**
* Boolean to change the state of the wifi for a `toggleWiFi` step type.
*/
"enabled"?: boolean;
/**
* Maximum number of scrolls to do for a `scrollToElement` step type.
*/
"maxScrolls"?: number;
/**
* List of positions for the `flick` step type. The maximum is 10 flicks per step
*/
"positions"?: Array<SyntheticsMobileStepParamsPositionsItems>;
/**
* Public ID of the test to be played as part of a `playSubTest` step type.
*/
"subtestPublicId"?: string;
/**
* Values used in the step for in multiple step types.
*/
"value"?: SyntheticsMobileStepParamsValue;
/**
* Variable object for `extractVariable` step type.
*/
"variable"?: SyntheticsMobileStepParamsVariable;
/**
* Boolean to indicate if `Enter` should be pressed at the end of the `typeText` step type.
*/
"withEnter"?: boolean;
/**
* Amount to scroll by on the `x` axis for a `scroll` step type.
*/
"x"?: number;
/**
* Amount to scroll by on the `y` axis for a `scroll` step type.
*/
"y"?: number;
/**
* A container for additional, undeclared properties.
* This is a holder for any undeclared properties as specified with
* the 'additionalProperties' keyword in the OAS document.
*/
"additionalProperties"?: {
[key: string]: any;
};
/**
* @ignore
*/
"_unparsed"?: boolean;
/**
* @ignore
*/
static readonly attributeTypeMap: AttributeTypeMap;
/**
* @ignore
*/
static getAttributeTypeMap(): AttributeTypeMap;
constructor();
}