Class ValidationSuite

The validation suite allows you to validate a package while in development

Inheritance

object

ValidationSuite

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: UnityEditor.PackageManager.ValidationSuite

Assembly: Unity.PackageValidationSuite.Editor.dll

Syntax

[InitializeOnLoad]
public class ValidationSuite

Constructors

ValidationSuite()

Declaration

public ValidationSuite()

Methods

GetReport(string)

Get the validation suite report for the given package id.

Declaration

public static ValidationSuiteReportData GetReport(string packageId)

Parameters

Type	Name	Description
string	packageId	Package Id in the format of [package name]@[package version].

Returns

Type	Description
ValidationSuiteReportData	The validation suite report.

GetValidationSuiteReport(string)

Get the validation suite report for the given package id.

Declaration

public static string GetValidationSuiteReport(string packageId)

Parameters

Type	Name	Description
string	packageId	Package Id in the format of [package name]@[package version].

Returns

Type	Description
string	The validation suite report as a string.

GetValidationSuiteReport(string, string)

Get the validation suite report for the given package.

Declaration

public static string GetValidationSuiteReport(string packageName, string packageVersion)

Parameters

Type	Name	Description
string	packageName	Package name.
string	packageVersion	Package version.

Returns

Type	Description
string	The validation suite report as a string.

JsonReportExists(string)

Find out if the validation suite report exists for the given package id.

Declaration

public static bool JsonReportExists(string packageId)

Parameters

Type	Name	Description
string	packageId	Package Id in the format of [package name]@[package version].

Returns

Type	Description
bool	True if the validation suite report exists.

ReportExists(string)

Find out if the validation suite report exists for the given package id.

Declaration

public static bool ReportExists(string packageId)

Parameters

Type	Name	Description
string	packageId	Package Id in the format of [package name]@[package version].

Returns

Type	Description
bool	True if the validation suite report exists.

ValidatePackage(string, string, string[])

Declaration

public static bool ValidatePackage(string packageName, string packageVersion, string[] packageIdsForPromotion)

Parameters

Type	Name	Description
string	packageName
string	packageVersion
string[]	packageIdsForPromotion

Returns

Type	Description
bool

ValidatePackage(string, string, ValidationType)

Validate a package for the given validation context.

Declaration

public static bool ValidatePackage(string packageName, string packageVersion, ValidationType validationType)

Parameters

Type	Name	Description
string	packageName	The name of the package to validate.
string	packageVersion	The version of the package to validate.
ValidationType	validationType	The type of validation to assess.

Returns

Type	Description
bool	True if the validation successfully completed.

ValidatePackage(string, ValidationType)

Validate a package for the given validation context.

Declaration

public static bool ValidatePackage(string packageId, ValidationType validationType)

Parameters

Type	Name	Description
string	packageId	Package Id in the format of [package name]@[package version].
ValidationType	validationType	The type of validation to assess.

Returns

Type	Description
bool	True if the validation successfully completed.

ValidatePackage(VettingContext, out ValidationSuiteReport)

Declaration

public static bool ValidatePackage(VettingContext context, out ValidationSuiteReport report)

Parameters

Type	Name	Description
VettingContext	context
ValidationSuiteReport	report

Returns

Type	Description
bool

ValidatePackage(VettingContext, ValidationType, out ValidationSuiteReport)

Declaration

public static bool ValidatePackage(VettingContext context, ValidationType validationType, out ValidationSuiteReport report)

Parameters

Type	Name	Description
VettingContext	context
ValidationType	validationType
ValidationSuiteReport	report

Returns

Type	Description
bool