<img height="1" width="1" style="display:none;" alt="" src="https://px.ads.linkedin.com/collect/?pid=6889170&amp;fmt=gif">
Skip to content
  • There are no suggestions because the search field is empty.

Compiled.EDD.Scripting Namespace

This namespace contains scripting components available for use in ReadySuite.

Classes

Class Description
pubClass ChatConversationItem Represents a chat conversation.
pubClass ChatEventAttachmentItem Represents a chat event attachment.
pubClass ChatEventEditItem Represents a chat event edit.
pubClass ChatEventItem Represents a chat event.
pubClass ChatEventReactionItem Represents a chat event reaction.
pubClass ChatEventReadReceiptItem Represents a chat event read receipt.
pubClass ChatItemBase Represents the base type for all chat items.
pubClass ChatParticipantItem Represents a chat participant.
pubClass ChatProjectItem Represents a chat project. This type allows for modification of chat data contained within the project.
pubClass ChatSourceItem Represents a chat source.
pubClass CustomReportRow Represents a custom item that can be reported on. Not intended to be created outside of a ScriptReport instance.
pubClass DocumentItem
 Represents an item in ReadySuite. Contains a collection of field data, PageItem's, TextItem's and NativeItem.
pubClass FieldContainer<T> FieldContainer is responsible for executing a scripted field assigned a FieldItem.
pubClass FieldContext Provides the context for performing available actions within a FieldContainer<T>.
pubClass FieldItem Represents a field that can hold data for a DocumentItem.
pubClass FieldItemAttribute Specifies the settings for a FieldItem when used with ScriptOptions. These settings can limit the field creation and fields available in the ScriptOptions.
pubClass FieldSetItem Represents a set or collection of FieldItem
pubClass FindAndReplaceItem Represents a single entry for a find/replace action.
pubClass FolderPathEditor UI editor for browsing or selecting a folder path. Use with a ScriptOptions instance to allow a user to assign a folder path to an option property.
pubClass NativeItem Represents a native file link path to a DocumentItem.
pubClass NotConversationParticipantException Represents an error that occurs when attempting to associate a participant with data for a conversation they are not a member of.
pubClass NotNullOrEmptyCollectionAttribute Validation attribute for not null or empty collections used with ScriptOptions.
pubClass NotSameEventException Represents an error that occurs when attempting to modify event reactions, attachments, edits, or read receipts through an event those items do not belong to.
pubClass PageItem Represents an individual page file link path in a DocumentItem.
pubClass ProjectItem Represents a project.
pubClass RequiredIfAttribute Provides conditional validation based on a related property value when used with ScriptOptions.
pubClass RequiresFeaturesAttribute Specifies that the decorated script requires specific features to function.
pubClass ResourceFileItem Represents a base resource/file pertaining to a DocumentItem.
pubClass SaveFileNameEditor UI editor for browsing or selecting a folder path. Use with a ScriptOptions instance to allow a user to assign a folder path to an option property.
pubClass ScriptAttribute Script attributes assigned to a script. This class cannot be inherited.
pubClass ScriptAuthor Represents author information for a script.
pubClass ScriptAuthorAttribute Assigns related author metadata to the script. This class cannot be inherited.
pubClass ScriptCategoryReport Represents a report intended to show categories of data when used in a ScriptContainer.
pubClass ScriptContainer ScriptContainer is responsible for hosting and running a script module.
pubClass ScriptContext Provides the context for performing available actions within a ScriptContainer.
pubClass ScriptError  
pubClass ScriptGuidAttribute Assigns a unique identifier to the script. This class cannot be inherited.
pubClass ScriptMessageEventArgs Contains information about a log message event during script execution.
pubClass ScriptOptions Represents a base class intended to be extended for setting available options in a ScriptContainer.
pubClass ScriptProgressEventArgs Contains information about progress on a Document action in a script.
pubClass ScriptReport Represents a base class intended to be extended for showing an execution report from a ScriptContainer.
pubClass ScriptTextReport Represents a report intended to show only text data when used in a ScriptContainer.
pubClass ScriptUtil Contains helpful utilities that can be used by scripts.
pubClass ScriptWarningEventArgs Contains information about a warning message event during script execution.
pubClass TextItem Represents an individual text file link path in a DocumentItem.

Interfaces

Interface Description
pubInterface IChoiceFieldItem Interface to manage the choices on a FieldItem.
pubInterface IContainer Interface to represent a container used to execute scripts.
pubInterface IFieldContainer<T> Interface to represent a script scoped to a single FieldItem.
pubInterface IFieldContainerBase Base interface to represent a script scoped to a single FieldItem.
pubInterface IFieldContext Defines the actions available to a script within a IFieldContainer<T>.
pubInterface IScriptContainer Interface to represent a script scoped to a DocumentItem set.
pubInterface IScriptContext Defines the actions available to a script within a IScriptContainer.

Enumerations

Enumeration Description
pubEnumeration ChatConversationItemType Defines the type of a chat conversation.
pubEnumeration ChatEventItemDirection Defines the direction of a chat event, i.e. whether an event is incoming or outgoing.
pubEnumeration ChatEventItemImportance Defines the importance of a chat event.
pubEnumeration ChatEventItemType Defines the types of chat events.
pubEnumeration ChatEventReadReceiptItemType Defines the type of a read receipt.
pubEnumeration ChoiceFieldItemType Specifies the type of choice field.
pubEnumeration ContainerType Specifies the container type of a script.
pubEnumeration FieldItemLevel Indicates the field level source in a DocumentItem.
pubEnumeration FieldItemScope Indicates the creation scope of a FieldItem.
pubEnumeration FieldItemType Indicates the data type of a FieldItem.
pubEnumeration FieldSetItemType Indicates the type of a FieldSetItem.
pubEnumeration ProgressAction Specifies actions performed on a document for progress events.
pubEnumeration ProjectItemType Indicates the type of a ProjectItem.
pubEnumeration ScriptFeatures Defines features scripts may require to function.
pubEnumeration ScriptProgressItem Specifies items that are reported on for progress related events.
pubEnumeration ScriptProgressMode Specifies if progress is updated automatically in the ScriptContainer or if the script author has manually implement progress updates.