docs.unity3d.com
    Show / Hide Table of Contents

    Class Driver

    Inheritance
    Object
    Driver
    Namespace: Unity.AutomatedQA
    Syntax
    public class Driver : MonoBehaviour

    Fields

    Steps

    Declaration
    public static List<RecordingInputModule.TouchData> Steps
    Field Value
    Type Description
    List<RecordingInputModule.TouchData>

    Properties

    Perform

    Declaration
    public static Driver Perform { get; }
    Property Value
    Type Description
    Driver

    Methods

    Action(RecordingInputModule.TouchData)

    Grabs the requested step's index, and waits until the step is executed.

    Declaration
    public IEnumerator Action(RecordingInputModule.TouchData action)
    Parameters
    Type Name Description
    RecordingInputModule.TouchData action
    Returns
    Type Description
    IEnumerator

    Click(GameObject, Single)

    Declaration
    public IEnumerator Click(GameObject go, float holdDurationBeforeReleasingClick = 0F)
    Parameters
    Type Name Description
    GameObject go
    Single holdDurationBeforeReleasingClick
    Returns
    Type Description
    IEnumerator

    Click(String, Single)

    Declaration
    public IEnumerator Click(string querySelector, float holdDurationBeforeReleasingClick = 0F)
    Parameters
    Type Name Description
    String querySelector
    Single holdDurationBeforeReleasingClick
    Returns
    Type Description
    IEnumerator

    Click(GameElement, Single)

    Declaration
    public IEnumerator Click(GameElement ge, float holdDurationBeforeReleasingClick = 0F)
    Parameters
    Type Name Description
    GameElement ge
    Single holdDurationBeforeReleasingClick
    Returns
    Type Description
    IEnumerator

    Drag(GameObject, GameObject, Single)

    Declaration
    public IEnumerator Drag(GameObject go, GameObject target, float duration = 1F)
    Parameters
    Type Name Description
    GameObject go
    GameObject target
    Single duration
    Returns
    Type Description
    IEnumerator

    Drag(GameObject, Vector2, Single)

    Declaration
    public IEnumerator Drag(GameObject go, Vector2 position, float duration = 1F)
    Parameters
    Type Name Description
    GameObject go
    Vector2 position
    Single duration
    Returns
    Type Description
    IEnumerator

    Drag(String, String, Single)

    Declaration
    public IEnumerator Drag(string querySelectorDragObject, string querySelectorTargetOfDrag, float duration = 1F)
    Parameters
    Type Name Description
    String querySelectorDragObject
    String querySelectorTargetOfDrag
    Single duration
    Returns
    Type Description
    IEnumerator

    Drag(String, Vector2, Single)

    Declaration
    public IEnumerator Drag(string querySelectorDragObject, Vector2 targetDropPosition, float duration = 1F)
    Parameters
    Type Name Description
    String querySelectorDragObject
    Vector2 targetDropPosition
    Single duration
    Returns
    Type Description
    IEnumerator

    Drag(GameElement, GameElement, Single)

    Declaration
    public IEnumerator Drag(GameElement ge, GameElement target, float duration = 1F)
    Parameters
    Type Name Description
    GameElement ge
    GameElement target
    Single duration
    Returns
    Type Description
    IEnumerator

    Drag(GameElement, Vector2, Single)

    Declaration
    public IEnumerator Drag(GameElement ge, Vector2 position, float duration = 1F)
    Parameters
    Type Name Description
    GameElement ge
    Vector2 position
    Single duration
    Returns
    Type Description
    IEnumerator

    EmitTestComplete()

    Declaration
    public IEnumerator EmitTestComplete()
    Returns
    Type Description
    IEnumerator

    GetError(String)

    Declaration
    protected string GetError(string stepInfo)
    Parameters
    Type Name Description
    String stepInfo
    Returns
    Type Description
    String

    PerformInterpolatedDragActions(Int32, Int32, Single)

    Declaration
    protected IEnumerator PerformInterpolatedDragActions(int startIndex, int interpolatedEventCount, float duration = 2F)
    Parameters
    Type Name Description
    Int32 startIndex
    Int32 interpolatedEventCount
    Single duration
    Returns
    Type Description
    IEnumerator

    RegisterStep(RecordingInputModule.TouchData)

    Only use this when registering an action BEFORE test execution has begun. If multiple steps are registered individually before any are executed, then each added data will be inserted before the previous one, yielding unintended order of execution. Use Driver.Perform.RegisterSteps during test execution to register multiple steps in a row.

    Declaration
    public void RegisterStep(RecordingInputModule.TouchData data)
    Parameters
    Type Name Description
    RecordingInputModule.TouchData data

    RegisterSteps(RecordingInputModule.TouchData[])

    This will determine the correct placement of touchdata added either before or while test execution is in progress.

    Declaration
    public void RegisterSteps(params RecordingInputModule.TouchData[] data)
    Parameters
    Type Name Description
    RecordingInputModule.TouchData[] data

    Reset()

    Declaration
    public static void Reset()

    SendKeys(GameObject, String, Single)

    Provide GameObject and type text into field.

    Declaration
    public IEnumerator SendKeys(GameObject go, string text, float duration = null)
    Parameters
    Type Name Description
    GameObject go
    String text
    Single duration
    Returns
    Type Description
    IEnumerator

    SendKeys(String, String, Single)

    Find GameElement using query selector and type text into field.

    Declaration
    public IEnumerator SendKeys(string querySelector, string text, float duration = null)
    Parameters
    Type Name Description
    String querySelector
    String text
    Single duration
    Returns
    Type Description
    IEnumerator

    SendKeys(GameElement, String, Single)

    Provide GameElement and type text into field.

    Declaration
    public IEnumerator SendKeys(GameElement ge, string text, float duration = null)
    Parameters
    Type Name Description
    GameElement ge
    String text
    Single duration
    Returns
    Type Description
    IEnumerator

    WaitFor(Func<Boolean>)

    Declaration
    protected IEnumerator WaitFor(Func<bool> condition)
    Parameters
    Type Name Description
    Func<Boolean> condition
    Returns
    Type Description
    IEnumerator
    Back to top
    Copyright © 2023 Unity Technologies — Terms of use
    • Legal
    • Privacy Policy
    • Cookies
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)
    "Unity", Unity logos, and other Unity trademarks are trademarks or registered trademarks of Unity Technologies or its affiliates in the U.S. and elsewhere (more info here). Other names or brands are trademarks of their respective owners.
    Generated by DocFX on 18 October 2023