Menu

12d Synergy API Reference

Client Scripting

Getting Started

Server Events and Waits

Sample Script

SynergyClientAPI Namespace

ConnectionParameters Class

Methods

Fields

frs_address Field

server_address Field

user_name Field

Methods

Connect(ConnectionParameters) Method

Connect(string) Method

GetEntityIDAndTypeFromPath Method

Initialise Method

RegisterLogger Method

ShowDescriptionForm Method

SynergyClientAPI.Address Namespace

Methods

ValidateAddress Method

SynergyClientAPI.Attributes Namespace

Attribute Class

Methods

CreateAttribute Method

GetAttachedFileAttributes Method

GetAttribute Method

GetAttributes Method

GetAttributes() Method

GetAttributes(string) Method

GetRequiredFileChangeAttributes Method

GetSystemProjectAttributes Method

OpenAttributeEditor Method

SynergyClientAPI.CADLayouts Namespace

CADLayout Class

Methods

GetLayouts Method

GetLayouts(EntityID, bool) Method

GetLayouts(EntityID, int, bool) Method

ImportAndSelectLayouts Method

ImportLayouts Method

SynergyClientAPI.Common Namespace

UpdateEntityPermissionParameters Class

Properties

delete_permission Property

set_permission Property

Methods

Fields

target_entity_id Field

SynergyClientAPI.Companies Namespace

Methods

AddRemoveCompanyStaff Method

CreateCompany Method

GetAllCompanies Method

GetCompanyID Method

GetCompanyInfo Method

GetCompanyStaff Method

UpdateCompany Method

SynergyClientAPI.ContactsUsersAndGroups Namespace

AddUserFromContactParameters Class

Methods

Fields

contact_id Field

create_personal_job Field

initial_groups Field

is_job_creator Field

is_system_admin Field

send_email Field

AddUserParameters Class

Methods

Fields

attributes Field

create_personal_job Field

first_name Field

initial_groups Field

is_job_creator Field

is_system_admin Field

last_name Field

send_email Field

Methods

AddContact Method

GetAllContacts Method

GetContactID Method

GetContactInfo Method

Methods

AddGroup Method

DeleteGroup Method

GetAllGroups Method

User Class

Methods

CreateUserForExisting Method

EditUserGroups Method

GetAllUsers Method

GetUserGroups Method

SynergyClientAPI.Files Namespace

CopyFileData Class

Methods

Fields

change_data Field

CopyFileParameters Class

Methods

Fields

data_to_copy Field

destination_folder_id Field

File Class

Methods

AddFiles Method

AddFilesToFolder Method

BrowseForFile Method

CheckInFile Method

CheckInFiles Method

CheckOutFile Method

CheckOutFiles Method

CopyFiles Method

CreateNewFile Method

DeleteFile Method

DeleteFile(EntityID, FileChangeData, IASyncWait) Method

DeleteFile(EntityID, EntityID, FileChangeData, IASyncWait) Method

ExportFiles Method

GetFileHistory Method

GetFileIdByName Method

GetInfo(EntityID) Method

GetInfo(EntityID, int) Method

GetLatest Method

GetLatest(EntityID, IASyncWait) Method

GetLatest(HashSet<EntityID>, IASyncWait) Method

GetLocalPathToFile Method

GetVersion Method

LinkFile Method

MoveFiles Method

OfflineFiles Method

OnlineFiles Method

PurgeFile Method

SaveFileVersion Method

MoveFileData Class

Methods

Fields

change_data Field

MoveFileParameters Class

Methods

Fields

data_to_copy Field

destination_folder_id Field

NewFileParameters Class

Methods

Fields

change_data Field

folder_id Field

original_file Field

FileAction Enumeration

SynergyClientAPI.Files.Issues Namespace

CreateNewFileSetParameters Class

Methods

Fields

project_id Field

set_description Field

IssuedFileRegistry Class

Methods

CreateNewFileSet Method

GetIssuedFileSetIssueDetails Method

GetIssuedFileSetTypes Method

GetIssuedFileSetTypes() Method

GetIssuedFileSetTypes(EntityID) Method

GetIssuedFileSets Method

ModifyFileSet Method

SynergyClientAPI.Files.Publishing Namespace

Methods

DeletePublishedFile Method

GetPublishedFileInfo Method

GetPublishedFileTrackingData Method

PublishFile Method

PublishPackage Method

PublishFileParameters Class

Methods

Fields

description Field

display_name Field

expiry_date_utc Field

include_password_in_email Field

optional_email_note Field

send_email Field

show_langing_page Field

track_contacts_individually Field

PublishPackageParameters Class

Methods

Fields

description Field

display_name Field

expiry_date_utc Field

include_password_in_email Field

optional_email_note Field

send_email Field

show_langing_page Field

track_contacts_individually Field

SynergyClientAPI.Folders Namespace

CheckInFolderParameters Class

Methods

Fields

description Field

folder_id Field

keep_check_out Field

CreateFolderParameters Class

Methods

Fields

inherits_file_attributes Field

inherits_naming_rules Field

inherits_permissions Field

is_managed Field

parent_folder_id Field

project_id Field

DeletePermissionInfo Class

Methods

Fields

entity_permission_id Field

entity_type Field

Methods

BrowseForFolder Method

CancelFolderCheckOut Method

CheckInFolder Method

CheckOutFolder Method

CopyFolder Method

CreateFolder Method

ExportFolder Method

FindFolderByName Method

GetAllFileInfo Method

GetAllGroupAccess Method

GetAllRoleAccess Method

GetAllUserAccess Method

GetBasicFileInfo Method

GetFolderInfo Method

GetFolderPath Method

GetHistory Method

GetLocalPathToFolder Method

GetSubItems Method

MoveFolder Method

OfflineFolder Method

OnlineFolder Method

PurgeFolder Method

RenameFolder Method

UpdateFolderAttributes Method

UpdateFolderRules Method

UpdateGroupLevelPermission Method

UpdateRoleLevelPermission Method

UpdateUserLevelPermission Method

UpdateFolderRulesParameters Class

Methods

Fields

changed_group_access Field

changed_role_access Field

changed_user_access Field

deleted_group_access Field

deleted_naming_sets Field

deleted_role_access Field

deleted_user_access Field

extensions Field

file_attribs_to_delete Field

file_attribs_to_set Field

file_change_attribs_to_delete Field

file_change_attribs_to_set Field

folder_id Field

inherit_file_attributes Field

inherit_permissions Field

is_managed Field

modified_naming_sets Field

UpdatePermissionParameters Class

Methods

Fields

added_or_changed Field

SynergyClientAPI.Maps Namespace

Map Class

Methods

PolyFromMap Method

PolyFromMap(Address, IWin32Window) Method

PolyFromMap(Coordinate, IWin32Window) Method

PolyFromMap(IWin32Window) Method

SynergyClientAPI.Projects Namespace

CreateProjectParameters Class

Methods

Fields

always_display_parent Field

attributes Field

cover_image_file Field

description Field

inherit_file_naming_rules Field

inherit_permissions Field

parent_project Field

EditProjectParameters Class

Methods

Methods

CreateProject Method

GetProjectInfo Method

GetProjectInfo(EntityID) Method

GetProjectInfo(string, EntityID) Method

GetSubItems Method

MoveProject Method

PromptForProject Method

PurgeProject Method

SearchForProject Method

SetAttributes Method

UpdateCategories Method

UpdateFileAttributes Method

UpdateFileChangeAttributes Method

UpdateGroupLevelPermission Method

UpdateNamingRules Method

UpdateRoleLevelPermission Method

UpdateUserLevelPermission Method

UpdateProjectRolePermissionParameters Class

Properties

delete_permission Property

set_permission Property

Methods

Fields

project_entity_id Field

SynergyClientAPI.TDProjects Namespace

CheckInTDProjectParameters Class

Methods

Fields

description Field

keep_check_out Field

td_project_id Field

CreateTDProjectParameters Class

Methods

Fields

folder_id Field

project_id Field

project_name Field

td_model_version Field

TDProject Class

Methods

CancelCheckOut Method

CheckInTDProject Method

CheckOutTDProject Method

CheckOutTDProject(EntityID, ChangedFilesActionHandler, out bool, IASyncWait) Method

CheckOutTDProject(EntityID, out bool, IASyncWait) Method

CreateTDProject Method

ExportTDProject Method

GetElements Method

GetLocalTDProjectPath Method

GetTDProjectInfo Method

LocalRollback Method

OfflineTDProject Method

OnlineFolder Method

UpdateAttributes Method

UpdateGroupLevelPermission Method

UpdateRoleLevelPermission Method

UpdateSharing Method

UpdateUserLevelPermission Method

UpdateTDProjectAttributeParameters Class

Properties

delete_attributes Property

set_attributes Property

Methods

Fields

td_project_id Field

UpdateTDProjectShareElementParameters Class

Methods

Fields

model_share_elements Field

model_unshare_elements Field

td_project_id Field

tin_share_elements Field

tin_unshare_elements Field

SynergyClientAPI.Tasks Namespace

Task Class

Methods

CreateTask Method

DeleteTasks Method

GetNextStates Method

GetTaskListForJob Method

GetTaskTypes Method

UpdateTask Method

SynergyClientAPI.Utilities Namespace

Methods

RunDBTune Method

ToggleMaintenanceMode Method

ReindexParameters Class

Methods

Fields

index_companies Field

index_contacts Field

index_files Field

index_jobs_and_folders Field

index_tasks Field

SynergyClientAPI.Waits Namespace

SimpleWait Class

SimpleWait Constructor

SimpleWait() Constructor

SimpleWait(OperationCallback) Constructor

Methods

GetCallback Method

SetServerEventID Method

UIWait Constructor

UIWait(IWin32Window) Constructor

UIWait(IWin32Window, OperationCallback) Constructor

Methods

GetCallback Method

SetServerEventID Method

Server Scripting

Getting Started

Dashboard Gadgets

Sample Gadget - Upcoming Tasks

Event Scripts

Sample Event - Email Reviewer

Sample Event - Push Data

Task Scripts

Sample Task - Create Job from XML

Reports

Sample Report - Job Search

Workflow Scripting

Sample Activity - Write Job Info to JSON

Web Hooks

SynergyServerScripting Namespace

ReportVisibilityAttribute Class

ReportVisibilityAttribute Constructor

Properties

Visible Property

Methods

ServerEventScript Class

ServerEventScript Constructor

Methods

OnAfterCreateToDoItem Method

OnAfterEditTaskItem Method

OnAfterFileAdd Method

OnAfterFileCheckIn Method

OnAfterFileCheckedout Method

OnAfterFileCopy Method

OnAfterFileDelete Method

OnAfterFileMove Method

OnAfterFilePurge Method

OnAfterFolderAdded Method

OnAfterFolderAttributeChange Method

OnAfterFolderCheckedIn Method

OnAfterFolderCheckedOut Method

OnAfterFolderDeleted Method

OnAfterManagedFolderDeleted Method

OnAfterProjectAttributeChange Method

OnAfterProjectCreated Method

OnAfterProjectEdited Method

OnAfterTDProjectAttributeChange Method

OnAfterTDProjectCheckedIn Method

OnAfterTDProjectCheckedOut Method

OnAfterTDProjectCreated Method

OnBeforeCreateToDoItem Method

OnBeforeEditTaskItem Method

OnBeforeFileAdd Method

OnBeforeFileCheckIn Method

OnBeforeFileCheckedout Method

OnBeforeFileCopy Method

OnBeforeFileDelete Method

OnBeforeFileMove Method

OnBeforeFilePurge Method

OnBeforeFolderAdded Method

OnBeforeFolderAttributeChange Method

OnBeforeFolderCheckedIn Method

OnBeforeFolderCheckedOut Method

OnBeforeFolderDeleted Method

OnBeforeManagedFolderDeleted Method

OnBeforeProjectAttributeChange Method

OnBeforeProjectCreated Method

OnBeforeProjectEdited Method

OnBeforeTDProjectAttributeChange Method

OnBeforeTDProjectCheckedIn Method

OnBeforeTDProjectCheckedOut Method

OnBeforeTDProjectCreated Method

Task Class

Task Constructor

Properties

IsRunning Property

Methods

Create(DateTime) Method

Create(DateTime, TimeSpan, DateTime) Method

GetConfigurableInputs Method

GetDescription Method

GetEntitiesToLock Method

GetLastRunTime Method

GetRepeatTime Method

GetStartTime Method

PerformTask Method

ShouldRun Method

IBaseReport Interface

Methods

CanUserAccess Method

GetDescription Method

GetExtensions Method

GetInputs Method

IEntityReport Interface

Properties

EntityType Property

Methods

CanUserAccess Method

CanUserAccess(EntityID, IDatabase) Method

CanUserAccess(EntityID, EntityID, IDatabase) Method

GenerateReport Method

GetDescription Method

GetExtensions Method

GetInputs Method

IInstallable Interface

Methods

ILicenseable Interface

Methods

IReport Interface

Methods

CanUserAccess Method

GenerateReport Method

GetDescription Method

GetExtensions Method

GetInputs Method

IReportCategoriser Interface

Properties

Category Property

IReportInputValidate Interface

Methods

Validate Method

IWebDropEventScript Interface

Methods

OnAfterFileDrop Method

SynergyServerScripting.Entities Namespace

ActiveDirectory Class

Methods

GetADUsers Method

GetADUsersInAGroup Method

GetUserGroups Method

Association Class

Methods

GetAssociatedEntities Method

GetAssociatedEntities(EntityID, EntityType, EntityType, IDatabase) Method

GetAssociatedEntities(EntityID, EntityType, IDatabase) Method

GetAssociatedEntitiesAndPerformChecks Method

GetAssociatedEntityIDs Method

GetAssociatedEntityIDs(EntityID, EntityType, EntityType, IDatabase) Method

GetAssociatedEntityIDs(EntityID, EntityType, IDatabase) Method

GetEntitiesWithAssociatedEntities Method

SetEntityAssociations Method

SetEntityAssociations(EntityID, EntityType, List<AssociatedEntity>, EntityID, IDatabase) Method

SetEntityAssociations(EntityID, EntityType, List<Tuple<EntityIDEntityTypeString>>, EntityID, IDatabase) Method

Attribute Class

Methods

AddAttributeEnumItem Method

AttachAttributeToProjectFile Method

CreateAttribute Method

CreateAttribute(ServerID, AttributeInfo, bool, IDatabase) Method

CreateAttribute(ServerID, string, AttributeType, string, bool, IDatabase) Method

CreateAttribute(ServerID, string, string, AttributeType, string, bool, IDatabase) Method

FindAttributeByName Method

FindAttributeByName(string, IDatabase) Method

FindAttributeByName(string, bool, IDatabase) Method

GetAllAttributesForEntity Method

GetAttributeEnumItems Method

GetAttributeIDForEnum Method

GetAttributeInfo Method

GetAttributeValue Method

GetAttributeValues Method

GetAttributesForFileChange Method

GetBasicAttributeInfoForEntities Method

GetEnumIDForValue Method

GetFileAttributesForFileChange Method

IsMatchAttribute Method

RemoveAttributeValue Method

RemoveAttributeValues Method

SetEnumItems Method

SetSystemAttribute Method

UpdateAttributeDetails Method

UpdateAttributeEnumItem Method

UpdateAttributeEnumItem(EntityID, string, int, IDatabase) Method

UpdateAttributeEnumItem(EntityID, string, int, string, IDatabase) Method

UpdateAttributeEnumItem(EntityID, string, int, string, Nullable<Int64>, IDatabase) Method

UpdateAttributeValue Method

CADLayout Class

Methods

CopyFileChangeLayouts Method

CreateLayout Method

DeleteLayout Method

GetCADLayouts Method

GetCADLayouts(EntityID, bool, IDatabase) Method

GetCADLayouts(EntityID, int, bool, IDatabase) Method

PurgeFileLayouts Method

SetFileChangeLayouts Method

SetLayoutAttributes Method

Methods

CreateCategory Method

GetAllGroupAccess Method

GetAllRoleAccess Method

GetAllUserAccess Method

GetCategoryID Method

GetParentCategoryID Method

GetUserAccess Method

GetUserAccess(EntityID, EntityID, IDatabase) Method

GetUserAccess(EntityID, EntityID, List<EntityID>, IDatabase) Method

UpdateCategory Method

Methods

Create(CompanyInfo, EntityID, IDatabase) Method

Create(IEnumerable<CompanyInfo>, EntityID, IDatabase) Method

CreateOrUpdate Method

CreateOrUpdate(CompanyInfo, EntityID, IDatabase) Method

CreateOrUpdate(IEnumerable<CompanyInfo>, EntityID, IDatabase) Method

Delete(CompanyInfo, IDatabase) Method

Delete(List<CompanyInfo>, IDatabase) Method

DeleteByCompanyAndContact Method

Get Method

Get(EntityID, IDatabase) Method

Get(IDatabase) Method

GetAllCompanies Method

GetAllCompanies(IDatabase) Method

GetAllCompanies(CompanyGatherer, IDatabase) Method

GetAllCompaniesWhere Method

GetAllUniqueCompanyAttributes Method

GetCompaniesByAttributeValues Method

GetCompanyInfo Method

GetLogoImage Method

GetStaffByCompany Method

IndexCompany Method

IndexCompany(CompanyInfo, bool, IDatabase) Method

IndexCompany(EntityID, IDatabase) Method

IndexCompany(EntityID, bool, IDatabase) Method

ReIndexCompanies Method

SearchCompanies Method

SetLogoImage Method

SetStaffContacts Method

UpdateManagedDocuments Method

Connector Class

Methods

Get Method

Get(EntityID, IDatabase) Method

Get(IDatabase) Method

GetConfiguredConnectors Method

GetConfiguredConnectorsBasic Method

GetConnectorAssemblies Method

Save(ConnectorInfo, IDatabase) Method

Save(IList<ConnectorInfo>, IDatabase) Method

UpdateConnectorConfig Method

Methods

CreateContact Method

DeleteSystemContactAttribute Method

FindAttributesByName Method

GetAllContactAttributes Method

GetAllContactInfo Method

GetAllUniqueContactAttributes Method

GetContactID Method

GetContactImage Method

GetContactImageLastModifiedTime Method

GetContactInfo Method

GetContactInfo(EntityID, bool, IDatabase) Method

GetContactInfo(EntityID, bool, bool, IDatabase) Method

GetContactInfos Method

GetContactInfos(IList<EntityID>, IDatabase) Method

GetContactInfos(IList<EntityID>, bool, IDatabase) Method

GetContactInfosByEmail Method

GetSystemContactAttributes Method

IndexContact Method

IndexContact(ContactInfo, bool, IDatabase) Method

IndexContact(EntityID, bool, IDatabase) Method

RemoveContactAttribute Method

SetContactAttribute Method

SetContactImage Method

UpdateContact Method

Converter Class

Methods

ConvertHTMLToPDF Method

Databases Class

Methods

Create() Method

Create(bool) Method

CreateManual Method

DocumentManagement Class

Methods

GetDocumentManager Method

GetDocumentManager(string, bool, out string) Method

GetDocumentManager(string, string, bool, out string) Method

GetReferencedFileInfoList Method

GetReferencedFileInfoListByDate Method

GetReferencedFiles Method

IsManageableDocumentFile Method

Methods

AddEmailTemplate Method

AddNewStamp Method

DeleteEmailTemplate Method

DeleteStamp Method

GetEmailTemplate Method

GetEmailTemplate(string, IDatabase, bool) Method

GetEmailTemplate(int, IDatabase) Method

GetEmailTemplates Method

GetStamps Method

UpdateEmailTemplate Method

UpdateStamp Method

Methods

SendEmail Method

SendEmail(ContactInfo, EmailTemplate, List<ContactInfo>, List<ContactInfo>, bool) Method

SendEmail(ContactInfo, EmailTemplate, List<ContactInfo>, List<ContactInfo>, bool, IDatabase) Method

SendEmail(EmailTemplate, List<ContactInfo>, List<ContactInfo>, bool) Method

SendEmail(EmailTemplate, List<ContactInfo>, List<ContactInfo>, bool, IDatabase) Method

EntityLog Class

Methods

GetEntityLogForContact Method

GetEntityLogForEntity Method

File Class

Methods

AttachCustomFileAttribute Method

CheckInFile Method

CheckInFileList Method

CheckoutFile Method

DeleteSystemFileAttribute Method

FindAttributesByName Method

FlattenAttributes Method

GetActiveCheckout Method

GetActiveCheckoutInfoForFileList Method

GetActiveUserCheckouts Method

GetActiveUserCheckouts(EntityID, EntityID, IDatabase) Method

GetActiveUserCheckouts(EntityID, IDatabase) Method

GetAllGroupAccess Method

GetAllRoleAccess Method

GetAllUserAccess Method

GetAttachedFileAttributes Method

GetBasicFileInfoList Method

GetBasicFileInfoListWithLinkedFiles Method

GetCurrentVersionNumber Method

GetCustomFileAttributes Method

GetFileFolder Method

GetFileHistory Method

GetFileID Method

GetFileIDs Method

GetFileInfo Method

GetFileInfo(EntityID, bool, IDatabase) Method

GetFileInfo(EntityID, int, bool, IDatabase) Method

GetFileInfo(EntityID, int, bool, bool, IDatabase) Method

GetFileName Method

GetFileNamesForListOfFiles Method

GetFileProject Method

GetGroupAccess Method

GetLinkedFileSource Method

GetLinkedFileSourcePath Method

GetProjectIdsForFiles Method

GetStandardFlatSearchAttributes Method

GetStandardSearchAttributes Method

GetSystemFileAttribute Method

GetSystemFileAttributeExtensions Method

GetSystemFileAttributesAndExtensions Method

GetUpdatedFiles Method

GetUserAccess Method

GetUserAccess(EntityID, EntityID, IDatabase) Method

GetUserAccess(EntityID, EntityID, bool, IDatabase) Method

GetUserCheckouts Method

GetUserFolderCheckouts Method

GetUserProjectCheckouts Method

HasBeenLinkedTo Method

HasFileBeenIssued Method

IsLinkedFile Method

MarkAsModified Method

MarkMultipleFilesAsModified Method

PerformAddFile Method

PerformAddFile(string, EntityID, EntityID, string, FileChangeData, DateTime, IDatabase) Method

PerformAddFile(string, EntityID, EntityID, string, FileChangeData, DateTime, bool, IDatabase) Method

PurgeFile Method

PurgeFiles Method

RegenPreview Method

ReindexFile Method

ReindexFile(EntityID, IDatabase) Method

ReindexFile(EntityID, int, bool, IDatabase) Method

ReplicateFile Method

SearchAndGatherFiles Method

SetGroupAccess Method

SetStandardFlatSearchAttributes Method

SetStandardSearchAttributes Method

SetSystemFileAttribute Method

SetUserAccess Method

FileChange Class

Methods

AddChange Method

AddFileAttributesForFileChange Method

AddFileAttributesForFileChange(ServerID, EntityID, AttributeValueCollection, IDatabase) Method

AddFileAttributesForFileChange(ServerID, EntityID, EntityID, string, EntityID, Dictionary<EntityIDAttributeInfo>, IDatabase) Method

FindAttributesByName Method

GetFileChangeID Method

GetFileChangeInfo Method

GetFileChangeStatus Method

GetFileChangeVersion Method

GetFileChanges Method

GetFileChangesForListOfFiles Method

GetFileID Method

GetFolderFileChanges Method

GetLastFolderFileChanges Method

GetManagedFolderFileChangeID Method

GetPreview Method

GetPreviewType Method

RegeneratePreview Method

SetFileChangeAttribute Method

FileNamingRules Class

Methods

SuggestName Method

SuggestName(string, string, EntityID, EntityID, bool, List<EntityID>, IDatabase) Method

SuggestName(string, string, EntityID, EntityID, EntityID, bool, IDatabase) Method

FileServer Class

Methods

GetFileServerStatistics Method

GetFileServers Method

FileStore Class

Methods

GetFileStoreID Method

GetFileStoreInfo Method

GetLatestFileChange Method

GetLatestStoredFileChange Method

GetLatestStoredFileChange(EntityID, int, IDatabase) Method

GetLatestStoredFileChange(FileInfo, IDatabase) Method

RegenFilePreview Method

RegenFilePreview(EntityID, IDatabase) Method

RegenFilePreview(EntityID, int, IDatabase) Method

RetrieveFileFromStore Method

RetrieveFilePreviewFromStore Method

RetrieveTempFileFromStore Method

RetrieveTempFilePreviewFromStore Method

StoreFileInStore Method

Methods

AddChangeAttribute Method

AddChangeAttribute(EntityID, EntityID, bool, IDatabase) Method

AddChangeAttribute(EntityID, EntityID, bool, Nullable<Int64>, IDatabase) Method

AttachAttributeToFolder Method

CancelCheckOut Method

CheckInFolder Method

CheckoutFolder Method

ClearUserFolderLayouts Method

ContainsFile Method

CreateFolder Method

CreateFolder(EntityID, string, EntityID, EntityID, bool, bool, FolderType, EntityID, IDatabase) Method

CreateFolder(string, EntityID, EntityID, bool, bool, FolderType, EntityID, IDatabase) Method

CreateManagedFolderChange Method

DoesFolderHaveIssuedFiles Method

ExportFolder Method

FindAttributesByName Method

FlattenAttributes Method

GetActiveCheckout Method

GetActiveUserCheckouts Method

GetActiveUserCheckouts(EntityID, EntityID, IDatabase) Method

GetActiveUserCheckouts(EntityID, IDatabase) Method

GetActiveUserCheckoutsClosingRules Method

GetAllGroupAccess Method

GetAllRoleAccess Method

GetAllUserAccess Method

GetAllowableFileExtensions Method

GetChangeDetails Method

GetChangedFolderFiles Method

GetCurrentManagedFolderVersion Method

GetEntityPath Method

GetFileChangesForManagedFolder Method

GetFileCount Method

GetFolder Method

GetFolderAttributeValue Method

GetFolderAttributes Method

GetFolderChangeID Method

GetFolderFileAttributeExtensions Method

GetFolderFileAttributes Method

GetFolderFileAttributes(EntityID, bool, IDatabase) Method

GetFolderFileAttributes(EntityID, string, bool, IDatabase) Method

GetFolderFileAttributesAndExtensions Method

GetFolderFileAttributesWithInheritance Method

GetFolderFileChangeAttributes Method

GetFolderFileIDs Method

GetFolderFileNames Method

GetFolderFiles Method

GetFolderFiles(EntityID, EntityID, bool, IDatabase) Method

GetFolderFiles(EntityID, bool, IDatabase) Method

GetFolderID Method

GetFolderIDFromChangeID Method

GetFolderIDFromPath Method

GetFolderIDFromPath(string, EntityID, IDatabase) Method

GetFolderIDFromPath(string, IDatabase) Method

GetFolderIDFromURIPath Method

GetFolderName Method

GetFolderPath Method

GetFolderPath(EntityID, IDatabase) Method

GetFolderPath(EntityID, bool, IDatabase) Method

GetFolderType Method

GetFolders Method

GetFolders(HashSet<EntityID>, IDatabase) Method

GetFolders(HashSet<EntityID>, bool, IDatabase) Method

GetGroupAccess Method

GetGroupAccessOld Method

GetLatestVersion Method

GetParentFolderID Method

GetPopularAttributes Method

GetProjectID Method

GetProjectIDForRootFolder Method

GetProjectRootFolder Method

GetProjectRootFolderIDs Method

GetProjectRootFolders Method

GetSubFolder Method

GetSubFolderIDs Method

GetSubFolders Method

GetSubFolders(EntityID, bool, bool, IDatabase) Method

GetSubFolders(EntityID, bool, bool, int, IDatabase) Method

GetTDProjectID Method

GetUserAccess Method

GetUserAccess(EntityID, EntityID, IDatabase) Method

GetUserAccess(EntityID, EntityID, List<EntityID>, List<EntityID>, IDatabase) Method

GetVisibleTDProjects Method

HasFileExtensionsSet Method

Index(EntityID, bool, IDatabase) Method

Index(EntityID, bool, bool, IDatabase) Method

Index(ProjectFolder, bool, IDatabase) Method

Index(ProjectFolder, bool, bool, IDatabase) Method

InheritsFromParent Method

IsFileExtensionAllowed Method

MoveFolder Method

PurgeFolder Method

RegenAllFilePreviews Method

RemoveFolderAttribute Method

RemoveFolderFileAttribute Method

RemoveFolderFileChangeAttribute Method

ReplicateFolder Method

SetAllowableFolderFileExtensions Method

SetFolderAttribute Method

SetFolderAttributeValues Method

SetFolderFileAttribute Method

SetFolderFileChangeAttribute Method

SetFolderName Method

SetFolderType Method

SetGroupAccess Method

SetInheritsFileAttributes Method

SetInheritsFileNamingRules Method

SetInheritsPermissions Method

SetRoleAccess Method

SetUserAccess Method

Methods

AttachForumToProject Method

CreateCategory Method

CreateForum Method

CreatePost Method

CreatePost(ServerID, EntityID, string, EntityID, IDatabase) Method

CreatePost(ServerID, EntityID, string, EntityID, IDatabase, DateTime) Method

CreateTopic Method

CreateTopic(ServerID, EntityID, string, EntityID, IDatabase) Method

CreateTopic(ServerID, EntityID, string, EntityID, IDatabase, DateTime) Method

DeleteCategory Method

DeleteForum Method

DeleteTopic Method

FillLastPostInfo Method

GetCategories Method

GetCategory Method

GetCategoryForum Method

GetCategoryIDs Method

GetChangedForumCategories Method

GetChangedForumPosts Method

GetChangedForumTopics Method

GetChangedForums Method

GetForum Method

GetForumProject Method

GetForumTopicIDFromPost Method

GetPosts Method

GetProjectForums Method

GetTopicCategory Method

GetTopicIDs Method

GetTopics Method

GetUserAccess Method

GetUserAccess(EntityType, EntityID, EntityID, IDatabase) Method

GetUserAccess(EntityType, EntityID, EntityID, List<EntityID>, List<EntityID>, IDatabase) Method

IsUserWatchingCategory Method

IsUserWatchingForum Method

IsUserWatchingTopic Method

ReplicateCategory Method

ReplicateForum Method

ReplicateTopic Method

SearchForums Method

StopWatchingCategory Method

StopWatchingForum Method

StopWatchingTopic Method

UpdateForum Method

WatchCategory Method

WatchForum Method

WatchTopic Method

GIS Class

Methods

GetAddressAttributeGeoCode Method

GetGeoCode Method

GetGeoCode(string, IDatabase) Method

GetGeoCode(string, IDatabase, out bool) Method

InsertGeocode Method

Methods

AddGroup Method

AddGroupMembership Method

ClearGroupMembership Method

DeleteGroup Method

DeleteGroupMembership Method

DoSimpleSearch Method

GetAllGroups Method

GetAllGroups(IDatabase) Method

GetAllGroups(string, IDatabase) Method

GetGroup Method

GetGroupIDByName Method

GetGroupMembers Method

GetGroupMembers(List<EntityID>, IDatabase) Method

GetGroupMembers(EntityID, IDatabase) Method

GetGroups Method

GetGroupsByName Method

GetUserGroupMembership Method

GetUserGroupMembershipForUsers Method

GetUserGroupMembershipIDs Method

UpdateGroup Method

IssuedFileRegistry Class

Methods

GetIssuedFileReportData Method

LicenseHistory Class

Methods

GetLicenseLogsWithinDateRange Method

GetLicenseStatusAtAGivenDateTime Method

LogLicenseHistory Method

LicensePool Class

Methods

AssignGroupsToLicensePool Method

CreateLicensePool Method

DeactivateLicensePool Method

EditLicensePool Method

GetAllActiveLicensePools Method

GetAllGroupsBelongToLicensePool Method

GetAllLicensePools Method

GetLicensePool Method

GetLicensePoolsByUserGroups Method

GetTotalMaxLimitsForLicenseClass Method

IsNameAlreadyTaken Method

LicensePoolHistory Class

Methods

GetLicensePoolLogsWithinDateRangeForLicensePool Method

GetLicensePoolStatusAtAGivenDateTime Method

GetLicensePoolStatusesAtAGivenDateTime Method

LogGenericPoolHistory Method

LogLicensePoolHistory Method

Note Class

Methods

GetNoteHeader Method

GetNoteHeaders Method

GetNoteMessage Method

Methods

AddProjectToCategory Method

AssignUserAccess Method

AttachAttributeToProject Method

AttachAttributeToProject(EntityID, EntityID, bool, bool, IDatabase) Method

AttachAttributeToProject(EntityID, EntityID, bool, bool, int, long, IDatabase) Method

AttachAttributeToProject(EntityID, EntityID, bool, bool, int, long, bool, IDatabase) Method

CanUserAccess Method

CreateProject Method

DoesProjectHaveIssuedFiles Method

ExportProjectFileStructure Method

FindAttributesByName Method

FindProjectByAttribute Method

FindProjectByAttribute(EntityID, EntityID, object, IDatabase) Method

FindProjectByAttribute(EntityID, object, IDatabase) Method

GetAllGroupAccess Method

GetAllRoleAccess Method

GetAllUserAccess Method

GetChangedFolderIDs Method

GetChangedProjectAttributes Method

GetChangedProjects Method

GetDefaultDashboardHeader Method

GetEntityPath Method

GetGroupAccess Method

GetLocationFromURIPath Method

GetParentProjectID Method

GetPathToProject Method

GetProjectAttributeValue Method

GetProjectAttributeValue(EntityID, EntityID, IDatabase) Method

GetProjectAttributeValue(EntityID, string, IDatabase) Method

GetProjectCategories Method

GetProjectCoverImage Method

GetProjectDashboardHeader Method

GetProjectDashboardHeader(EntityID, bool, IDatabase) Method

GetProjectDashboardHeader(EntityID, bool, bool, IDatabase) Method

GetProjectDisplayAttributes Method

GetProjectFileAttributeExtensions Method

GetProjectFileAttributes Method

GetProjectFileAttributesAndExtensions Method

GetProjectFileChangeAttributes Method

GetProjectID Method

GetProjectIDFromPath Method

GetProjectInfo Method

GetProjectName Method

GetProjectOwnerID Method

GetProjects Method

GetSourceProjectID Method

GetStandardSearchAttributes Method

GetSubProjectIDs Method

GetSystemProjectAttributes Method

GetTDProjectID Method

GetTemplateIDForProject Method

GetUserAccess Method

GetUserAccess(EntityID, EntityID, IDatabase) Method

GetUserAccess(EntityID, EntityID, List<EntityID>, List<EntityID>, IDatabase) Method

GetVisibleProjects Method

GetVisibleProjects(EntityID, EntityID, IDatabase) Method

GetVisibleProjects(EntityID, EntityID, bool, IDatabase) Method

GetVisibleTDProjects Method

HasProjectAttribute Method

HasProjectChanged Method

Index(EntityID, bool, bool, bool, bool, IDatabase) Method

Index(EntityID, bool, bool, bool, bool, bool, IDatabase) Method

Index(EntityID, bool, bool, bool, IDatabase) Method

Index(ProjectInfo, bool, bool, bool, bool, bool, IDatabase) Method

InheritsFromParent Method

MatchTemplate Method

ProcessDashboardHTML Method

PurgeProject Method

RegenAllFilePreviews Method

RemoveProjectFromCategory Method

RemoveSystemProjectAttribute Method

RenameProject Method

ReplicateProject Method

ReplicateProject(EntityID, EntityID, EntityID, IDatabase, IClient) Method

ReplicateProject(string, string, long, EntityID, EntityID, EntityID, IDatabase, IClient) Method

SearchProjects Method

SetProjectAttribute Method

SetProjectAttributeValue Method

SetProjectDashboardHeader Method

SetProjectDisplayAttributes Method

SetProjectRootFolder Method

SetStandardSearchAttributes Method

SetSystemProjectAttribute Method

SubmitProject Method

UpdateProjectInfo Method

UpdateProjectInfo(EntityID, string, string, bool, IDatabase) Method

UpdateProjectInfo(EntityID, string, string, bool, bool, bool, IDatabase) Method

Methods

GetScriptedReport Method

Methods

GetCompanyLogo Method

GetServerID Method

GetSetting Method

GetSimpleReportFormats Method

GetSimpleReportXSLT Method

IndexFile Method

IndexFile(FileInfo, EntityID, int, string, string, bool, IDatabase, bool) Method

IndexFile(FileInfo, EntityID, EntityID, int, EntityID, DateTime, string, string, bool, IDatabase, bool) Method

IndexForumPost Method

LogMessage Method

QueueEventFromScript Method

ResolveServerID Method

TDProject Class

Methods

CreateSnapshot Method

CreateTDProject Method

CreateTDProject(EntityID, EntityID, string, TDProjectType, bool, EntityID, EntityID, EntityID, TDProjectVersion, TDCustomisationMode, IDatabase) Method

CreateTDProject(string, TDProjectType, bool, EntityID, bool, EntityID, TDProjectVersion, TDCustomisationMode, IDatabase) Method

CreateTDProject(string, TDProjectType, bool, EntityID, bool, EntityID, TDProjectVersion, IDatabase) Method

CreateTDProject(string, TDProjectType, bool, EntityID, EntityID, EntityID, TDProjectVersion, TDCustomisationMode, IDatabase) Method

CreateTDProject(string, TDProjectType, bool, EntityID, EntityID, EntityID, TDProjectVersion, IDatabase) Method

CreateTDProjectChange Method

DeleteSystemTDProjectAttribute Method

GetActiveUserCheckouts Method

GetActiveUserCheckouts(EntityID, EntityID, IDatabase) Method

GetActiveUserCheckouts(EntityID, IDatabase) Method

GetActiveUserCheckoutsClosingRules Method

GetAllRoleAccess Method

GetAllUserAccess Method

GetAttributeByName Method

GetChangeLog Method

GetChangedTDProjects Method

GetElementType Method

GetFileIDForShare Method

GetShareIDFromFileID Method

GetSystemTDProjectAttributes Method

GetTDProjectAttributes Method

GetTDProjectChangeDetails Method

GetTDProjectFileInfo Method

GetTDProjectFileInfo(EntityID, bool, string, bool, IDatabase) Method

GetTDProjectFileInfo(TDProjectInfo, bool, string, bool, IDatabase) Method

GetTDProjectForShare Method

GetTDProjectForShare(EntityID, EntityID, IDatabase) Method

GetTDProjectForShare(EntityID, EntityID, IDatabase, out EntityID) Method

GetTDProjectFromPath Method

GetTDProjectID Method

GetTDProjectIDForFolder Method

GetTDProjectInfo Method

GetTDProjectPreviewImage Method

GrantGroupAccessToSharedElement Method

GrantUserAccessToSharedElement Method

HasAttribute Method

PerformServerShareMigration Method

PurgeTDProject Method

RemoveTDProjectAttribute Method

ResetProjectID Method

RevokeGroupAccessToSharedElement Method

RevokeUserAccessToSharedElement Method

SetSystemTDProjectAttribute Method

SetTDProjectAttributeValues Method

ShareElement Method

UnshareElement Method

Task Class

Methods

ChangeAssignedRoles Method

LogTaskMessage Method

SetScriptInput Method

Methods

AddChange Method

AssignTask Method

CreateState Method

CreateTaskType Method

DeleteState Method

GetAssignedEntityID Method

GetChangedTaskIDs Method

GetChildTasks Method

GetChildTasks(EntityID, bool, IDatabase) Method

GetChildTasks(EntityID, bool, Dictionary<EntityIDTaskItem>, IDatabase) Method

GetDependencyIDs Method

GetDependingTaskIDs Method

GetInitialStateIDs Method

GetInitialStates Method

GetNextTaskStateIDs Method

GetNextTaskStates Method

GetProjectTaskIDs Method

GetProjectTasks Method

GetTaskByName Method

GetTaskIDsByAssignedRole Method

GetTaskIDsByAssociatedFileID Method

GetTaskReminders Method

GetTaskReminders(EntityID, EntityID, IDatabase) Method

GetTaskReminders(EntityID, EntityID, IDatabase, bool) Method

GetTaskState Method

GetTaskStateAttributes Method

GetTaskStateByName Method

GetTaskStateIDs Method

GetTaskStates Method

GetTaskStatesByEntityIDs Method

GetTaskType Method

GetTaskTypeID Method

GetTaskTypes Method

GetTaskVersion Method

GetTasksByAssociatedFileID Method

GetTemplateTaskByName Method

HasDependingItems Method

IsStateInUse Method

PurgeTask Method

ReplicateTask Method

ReplicateTask(EntityID, EntityID, EntityID, EntityID, IDatabase) Method

ReplicateTask(EntityID, EntityID, string, EntityID, EntityID, IDatabase) Method

SearchTasks Method

SendCreatedEmail Method

SendUpdatedEmail Method

SetTaskDependencies Method

SetTaskReminder Method

SubmitTask Method

UpdateState Method

UpdateTaskProgress Method

Team Class

Methods

GetRoleContactIDs Method

GetRoleContactIDs(EntityID, EntityID, IDatabase) Method

GetRoleContactIDs(EntityID, List<EntityID>, IDatabase) Method

GetRoleDefinition Method

GetRoleIDByName Method

PurgeRole Method

RemoveProjectRole Method

SaveRole Method

SetProjectRole Method

User Class

Methods

CreateUser Method

CreateUser(EntityID, string, IDatabase) Method

CreateUser(string, string, string, string, IDatabase) Method

DeleteSystemUserAttribute Method

DoUsersRequireCustomPasswords Method

FindAttributesByName Method

Get10LastChangedItems Method

Get10MostPopularJobs Method

GetAllSystemAdminUserIDs Method

GetAllUserAttributes Method

GetAllUserContacts Method

GetAllUserIDs Method

GetBasicUserInfoForUserList Method

GetFileServerIDsForUser Method

GetGroupMembership Method

GetNumberOfFileChangesAndLastChangeTimeByUser Method

GetNumberOfLoginsAndLastLoginTimeInGivenDateRange Method

GetNumberOfTDProjectChangesAndLastChangeTimeByUser Method

GetNumberOfTaskChangesAndLastChangeTimeByUser Method

GetNumberOfUsers Method

GetSystemUserAttributes Method

GetUserAttributeValue Method

GetUserID Method

GetUserInfo Method

GetUserModules Method

IsJobCreator Method

IsSystemAdmin Method

RemoveUserAttribute Method

SetJobCreator Method

SetSystemAdmin Method

SetSystemUserAttribute Method

SetUserAttribute Method

SetUserPassword Method

UpdateUser Method

UserNotification Class

Methods

GetNotifications Method

GetUsersToNotifyForEvent Method

SetUserNotification Method

WebFileServer Class

Methods

CreateWebFileDrop Method

CreateWebFileDropToken Method

DeactivatePublishedFile Method

DeactivatePublishedFilesList Method

GetFolderWebDrops Method

GetWebFileDropInfo Method

GetWebServerSettings Method

PublishFile Method

PublishPackage Method

PublishPackage(string, Dictionary<EntityIDInt32>, string, DateTime, bool, EntityID, string, bool, Nullable<Int64>, IPublishingNamer, IDatabase, IClient) Method

PublishPackage(string, Dictionary<EntityIDInt32>, string, DateTime, bool, EntityID, string, bool, Nullable<Int64>, IPublishingNamer, IDatabase, IClient, List<String>) Method

RegisterWebHook Method

RemovePublishedFile Method

RemovePublishedFile(EntityID, IDatabase) Method

RemovePublishedFile(EntityID, int, IDatabase) Method

RemovePublishedFilesList Method

SendWebFileDropInvitation Method

SetWebDropAttributes Method

Methods

GetEntityFromPath Method

GetFilesFromInput Method

GetTaskFromInput Method

GetValidTransitionsForWorkflow Method

GetWorkflowInstanceInfo Method

GetWorkflowInstanceInfo(EntityID, EntityID, EntityType, IDatabase) Method

GetWorkflowInstanceInfo(EntityID, IDatabase) Method

GetWorkflowTransitionNames Method

ProcessAttributeInput Method

ProcessInputForVariables Method

ResolveContacts Method

SynergyServerScripting.Gadgets Namespace

Gadget Constructor

Properties

AllowUserSizing Property

Category Property

DefaultHeight Property

DefaultWidth Property

Description Property

IsGlobal Property

ShowHeader Property

UseMaxHeight Property

Methods

Generate Method

GetScriptInputs Method

SynergyServerScripting.Reports Namespace

DataTable Class

DataTable Constructor

Properties

BorderPen Property

DataColour Property

DataTextFont Property

LabelColour Property

LabelTextFont Property

TableRatio Property

TitleBackgroundColour Property

TitleFont Property

TitleForegroundColour Property

Visible Property

Methods

EntityXSLTReport Class

EntityXSLTReport Constructor

Properties

EntityType Property

Parameters Property

ReportType Property

Methods

BuildParameters Method

CanUserAccess Method

CanUserAccess(EntityID, EntityID, IDatabase) Method

CanUserAccess(EntityID, IDatabase) Method

DoGenerateReport Method

GenerateReport Method

GetDescription Method

GetExtensions Method

GetInputs Method

LogException Method

LogException(Exception) Method

LogException(string, Exception) Method

LogMessage Method

GlobalXSLTReport Class

GlobalXSLTReport Constructor

Properties

Parameters Property

ReportType Property

Methods

BuildParameters Method

CanUserAccess Method

DoGenerateReport Method

GenerateReport Method

GetDescription Method

GetExtensions Method

GetInputs Method

LogException Method

LogException(Exception) Method

LogException(string, Exception) Method

LogMessage Method

Graph Constructor

Properties

DataTable Property

MeasureBitmap Property

ShowLegend Property

UnderlyingGraph Property

Methods

AddPieSegment Method

SaveToBitmap Method

SetXAxisLabels Method

SetYAxisLabels Method

ReportHelpers Class

Methods

GetEndOfReport Method

GetNoWidthReportGadgetStart Method

GetReportEndBanner Method

GetReportGadgetEnd Method

GetReportGadgetStart Method

GetReportStartBanner Method

GetReportStyles Method

GetStartOfReport Method

XSLTHelperFunctions Class

XSLTHelperFunctions Constructor

Properties

AssemblyPath Property

Methods

FormatFileSize Method

Get12dModelProjectPreview Method

Get12dSynergyBanner Method

GetCSSPath Method

GetCompanyLogo Method

GetImage Method

GetNoWidthReportGadgetStart Method

GetPreviewImage Method

GetPreviewImage(string) Method

GetPreviewImage(string, IDatabase) Method

GetProjectCoverImage Method

GetReportFooter Method

GetReportGadgetEnd Method

GetReportGadgetStart Method

GetReportHeader Method

GetReportStyles Method

ReadLocalFile Method

SynergyServerScripting.Workflows Namespace

ActivityInstance Class

ActivityInstance Constructor

Properties

Methods

GetGeneralInfo Method

GetInputs Method

ConditionInstance Class

ConditionInstance Constructor

Properties

Methods

Check(IWorkflowInstanceDetails, Dictionary<StringScriptInput>, EntityID, IDatabase, out bool, out string) Method

Check(IWorkflowInstanceDetails, Dictionary<StringScriptInput>, EntityID, bool, IDatabase, out bool, out string) Method

GetGeneralInfo Method

GetInputs Method

Common Contracts

Contracts.Data Namespace

AccessDeniedStatus Class

Properties

Access Property

Denied Property

Methods

ActiveCheckoutRule Class

ActiveCheckoutRule Constructor

ActiveCheckoutRule() Constructor

ActiveCheckoutRule(CheckoutType, string, string, bool) Constructor

Properties

active Property

checkout_type Property

description Property

id_serverid Property

values Property

Methods

ToString Method

Properties

IsEmpty Property

Methods

FromTabString Method

ToKeyValueString Method

ToString Method

ToTabString Method

is_equal Method

Fields

geocoded_latitude Field

geocoded_longitude Field

search_distance Field

search_is_metric Field

search_wkt Field

AssignedContact Class

AssignedContact Constructor

Properties

DisplayName Property

Methods

Fields

AssignedEntity Class

Properties

DisplayName Property

Methods

AssignedGroup Class

AssignedGroup Constructor

Properties

DisplayName Property

Methods

Fields

AssignedRole Class

AssignedRole Constructor

Properties

DisplayName Property

Methods

Fields

AssociatedCompanyEntity Class

Properties

AssociatedEntityID Property

AssociatedEntityType Property

Methods

Fields

assoc_entity Field

association_date_utc Field

created_by Field

description Field

has_access Field

AssociatedContactEntity Class

Properties

AssociatedEntityID Property

AssociatedEntityType Property

Methods

Fields

assoc_entity Field

association_date_utc Field

created_by Field

description Field

has_access Field

AssociatedEntity Class

Properties

AssociatedEntityID Property

AssociatedEntityType Property

Methods

Fields

association_date_utc Field

created_by Field

description Field

has_access Field

AssociatedFileEntity Class

Properties

AssociatedEntityID Property

AssociatedEntityType Property

Methods

Fields

assoc_entity Field

association_date_utc Field

created_by Field

description Field

has_access Field

AssociatedFolderEntity Class

Properties

AssociatedEntityID Property

AssociatedEntityType Property

Methods

Fields

assoc_entity Field

association_date_utc Field

created_by Field

description Field

has_access Field

AssociatedProjectEntity Class

Properties

AssociatedEntityID Property

AssociatedEntityType Property

Methods

Fields

assoc_entity Field

association_date_utc Field

created_by Field

description Field

has_access Field

AssociatedTDProjectEntity Class

Properties

AssociatedEntityID Property

AssociatedEntityType Property

Methods

Fields

assoc_entity Field

association_date_utc Field

created_by Field

description Field

has_access Field

AssociatedTaskEntity Class

Properties

AssociatedEntityID Property

AssociatedEntityType Property

Methods

Fields

assoc_entity Field

association_date_utc Field

created_by Field

description Field

has_access Field

AttributeAddressValue Class

AttributeAddressValue Constructor

Properties

Address Property

Methods

ToChangeTrackerString Method

ToString Method

is_equal Method

Fields

AttributeAutoIncValue Class

AttributeAutoIncValue Constructor

Properties

Methods

ToChangeTrackerString Method

ToString Method

is_equal Method

Fields

AttributeCompanyValue Class

AttributeCompanyValue Constructor

Properties

Company Property

Methods

ToChangeTrackerString Method

ToString Method

is_equal Method

Fields

AttributeConstraint Class

Methods

Fields

constraint Field

AttributeContactValue Class

AttributeContactValue Constructor

Properties

Contact Property

Methods

ToChangeTrackerString Method

ToString Method

is_equal Method

Fields

AttributeCoordinateValue Class

AttributeCoordinateValue Constructor

Properties

Coordinate Property

Methods

ToChangeTrackerString Method

ToString Method

is_equal Method

Fields

AttributeEnumItem Class

Properties

display_name Property

enum_id Property

id_serverid Property

Methods

ToString Method

Fields

visibility_constraint Field

AttributeEnumWorkflow Class

AttributeEnumWorkflow Constructor

Properties

active Property

attribute_id Property

created_by Property

created_date Property

id_serverid Property

position_data Property

state_transitions Property

workflow_description Property

workflow_name Property

workflow_states Property

workflow_type Property

Methods

ToString Method

AttributeEnumWorkflowState Class

AttributeEnumWorkflowState Constructor

Properties

enum_name Property

id_serverid Property

item_id Property

position_data Property

unique_id Property

Methods

ToString Method

Fields

description Field

is_resolution Field

AttributeInfo Class

Properties

attribute_id Property

display_name Property

id_serverid Property

Methods

CopyWithNewEmptyValue Method

CopyWithNewValue Method

CopyWithoutValue Method

IsPrimitiveOrEnum Method

ToChangeTrackerString Method

ToString Method

Fields

auto_increment_start Field

description Field

enum_items Field

input_mask Field

is_auto_increment Field

is_visible Field

read_only Field

reprompt_on_change Field

visibility_constraint Field

workflow_id Field

AttributeListScriptInput Class

AttributeListScriptInput Constructor

Properties

Context Property

HasValue Property

Methods

Fields

attribute_ids Field

description Field

is_optional Field

is_single Field

AttributeMatchValueCollection Class

AttributeMatchValueCollection Constructor

Properties

Methods

AttributeOperationInfo Class

Methods

Fields

operation Field

AttributeReferenceInfo Class

Methods

Fields

document_path Field

AttributeUsageInfo Class

Properties

attribute_id Property

attribute_name Property

attribute_type Property

entity_count Property

entity_with_doc_reference_count Property

is_system_attribute Property

set_id Property

set_server_id Property

Methods

AttributeValue Class

AttributeValue Constructor

AttributeValue() Constructor

AttributeValue(object) Constructor

Properties

Methods

ToChangeTrackerString Method

ToString Method

is_equal Method

Fields

AttributeValueCollection Class

AttributeValueCollection Constructor

AttributeValueCollection() Constructor

AttributeValueCollection(AttributeValueCollection) Constructor

AttributeValueCollection(List<AttributeInfo>) Constructor

Properties

Methods

Add Method

Add(TKey, TValue)

Add(KeyValuePair<EntityIDAttributeValue>) Method

AttributeYesNoValue Class

AttributeYesNoValue Constructor

AttributeYesNoValue() Constructor

AttributeYesNoValue(AttributeYesNo) Constructor

Properties

Methods

ToChangeTrackerString Method

ToString Method

is_equal Method

Fields

AttributesScriptInput Class

AttributesScriptInput Constructor

Properties

HasValue Property

Methods

Fields

description Field

is_optional Field

AutoConverter Class

AutoConverter Constructor

Properties

converter_id Property

id_serverid Property

source_id Property

source_is_file Property

target_folder_id Property

Methods

BaseParseableEmailTemplate Class

BaseParseableEmailTemplate Constructor

BaseParseableEmailTemplate(EmailTemplate) Constructor

BaseParseableEmailTemplate(EmailTemplateCategory, string, string, string) Constructor

Properties

Variables Property

Methods

Parse(out string, out string) Method

SetVariables Method

Fields

BasicFileInfo Class

Methods

Fields

change_type Field

checked_out_by Field

checkout_machine_id Field

creation_time_utc Field

file_size Field

file_type Field

folder_id Field

is_checked_out_by_user Field

last_write_time_utc Field

relative_path Field

CADLayoutInfo Class

Properties

attributes Property

Methods

Fields

created_by_id Field

inherit_empty_values_from_above Field

layout_id Field

layout_name Field

layout_order Field

CADLayoutInfoExtensionData Class

Methods

Fields

layout_info Field

CADLayoutTemplateInfo Class

Properties

attributes Property

Methods

Fields

created_by_id Field

folder_id Field

inherit_empty_values_from_above Field

layout_id Field

layout_name Field

layout_order Field

project_id Field

CADUpdateResult Class

Methods

Fields

CategoryInfo Class

Properties

Methods

Fields

created_by_id Field

created_on Field

description Field

last_updated Field

parent_id Field

ChangeTrackerHelper Class

Methods

GetAttributesString Method

GetFieldsString Method

CheckOutInfo Class

Methods

CompareTo Method

Fields

checkout_time Field

checkout_user_id Field

checkout_user_name Field

machine_id Field

CheckoutEntity Class

Methods

Fields

checkout_date Field

entity_id Field

entity_type Field

item_name Field

machine_key Field

project_id Field

ChunkData Class

Methods

Fields

num_bytes Field

ChunkInfo Class

Methods

Fields

chunk_size Field

num_chunks Field

ClientRegistrationInfo Class

Methods

Fields

client_current_gmt_offset Field

client_type Field

contracts_version Field

downgrade Field

CompanyContactInfo Class

CompanyContactInfo Constructor

Properties

company_id Property

contact_id Property

id_serverid Property

Methods

CompanyGatherer Class

Methods

AddCompany Method

CompanyInfo Class

CompanyInfo Constructor

Properties

active Property

attributes Property

create_date Property

created_by Property

id_serverid Property

updated_date Property

Methods

GetHashCode Method

ToChangeTrackerString Method

ToString Method

CompanyReportParameters Class

Properties

IncludeInactive Property

IncludeStaff Property

Methods

CompanyScriptInput Class

CompanyScriptInput Constructor

Properties

HasValue Property

company_id Property

company_name Property

Methods

Fields

description Field

is_optional Field

ConcurrencyCount Class

Methods

Fields

ConcurrencyCounts Class

Methods

Fields

advanced_data_management Field

data_management Field

ConnectedClient Class

Methods

Fields

active_event Field

connected_since Field

ip_address Field

license_pool Field

session_id Field

user_name Field

ConnectionLogInfo Class

ConnectionLogInfo Constructor

ConnectionLogInfo() Constructor

ConnectionLogInfo(EntityID, ConnectionEventType, string, string, DateTime, Guid, int, string, LicensePool, double) Constructor

Properties

client_app Property

client_gmt_offset_in_minutes Property

connection_event_type Property

id_serverid Property

license_pool_id Property

license_type Property

session_id Property

timestamp Property

user_id Property

version Property

Methods

ConnectorAssemblyInfo Class

Properties

assembly_name Property

id_serverid Property

status Property

version Property

Methods

ConnectorConfigInfo Class

Properties

description Property

id_serverid Property

Methods

ConnectorConstantInfo Class

ConnectorConstantInfo Constructor

Properties

attribute_id Property

attribute_value_id Property

entity_type Property

id_serverid Property

Methods

Fields

attribute Field

ConnectorCustomField Class

ConnectorCustomField Constructor

Properties

attribute_types Property

destination_field Property

entity_type Property

list_items Property

source_field Property

Methods

ConnectorCustomFieldSettings Class

Properties

ButtonText Property

IsSupported Property

Methods

ConnectorDefaultMapping Class

ConnectorDefaultMapping Constructor

ConnectorDefaultMapping() Constructor

ConnectorDefaultMapping(ConnectorMappingEntityType, string, string, AttributeType) Constructor

ConnectorDefaultMapping(ConnectorMappingEntityType, string, string, List<String>) Constructor

Properties

attribute_type Property

destination_field Property

entity_type Property

id_serverid Property

list_items Property

source_field Property

Methods

ConnectorInfo Class

ConnectorInfo Constructor

Properties

allow_client_manual_sync Property

configuration Property

constants Property

custom_field_default_mappings Property

download_link Property

frequency_seconds Property

friendly_name Property

id_serverid Property

is_scheduled Property

last_run_timestamp Property

mappings Property

parent_project_constant Property

run_as_user_id Property

skip_debug_logging Property

test_run_accepted Property

type_name Property

Methods

AddConfiguration Method

AddCustomFieldMappings Method

AddCustomFieldMappingsToStart Method

AddMapping Method

SetConfiguration Method

SetConstants Method

SetCustomFieldDefaultMappings Method

SetMappings Method

Fields

assembly_version Field

connection_test_supported Field

custom_field_settings Field

in_assembly_named Field

is_available Field

licence_check_passed Field

manual_mode_setup Field

up_to_date Field

ConnectorLog Class

ConnectorLog Constructor

Properties

connector_id Property

context Property

extra_detail Property

id_serverid Property

message Property

message_level Property

timestamp Property

Methods

GetHashCode Method

ToString Method

ConnectorManualModeSetting Class

ConnectorManualModeSetting Constructor

ConnectorManualModeSetting() Constructor

ConnectorManualModeSetting(string, string, ConnectorMappingEntityType, string) Constructor

Properties

Description Property

SourceField Property

Methods

ConnectorManualModeSetup Class

Properties

IsSupported Property

Selected Property

Settings Property

Methods

ConnectorMappingExclusion Class

ConnectorMappingExclusion Constructor

Properties

connector_id Property

id_serverid Property

mapping_entity_type Property

Methods

ConnectorMappingInfo Class

ConnectorMappingInfo Constructor

ConnectorMappingInfo() Constructor

ConnectorMappingInfo(string, EntityID) Constructor

Properties

attributeid Property

attributeid_id Property

attributeid_serverguid Property

attributeid_serverid Property

id_serverid Property

source_field Property

Methods

ContactGatherer Class

Methods

AddContact Method

ContactInfo Class

ContactInfo Constructor

Properties

FullName Property

active Property

active_byte Property

attributes Property

create_date Property

first_name Property

id_serverid Property

image_modified_date_time Property

last_name Property

Methods

CopyFrom Method

ToChangeTrackerString Method

ToString Method

Fields

companies Field

ContactList Class

ContactList Constructor

Properties

attributes Property

created_by Property

id_serverid Property

project_id Property

Methods

ToChangeTrackerString Method

ContactListContact Class

ContactListContact Constructor

Properties

contact_id Property

contact_list_id Property

id_serverid Property

Methods

ContactQueryValue Class

ContactQueryValue Constructor

ContactQueryValue() Constructor

ContactQueryValue(ContactInfo) Constructor

Properties

Methods

ToString Method

ContactReportParameters Class

Properties

IncludeCompanies Property

Methods

ContactScriptInput Class

ContactScriptInput Constructor

Properties

HasValue Property

OnlyOneSource Property

allow_variable Property

contact_sources Property

entity_ids Property

variable_string Property

Methods

Fields

description Field

is_optional Field

ContactTable Class

Methods

ContactsScriptInput Class

ContactsScriptInput Constructor

Properties

HasValue Property

OnlyOneSource Property

allow_variable Property

contact_sources Property

values Property

Methods

Fields

description Field

is_optional Field

Converter Class

Properties

Methods

Fields

arguments Field

extensions Field

out_extension Field

Coordinate Class

Coordinate Constructor

Coordinate() Constructor

Coordinate(double, double) Constructor

Methods

ToString Method

is_equal Method

Fields

byte_data Field

search_distance Field

search_is_metric Field

search_wkt Field

Counter Constructor

Properties

attached_to_entity_id Property

attached_to_entity_type Property

counter_name Property

id_serverid Property

Methods

CustomReport Class

CustomReport Constructor

Properties

Parameters Property

Methods

DoGenerateReport Method

GenerateReport Method

CustomReportInput Class

CustomReportInput Constructor

Methods

Fields

description Field

is_optional Field

user_control_type Field

DashboardScriptInput Class

DashboardScriptInput Constructor

Properties

HasValue Property

Methods

Fields

description Field

global_gadgets_only Field

is_optional Field

DataCleanerSettings Class

Methods

Deserialize Method

Serialize Method

Fields

disk_percentage_used_before_run Field

interval_in_minutes Field

DataRetentionPolicy Class

Properties

IsActive Property

Methods

Fields

Properties

attributes Property

data_set_type Property

Methods

DateRangeQueryValue Class

DateRangeQueryValue Constructor

Properties

Methods

ToString Method

DomainValueCollection Class

DomainValueCollection Constructor

Properties

Methods

EditFileServerResult Class

Methods

Fields

able_to_communicate_sync_rules Field

incoming_auth_key Field

master_public_key Field

outgoing_auth_key Field

server_id Field

EmailExceptionRule Class

EmailExceptionRule Constructor

EmailExceptionRule() Constructor

EmailExceptionRule(string, string, bool) Constructor

Properties

active Property

description Property

id_serverid Property

Methods

ToString Method

EmailMessageID Class

EmailMessageID Constructor

Properties

file_id Property

id_serverid Property

message_id Property

Methods

EmailMessageIDReference Class

EmailMessageIDReference Constructor

Properties

id_serverid Property

message_id Property

references_message_id Property

Methods

EmailSettings Class

Methods

Fields

attrib_stamp_ids Field

email_stamp_attrib_display Field

email_stamp_attrib_string Field

source_type Field

EmailStamp Class

Methods

Fields

is_default Field

EmailStampSource Class

Methods

Fields

attribute_id Field

source_type Field

EmailTemplate Class

StockTemplates Class

Properties

AssignedWorkflow Property

DependentTaskItemClosed Property

EntityRequested Property

FileChangeUserNotification Property

FileCheckedOut Property

FileCheckoutCancelled Property

FileCopied Property

FileMoved Property

FilesCheckedIn Property

FilesMoved Property

FolderChangeUserNotification Property

FolderCheckedIn Property

FolderCheckedOut Property

FolderCheckoutCancelled Property

ForumTopicNotification Property

IssueFileSetNotification Property

IssuedFiles Property

IssuedFilesReceipt Property

IssuedFilesReceiptManual Property

NewFile Property

NewFiles Property

NewFolder Property

NewForumPost Property

NewNote Property

NewTaskItemCreated Property

NewUser Property

PublishedFile Property

PublishedFileDownloaded Property

PublishedFileWithPassword Property

ScheduledEntityTypeReport Property

ScheduledReport Property

TDModelChangeUserNotification Property

TDModelCheckedIn Property

TDModelCheckedOut Property

TDModelCreated Property

TaskChangeUserNotification Property

TaskDueToStart Property

TaskItemReminderDueDateFuture Property

TaskItemReminderDueDatePast Property

TaskItemReminderStartDateFuture Property

TaskItemReminderStartDatePast Property

TaskItemUpdated Property

WebFileDropInvitation Property

WebFileDropNotification Property

Methods

EmailTemplate Constructor

Methods

Fields

EmailTemplateScriptInput Class

EmailTemplateScriptInput Constructor

Properties

HasValue Property

template_name Property

Methods

Fields

description Field

is_optional Field

EmailTemplateVariables Class

TemplateVariable Class

Methods

Fields

description Field

is_primitive Field

Methods

GetVariables Method

EntityAttributeCache Class

Properties

Methods

EntityAttributeInfo Class

Properties

attribute_id Property

display_name Property

id_serverid Property

Methods

CopyWithNewEmptyValue Method

CopyWithNewValue Method

CopyWithoutValue Method

IsPrimitiveOrEnum Method

ToChangeTrackerString Method

ToString Method

Fields

auto_increment_start Field

description Field

enum_items Field

input_mask Field

is_auto_increment Field

is_visible Field

owner_entity_id Field

read_only Field

reprompt_on_change Field

visibility_constraint Field

workflow_id Field

EntityID Constructor

EntityID() Constructor

EntityID(EntityID) Constructor

EntityID(long, Guid) Constructor

EntityID(long, ServerID) Constructor

EntityID(long, int, Guid) Constructor

Properties

ServerID Property

Methods

Equality Operator

GetHashCode Method

Inequality Operator

LoadFromString Method

LoadFromXml Method

ToString Method

ToURIString Method

ToXmlString Method

Fields

ServerGUID Field

EntityInfoLight Class

Methods

Fields

entity_id Field

entity_type Field

item_name Field

EntityLogItem Class

Methods

Fields

date_time Field

file_change_type Field

item_name Field

target_id Field

target_type Field

EntityPathPart Class

EntityPathPart Constructor

EntityPathPart() Constructor

EntityPathPart(EntityType, string, EntityID) Constructor

Methods

Fields

EntityPermission Class

EntityPermission Constructor

Properties

Permission Property

entity_id Property

entity_type Property

id_serverid Property

permission_type Property

target_id Property

target_type Property

Methods

EntityReportInput Class

EntityReportInput Constructor

Methods

Fields

description Field

entity_id Field

entity_type Field

is_optional Field

EntityScriptInput Class

EntityScriptInput Constructor

Properties

HasValue Property

Methods

Fields

description Field

entity_id Field

entity_type Field

is_optional Field

EntitySearchResult Class

EntitySearchResult Constructor

Properties

context Property

entity_id Property

timestamp Property

Methods

EntitySelectionInput Class

Methods

Fields

entity_id_list Field

EntityTypeServerReport Class

Methods

Fields

description Field

entity_type Field

extensions Field

is_visible Field

report_guid Field

EnumScriptInput Class

EnumScriptInput Constructor

Properties

HasValue Property

Methods

Fields

description Field

is_optional Field

selected_index Field

Extension Class

Methods

ToAttributeValueCollection<TSource> Method

ExtraFileInfo Class

Methods

Fields

num_assocs Field

num_issue Field

num_linked Field

num_notes Field

ExtraProjectInfo Class

Methods

Fields

num_assocs Field

num_notes Field

FileChangeData Class

Methods

Fields

description Field

file_attribs Field

file_attribs_to_remove Field

file_change_attribs Field

workflow_capture_data Field

FileChangeDetails Class

Methods

Fields

change_attribs Field

change_time Field

contact_id Field

description Field

file_attribs Field

file_change_id Field

file_change_type Field

file_name Field

file_size Field

FileChangeInfo Class

Methods

Fields

change_attribs Field

change_time Field

contact_id Field

description Field

file_attribs Field

file_change_id Field

file_change_type Field

file_size Field

FileChangeTransferData Class

Methods

Fields

file_change_id Field

transfer_guid Field

FileConverterScriptInput Class

FileConverterScriptInput Constructor

Properties

HasValue Property

Methods

Fields

ConverterID Field

ConverterName Field

description Field

is_optional Field

FileDropNotification Class

Methods

Fields

entity_id Field

friendly_name Field

FileDropSetting Class

FileDropSetting Constructor

Properties

DisplayName Property

Methods

FileGatherer Class

FileGatherer Constructor

FileGatherer() Constructor

FileGatherer(int) Constructor

Properties

Methods

GetFolderPath Method

SendColumnLayoutResponse Method

SetAttributes Method

SetFolderPaths Method

SetInheritedAttributes Method

Fields

_inherited_attributes Field

FileHistory Class

Methods

Fields

attribute_change Field

change_by Field

change_type Field

file_change Field

file_change_data Field

file_change_id Field

utc_change_time Field

Properties

attributes Property

Methods

CreateExtensionData Method

GetChangedAttributes Method

ToString Method

Fields

active_check_out Field

active_folder_check_out Field

change_attribs Field

display_name Field

extension_data Field

file_access Field

file_created_utc Field

file_lock Field

file_modified_utc Field

file_name Field

file_size Field

file_store Field

file_type Field

flattened_parent_attributes Field

folder_id Field

has_file_access Field

has_folder_references Field

has_layouts Field

has_references Field

is_link_source Field

is_referenced Field

last_change_time Field

last_change_type Field

last_user_id Field

last_user_name Field

latest_version Field

link_path Field

link_source_id Field

preview_state Field

workflows Field

FileInfoForFileChange Class

Methods

Fields

duplicate_file_id Field

file_change_attributes Field

file_name Field

folder_id Field

missing_file_attributes Field

needs_rename Field

FileIssuingDetails Class

Methods

Fields

change_attribs Field

file_change_id Field

file_set_id Field

file_set_name Field

issue_date_utc Field

issued_by Field

set_type_id Field

set_type_name Field

FileLauncher Class

Properties

LocalId Property

Methods

Fields

arguments Field

cosmetic_name Field

description Field

file_type Field

FilePlaceHolder Class

Properties

DisplayName Property

Methods

Fields

attribute Field

FilePreviewTransferData Class

Methods

Fields

file_change_id Field

preview_type Field

server_event_id Field

transfer_guid Field

FileReferenceHistories Class

Properties

Methods

FileReportParameters Class

Properties

IncludeAssociations Property

IncludeHistory Property

IncludeInheritedAttributeValues Property

IncludeNotes Property

IncludeReferences Property

Methods

FileRetrieval Class

Methods

Fields

delete_after Field

path_to_file Field

FileSearchQuery Class

FileSearchQuery Constructor

StoredSearchQuery() Constructor

StoredSearchQuery(SearchQuery, SearchLimitOption, EntityID, EntityType) Constructor

Methods

Deserialize Method

GetQuickSearchString Method

Serialize Method

Fields

limit_name Field

limit_option Field

search_string Field

search_type Field

FileServerInfo Class

Methods

ToString Method

Fields

default_store_id Field

default_store_name Field

incoming_auth_key Field

last_hello_utc Field

local_address Field

outgoing_auth_key Field

public_key Field

server_name Field

FileServerIntervalSyncRule Class

Methods

Fields

file_server_id Field

full_sync Field

search_query Field

FileServerLink Class

Methods

Fields

server_name Field

FileServerQueue Class

Methods

Fields

FileServerQueueItem Class

Methods

Fields

active_files Field

completed_files Field

last_updated_time Field

owner_info Field

queue_time Field

total_files Field

FileServerStatistic Class

FileServerStatistic Constructor

FileServerStatistic() Constructor

FileServerStatistic(string, string, string, object, FileServerStatisticType, bool) Constructor

Methods

Create(string, string, string, DateTime, bool) Method

Create(string, string, string, TimeSpan, bool) Method

Create(string, string, string, double, bool) Method

Create(string, string, string, long, bool) Method

Fields

internal_name Field

persisted Field

string_value Field

FileServerStatistics Class

Methods

Fields

general_stats Field

persistent_stats Field

session_stats Field

FileServerSyncRule Class

Methods

Fields

file_server_id Field

full_sync Field

search_query Field

FileServerTimeSyncRule Class

Methods

Fields

file_server_id Field

full_sync Field

minute_utc Field

search_query Field

FileStoreBindingCatchAllRule Class

Methods

Fields

create_time Field

created_by_id Field

file_stores Field

rule_name Field

rule_order Field

rule_set_id Field

rule_type Field

FileStoreBindingFileNameRule Class

Methods

Fields

create_time Field

created_by_id Field

file_stores Field

rule_name Field

rule_order Field

rule_set_id Field

rule_type Field

FileStoreBindingFolderNameRule Class

Methods

Fields

create_time Field

created_by_id Field

file_stores Field

rule_name Field

rule_order Field

rule_set_id Field

rule_type Field

FileStoreBindingRule Class

Methods

Fields

create_time Field

created_by_id Field

file_stores Field

rule_name Field

rule_order Field

rule_set_id Field

rule_type Field

FileStoreInfo Class

Methods

ToString Method

Fields

create_date Field

is_remote Field

server_id Field

server_name Field

store_type Field

FileStoreRuleSet Class

Methods

ToString Method

Fields

created_by_id Field

created_date Field

FileStoreScriptInput Class

FileStoreScriptInput Constructor

Properties

HasValue Property

info_list Property

Methods

Fields

description Field

is_optional Field

FileStoreStats Class

Methods

Fields

num_file_changes Field

num_files Field

num_rule_sets Field

server_id Field

FileTable Class

Methods

FileTransferData Class

Methods

Fields

transfer_guid Field

FileWithMissingReferences Class

Methods

Fields

untracked_references Field

FilesOverWebPasswordSettings Class

Methods

Fields

min_numbers_in_password Field

min_password_length Field

min_special_chars_in_password Field

mix_case_required_in_password Field

require_password Field

FlatSearchAttribute Class

FlatSearchAttribute Constructor

FlatSearchAttribute() Constructor

FlatSearchAttribute(FlatSearchAttributeType, AttributeSearchContext) Constructor

Methods

Fields

attrib_context Field

attribute Field

FolderColumn Class

FolderColumn Constructor

FolderColumn() Constructor

FolderColumn(FolderColumnType) Constructor

FolderColumn(FolderColumnType, int, FolderSort, int) Constructor

Methods

GetStandardColumns Method

Fields

attribute_info Field

column_type Field

sort_index Field

FolderHistory Class

Methods

Fields

change_date Field

change_description Field

change_id Field

contact_info Field

FolderItems Class

Methods

Fields

data_sets Field

sub_folders Field

sub_td_projects Field

FolderParameters Class

FolderParameters Constructor

Properties

package_associations Property

package_file_attributes Property

package_file_change_attributes Property

package_files Property

package_folder_layout Property

package_latest_file_version_only Property

package_naming_rules Property

package_notes Property

package_notifications Property

package_permissions Property

Methods

FolderProfile Class

Methods

Fields

FolderTransferData Class

Methods

Fields

create_time Field

folder_id Field

folder_state Field

transfer_guid Field

write_time Field

ForumCategory Class

Methods

Fields

category_id Field

category_name Field

category_order Field

category_posts Field

category_topics Field

create_date Field

created_by_id Field

description Field

last_post_by Field

last_post_date Field

last_post_id Field

ForumInfo Class

Properties

Methods

Fields

create_date Field

created_by Field

has_user_access Field

user_access Field

ForumPost Class

Methods

Fields

can_delete Field

in_reply_to_id Field

post_time Field

poster_info Field

ForumSearchQuery Class

ForumSearchQuery Constructor

Methods

AddDomainValue Method

GetDomainContactInfo Method

GetDomainDateValue Method

GetDomainProjectInfo Method

GetDomainStringValue Method

GetDomainValue Method

HasDomainValue Method

Fields

created_by_id Field

domain_specific_values Field

ForumTopic Class

Methods

Fields

category_id Field

created_by_id Field

created_by_name Field

date_created Field

last_post_by Field

last_post_date Field

last_post_id Field

project_id Field

read_posts Field

topic_name Field

total_posts Field

total_views Field

FoundFolderResult Class

Methods

Fields

folder_id Field

project_id Field

GadgetData Class

Methods

Fields

height_is_max Field

show_header Field

GadgetInfo Class

Methods

Fields

allow_user_sizing Field

default_height Field

default_width Field

description Field

height_is_max Field

is_global Field

show_header Field

GeocodedAddress Class

Properties

Address Property

ManuallyAdded Property

Methods

GroupAccessInfo Class

GroupAccessInfo Constructor

Properties

Methods

Fields

permissions Field

GroupInfo Class

Properties

FileServerID Property

LicensePoolID Property

Methods

ToString Method

Fields

group_name Field

GroupQueryValue Class

GroupQueryValue Constructor

GroupQueryValue() Constructor

GroupQueryValue(GroupInfo) Constructor

Properties

Methods

ToString Method

ImportModifier Class

Methods

Fields

ImportModifiers Class

Methods

AddExclusion Method

GetItemName Method

IsExcluded Method

RemoveExclusion Method

Fields

modifiers Field

InheritedEntity Class

Properties

EntityType Property

Parent Property

Methods

IssueAction Class

Methods

IssueByEmail Class

Methods

Fields

IssueByOutlook Class

Methods

IssueByPublishing Class

Methods

Fields

available_until Field

description Field

download_page_id Field

notifications Field

send_server_emails Field

show_landing_page Field

show_password Field

IssueContact Class

Methods

Fields

send_mode Field

IssuePublishingInfo Class

Methods

Fields

contact_id Field

num_downloads Field

IssueStructure Class

Methods

Fields

root_type Field

IssuedFile Class

Methods

Fields

description Field

file_change_id Field

issue_date_utc Field

issued_by Field

issued_contacts Field

issued_type_id Field

issued_type_name Field

IssuedFileSet Class

IssuedFileSet Constructor

Properties

created_by Property

created_date_utc Property

description Property

has_issues Property

project_id Property

set_version Property

structure_root Property

type_id Property

Methods

Fields

add_all_referenced_files Field

IssuedFileSetIssueDetails Class

IssuedFileSetIssueDetails Constructor

Properties

additional_note Property

attributes Property

issue_action Property

issue_date Property

issue_set_id Property

issued_by Property

issued_to Property

set_version Property

transmittal_file_name Property

transmittal_stream Property

Methods

IssuedFileSetType Class

Properties

description Property

type_id Property

type_name Property

Methods

ToString Method

Fields

num_file_sets Field

IssuedFileSetVersion Class

Methods

Fields

added_dates Field

JobScriptInput Class

JobScriptInput Constructor

Properties

HasValue Property

job_id Property

job_name Property

Methods

Fields

description Field

is_optional Field

LastUsedDataRetentionPolicy Class

Properties

IsActive Property

NumberOfDays Property

Methods

Fields

number_of_days Field

LicenseID Class

LicenseID Constructor

Properties

Methods

LicenseInfo Class

Methods

Fields

concurrency_counts Field

dm_user_count Field

expiry_date Field

max_users Field

user_count Field

LicenseLogInfo Class

Methods

Fields

Max_Num_ADM_Licenses Field

Max_Num_DM_Licenses Field

Max_Num_Email_Licenses Field

Max_Overflow_ADM_Licenses Field

Max_Overflow_DM_Licenses Field

Max_Overflow_Email_Licenses Field

LicenseModuleInfo Class

Methods

Fields

description Field

is_user_quota Field

max_num_overflow_slots Field

max_num_slots Field

used_slots Field

LicensePool Class

Methods

Fields

Created_By Field

Description Field

Is_Active Field

Max_Num_ADM_Licenses Field

Max_Num_DM_Licenses Field

Max_Num_Email_Licenses Field

Max_Overflow_ADM_Licenses Field

Max_Overflow_DM_Licenses Field

Max_Overflow_Email_Licenses Field

LicensePoolLogInfo Class

Methods

Fields

Is_Active Field

Max_Num_ADM_Licenses Field

Max_Num_DM_Licenses Field

Max_Num_Email_Licenses Field

Max_Overflow_ADM_Licenses Field

Max_Overflow_DM_Licenses Field

Max_Overflow_Email_Licenses Field

Modified_By Field

ListContactGatherer Class

Properties

Contacts Property

Methods

AddContact Method

ListFileGatherer Class

ListFileGatherer Constructor

Properties

Methods

GetFolderPath Method

SendColumnLayoutResponse Method

SetAttributes Method

SetFolderPaths Method

SetInheritedAttributes Method

Fields

_inherited_attributes Field

ListScriptInput Class

ListScriptInput Constructor

Properties

HasValue Property

Methods

Fields

current_value Field

description Field

is_optional Field

Methods

Fields

cosmetic_lock_name Field

locked_for_id Field

locked_for_type Field

MailAttachment Class

Methods

Fields

delete_after Field

ManagedFolderChange Class

Methods

Fields

change_description Field

change_time Field

changed_by_id Field

folder_change_id Field

folder_id Field

folder_state Field

ManagedFolderChangeData Class

Methods

Fields

file_changes Field

managed_folder_change Field

sub_managed_folder_change_details Field

ManagedFolderChangeDetails Class

Methods

Fields

change_description Field

change_time Field

change_type Field

changed_by_id Field

folder_change_id Field

folder_id Field

folder_name Field

folder_state Field

Properties

Active Property

LayerOrder Property

LocalId Property

Password Property

ServiceMode Property

ShouldUserPromptForUserAccount Property

Username Property

created_by Property

id_serverid Property

project_id Property

Methods

MapSettingData Class

Methods

Fields

map_layers Field

MessageData Class

Methods

Fields

sender_id Field

sender_info Field

sent_time_utc Field

MinimumSizeDataRetentionPolicy Class

Properties

IsActive Property

Methods

Fields

size_in_kb Field

MissingReferenceSuggestions Class

Methods

Fields

most_likely Field

suggestions Field

NamingRule Class

Methods

Fields

has_placeholders Field

rule_order Field

NamingRuleSet Class

Properties

Methods

Fields

extensions Field

NoteHeader Class

Methods

Fields

from_details Field

in_reply_to_id Field

notifies_sent_to Field

NoteInfo Constructor

Properties

from_id Property

in_reply_to Property

subject Property

target Property

target_id Property

Methods

NotificationSubscription Class

Methods

Fields

created_by_id Field

event_source_id Field

event_source_type Field

event_type Field

friendly_subscriber_name Field

subscriber_id Field

subscriber_type Field

ObservationInfo Class

Properties

created_date Property

id_serverid Property

submitted_date Property

Methods

OutlookTemplateSetting Class

Methods

Fields

cosmetic_path Field

folder_id Field

project_id Field

PackageData Class

Methods

Fields

date_added Field

owner_info Field

PackageParameters Class

Methods

Fields

folder_parameters Field

project_parameters Field

td_project_parameters Field

PagedResults<T> Class

Properties

PageCount Property

Methods

PathScriptInput Class

PathType Enumeration

PathScriptInput Constructor

Properties

HasValue Property

Methods

Fields

description Field

for_workflow Field

is_optional Field

path_type Field

path_value Field

Permission Class

Permission Constructor

Properties

can_admin Property

can_assign_tasks Property

can_create_files Property

can_create_folders Property

can_create_issue_set Property

can_create_projects Property

can_create_tasks Property

can_create_td_projects Property

can_create_web_drops Property

can_delete_tasks Property

can_edit_tasks Property

can_issue_issue_set Property

can_leave_notes Property

can_list Property

can_manage_timesheets Property

can_moderate_forums Property

can_modify_issue_set Property

can_open_td_projects Property

can_publish Property

can_read Property

can_read_forums Property

can_report Property

can_share_td_projects Property

can_update_attributes Property

can_view_td_projects Property

can_write Property

can_write_forums Property

id_serverid Property

permission_sets Property

permissions Property

Methods

PermissionToRoleAccess Method

RoleAccessToPermission Method

PermissionSet Class

Properties

Permission Property

id_serverid Property

Methods

PermissionsChange Class

Methods

Fields

PredefinedChangeDescription Class

Properties

Methods

ToString Method

Fields

change_type Field

description_name Field

display_order Field

full_description Field

PreviewItem Class

Methods

Fields

sub_items Field

PrimitiveQueryValue Class

PrimitiveQueryValue Constructor

PrimitiveQueryValue() Constructor

PrimitiveQueryValue(object) Constructor

Properties

Methods

ToString Method

PrimitiveReportInput Class

PrimitiveReportInput Constructor

Methods

Fields

description Field

is_optional Field

type_value Field

value_type Field

PrimitiveScriptInput Class

PrimitiveScriptInput Constructor

Properties

HasValue Property

Methods

GetDateRange Method

ToString Method

Fields

description Field

is_optional Field

type_value Field

value_type Field

ProjectFolder Class

Properties

attributes Property

has_sub_folders Property

has_td_projects Property

Methods

ToString Method

Fields

active_checkout Field

created_date Field

folder_id Field

folder_name Field

folder_state Field

folder_type Field

inherits_file_attributes Field

inherits_file_naming_rules Field

inherits_permissions Field

lock_info Field

num_sub_folders Field

num_td_projects Field

parent_folder_id Field

project_id Field

updated_date Field

ProjectInfo Class

ProjectInfo Constructor

Properties

attributes Property

create_date Property

creator_id Property

description Property

id_serverid Property

Methods

ToChangeTrackerString Method

ToString Method

Fields

always_display_parent Field

creator_name Field

inherit_permissions Field

inherits_file_naming_rules Field

num_children Field

num_folders Field

num_td_projects Field

parent_project_id Field

ProjectItems Class

Methods

Fields

data_sets Field

has_issued_file_registry Field

sub_folders Field

sub_projects Field

sub_td_projects Field

ProjectNamingRule Class

Methods

Fields

components Field

created_by_id Field

created_date Field

ProjectNamingRuleComponent Class

Methods

Fields

attribute Field

fixed_component Field

ProjectNoteInfo Class

ProjectNoteInfo Constructor

Properties

created_date Property

external_id Property

from_id Property

id_serverid Property

in_reply_to Property

subject Property

target Property

target_id Property

Methods

ToChangeTrackerString Method

ProjectParameters Class

ProjectParameters Constructor

Properties

package_associations Property

package_file_attributes Property

package_file_change_attributes Property

package_forums Property

package_issues Property

package_naming_rules Property

package_notes Property

package_notifications Property

package_permissions Property

package_tasks Property

package_team Property

Methods

ProjectQueryValue Class

ProjectQueryValue Constructor

ProjectQueryValue() Constructor

ProjectQueryValue(ProjectInfo) Constructor

Properties

Methods

ToString Method

ProjectReportParameters Class

Properties

AttributeRestriction Property

IncludeAssociations Property

IncludeAttributes Property

IncludeCreatedBy Property

Methods

ProjectRole Class

Methods

Fields

filled_positions Field

project_id Field

ProjectTemplate Class

Properties

attributes Property

Methods

Fields

description Field

match_attributes Field

naming_rule Field

project_id Field

template_id Field

template_name Field

PublishedFile Class

Methods

Fields

available_until Field

description Field

display_name Field

file_type Field

is_password_protected Field

publish_id Field

published_by Field

published_on Field

total_downloads Field

PublishedFileNotification Class

Methods

Fields

entity_id Field

friendly_name Field

PublishedFileTrackingData Class

Methods

Fields

who_contact Field

QueryScriptInput Class

QueryScriptInput Constructor

Properties

HasValue Property

Methods

Fields

description Field

is_optional Field

search_type Field

QueryValue Class

QueryValue Constructor

Properties

Methods

ToString Method

QueryValueOperation Class

QueryValueOperation Constructor

Methods

GetOperationString Method

Fields

operation Field

query_value Field

QueuedEventData Class

Properties

SubEvents Property

Methods

Fields

active_sub_event Field

description Field

queue_time_utc Field

queued_by Field

sub_events Field

ReferenceChangeData Class

ReferenceChangeData Constructor

Methods

ToString Method

Fields

original_path Field

ReferenceGraph Class

Methods

Fields

folder_items Field

ReferenceInfo Class

ReferenceInfo Constructor

ReferenceInfo(EntityID, DocumentType, ReferenceMode) Constructor

ReferenceInfo(EntityID, DocumentType, ReferenceMode, int) Constructor

Methods

Fields

ref_version Field

ReferenceLink Class

ReferenceLink Constructor

Methods

Fields

references_id Field

ReferencedFolderInfo Class

ReferencedFolderInfo Constructor

Methods

Fields

folder_id Field

ReferencingFileInfo Class

ReferencingFileInfo Constructor

Methods

Fields

RelatedFile Class

Methods

Fields

Methods

AppendValueNode Method

BeginReportDocument Method

GenerateApplicationData Method

GenerateMetaData Method

GetEntityTypeString Method

ReportApplicationData Class

Properties

Application Property

ApplicationBuild Property

ApplicationDateUTC Property

ApplicationPath Property

Manufacturer Property

ManufacturerURL Property

Methods

ReportInput Class

ReportInput Constructor

Methods

Fields

description Field

is_optional Field

ReportMetaData Class

ReportMetaData Constructor

Properties

Application Property

Methods

ReportParameters Class

ReportParameters Constructor

Properties

CompanyParameters Property

ContactParameters Property

FileParameters Property

MetaData Property

ProjectParameters Property

TDProjectParameters Property

TaskParameters Property

Methods

ReportSchedule Class

Methods

Fields

delivery_mode Field

email_recipient_data Field

end_date_time Field

entity_type Field

frequency Field

is_active Field

last_execution_date_time Field

network_path Field

next_execution_date_time Field

report_data Field

report_guid Field

start_date_time Field

synergy_path_folder_id Field

ReportScheduleDeliveryData Class

Methods

Fields

contacts_to_be_added Field

contacts_to_be_deleted Field

groups_to_be_added Field

groups_to_be_deleted Field

roles_to_be_added Field

roles_to_be_deleted Field

ReportScheduleReportData Class

Methods

Fields

entity_id_input Field

entity_id_input_type Field

report_input Field

RoleAccess Class

Methods

CanAccess Method

GetAccessString Method

GetAccessValue Method

GetFolderAccessors Method

GetFullAccess Method

GetProjectAccessors Method

GetTDProjectAccessors Method

UpdateRole Method

RoleAccessInfo Class

RoleAccessInfo Constructor

Properties

RoleDefinition Property

Methods

Fields

permissions Field

RoleContact Class

RoleContact Constructor

Methods

Fields

contact_id Field

RoleDefinition Class

Properties

Methods

ToString Method

Fields

num_positions Field

role_name Field

RoleQueryValue Class

RoleQueryValue Constructor

RoleQueryValue() Constructor

RoleQueryValue(RoleDefinition) Constructor

Properties

Methods

ToString Method

ScriptInput Class

ScriptInput Constructor

Properties

HasValue Property

Methods

Fields

description Field

is_optional Field

SearchAttributes Class

Properties

Methods

Add Method

Add(TKey, TValue)

Add(AttributeSearchContext, EntityID, AttributeOperationInfo) Method

SearchProfile Class

Properties

Columns Property

Conditions Property

Methods

ToString Method

SearchProfileCondition Class

Properties

FileExtension Property

Percentage Property

RelationalOperator Property

Methods

SearchQuery Class

SearchQuery Constructor

Methods

AddDomainValue Method

GetDomainContactInfo Method

GetDomainDateValue Method

GetDomainProjectInfo Method

GetDomainStringValue Method

GetDomainValue Method

HasDomainValue Method

Fields

domain_specific_values Field

SearchQueryContractResolver Class

Methods

ResolveName Method

TryResolveType Method

TryResolveType(Type, Type, DataContractResolver, XmlDictionaryStringref , XmlDictionaryStringref )

TryResolveType(Type, Type, DataContractResolver, out XmlDictionaryString, out XmlDictionaryString) Method

ServerGadgetLibrary Class

Methods

Fields

date_time Field

ServerID Constructor

Methods

Fields

ServerReport Class

Methods

Fields

description Field

extensions Field

is_visible Field

report_guid Field

ServerReportLibrary Class

Methods

Fields

date_time Field

ServerScriptLibrary Class

Methods

Fields

date_time Field

ServerTask Class

Methods

Fields

description Field

is_running Field

repeat_time Field

start_from Field

ServerTaskLibrary Class

Methods

Fields

date_time Field

ServerTaskSchedule Class

Methods

Fields

start_from Field

ServerVersionInfo Class

Methods

ToVersion Method

Fields

alternative_client_dl_uri Field

feature_version Field

protocol_version Field

serializer_version Field

server_version Field

upgrade_optional Field

upgrade_version Field

ServerWorkflowLibrary Class

Methods

Fields

activities Field

conditions Field

date_time Field

SetLicenseResult Class

Methods

Fields

SimpleFolder Class

Methods

Fields

folder_type Field

SimpleReportFormat Class

Methods

ToString Method

Fields

extension Field

format_id Field

is_system Field

SortOrderAttribute Class

SortOrderAttribute Constructor

Properties

SortOrder Property

Methods

SourcedAttributeInfo Class

Properties

QueueHash Property

Methods

Fields

attribute Field

source_id Field

source_type Field

StartState Class

StartState Constructor

Properties

id_serverid Property

position_data Property

unique_id Property

Methods

ToString Method

Fields

description Field

is_resolution Field

StatisticInfo Class

Properties

Methods

StoredSearchQuery Class

StoredSearchQuery Constructor

StoredSearchQuery() Constructor

StoredSearchQuery(SearchQuery, SearchLimitOption, EntityID, EntityType) Constructor

Methods

Deserialize Method

GetQuickSearchString Method

Serialize Method

Fields

limit_name Field

limit_option Field

search_string Field

search_type Field

SyncToolSetup Class

Properties

is_installed Property

machine_group_attrib Property

Methods

TDElement Class

Methods

Fields

display_name Field

TDProjectChangeData Class

Methods

Fields

sub_managed_folder_change_details Field

td_project_change Field

TDProjectFullHistory Class

Properties

DateTime Property

Description Property

TDProjectID Property

Version Property

Methods

TDProjectHistory Class

Methods

Fields

change_date Field

change_description Field

change_id Field

change_type Field

contact_info Field

TDProjectInfo Class

Properties

CleanName Property

attributes Property

Methods

Fields

check_out_info Field

cosmetic_path Field

created_by_id Field

created_on Field

customisation_mode Field

direct_path Field

folder_id Field

inherits_file_attributes Field

is_locked Field

lock_info Field

map_file_id Field

map_file_mode Field

parent_folder_id Field

parent_project_id Field

project_version Field

TDProjectParameters Class

TDProjectParameters Constructor

Properties

package_associations Property

package_notes Property

package_notifications Property

package_permissions Property

Methods

TDProjectReportParameters Class

Properties

IncludeAssociations Property

IncludeAttributes Property

IncludeHistory Property

Methods

TDProjectTemplate Class

Properties

attributes Property

Methods

Fields

description Field

match_attributes Field

naming_rule Field

td_project_id Field

template_id Field

template_name Field

TDProjectVersionDetails Class

TDProjectVersionDetails Constructor

Properties

CanCreate Property

VersionNum Property

Methods

TDProjectVersionHelper Class

Methods

GetTDProjectVersion Method

RunTDProjectTool Method

Fields

MAX_SUPPORTED_VERSION Field

TDSharedElementInfo Class

Methods

Fields

cosmetic_path Field

file_info Field

is_checked_out_by_current_user Field

proj_info Field

TaskAction Class

Methods

Fields

action_data_id Field

action_mode Field

Properties

Methods

TaskContactCC Class

TaskContactCC Constructor

Properties

Methods

Fields

TaskGroupCC Class

TaskGroupCC Constructor

Properties

Methods

Fields

TaskHistory Class

Methods

Fields

change_date Field

change_description Field

contact_info Field

Properties

AllProgress Property

AssignedContacts Property

DueDateString Property

DueDays Property

StartDateString Property

StartDays Property

attributes Property

Methods

ContainsChild Method

GetProgress Method

ShallowCopy Method

ToChangeTrackerString Method

Fields

assigned_by Field

assigned_entity Field

dependent_task_action Field

depends_on_ids Field

description Field

due_date_mode Field

due_date_utc Field

is_closed Field

item_owner Field

parent_item_id Field

project_id Field

project_path Field

relative_due_date_days Field

relative_start_date_days Field

start_date_mode Field

start_date_utc Field

start_task_action Field

task_path Field

task_state Field

task_state_name Field

task_type_id Field

task_type_name Field

user_task_id Field

TaskItemPreview Class

Methods

Fields

task_history Field

TaskItemReminder Class

Methods

Fields

is_deleted Field

is_recurring Field

last_sent_timestamp Field

remind_delta_days Field

remind_even_after_finished Field

remind_even_after_started Field

remind_who Field

remind_who_type Field

reminder_type Field

times_sent Field

TaskRecurrence Class

Methods

Fields

number_of_recurrences Field

pattern_value Field

TaskReportParameters Class

Properties

IncludeAssociations Property

IncludeAttributes Property

IncludeDependencies Property

IncludeHistory Property

IncludeNotes Property

IncludeReminders Property

Methods

TaskRoleCC Class

TaskRoleCC Constructor

Properties

Methods

Fields

TaskSearchResultNode Class

Methods

Fields

sub_proj_nodes Field

TaskState Class

TaskState Constructor

Properties

attributes Property

completion_percentage Property

id_serverid Property

is_closure_db_field Property

sort_order Property

Methods

GetHashCode Method

ToString Method

Fields

is_closure Field

task_type_name Field

TaskType Constructor

Properties

attributes Property

Methods

ToString Method

Fields

create_date_utc Field

created_by_id Field

dependent_task_action Field

description Field

start_task_action Field

task_type_id Field

workflow_id Field

TaskTypeItemReminder Class

Methods

Fields

is_recurring Field

remind_delta Field

remind_delta_type Field

remind_even_after_finished Field

remind_even_after_started Field

remind_who Field

remind_who_type Field

reminder_type Field

TaskTypeWorkflow Class

TaskTypeWorkflow Constructor

Properties

active Property

created_by Property

created_date Property

id_serverid Property

position_data Property

state_transitions Property

type_id Property

workflow_description Property

workflow_name Property

workflow_states Property

workflow_type Property

Methods

ToString Method

TaskTypeWorkflowState Class

TaskTypeWorkflowState Constructor

Properties

id_serverid Property

position_data Property

state_id Property

state_name Property

unique_id Property

Methods

ToString Method

Fields

description Field

is_resolution Field

TaskUpdate Class

Methods

Fields

new_progress Field

new_state Field

TemporaryFileTransferData Class

Methods

Fields

delete_after Field

path_to_file Field

transfer_guid Field

TimesheetDay Class

Methods

Fields

day_date_utc Field

TimesheetEntry Class

Methods

Fields

attributes Field

contact_id Field

description Field

project_id Field

start_time Field

TransferData Class

Methods

Fields

transfer_guid Field

TransmittalCoverTemplate Class

Methods

Fields

convert_to_pdf Field

project_id Field

TriggerWorkflow Class

TriggerWorkflow Constructor

Properties

active Property

created_by Property

created_date Property

id_serverid Property

owner_id Property

owner_type Property

position_data Property

state_transitions Property

trigger_type Property

workflow_description Property

workflow_name Property

workflow_states Property

workflow_type Property

Methods

ToString Method

TriggerWorkflowState Class

TriggerWorkflowState Constructor

Properties

id_serverid Property

position_data Property

unique_id Property

Methods

ToString Method

Fields

description Field

is_resolution Field

UpdateReferencesData Class

Methods

Fields

change_data Field

references_to_update Field

UploadFileRequest Class

Methods

Fields

client_transfer_id Field

file_change_id Field

file_name Field

file_references Field

file_type Field

folder_id Field

server_transfer_id Field

UserAccessInfo Class

UserAccessInfo Constructor

Properties

Methods

Fields

permissions Field

Properties

Methods

GetHashCode Method

ToString Method

Fields

attributes Field

contact_info Field

is_custom_login Field

is_job_creator Field

is_locked Field

is_sys_admin Field

personal_project_id Field

windows_identity Field

VersionedFileTransferData Class

Methods

Fields

all_known_file_servers Field

create_time Field

file_change_id Field

file_name Field

folder_id Field

folder_path Field

is_read_only Field

num_bytes Field

server_event_id Field

transfer_guid Field

write_time Field

WatchFolder Class

WatchFolder Constructor

Properties

created_by_id Property

created_date Property

custom_attributes Property

default_description Property

duplicate_mode Property

extensions Property

file_server_id Property

folder_id Property

folder_to_watch Property

id_serverid Property

Methods

WebFileDropContact Class

Methods

Fields

contact_info Field

WebFileDropInfo Class

Methods

Fields

allowed_file_extensions Field

attributes Field

close_after_contact_drop Field

create_mode Field

created_by Field

describe_page_id Field

description Field

display_name Field

expiry_date Field

folder_id Field

has_password Field

is_deleted Field

main_page_id Field

max_size_bytes Field

WebFileServerData Class

Methods

Fields

absolute_packaging_path Field

allow_file_publishing Field

allow_web_drops Field

allow_web_server Field

drop_settings Field

external_https_only Field

files_over_web_password_settings Field

http_port Field

https_port Field

internal_port Field

publishing_path Field

show_download_page_as_default Field

thumbprint Field

use_https Field

web_drop_path Field

web_server_address Field

web_server_page_defaults Field

WebServerPageInfo Class

Properties

Default Property

Methods

ToString Method

Fields

is_default Field

WidgetInfo Class

Properties

aggregate_function Property

attribute_id Property

attribute_server_id Property

date_range Property

group_by Property

id_serverid Property

project_scope Property

target_entity Property

value_field Property

Methods

GetAsDictionary Method

GetDataUri Method

GetKeyDescriptor Method

GetKeyDescriptor() Method

GetKeyDescriptor(AttributeInfo) Method

GetTypeName Method

GetValueDescriptor Method

GetValueFormatter Method

Workflow Constructor

Properties

active Property

created_by Property

created_date Property

id_serverid Property

position_data Property

state_transitions Property

workflow_description Property

workflow_name Property

workflow_states Property

workflow_type Property

Methods

ToString Method

WorkflowActivityInfo Class

Properties

activity_category Property

activity_description Property

activity_name Property

target_type Property

Methods

WorkflowAssigneeQueryValue Class

WorkflowAssigneeQueryValue Constructor

WorkflowAssigneeQueryValue() Constructor

WorkflowAssigneeQueryValue(ContactInfo, List<GroupInfo>, List<ProjectRole>) Constructor

Properties

Methods

ToString Method

WorkflowConditionInfo Class

Properties

category Property

description Property

Methods

WorkflowCreateableAttribute Class

WorkflowCreateableAttribute Constructor

Properties

NamespaceSuffix Property

Methods

WorkflowInstanceInfo Class

Properties

assignee_id Property

assignee_type Property

entity_info Property

entity_path Property

is_resolved Property

state_id Property

state_name Property

target_id Property

target_type Property

workflow_id Property

workflow_info Property

workflow_instance_id Property

workflow_name Property

workflow_type Property

Methods

WorkflowNonAttributeCaptureData Class

Methods

Fields

associations Field

property_bytes Field

WorkflowPropertyAttribute Class

WorkflowPropertyAttribute Constructor

WorkflowPropertyAttribute(WorkflowPropertyType, WorkflowPropertyType) Constructor

WorkflowPropertyAttribute(WorkflowPropertyType, WorkflowPropertyType, string) Constructor

Properties

Createable Property

DisplayName Property

Settable Property

Methods

WorkflowPropertyItem Class

Properties

Display Property

Methods

Fields

primitive_value Field

property_id_value Field

property_name Field

type_name Field

WorkflowPropertySerialization Class

Methods

DeserializeWorkflowProperties Method

SerializeWorkflowAssociations Method

SerializeWorkflowProperties Method

WorkflowQueryValue Class

WorkflowQueryValue Constructor

WorkflowQueryValue() Constructor

WorkflowQueryValue(Workflow) Constructor

Properties

Methods

ToString Method

WorkflowScriptInput Class

WorkflowScriptInput Constructor

Properties

HasValue Property

Methods

Fields

description Field

entity_id Field

is_optional Field

workflow_type Field

WorkflowSettableAttribute Class

WorkflowSettableAttribute Constructor

Properties

NamespaceSuffix Property

Methods

WorkflowState Class

WorkflowState Constructor

Properties

id_serverid Property

position_data Property

unique_id Property

Methods

ToString Method

Fields

description Field

is_resolution Field

WorkflowTransition Class

WorkflowTransition Constructor

Properties

activities Property

conditions Property

created_by_id Property

created_date Property

data_capture Property

fail_on_activity_error Property

from_state_guid Property

from_state_id Property

id_serverid Property

position_data Property

to_state_guid Property

to_state_id Property

workflow_id Property

Methods

WorkflowTransitionActivity Class

WorkflowTransitionActivity Constructor

Properties

active Property

activity_data Property

activity_type Property

error_is_critical Property

id_serverid Property

transition_id Property

Methods

WorkflowTransitionAssociationCapture Class

WorkflowTransitionAssociationCapture Constructor

Properties

assoc_default_description Property

assoc_desc Property

assoc_entity_id Property

assoc_entity_type Property

optional Property

transition_id Property

Methods

WorkflowTransitionAttributeCapture Class

Properties

attribute Property

optional Property

transition_id Property

Methods

MapAttributes Method

WorkflowTransitionCondition Class

WorkflowTransitionCondition Constructor

Properties

condition_data Property

condition_type Property

id_serverid Property

is_not Property

transition_id Property

Methods

Fields

WorkflowTransitionDataCapture Class

Properties

optional Property

transition_id Property

Methods

WorkflowTransitionLog Class

Properties

ContactName Property

LocalTime Property

Transition Property

Methods

Fields

description Field

transition_time_utc Field

transitioned_by_id Field

transitioned_by_name Field

WorkflowTransitionPropertyCapture Class

Properties

extra_data Property

optional Property

property_name Property

property_type Property

transition_id Property

Methods

BaseEFEntity Interface

Properties

id_serverid Property

IChangeTrackable Interface

Methods

ToChangeTrackerString Method

IExtensionData Interface

IHasAttributes Interface

Properties

attributes Property

IImportTarget Interface

Properties

ILogger Interface

Methods

LogException Method

LogException(Exception) Method

LogException(string, Exception) Method

LogMessage Method

IMaterialized Interface

Methods

AfterMaterialized Method

IPersistedQueueable Interface

Properties

QueueHash Property

IPublishingNamer Interface

Methods

ISynergyEntity Interface

Properties

ITransferLogger Interface

Methods

LogException Method

LogException(Exception) Method

LogException(string, Exception) Method

LogMessage Method

LogMessage(long, string, LogLevel) Method

LogMessage(string, LogLevel) Method

IWebHook Interface

Methods

CanHandle Method

HandleRequest Method

IWorkflowInstanceDetails Interface

Properties

InstanceID Property

TargetID Property

TargetType Property

Methods

GetEntity<T> Method

GetProjectID Method

GetProperties Method

GetProperty Method

GetTargetPath Method

GetVariables Method

SetActor Method

SetProperty Method

IWorkflowLogger Interface

Methods

LogWorkflow Method

WantsWorkflowLogging Method

AggregateFunction Enumeration

AllowableContactSources Enumeration

AssignedEntityType Enumeration

AttributeMatchOperation Enumeration

AttributeSearchContext Enumeration

AttributeType Enumeration

AttributeYesNo Enumeration

AuthorizationMode Enumeration

ChangeDescriptionType Enumeration

CheckoutOwnerMachine Enumeration

CheckoutType Enumeration

ComparisonFileType Enumeration

ComparisonToolType Enumeration

CompressionLevel Enumeration

ConnectionEventType Enumeration

ConnectorConfigInfoType Enumeration

ConnectorMappingEntityType Enumeration

ConnectorRunType Enumeration

ConverterType Enumeration

DashBoardDefinitionType Enumeration

DataSetType Enumeration

DataTransferMode Enumeration

DateRange Enumeration

DocumentType Enumeration

EmailStampSourceType Enumeration

EmailTemplateCategory Enumeration

EntityIDInputType Enumeration

EntityType Enumeration

EventStatus Enumeration

FileChangeType Enumeration

FilePreviewType Enumeration

FileServerStatisticType Enumeration

FileServerSyncRuleType Enumeration

FileStoreBindingRuleType Enumeration

FileStoreType Enumeration

FileType Enumeration

FlatSearchAttributeType Enumeration

FolderChangeType Enumeration

FolderColumnType Enumeration

FolderProfileMode Enumeration

FolderProfileResetMode Enumeration

FolderSort Enumeration

FolderState Enumeration

FolderType Enumeration

GeocodeProviderType Enumeration

GroupByField Enumeration

IssueActionType Enumeration

IssueSendMode Enumeration

LicenseModule Enumeration

LimitTableContent Enumeration

LogLevel Enumeration

MapLayerType Enumeration

NamingRuleSetMode Enumeration

NoteMode Enumeration

NoteTarget Enumeration

OutlookTemplateType Enumeration

PermissionType Enumeration

PreviewState Enumeration

PrimitiveReportInputType Enumeration

PrimitiveScriptInputType Enumeration

Product Enumeration

ProjectNamingRuleComponentType Enumeration

ProjectScope Enumeration

ProjectType Enumeration

PublishedFilePackageType Enumeration

PublishedFileType Enumeration

ReceiptOptions Enumeration

ReferenceMode Enumeration

RelatedFileType Enumeration

RelationalOperatorType Enumeration

RemindDeltaType Enumeration

ReportDeliveryMode Enumeration

ReportScheduleFrequency Enumeration

RoleAccessEntity Enumeration

RoleAccessType Enumeration

SearchLimitOption Enumeration

ServerTaskLogLevel Enumeration

ServiceMode Enumeration

SimpleReportType Enumeration

TDConnectionContext Enumeration

TDCustomisationMode Enumeration

TDElementType Enumeration

TDProjectChangeType Enumeration

TDProjectMapFileMode Enumeration

TDProjectType Enumeration

TDProjectVersion Enumeration

TargetEntity Enumeration

TaskActionMode Enumeration

TaskActionOwnerType Enumeration

TaskActionType Enumeration

TaskCCType Enumeration

TaskClosureStatus Enumeration

TaskDateMode Enumeration

TaskPriority Enumeration

TaskRecurrencePattern Enumeration

TaskReminderType Enumeration

TransitionPropertyCaptureType Enumeration

TriggerType Enumeration

UserNotificationEventType Enumeration

ValueField Enumeration

WatchFolderDuplicateMode Enumeration

WebFileDropCreateMode Enumeration

WidgetType Enumeration

WorkflowActivityTarget Enumeration

WorkflowDataCaptureType Enumeration

WorkflowPropertyType Enumeration

WorkflowType Enumeration

Contracts.Data.Geocoding Namespace

GeocodeParameters Class

Properties

Address Property

AddressString Property

minimum_score_for_arcgis Property

Methods

GeocodeValidationResult Class

Properties

CorrectAddress Property

Exists Property

Methods

GeocodingResult Class

Properties

Status Property

Methods

ParsedAddress Class

Properties

Country Property

FullAddressString Property

StreetName Property

StreetType Property

Suburb Property

Methods

ToString Method

Fields

StreetNumber Field

ValidationStatus Enumeration

Contracts.Data.ImportModel Namespace

Properties

Address1 Property

Address2 Property

Country Property

Latitude Property

Longitude Property

PostCode Property

Suburb Property

Methods

Association Class

Properties

AssociatedEntity Property

Description Property

Methods

Attribute Class

Attribute Constructor

Properties

AttributeID Property

Methods

AttributeEntity Class

AttributeEntity Constructor

Properties

DisplayName Property

Identity Property

ImportMode Property

IncludedInTestMode Property

Methods

IdentifyByProperty Method

IsRequired<T> Method

ToString Method

Validate Method

ValidateRequiredFields Method

AttributeIdentity Class

AttributeIdentity Constructor

Properties

Attribute Property

UniqueID Property

Methods

AttributeList Class

AttributeList Constructor

Methods

GetEnumerator Method

AttributedImportEntity Class

AttributedImportEntity Constructor

Properties

Attributes Property

Identity Property

ImportMode Property

IncludedInTestMode Property

Methods

DoValidate Method

IsRequired<T> Method

ToString Method

Validate Method

ValidateRequiredFields Method

Company Constructor

Properties

Active Property

Associations Property

Attributes Property

Identity Property

ImportMode Property

IncludedInTestMode Property

StaffContacts Property

Methods

DoValidate Method

IdentifyByAttribute Method

IdentifyByProperty Method

IsRequired<T> Method

ToString Method

Validate Method

ValidateRequiredFields Method

Contact Constructor

Properties

Associations Property

Attributes Property

FirstName Property

Identity Property

ImportMode Property

IncludedInTestMode Property

LastName Property

Methods

DoValidate Method

IdentifyByAttribute Method

IdentifyByEntityID Method

IdentifyByProperty Method

IsRequired<T> Method

ToString Method

Validate Method

ValidateRequiredFields Method

EntityIDIdentity Class

EntityIDIdentity Constructor

Properties

EntityID Property

UniqueID Property

Methods

EnumAttributeEntity Class

EnumAttributeEntity Constructor

Properties

DisplayName Property

Identity Property

ImportMode Property

IncludedInTestMode Property

Methods

IdentifyByProperty Method

IsRequired<T> Method

ToString Method

Validate Method

ValidateRequiredFields Method

EnumItem Constructor

Properties

DisplayName Property

Identity Property

ImportMode Property

IncludedInTestMode Property

Methods

IdentifyByProperty Method

IsRequired<T> Method

ToString Method

Validate Method

ValidateRequiredFields Method

EnumValue Class

Properties

enum_id Property

string_value Property

Methods

Extensions Class

Methods

File Class

File Constructor

Properties

Associations Property

Attributes Property

CreatedDateUtc Property

DeleteAfterImport Property

Identity Property

ImportMode Property

ImportPath Property

IncludedInTestMode Property

Methods

DoValidate Method

IdentifyByAttribute Method

IdentifyByProperty Method

IsRequired<T> Method

ToString Method

Validate Method

ValidateRequiredFields Method

Folder Constructor

Properties

Associations Property

Attributes Property

Folders Property

Identity Property

ImportMode Property

IncludedInTestMode Property

Methods

DoValidate Method

IdentifyByAttribute Method

IsRequired<T> Method

ToString Method

Validate Method

ValidateRequiredFields Method

ImportEntity Class

ImportEntity Constructor

Properties

Identity Property

ImportMode Property

IncludedInTestMode Property

Methods

IsRequired<T> Method

ToString Method

Validate Method

ValidateRequiredFields Method

ImportResults Class

ImportResults Constructor

Properties

errors_by_type Property

new_entities_by_type Property

no_changes_entities_by_type Property

total_errors Property

total_imports Property

total_new Property

total_no_changes Property

total_updated Property

updated_entities_by_type Property

Methods

AddError Method

DecrementNewEntities Method

DecrementUpdatedEntities Method

GetErrorsOfType Method

GetImportsOfType Method

IncrementNewEntities Method

IncrementNoChangesEntities Method

IncrementUpdatedEntities Method

ToString Method

ModelRoot Class

ModelRoot Constructor

ModelRoot() Constructor

ModelRoot(IEnumerable<Project>, IEnumerable<Contact>, IEnumerable<Company>) Constructor

Properties

Attributes Property

Companies Property

Contacts Property

IsTestMode Property

Projects Property

Methods

MultipleIdentity Class

MultipleIdentity Constructor

Properties

Identities Property

UniqueID Property

Methods

Project Constructor

Properties

Associations Property

Attributes Property

Description Property

Folders Property

Identity Property

ImportMode Property

IncludedInTestMode Property

ParentProject Property

Methods

DoValidate Method

IdentifyByAttribute Method

IdentifyByEntityID Method

IdentifyByProperty Method

IsRequired<T> Method

ToString Method

Validate Method

ValidateRequiredFields Method

ProjectNote Class

ProjectNote Constructor

Properties

CreatedDate Property

ExternalID Property

Identity Property

ImportMode Property

IncludedInTestMode Property

Subject Property

Methods

IdentifyByProperty Method

IsRequired<T> Method

ToString Method

Validate Method

ValidateRequiredFields Method

PropertyIdentity Class

PropertyIdentity Constructor

Properties

PropertyName Property

UniqueID Property

Methods

Task Class

Task Constructor

Properties

Assignee Property

Associations Property

Attributes Property

CreatedBy Property

Description Property

DueDate Property

Identity Property

ImportMode Property

IncludedInTestMode Property

Priority Property

Progress Property

StartDate Property

TaskTypeName Property

Methods

DoValidate Method

IdentifyByAttribute Method

IsRequired<T> Method

ToString Method

Validate Method

ValidateRequiredFields Method

TaskState Class

TaskState Constructor

Properties

Attributes Property

Identity Property

ImportMode Property

IncludedInTestMode Property

IsClosure Property

SortOrder Property

TaskTypeName Property

Methods

DoValidate Method

IdentifyByEntityID Method

IdentifyByProperty Method

IsRequired<T> Method

ToString Method

Validate Method

ValidateRequiredFields Method

IAssociable Interface

Properties

Associations Property

IAttribute Interface

Properties

AttributeID Property

IIdentifyByAttribute Interface

Methods

IdentifyByAttribute Method

IIdentifyByEntityID Interface

Methods

IdentifyByEntityID Method

IIdentifyByProperty Interface

Methods

IdentifyByProperty Method

IIdentity Interface

Properties

UniqueID Property

ImportMode Enumeration

Contracts.Data.Reporting Namespace

IssueFileReportData Class

Properties

Issue_Action Property

Issue_Date Property

Issue_Set_Name Property

Issue_Set_Type_Name Property

Issue_Set_Version Property

Issued_To_First_Name Property

Issued_To_Last_Name Property

contact_id Property

issue_set_id Property

job_id Property

project_name Property

Methods

Contracts.Databases Namespace

ByteDBParameter Class

ByteDBParameter Constructor

Properties

Methods

Fields

DBParameter Class

DBParameter Constructor

Properties

Methods

StringDBParameter Class

StringDBParameter Constructor

Properties

Methods

IDBCommand Interface

Methods

AddEntityParameter Method

AddParameter Method

AddParameter(object) Method

AddParameter(string, object) Method

AddParameters Method

ExecuteNonQuery Method

ExecuteReader Method

ExecuteScalar Method

SelectAll<T> Method

SetTimeout Method

IDBIdentityInsert Interface

IDBReader Interface

Methods

GetBoolean Method

GetBoolean(int) Method

GetBoolean(string) Method

GetByte(int) Method

GetByte(string) Method

GetColumn Method

GetColumnName Method

GetColumnType Method

GetDateTime Method

GetDateTime(int) Method

GetDateTime(string) Method

GetDouble Method

GetDouble(int) Method

GetDouble(string) Method

GetEntityID Method

GetEntityID(ref int, Func<Int32Guid>) Method

GetEntityID(string, Func<Int32Guid>) Method

GetGuid(int) Method

GetGuid(string) Method

GetInt16 Method

GetInt16(int) Method

GetInt16(string) Method

GetInt32 Method

GetInt32(int) Method

GetInt32(string) Method

GetInt64 Method

GetInt64(int) Method

GetInt64(string) Method

GetNullableString Method

GetNullableString(int) Method

GetNullableString(string) Method

GetNumberOfColumns Method

GetString Method

GetString(int) Method

GetString(string) Method

GetValue Method

GetValue(int) Method

GetValue(string) Method

IsDBNull Method

IsDBNull(int) Method

IsDBNull(string) Method

SelectAll<T> Method

IDatabase Interface

Properties

Connection Property

Transaction Property

TransactionID Property

Methods

AddEntityParameters Method

AddInfoMessageEventHandler Method

AllowIdentityInsert Method

CommitChanges Method

CreateCommand Method

CreateInsertAdapter Method

CreateSelectAdapter Method

ExportToCESQL Method

GetLastInsertedID Method

OnCommit Method

OnRollback Method

RegisterOnCommitHandler Method

RegisterOnRollbackHandler Method

RollbackChanges Method

StartNewTransaction Method

Contracts.Responses Namespace

AttributeExtensionResponse Class

AttributeExtensionResponse Constructor

AttributeExtensionResponse(long) Constructor

AttributeExtensionResponse(long, OperationResponseLevel, string) Constructor

Properties

Attributes Property

EventID Property

IsException Property

Message Property

ServerEventID Property

Methods

ErrorWithData<T> Method

ToString Method

AttributeSearchResponse Class

AttributeSearchResponse Constructor

AttributeSearchResponse(long) Constructor

AttributeSearchResponse(long, OperationResponseLevel, string) Constructor

Properties

Attributes Property

EventID Property

IsException Property

Message Property

ServerEventID Property

Methods

ErrorWithData<T> Method

ToString Method

AttributesResponse Class

AttributesResponse Constructor

AttributesResponse(OperationResponseLevel, string) Constructor

AttributesResponse(long) Constructor

AttributesResponse(long, OperationResponseLevel, string) Constructor

Properties

Attributes Property

EventID Property

IsException Property

Message Property

ServerEventID Property

Methods

ErrorWithData<T> Method

ToString Method

AuthorizationModeResponse Class

AuthorizationModeResponse Constructor

AuthorizationModeResponse(AuthorizationMode) Constructor

AuthorizationModeResponse(string) Constructor

Properties

EventID Property

IsException Property

Message Property

ServerEventID Property

Methods

ErrorWithData<T> Method

ToString Method

ByteDataResponse Class

ByteDataResponse Constructor

ByteDataResponse(byte[]) Constructor

ByteDataResponse(string) Constructor

Properties

EventID Property

IsException Property

Message Property

ServerEventID Property

Methods

ErrorWithData<T> Method

ToString Method

CategoryInfoListResponse Class

CategoryInfoListResponse Constructor

CategoryInfoListResponse(long, string) Constructor

CategoryInfoListResponse(long) Constructor

CategoryInfoListResponse(string) Constructor

Properties

Categories Property

EventID Property

IsException Property

Message Property

ServerEventID Property

Methods

ErrorWithData<T> Method

ToString Method

CategoryInfoResponse Class

CategoryInfoResponse Constructor

CategoryInfoResponse(long, string) Constructor

CategoryInfoResponse(long, CategoryInfo) Constructor

CategoryInfoResponse(string) Constructor

Properties

Category Property

EventID Property

IsException Property

Message Property

ServerEventID Property

Methods

ErrorWithData<T> Method

ToString Method

CheckoutFileResponse Class

CheckoutFileResponse Constructor

CheckoutFileResponse(EntityID, CheckOutInfo, FileInfo, long) Constructor

CheckoutFileResponse(string) Constructor

Properties

CheckoutInfo Property

EventID Property

FileID Property

FileInfo Property

IsException Property

Message Property

ServerEventID Property

Methods

ErrorWithData<T> Method

ToString Method

CompanyInfoListResponse Class

CompanyInfoListResponse Constructor

CompanyInfoListResponse(List<CompanyInfo>) Constructor

CompanyInfoListResponse(List<CompanyInfo>, long) Constructor

CompanyInfoListResponse(OperationResponseLevel, string) Constructor

Properties

Companies Property

EventID Property

IsException Property

Message Property

ServerEventID Property

TotalToSend Property

Methods

ErrorWithData<T> Method

ToString Method

ConnectToProjectResponse Class

ConnectToProjectResponse Constructor

ConnectToProjectResponse(EntityID) Constructor

ConnectToProjectResponse(OperationResponseLevel, string) Constructor

Properties

EventID Property

IsException Property

Message Property

ProjectID Property

ServerEventID Property

Methods

ErrorWithData<T> Method

ToString Method

ConnectToURIFolderResponse Class

ConnectToURIFolderResponse Constructor

ConnectToURIFolderResponse() Constructor

ConnectToURIFolderResponse(string) Constructor

Properties

EventID Property

IsException Property

Message Property

ServerEventID Property

Methods

ErrorWithData<T> Method

ToString Method

Fields

folder_id Field

proj_info Field

ConnectToURIResponse Class

ConnectToURIResponse Constructor

ConnectToURIResponse() Constructor

ConnectToURIResponse(string) Constructor

Properties

EventID Property

IsException Property

Message Property

ServerEventID Property

Methods

ErrorWithData<T> Method

ToString Method

Fields

folder_id Field

proj_info Field

td_project_id Field

ContactInfoListResponse Class

ContactInfoListResponse Constructor

ContactInfoListResponse(List<ContactInfo>) Constructor

ContactInfoListResponse(List<ContactInfo>, long) Constructor

ContactInfoListResponse(OperationResponseLevel, string) Constructor

Properties

Contacts Property

EventID Property

IsException Property

Message Property

ServerEventID Property

TotalToSend Property

Methods

ErrorWithData<T> Method

ToString Method

DataDictionaryResponse Class

DataDictionaryResponse Constructor

DataDictionaryResponse() Constructor

DataDictionaryResponse(Dictionary<StringString>) Constructor

DataDictionaryResponse(OperationResponseLevel, string) Constructor

DataDictionaryResponse(string) Constructor

Properties

EventID Property

IsException Property

Message Property

ServerEventID Property

Methods

ErrorWithData<T> Method

GetNumberOfKeys Method

GetValue Method

SetValue Method

ToString Method

DataOperationResponse<T> Class

DataOperationResponse<T> Constructor

DataOperationResponse(OperationResponseLevel, string) Constructor

DataOperationResponse(T) Constructor

DataOperationResponse(T, long) Constructor

DataOperationResponse(long) Constructor

DataOperationResponse(string) Constructor

DataOperationResponse(string, long) Constructor

Properties

EventID Property

IsException Property

Message Property

ServerEventID Property

Methods

ErrorWithData<T> Method

ToString Method

Fields

DataOperationResponse.data Field

EntityIDListResponse Class

EntityIDListResponse Constructor

EntityIDListResponse(int, string) Constructor

EntityIDListResponse(long) Constructor

EntityIDListResponse(string) Constructor

Properties

EntityIDs Property

EventID Property

IsException Property

Message Property

ServerEventID Property

Methods

ErrorWithData<T> Method

ToString Method

EntityIDResponse Class

EntityIDResponse Constructor

EntityIDResponse(int, string) Constructor

EntityIDResponse(long) Constructor

EntityIDResponse(long, EntityID) Constructor

EntityIDResponse(string) Constructor

Properties

EntityID Property

EventID Property

IsException Property

Message Property

ServerEventID Property

Methods

ErrorWithData<T> Method

ToString Method

EventStatusResponse Class

EventStatusResponse Constructor

Properties

EventID Property

IsException Property

Message Property

ServerEventID Property

Methods

ErrorWithData<T> Method

ToString Method

Fields

ExtensionResponse Class

ExtensionResponse Constructor

ExtensionResponse() Constructor

ExtensionResponse(string) Constructor

Properties

CustomResponse Property

EventID Property

ExtensionID Property

IsException Property

Message Property

ServerEventID Property

Methods

ErrorWithData<T> Method

ToString Method

FileHistoryResponse Class

FileHistoryResponse Constructor

FileHistoryResponse(IEnumerable<FileHistory>, IEnumerable<AttributeInfo>, IEnumerable<AttributeInfo>) Constructor

FileHistoryResponse(OperationResponseLevel, string) Constructor

Properties

ChangeAttributeInfos Property

EventID Property

FileAttributeInfos Property

History Property

IsException Property

Message Property

ServerEventID Property

Methods

ErrorWithData<T> Method

ToString Method

FileInfoListResponse Class

FileInfoListResponse Constructor

FileInfoListResponse(long) Constructor

FileInfoListResponse(long, OperationResponseLevel, string) Constructor

FileInfoListResponse(string) Constructor

Properties

EventID Property

IsException Property

Message Property

ServerEventID Property

TotalToSend Property

Methods

ErrorWithData<T> Method

ToString Method

FileInfoResponse Class

FileInfoResponse Constructor

FileInfoResponse(FileInfo, long) Constructor

FileInfoResponse(long, OperationResponseLevel, string) Constructor

FileInfoResponse(string) Constructor

Properties

EventID Property

FileInfo Property

IsException Property

Message Property

ServerEventID Property

Methods

ErrorWithData<T> Method

ToString Method

FilePlaceHoldersResponse Class

FilePlaceHoldersResponse Constructor

Properties

EventID Property

IsException Property

Message Property

ServerEventID Property

Methods

ErrorWithData<T> Method

ToString Method

Fields

found_place_holders Field

replacements Field

unresolved_attribs Field

FilePreviewResponse Class

FilePreviewResponse Constructor

FilePreviewResponse(long, EntityID, int) Constructor

FilePreviewResponse(long, EntityID, int, FilePreviewType) Constructor

FilePreviewResponse(long, string) Constructor

Properties

EventID Property

FileID Property

IsException Property

Message Property

ServerEventID Property

Version Property

Methods

ErrorWithData<T> Method

ToString Method

Fields

local_preview_file Field

FileStoreInfoResponse Class

FileStoreInfoResponse Constructor

FileStoreInfoResponse() Constructor

FileStoreInfoResponse(OperationResponseLevel, string) Constructor

FileStoreInfoResponse(string) Constructor

Properties

EventID Property

FileStores Property

IsException Property

Message Property

ServerEventID Property

Methods

ErrorWithData<T> Method

ToString Method

ForumCategoryResponse Class

ForumCategoryResponse Constructor

ForumCategoryResponse(List<ForumCategory>) Constructor

ForumCategoryResponse(List<ForumCategory>, long) Constructor

ForumCategoryResponse(string) Constructor

Properties

Categories Property

EventID Property

IsException Property

Message Property

ServerEventID Property

Methods

ErrorWithData<T> Method

ToString Method

ForumPostResponse Class

ForumPostResponse Constructor

ForumPostResponse(List<ForumPost>) Constructor

ForumPostResponse(List<ForumPost>, long) Constructor

ForumPostResponse(string) Constructor

Properties

EventID Property

IsException Property

Message Property

ServerEventID Property

Methods

ErrorWithData<T> Method

ToString Method

ForumTopicResponse Class

ForumTopicResponse Constructor

ForumTopicResponse(List<ForumTopic>) Constructor

ForumTopicResponse(List<ForumTopic>, long) Constructor

ForumTopicResponse(string) Constructor

Properties

EventID Property

IsException Property

Message Property

ServerEventID Property

Topics Property

Methods

ErrorWithData<T> Method

ToString Method

GroupInfoAccessListResponse Class

GroupInfoAccessListResponse Constructor

GroupInfoAccessListResponse(List<GroupAccessInfo>) Constructor

GroupInfoAccessListResponse(OperationResponseLevel, string) Constructor

GroupInfoAccessListResponse(string) Constructor

Properties

EventID Property

Groups Property

IsException Property

Message Property

ServerEventID Property

Methods

ErrorWithData<T> Method

ToString Method

GroupInfoListResponse Class

GroupInfoListResponse Constructor

GroupInfoListResponse(List<GroupInfo>) Constructor

GroupInfoListResponse(List<GroupInfo>, long) Constructor

GroupInfoListResponse(OperationResponseLevel, string) Constructor

Properties

EventID Property

Groups Property

IsException Property

Message Property

ServerEventID Property

Methods

ErrorWithData<T> Method

ToString Method

ManagedProjectFolderResponse Class

ManagedProjectFolderResponse Constructor

ManagedProjectFolderResponse(OperationResponseLevel, string) Constructor

ManagedProjectFolderResponse(ProjectFolder, int) Constructor

ManagedProjectFolderResponse(long, OperationResponseLevel, string) Constructor

ManagedProjectFolderResponse(long, ProjectFolder, int) Constructor

Properties

EventID Property

Folder Property

IsException Property

Message Property

ServerEventID Property

Version Property

Methods

ErrorWithData<T> Method

ToString Method

NamingRuleSetResponse Class

NamingRuleSetResponse Constructor

NamingRuleSetResponse() Constructor

NamingRuleSetResponse(List<NamingRuleSet>) Constructor

NamingRuleSetResponse(long, string) Constructor

NamingRuleSetResponse(long, string, List<NamingRuleSet>) Constructor

NamingRuleSetResponse(string) Constructor

Properties

EventID Property

IsException Property

Message Property

RuleSets Property

ServerEventID Property

Methods

ErrorWithData<T> Method

ToString Method

Fields

rule_found Field

NoteHeaderResponse Class

NoteHeaderResponse Constructor

NoteHeaderResponse(List<NoteHeader>) Constructor

NoteHeaderResponse(OperationResponseLevel, string) Constructor

NoteHeaderResponse(long, List<NoteHeader>) Constructor

NoteHeaderResponse(long, string) Constructor

Properties

EventID Property

Headers Property

IsException Property

Message Property

ServerEventID Property

Methods

ErrorWithData<T> Method

ToString Method

OperationCancelledResponse Class

OperationCancelledResponse Constructor

OperationCancelledResponse(long) Constructor

OperationCancelledResponse(long, string) Constructor

Properties

EventID Property

IsException Property

Message Property

ServerEventID Property

Methods

ErrorWithData<T> Method

ToString Method

OperationResponse Class

OperationResponse Constructor

OperationResponse() Constructor

OperationResponse(OperationResponseLevel, string) Constructor

OperationResponse(long) Constructor

OperationResponse(long, OperationResponseLevel, string) Constructor

Properties

EventID Property

IsException Property

Message Property

ServerEventID Property

Methods

ErrorWithData<T> Method

ToString Method

OperationResponseList Class

OperationResponseList Constructor

Properties

EventID Property

IsException Property

Message Property

Responses Property

ServerEventID Property

Methods

ErrorWithData<T> Method

ToString Method

PopularAttributesResponse Class

PopularAttributesResponse Constructor

Properties

EventID Property

IsException Property

Message Property

ServerEventID Property

Methods

ErrorWithData<T> Method

ToString Method

Fields

attrib_ids Field

change_ids Field

ProcessNameResponse Class

ProcessNameResponse Constructor

ProcessNameResponse(List<NamingRuleSet>, ProcessNameResult) Constructor

ProcessNameResponse(List<NamingRuleSet>, ProcessNameResult, string) Constructor

ProcessNameResponse(ProcessNameResult) Constructor

ProcessNameResponse(string) Constructor

Properties

EventID Property

FinalName Property

IsException Property

MatchedRule Property

Message Property

Result Property

RuleSets Property

ServerEventID Property

Methods

ErrorWithData<T> Method

ToString Method

Fields

_rule_sets Field

ProjectCreateResponse Class

ProjectCreateResponse Constructor

Properties

EventID Property

IsException Property

Message Property

ServerEventID Property

Methods

ErrorWithData<T> Method

ToString Method

Fields

project_id Field

ProjectFolderResponse Class

ProjectFolderResponse Constructor

ProjectFolderResponse(List<ProjectFolder>) Constructor

ProjectFolderResponse(OperationResponseLevel, string) Constructor

ProjectFolderResponse(long, List<ProjectFolder>) Constructor

ProjectFolderResponse(long, OperationResponseLevel, string) Constructor

Properties

EventID Property

IsException Property

Message Property

ProjectFolders Property

ServerEventID Property

Methods

ErrorWithData<T> Method

ToString Method

ProjectInfoResponse Class

ProjectInfoResponse Constructor

ProjectInfoResponse(List<ProjectInfo>) Constructor

ProjectInfoResponse(OperationResponseLevel, string) Constructor

ProjectInfoResponse(ProjectInfo) Constructor

Properties

EventID Property

IsException Property

Message Property

ProjectInfo Property

ServerEventID Property

Methods

ErrorWithData<T> Method

ToString Method

ReportDataResponse Class

ReportDataResponse Constructor

ReportDataResponse(List<ServerReport>) Constructor

ReportDataResponse(string) Constructor

Properties

EventID Property

IsException Property

Message Property

Reports Property

ServerEventID Property

Methods

ErrorWithData<T> Method

ToString Method

ReportLibraryInfoResponse Class

ReportLibraryInfoResponse Constructor

ReportLibraryInfoResponse(List<ServerReportLibrary>) Constructor

ReportLibraryInfoResponse(string) Constructor

Properties

EventID Property

IsException Property

Message Property

Reports Property

ServerEventID Property

Methods

ErrorWithData<T> Method

ToString Method

ScriptInfoResponse Class

ScriptInfoResponse Constructor

ScriptInfoResponse(List<ServerScriptLibrary>) Constructor

ScriptInfoResponse(string) Constructor

Properties

EventID Property

IsException Property

Message Property

Scripts Property

ServerEventID Property

Methods

ErrorWithData<T> Method

ToString Method

ScriptInputsResponse Class

ScriptInputsResponse Constructor

ScriptInputsResponse(IEnumerable<ScriptInput>) Constructor

ScriptInputsResponse(string) Constructor

Properties

EventID Property

Inputs Property

IsException Property

Message Property

ServerEventID Property

Methods

ErrorWithData<T> Method

ToString Method

TDElementListResponse Class

TDElementListResponse Constructor

TDElementListResponse(IEnumerable<TDElement>) Constructor

TDElementListResponse(string) Constructor

Properties

Elements Property

EventID Property

IsException Property

Message Property

ServerEventID Property

Methods

ErrorWithData<T> Method

ToString Method

TDProjectInfoListResponse Class

TDProjectInfoListResponse Constructor

TDProjectInfoListResponse(List<TDProjectInfo>) Constructor

TDProjectInfoListResponse(OperationResponseLevel, string) Constructor

Properties

EventID Property

IsException Property

Message Property

Projects Property

ServerEventID Property

Methods

ErrorWithData<T> Method

ToString Method

TDProjectInfoResponse Class

TDProjectInfoResponse Constructor

TDProjectInfoResponse(OperationResponseLevel, string) Constructor

TDProjectInfoResponse(TDProjectInfo) Constructor

TDProjectInfoResponse(long, TDProjectInfo) Constructor

Properties

EventID Property

IsException Property

Message Property

ProjectInfo Property

ServerEventID Property

Methods

ErrorWithData<T> Method

ToString Method

TaskLibraryInfoResponse Class

TaskLibraryInfoResponse Constructor

TaskLibraryInfoResponse(List<ServerTaskLibrary>) Constructor

TaskLibraryInfoResponse(string) Constructor

Properties

EventID Property

IsException Property

Message Property

ServerEventID Property

Methods

ErrorWithData<T> Method

ToString Method

TaskResponse Class

TaskResponse Constructor

TaskResponse(List<TaskItem>, long) Constructor

TaskResponse(long, string) Constructor

TaskResponse(string) Constructor

Properties

EventID Property

IsException Property

Message Property

ServerEventID Property

Methods

ErrorWithData<T> Method

ToString Method

TaskSearchResponse Class

TaskSearchResponse Constructor

TaskSearchResponse(long) Constructor

TaskSearchResponse(long, string) Constructor

Properties

EventID Property

IsException Property

Message Property

ServerEventID Property

Methods

ErrorWithData<T> Method

ToString Method

Fields

res_nodes Field

TextOperationResponse Class

TextOperationResponse Constructor

TextOperationResponse(OperationResponseLevel, string) Constructor

TextOperationResponse(long, OperationResponseLevel, string) Constructor

TextOperationResponse(string) Constructor

TextOperationResponse(string, long) Constructor

Properties

EventID Property

IsException Property

Message Property

ServerEventID Property

Methods

ErrorWithData<T> Method

ToString Method

UserInfoAccessListResponse Class

UserInfoAccessListResponse Constructor

UserInfoAccessListResponse(List<UserAccessInfo>) Constructor

UserInfoAccessListResponse(OperationResponseLevel, string) Constructor

UserInfoAccessListResponse(string) Constructor

Properties

EventID Property

IsException Property

Message Property

ServerEventID Property

Methods

ErrorWithData<T> Method

ToString Method

UserInfoListResponse Class

UserInfoListResponse Constructor

UserInfoListResponse(List<UserInfo>) Constructor

UserInfoListResponse(List<UserInfo>, long) Constructor

UserInfoListResponse(OperationResponseLevel, string) Constructor

Properties

EventID Property

IsException Property

Message Property

ServerEventID Property

Methods

ErrorWithData<T> Method

ToString Method

UsernameAuthorizationFailedResponse Class

UsernameAuthorizationFailedResponse Constructor

Properties

EventID Property

IsException Property

Message Property

ServerEventID Property

Methods

ErrorWithData<T> Method

ToString Method

OperationResponseLevel Enumeration

ProcessNameResult Enumeration

Command Line Tool