docs.unity3d.com
    Show / Hide Table of Contents

    Class AutomatedQARuntimeSettings

    Inheritance
    Object
    AutomatedQARuntimeSettings
    Namespace: Unity.AutomatedQA
    Syntax
    public static class AutomatedQARuntimeSettings : object

    Fields

    DEVICE_TESTING_API_ENDPOINT

    Declaration
    public static readonly string DEVICE_TESTING_API_ENDPOINT
    Field Value
    Type Description
    String

    GAMESIM_API_ENDPOINT

    Declaration
    public static readonly string GAMESIM_API_ENDPOINT
    Field Value
    Type Description
    String

    Tooltips

    Declaration
    public static readonly Dictionary<string, string> Tooltips
    Field Value
    Type Description
    Dictionary<String, String>

    Properties

    ActivateClickFeedbackFx

    Activates ripple effect on point of click during playback of recordings.

    Declaration
    public static bool ActivateClickFeedbackFx { get; set; }
    Property Value
    Type Description
    Boolean

    ActivateDragFeedbackFx

    Activates drag effect between drag start and drag release during playback of recordings.

    Declaration
    public static bool ActivateDragFeedbackFx { get; set; }
    Property Value
    Type Description
    Boolean

    ActivateHighlightFeedbackFx

    Activates highlight effect on point of click during playback of recordings.

    Declaration
    public static bool ActivateHighlightFeedbackFx { get; set; }
    Property Value
    Type Description
    Boolean

    ActivatePlaybackVisualFx

    Enable or disable visual Fx feedback for actions taken during playback of recordings. If true, check individual feedback booleans to see if a subset will be activated.

    Declaration
    public static bool ActivatePlaybackVisualFx { get; set; }
    Property Value
    Type Description
    Boolean

    AutomatedQaSettingsFileName

    Declaration
    public static string AutomatedQaSettingsFileName { get; set; }
    Property Value
    Type Description
    String

    AutomatedQASettingsResourcesPath

    Name of the relative data path that our files are stored under.

    Declaration
    public static string AutomatedQASettingsResourcesPath { get; set; }
    Property Value
    Type Description
    String

    buildType

    Declaration
    public static BuildType buildType { get; }
    Property Value
    Type Description
    BuildType

    DynamicLoadSceneTimeout

    Period of time to wait for scene load while waiting to perform the next action in test playback.

    Declaration
    public static float DynamicLoadSceneTimeout { get; set; }
    Property Value
    Type Description
    Single

    DynamicWaitTimeout

    Period of time to wait for a target GameObject to be ready while waiting to perform the next action in test playback.

    Declaration
    public static float DynamicWaitTimeout { get; set; }
    Property Value
    Type Description
    Single

    EnableScreenshots

    Allows screenshots to be recorded during test run. These are used to show screenshots in reports.

    Declaration
    public static bool EnableScreenshots { get; set; }
    Property Value
    Type Description
    Boolean

    GeneratedTestsFolderName

    Name of folder where we tests generated from recordings.

    Declaration
    public static string GeneratedTestsFolderName { get; set; }
    Property Value
    Type Description
    String

    hostPlatform

    Declaration
    public static HostPlatform hostPlatform { get; }
    Property Value
    Type Description
    HostPlatform

    LogLevel

    Set the maximum level of log messages 0 = Logging disabled. 1 = Errors only. 2 = Errors and Warnings. 3 = Errors, Warnings, Info. 4 = Errors, Warnings, Info, Debug.

    Declaration
    public static AQALogger.LogLevel LogLevel { get; set; }
    Property Value
    Type Description
    AQALogger.LogLevel

    PackageAssetsFolderName

    Name of the Assets data path that our files are stored under.

    Declaration
    public static string PackageAssetsFolderName { get; set; }
    Property Value
    Type Description
    String

    PackageAssetsFolderPath

    Name of the Assets data path that our files are stored under.

    Declaration
    public static string PackageAssetsFolderPath { get; set; }
    Property Value
    Type Description
    String

    PersistentDataPath

    Folder on device where we store Automated QA temp and customization data.

    Declaration
    public static string PersistentDataPath { get; set; }
    Property Value
    Type Description
    String

    PostActionScreenshotDelay

    Declaration
    public static float PostActionScreenshotDelay { get; set; }
    Property Value
    Type Description
    Single

    RecordingDataPath

    Full path to folder where we store recording files.

    Declaration
    public static string RecordingDataPath { get; set; }
    Property Value
    Type Description
    String

    recordingFileStorage

    Declaration
    public static RecordingFileStorage recordingFileStorage { get; }
    Property Value
    Type Description
    RecordingFileStorage

    RecordingFolderName

    Name of folder under Assets where we store recording files.

    Declaration
    public static string RecordingFolderName { get; set; }
    Property Value
    Type Description
    String

    RecordingFolderNameWithAssetPath

    Name of folder under Assets, including Assets path, where we store recording files.

    Declaration
    public static string RecordingFolderNameWithAssetPath { get; }
    Property Value
    Type Description
    String

    UseDynamicWaits

    Wait for elements to become interactable before trying to interact with them (as opposed to waiting for the original recorded timeDelta period before executing an action).

    Declaration
    public static bool UseDynamicWaits { get; set; }
    Property Value
    Type Description
    Boolean

    Methods

    GetBooleanFromCustomSettings(String)

    Declaration
    public static bool GetBooleanFromCustomSettings(string key)
    Parameters
    Type Name Description
    String key
    Returns
    Type Description
    Boolean

    GetCustomSettingsData()

    Declaration
    public static AutomatedQARuntimeSettings.AutomatedQASettingsData GetCustomSettingsData()
    Returns
    Type Description
    AutomatedQARuntimeSettings.AutomatedQASettingsData

    GetFloatFromCustomSettings(String)

    Declaration
    public static float GetFloatFromCustomSettings(string key)
    Parameters
    Type Name Description
    String key
    Returns
    Type Description
    Single

    GetIntFromCustomSettings(String)

    Declaration
    public static int GetIntFromCustomSettings(string key)
    Parameters
    Type Name Description
    String key
    Returns
    Type Description
    Int32

    GetStringFromCustomSettings(String)

    Declaration
    public static string GetStringFromCustomSettings(string key)
    Parameters
    Type Name Description
    String key
    Returns
    Type Description
    String

    RefreshConfig()

    Resources are cached. Changes made to them in run time will not be seen until reload. Since edits to configs won't happen outside of editor, use Resources.Load outside of editor and File.ReadAllText in editor.

    Declaration
    public static void RefreshConfig()
    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