Class Script

Represents a script model.

Inheritance
System.Object
Artifact
NamedArtifact
Script
Implements
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Relativity.Testing.Framework.Models
Assembly: Relativity.Testing.Framework.dll
Syntax
[ObjectTypeName("Relativity Script")]
public class Script : NamedArtifact, IHasName

Properties

| Improve this Doc View Source

Category

Gets or sets a string used to define the script type.

Declaration
public string Category { get; set; }
Property Value
Type Description
System.String
| Improve this Doc View Source

Description

Gets or sets the description of the script.

Declaration
public string Description { get; set; }
Property Value
Type Description
System.String
| Improve this Doc View Source

IsLinkedScript

Gets a value indicating whether the script is imported from the admin script library.

Declaration
public bool IsLinkedScript { get; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

Key

Gets the value used to lock a script within Relativity. A locked script cannot be modified.

Declaration
public string Key { get; }
Property Value
Type Description
System.String
| Improve this Doc View Source

RelativityApplications

Gets or sets a list of identifiers of associated Relativity Applications for the script.

Declaration
public List<Artifact> RelativityApplications { get; set; }
Property Value
Type Description
System.Collections.Generic.List<Artifact>
| Improve this Doc View Source

ReportGroupURL

Gets a custom page URL that can be used to create new tabs for displaying scripts of the same category.

Declaration
public string ReportGroupURL { get; }
Property Value
Type Description
System.String
| Improve this Doc View Source

ScriptBody

Gets or sets the body of the script that will be executed. It must include the name property.

Declaration
public string ScriptBody { get; set; }
Property Value
Type Description
System.String
| Improve this Doc View Source

Version

Gets the internal script version.

Declaration
public string Version { get; }
Property Value
Type Description
System.String

Implements