Assembly: Contracts (in Contracts.dll)

Classes
Name Description
Public class AccessDeniedStatus Transfer Access and denied status
Public class ActiveCheckoutRule A class that helps define a CheckoutRule Item
Public class Address Details about an address
Public class AssignedContact An assigned contact
Public class AssignedEntity A class to details assigned entities
Public class AssignedGroup An assigned role
Public class AssignedRole An assigned role
Public class AssociatedCompanyEntity Information about an assoc task
Public class AssociatedContactEntity Information about an assoc contact
Public class AssociatedEntity Information about associated entities
Public class AssociatedFileEntity Information about an assoc file
Public class AssociatedFolderEntity Information about an assoc folder
Public class AssociatedProjectEntity Information about an assoc project
Public class AssociatedTDProjectEntity Information about an assoc td project
Public class AssociatedTaskEntity Information about an assoc task
Public class AttributeAddressValue
Public class AttributeAutoIncValue An auto increment value - only used as a place holder
Public class AttributeCompanyValue
Public class AttributeConstraint Information about an attribute constraint
Public class AttributeContactValue
Public class AttributeCoordinateValue A coordinate value
Public class AttributeEnumItem Information about an item in an enum
Public class AttributeEnumWorkflow
Public class AttributeEnumWorkflowState
Public class AttributeInfo Information about an attribute
Public class AttributeListScriptInput
Public class AttributeMatchValueCollection
Public class AttributeOperationInfo
Public class AttributeReferenceInfo
Public class AttributeUsageInfo
Public class AttributeValue Information about an attribute value
Public class AttributeValueCollection
Public class AttributeYesNoValue A yes no value
Public class AttributesScriptInput
Public class AutoConverter
Public class BaseParseableEmailTemplate
Public class BasicFileInfo Really simple file info
Public class CADLayoutInfo Information about a specific cad layout
Public class CADLayoutInfoExtensionData Extension data for attaching to files
Public class CADLayoutTemplateInfo Information about a cad layout template
Public class CADUpdateResult
Public class CategoryInfo Information about a category
Public class Static ChangeTrackerHelper
Public class CheckOutInfo Information about a historical or active checkout
Public class CheckoutEntity Details about a checked out entity
Public class ChunkData
Public class ChunkInfo
Public class ClientRegistrationInfo Info for registering with a server
Public class CompanyContactInfo
Public class CompanyGatherer
Public class CompanyInfo A container about company information
Public class CompanyReportParameters
Public class CompanyScriptInput Script input for picking a company
Public class ConcurrencyCount
Public class ConcurrencyCounts Information about concurrency
Public class ConnectedClient Information about a connected client
Public class ConnectionLogInfo A container about company information
Public class ConnectorAssemblyInfo
Public class ConnectorConfigInfo
Public class ConnectorConstantInfo Container for information about a connector constant
Public class ConnectorCustomField Container for information about custom field results
Public class ConnectorCustomFieldSettings
Public class ConnectorDefaultMapping Container for information about default mappings for a container
Public class ConnectorInfo
Public class ConnectorLog
Public class ConnectorManualModeSetting
Public class ConnectorManualModeSetup
Public class ConnectorMappingExclusion
Public class ConnectorMappingInfo
Public class ContactGatherer
Public class ContactInfo A container about contact information
Public class ContactList
Public class ContactListContact
Public class ContactQueryValue A query value that contains a contact
Public class ContactReportParameters
Public class ContactScriptInput An input for picking a contact, which could come from different sources
Public class ContactTable
Public class ContactsScriptInput An input for picking a contact, which could come from different sources
Public class Converter
Public class Coordinate A coordinate
Public class Counter
Public class CustomReport Base class for client reports
Public class CustomReportInput
Public class DashboardScriptInput
Public class DataCleanerSettings Our data cleaner settings object
Public class DataRetentionPolicy
Public class DataSet Place holder for future data sets
Public class DateRangeQueryValue A query value that contains a date range
Public class DomainValueCollection A collection of domain values
Public class EditFileServerResult
Public class EmailExceptionRule A class that helps define a EmailException Item
Public class EmailMessageID Email message id
Public class EmailMessageIDReference
Public class EmailSettings
Public class EmailStamp A data class for storing info about email stamps
Public class EmailStampSource A data class for telling us where a stamp should come from
Public class EmailTemplate Information about an email template
Public class EmailTemplateScriptInput Script input for picking an email template
Public class Static EmailTemplateVariables A helper class to get template variables
Public class EntityAttributeCache
Public class EntityAttributeInfo Information about an attribute
Public class EntityID An entity id
Public class EntityInfoLight Only necessary info about an entity
Public class EntityLogItem An entity log item
Public class EntityPathPart Helps give us information about where an entity is in a path
Public class EntityPermission Connection between a user/group/role, an entity and their permission
Public class EntityReportInput A report input that is an entity of some kind Only the following inputs will have editors: Contact User File Project Folder
Public class EntityScriptInput A script input that is an entity of some kind Only the following inputs will have editors: Contact User File Project Folder Task Type
Public class EntitySearchResult
Public class EntitySelectionInput
Public class EntityTypeServerReport Information about an individual server report
Public class EnumScriptInput A script input that acts as a pick list
Public class Static Extension Helper extension methods
Public class ExtraFileInfo An info class that stores some stats about files we don't always want with every file
Public class ExtraProjectInfo An info class that stores some stats about jobs we don't always want with every jobs
Public class FileChangeData A class to group information about a file change
Public class FileChangeDetails File change details
Public class FileChangeInfo File change information, used by serialization
Public class FileChangeTransferData
Public class FileConverterScriptInput
Public class FileDropNotification A notification for a file drop
Public class FileDropSetting
Public class FileGatherer
Public class FileHistory The history of a particular file
Public class FileInfo Information about a file
Public class FileInfoForFileChange The info required for file change operation
Public class FileIssuingDetails Issuing details about a specific file, for a specific version
Public class FileLauncher Definition for the file launcher
Public class FilePlaceHolder
Public class FilePreviewTransferData
Public class FileReferenceHistories The histories of the references of a set of files
Public class FileReportParameters Info about how to report on files
Public class FileRetrieval A class to hold information about how a file was retrieved
Public class FileSearchQuery
Public class FileServerInfo Info about a file server
Public class FileServerIntervalSyncRule Interval based sync rule
Public class FileServerLink Get basic details about a link to another file server
Public class FileServerQueue Information about file server queues
Public class FileServerQueueItem An item in the queue
Public class FileServerStatistic
Public class FileServerStatistics
Public class FileServerSyncRule Basic class for carrying info about frs sync rules
Public class FileServerTimeSyncRule Time sync rule
Public class FileStoreBindingCatchAllRule A catch all binding
Public class FileStoreBindingFileNameRule A binding rule that matches against file names
Public class FileStoreBindingFolderNameRule A binding rule that matches against file names
Public class FileStoreBindingRule Rule data structure
Public class FileStoreInfo Information about a file store
Public class FileStoreRuleSet A rule set for file storage
Public class FileStoreScriptInput
Public class FileStoreStats
Public class FileTable
Public class FileTransferData
Public class FileWithMissingReferences A file with unmanaged references
Public class FilesOverWebPasswordSettings Password settings for files over web
Public class FlatSearchAttribute A class storing info about a flat search attribute
Public class FolderColumn A folder column
Public class FolderHistory An item of folder history
Public class FolderItems
Public class FolderParameters Parameters controlling folder packaging
Public class FolderProfile
Public class FolderTransferData Information about a folder transfer
Public class ForumCategory Information about a category in a forum
Public class ForumInfo Information about a forum
Public class ForumPost Information about a post in a forum
Public class ForumSearchQuery A data contract for searching a forum
Public class ForumTopic Information about a topic in a forum
Public class FoundFolderResult
Public class GadgetData
Public class GadgetInfo
Public class GeocodedAddress Data contract to represent longitude and latitude data for an address
Public class GroupAccessInfo A class holding information about how a group has access to something
Public class GroupInfo Information about a group
Public class GroupQueryValue A query value that contains a group
Public class ImportModifier
Public class ImportModifiers Class to group up ways we might modify data we are importing
Public class InheritedEntity Used to show the inheritance hierarchy in entities
Public class IssueAction
Public class IssueByEmail Issue by email
Public class IssueByOutlook Issue by Outlook
Public class IssueByPublishing Issue by publishing
Public class IssueContact Info about who it was issued to and how (cc, to, etc)
Public class IssuePublishingInfo
Public class IssueStructure Defines the root of a structure for issuing
Public class IssuedFile Details about an issued file
Public class IssuedFileSet A set of documents that have been issued
Public class IssuedFileSetIssueDetails High level details about the issuing of a file set
Public class IssuedFileSetType A class storing info about an issued file set
Public class IssuedFileSetVersion All info about a file set version
Public class JobScriptInput Script input for picking a company
Public class LastUsedDataRetentionPolicy
Public class LicenseID License ID attribute
Public class LicenseInfo info about a license
Public class LicenseLogInfo Data to log a license change
Public class LicenseModuleInfo Info about a license module
Public class LicensePool Information about License pool
Public class LicensePoolLogInfo Data to log a License pool change
Public class ListContactGatherer A simple list gatherer
Public class ListFileGatherer
Public class ListScriptInput A script input that acts as a pick list
Public class LockInfo
Public class MailAttachment Helper class for mail attachments
Public class ManagedFolderChange A class to represent information about a change to a managed folder
Public class ManagedFolderChangeData Detailed history about a managed folder change
Public class ManagedFolderChangeDetails A class to represent information about a change to a managed folder
Public class MapLayer Configuration for a layer used in maps.
Public class MapSettingData Map setting data
Public class MessageData
Public class MinimumSizeDataRetentionPolicy
Public class MissingReferenceSuggestions Any possible missing reference suggestions
Public class NamingRule Carries information about a naming rule
Public class NamingRuleSet A set of naming rules
Public class NoteHeader A note header, which really only includes the data, subject and who it was from
Public class NoteInfo Information about a note
Public class NotificationSubscription Information about a notification subscription
Public class ObservationInfo
Public class OutlookTemplateSetting Information about an outlook template setting of an operation type
Public class PackageData Basic info about an import/export package
Public class PackageParameters Parameters controlling package packaging
Public class PagedResults<T>
Public class PathScriptInput
Public class Permission A permission
Public class PermissionSet A specific permission set
Public class PermissionsChange
Public class PredefinedChangeDescription A class that helps define a predefined change description
Public class PreviewItem
Public class PrimitiveQueryValue A query value that contains a primitive value of some sort - used for strings, ints etc
Public class PrimitiveReportInput A primitive report input - used for strings, ints etc All values are stored as a string and will be converted, so a type conversion must exist
Public class PrimitiveScriptInput A primitive script input - used for strings, ints etc All values are stored as a string and will be converted, so a type conversion must exist
Public class ProjectFolder An individual folder in a project
Public class ProjectInfo Information about a project
Public class ProjectItems
Public class ProjectNamingRule Represents information about a project naming rule Not all this info will be filled out, depending on the state of use
Public class ProjectNamingRuleComponent A component of a naming rule
Public class ProjectNoteInfo Information about a project note
Public class ProjectParameters Parameters controlling project packaging
Public class ProjectQueryValue A query value that contains a project
Public class ProjectReportParameters Info about how to report on 12d Synergy Projects
Public class ProjectRole Represents a project role
Public class ProjectTemplate
Public class PublishedFile Basic details about a published file only used for information gathering right now
Public class PublishedFileNotification A notification for a published file
Public class PublishedFileTrackingData Basic information about tracking
Public class QueryScriptInput
Public class QueryValue The base class for a query value (a value used in a query)
Public class QueryValueOperation Describes a query operation against a value
Public class QueuedEventData Information about a queued event
Public class ReferenceChangeData Data about a single referenced file that is used for the UpdatedReferencesEvent, (it does not contain the doc type as this is added during the document operation)
Public class ReferenceGraph Info about referencing
Public class ReferenceInfo
Public class ReferenceLink
Public class ReferencedFolderInfo
Public class ReferencingFileInfo
Public class RelatedFile A related file - carries information about a related file, and whether it's a reference (or therefore an association)
Public class Static Report Helper report class
Public class ReportApplicationData
Public class ReportInput
Public class ReportMetaData
Public class ReportParameters Info on how to report various entities
Public class ReportSchedule Data about a report schedule
Public class ReportScheduleDeliveryData Report recipient data for report delivery by email
Public class ReportScheduleReportData Input and Entity ID data required for the report schedule
Public class Static RoleAccess Helper class for role information
Public class RoleAccessInfo A class holding information about how a group has access to something
Public class RoleContact Role contact object
Public class RoleDefinition Represents a project role, which may or may not have permissions attached to it
Public class RoleQueryValue A query value that contains a role
Public class ScriptInput
Public class SearchAttributes
Public class SearchProfile Search Profile data
Public class SearchProfileCondition Condition to be satisfied to apply layout
Public class SearchQuery A class for carrying information for search queries
Public class SearchQueryContractResolver
Public class ServerGadgetLibrary Information about a server side scripted workflow library
Public class ServerID Stores info about the current server id
Public class ServerReport Information about an individual server report
Public class ServerReportLibrary Information about a server side scripted report library - this is not each individual report
Public class ServerScriptLibrary Information about a server side script library
Public class ServerTask Information about a server side scripted task
Public class ServerTaskLibrary Information about a server side scripted task library - this is not necessarily each individual task
Public class ServerTaskSchedule Information about a server side scripted task schedule
Public class ServerVersionInfo
Public class ServerWorkflowLibrary Information about a server side scripted workflow library
Public class SetLicenseResult The result of trying to set a license
Public class SimpleFolder Some really simple folder info
Public class SimpleReportFormat The format type of the report
Public class SortOrderAttribute
Public class SourcedAttributeInfo
Public class StartState
Public class StatisticInfo
Public class StoredSearchQuery Stores information about a file search query
Public class SyncToolSetup Info on whether or not the sync tool is setup
Public class TDElement An element in 12d model project
Public class TDProjectChangeData Detailed history about a managed folder change
Public class TDProjectFullHistory Helps to transfer td project full history data from server to client
Public class TDProjectHistory An item of td project history
Public class TDProjectInfo Information about a 12d model project
Public class TDProjectParameters Parameters controlling td project packaging
Public class TDProjectReportParameters Info about how to report on tasks
Public class TDProjectTemplate Contract to transfer data relkated to TD model project templates in/out
Public class TDProjectVersionDetails
Public class TDProjectVersionHelper
Public class TDSharedElementInfo Info about a shared element
Public class TaskAction Information about the action to take when a dependent task is clsoed
Public class TaskCC The base task CC class
Public class TaskContactCC A class for storing info about a contact to cc
Public class TaskGroupCC A class for storing info about a group to cc
Public class TaskHistory An item of to do item history
Public class TaskItem A to do item
Public class TaskItemPreview Task item preview that contains information for preview pane
Public class TaskItemReminder Information about a reminder for a task
Public class TaskRecurrence
Public class TaskReportParameters Info about how to report on tasks
Public class TaskRoleCC A class for storing info about a role to cc
Public class TaskSearchResultNode A node in our result tree
Public class TaskState States available for a task
Public class TaskType The task type
Public class TaskTypeItemReminder Information about a reminder created on new tasks of a given type
Public class TaskTypeWorkflow
Public class TaskTypeWorkflowState
Public class TaskUpdate Information about how to update the status and progress of a to do item
Public class TemporaryFileTransferData
Public class TimesheetDay
Public class TimesheetEntry
Public class TransferData Base transfer data class
Public class TransmittalCoverTemplate Class to handle data of the transmittal cover templates
Public class TriggerWorkflow
Public class TriggerWorkflowState
Public class UpdateReferencesData
Public class UploadFileRequest A request to upload a file
Public class UserAccessInfo A class holding information about how a user has access to something
Public class UserInfo A container about user information
Public class VersionedFileTransferData Information about a file transfer, used in bulk transfers
Public class WatchFolder Information about a watch folder
Public class WebFileDropContact
Public class WebFileDropInfo
Public class WebFileServerData Web file server data
Public class WebServerPageInfo
Public class WidgetInfo A container for a widget definition
Public class Workflow The workflow data structure
Public class WorkflowActivityInfo General info about an activity
Public class WorkflowAssigneeQueryValue A query value that contains a contact (with groups and roles). This is intended for server use only.
Public class WorkflowConditionInfo General info about an activity
Public class WorkflowCreateableAttribute
Public class WorkflowInstanceInfo Information about an assigned workflow
Public class WorkflowNonAttributeCaptureData
Public class WorkflowPropertyAttribute
Public class WorkflowPropertyItem Info about a workflow property item and its value
Public class Static WorkflowPropertySerialization Serialization helper class
Public class WorkflowQueryValue A query value that contains a workflow
Public class WorkflowScriptInput
Public class WorkflowSettableAttribute
Public class WorkflowState A workflow state
Public class WorkflowTransition A transition, which changes from one state to another
Public class WorkflowTransitionActivity
Public class WorkflowTransitionAssociationCapture
Public class WorkflowTransitionAttributeCapture Information about attributes users will be prompted for during a transition
Public class WorkflowTransitionCondition
Public class WorkflowTransitionDataCapture
Public class WorkflowTransitionLog Log information about a transition
Public class WorkflowTransitionPropertyCapture Information about user defined properties users will be prompted for during a transition
Top
Interfaces
Name Description
Public interface BaseEFEntity
Public interface IChangeTrackable
Public interface IExtensionData Helpful interface for extending data contract things in unique, often adhoc ways
Public interface IHasAttributes
Public interface IImportTarget
Public interface ILogger Handles some basic logging
Public interface IMaterialized
Public interface IPersistedQueueable
Public interface IPublishingNamer
Public interface ISynergyEntity
Public interface ITransferLogger
Public interface IWebHook Interface to implement a web hook
Public interface IWorkflowInstanceDetails
Public interface IWorkflowLogger
Top
Enumerations
Name Description
Public enumeration AggregateFunction
Public enumeration AllowableContactSources
Public enumeration AssignedEntityType The assigned entity type
Public enumeration AttributeMatchOperation
Public enumeration AttributeSearchContext
Public enumeration AttributeType The type of attribute
Public enumeration AttributeYesNo Why not bool? Because the editor sucks... so this is a bit ass backwards
Public enumeration AuthorizationMode
Public enumeration ChangeDescriptionType
Public enumeration CheckoutOwnerMachine
Public enumeration CheckoutType The type of checkout that the ActiveCheckoutRule effects
Public enumeration ComparisonFileType A type of file that can be compared
Public enumeration ComparisonToolType
Public enumeration CompressionLevel Available compression levels when using zipped transfer
Public enumeration ConnectionEventType
Public enumeration ConnectorConfigInfoType
Public enumeration ConnectorMappingEntityType The different types of entities a connector mapping can belong to
Public enumeration ConnectorRunType
Public enumeration ConverterType
Public enumeration DashBoardDefinitionType Type of the dashboard definition
Public enumeration DataSetType
Public enumeration DataTransferMode
Public enumeration DateRange
Public enumeration DocumentType An enum indicating what type of document this is
Public enumeration EmailStampSourceType The stamp source type
Public enumeration EmailTemplateCategory
Public enumeration EntityIDInputType
Public enumeration EntityType
Public enumeration EventStatus Event status enum
Public enumeration FileChangeType The type of file change
Public enumeration FilePreviewType A preview type
Public enumeration FileServerStatisticType
Public enumeration FileServerSyncRuleType
Public enumeration FileStoreBindingRuleType The type of rule
Public enumeration FileStoreType The list of available file stores
Public enumeration FileType The type of file
Public enumeration FlatSearchAttributeType The flat search attribute type
Public enumeration FolderChangeType FolderChangeType
Public enumeration FolderColumnType A type of folder column
Public enumeration FolderProfileMode A folder profile
Public enumeration FolderProfileResetMode An enum to define ways we can reset folder profiles
Public enumeration FolderSort
Public enumeration FolderState The staet of the folder - only really makes sense for managed folders
Public enumeration FolderType The type of folder
Public enumeration GeocodeProviderType Enum to represent geocode provider type
Public enumeration GroupByField
Public enumeration IssueActionType An action taken for an issue
Public enumeration IssueSendMode
Public enumeration LicenseModule License modules
Public enumeration LimitTableContent An enum of options to limit a search
Public enumeration LogLevel
Public enumeration MapLayerType
Public enumeration NamingRuleSetMode A naming set mode - not currently used
Public enumeration NoteMode
Public enumeration NoteTarget An enum indicating what type of item a note is attached to
Public enumeration OutlookTemplateType The type of operation that use outlook to send email
Public enumeration PermissionType Enum for permission type
Public enumeration PreviewState State details about previewing
Public enumeration PrimitiveReportInputType Options for the primitive report input type
Public enumeration PrimitiveScriptInputType Options for the primitive report input type
Public enumeration Product
Public enumeration ProjectNamingRuleComponentType The type of component
Public enumeration ProjectScope
Public enumeration ProjectType
Public enumeration PublishedFilePackageType
Public enumeration PublishedFileType The type of file being published
Public enumeration ReceiptOptions
Public enumeration ReferenceMode
Public enumeration RelatedFileType
Public enumeration RelationalOperatorType Relational operator type
Public enumeration RemindDeltaType
Public enumeration ReportDeliveryMode Report delivery mode
Public enumeration ReportScheduleFrequency Options for the primitive report input type
Public enumeration RoleAccessEntity
Public enumeration RoleAccessType An enum (used as a flag) indicating the type of access to an entity
Public enumeration SearchLimitOption An enum of options to limit a search
Public enumeration ServerTaskLogLevel
Public enumeration ServiceMode
Public enumeration SimpleReportType Actual reports
Public enumeration TDConnectionContext A context for how a 12d model project is being connected to
Public enumeration TDCustomisationMode
Public enumeration TDElementType Available types of 12d model elements we can work with
Public enumeration TDProjectChangeType An enum of change types for a td project
Public enumeration TDProjectMapFileMode
Public enumeration TDProjectType The 12d model project type
Public enumeration TDProjectVersion Valid 12d model versions
Public enumeration TargetEntity
Public enumeration TaskActionMode The type of action to take when a dependent task is completed
Public enumeration TaskActionOwnerType The owner of a task action
Public enumeration TaskActionType The type of action to take when a dependent task is completed
Public enumeration TaskCCType A possible cc target type
Public enumeration TaskClosureStatus Enum describing various closure types
Public enumeration TaskDateMode The date mode
Public enumeration TaskPriority The priority of a to do item
Public enumeration TaskRecurrencePattern
Public enumeration TaskReminderType
Public enumeration TransitionPropertyCaptureType
Public enumeration TriggerType
Public enumeration UserNotificationEventType All the various user workflow event types
Public enumeration ValueField
Public enumeration WatchFolderDuplicateMode Mode for when a watch folder finds a duplicate
Public enumeration WebFileDropCreateMode
Public enumeration WidgetType
Public enumeration WorkflowActivityTarget The type of target an activity can be used for
Public enumeration WorkflowDataCaptureType An enum for the different types of data capture
Public enumeration WorkflowPropertyType
Public enumeration WorkflowType
Top
Applies to

.NET Framework

Supported in: 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1