Interface IProject

Namespace: Sdl.ProjectAutomation.Core

Assembly: Sdl.ProjectAutomation.Core.dll

Syntax

public interface IProject

Methods

AddBilingualReferenceFile(BilingualFileMapping)

Declaration

void AddBilingualReferenceFile(BilingualFileMapping mapping)

Parameters

Type	Name	Description
BilingualFileMapping	mapping

AddBilingualReferenceFiles(BilingualFileMapping[])

Declaration

void AddBilingualReferenceFiles(BilingualFileMapping[] mappings)

Parameters

Type	Name	Description
BilingualFileMapping[]	mappings

AddFiles(String[])

Declaration

ProjectFile[] AddFiles(string[] filePaths)

Parameters

Type	Name	Description
System.String[]	filePaths

Returns

Type	Description
ProjectFile[]

AddFiles(String[], String)

Declaration

ProjectFile[] AddFiles(string[] filePaths, string folderPathInProject)

Parameters

Type	Name	Description
System.String[]	filePaths
System.String	folderPathInProject

Returns

Type	Description
ProjectFile[]

AddFolderWithFiles(String, Boolean)

Declaration

ProjectFile[] AddFolderWithFiles(string localFolderPath, bool recursive)

Parameters

Type	Name	Description
System.String	localFolderPath
System.Boolean	recursive

Returns

Type	Description
ProjectFile[]

AddFolderWithFiles(String, String, Boolean)

Declaration

ProjectFile[] AddFolderWithFiles(string localFolderPath, string folderPathInProject, bool recursive)

Parameters

Type	Name	Description
System.String	localFolderPath
System.String	folderPathInProject
System.Boolean	recursive

Returns

Type	Description
ProjectFile[]

AddNewFileVersion(Guid, String)

Declaration

void AddNewFileVersion(Guid projectFileId, string filePath)

Parameters

Type	Name	Description
System.Guid	projectFileId
System.String	filePath

CreateManualTask(String, String, DateTime, TaskFileInfo[])

Declaration

ManualTask CreateManualTask(string manualTaskName, string assignToUser, DateTime dueDate, TaskFileInfo[] inputFiles)

Parameters

Type	Name	Description
System.String	manualTaskName
System.String	assignToUser
System.DateTime	dueDate
TaskFileInfo[]	inputFiles

Returns

Type	Description
ManualTask

CreateManualTask(String, String, DateTime, Guid[])

Declaration

ManualTask CreateManualTask(string manualTaskName, string assignToUser, DateTime dueDate, Guid[] projectFileIds)

Parameters

Type	Name	Description
System.String	manualTaskName
System.String	assignToUser
System.DateTime	dueDate
System.Guid[]	projectFileIds

Returns

Type	Description
ManualTask

CreateMergedProjectFile(String, String, Guid[])

Declaration

MergedProjectFile CreateMergedProjectFile(string mergedFileName, string folderPathInProject, Guid[] projectFileIds)

Parameters

Type	Name	Description
System.String	mergedFileName
System.String	folderPathInProject
System.Guid[]	projectFileIds

Returns

Type	Description
MergedProjectFile

CreateProjectPackage(Guid, String, String, ProjectPackageCreationOptions)

Declaration

ProjectPackageCreation CreateProjectPackage(Guid manualTaskId, string packageName, string comment, ProjectPackageCreationOptions options)

Parameters

Type	Name	Description
System.Guid	manualTaskId
System.String	packageName
System.String	comment
ProjectPackageCreationOptions	options

Returns

Type	Description
ProjectPackageCreation

CreateProjectPackage(Guid, String, String, ProjectPackageCreationOptions, EventHandler<ProgressEventArgs>, EventHandler<MessageEventArgs>)

Declaration

ProjectPackageCreation CreateProjectPackage(Guid manualTaskId, string packageName, string comment, ProjectPackageCreationOptions options, EventHandler<ProgressEventArgs> statusEventHandler, EventHandler<MessageEventArgs> messageEventHandler)

Parameters

Type	Name	Description
System.Guid	manualTaskId
System.String	packageName
System.String	comment
ProjectPackageCreationOptions	options
System.EventHandler<ProgressEventArgs>	statusEventHandler
System.EventHandler<MessageEventArgs>	messageEventHandler

Returns

Type	Description
ProjectPackageCreation

CreateReturnPackage(Guid[], String, String)

Declaration

ReturnPackageCreation CreateReturnPackage(Guid[] projectFileIds, string packageName, string comment)

Parameters

Type	Name	Description
System.Guid[]	projectFileIds
System.String	packageName
System.String	comment

Returns

Type	Description
ReturnPackageCreation

CreateReturnPackage(Guid[], String, String, EventHandler<ProgressEventArgs>, EventHandler<MessageEventArgs>)

Declaration

ReturnPackageCreation CreateReturnPackage(Guid[] projectFileIds, string packageName, string comment, EventHandler<ProgressEventArgs> statusEventHandler, EventHandler<MessageEventArgs> messageEventHandler)

Parameters

Type	Name	Description
System.Guid[]	projectFileIds
System.String	packageName
System.String	comment
System.EventHandler<ProgressEventArgs>	statusEventHandler
System.EventHandler<MessageEventArgs>	messageEventHandler

Returns

Type	Description
ReturnPackageCreation

GetAutomaticTask(Guid)

Declaration

AutomaticTask GetAutomaticTask(Guid automaticTaskId)

Parameters

Type	Name	Description
System.Guid	automaticTaskId

Returns

Type	Description
AutomaticTask

GetFile(Guid)

Declaration

ProjectFile GetFile(Guid projectFileId)

Parameters

Type	Name	Description
System.Guid	projectFileId

Returns

Type	Description
ProjectFile

GetManualTask(Guid)

Declaration

ManualTask GetManualTask(Guid manualTaskId)

Parameters

Type	Name	Description
System.Guid	manualTaskId

Returns

Type	Description
ManualTask

GetProjectInfo()

Declaration

ProjectInfo GetProjectInfo()

Returns

Type	Description
ProjectInfo

GetProjectStatistics()

Declaration

ProjectStatistics GetProjectStatistics()

Returns

Type	Description
ProjectStatistics

GetSettings()

Declaration

ISettingsBundle GetSettings()

Returns

Type	Description
ISettingsBundle

GetSettings(Language)

Declaration

ISettingsBundle GetSettings(Language targetLanguage)

Parameters

Type	Name	Description
Language	targetLanguage

Returns

Type	Description
ISettingsBundle

GetSourceLanguageFiles()

Declaration

ProjectFile[] GetSourceLanguageFiles()

Returns

Type	Description
ProjectFile[]

GetTargetLanguageFiles()

Declaration

ProjectFile[] GetTargetLanguageFiles()

Returns

Type	Description
ProjectFile[]

GetTargetLanguageFiles(Language)

Declaration

ProjectFile[] GetTargetLanguageFiles(Language targetLanguage)

Parameters

Type	Name	Description
Language	targetLanguage

Returns

Type	Description
ProjectFile[]

GetTermbaseConfiguration()

Declaration

TermbaseConfiguration GetTermbaseConfiguration()

Returns

Type	Description
TermbaseConfiguration

GetTranslationProviderConfiguration()

Declaration

TranslationProviderConfiguration GetTranslationProviderConfiguration()

Returns

Type	Description
TranslationProviderConfiguration

GetTranslationProviderConfiguration(Language)

Declaration

TranslationProviderConfiguration GetTranslationProviderConfiguration(Language targetLanguage)

Parameters

Type	Name	Description
Language	targetLanguage

Returns

Type	Description
TranslationProviderConfiguration

ImportReturnPackage(String)

Declaration

ReturnPackageImport ImportReturnPackage(string returnPackageFilePath)

Parameters

Type	Name	Description
System.String	returnPackageFilePath

Returns

Type	Description
ReturnPackageImport

ImportReturnPackage(String, EventHandler<ProgressEventArgs>, EventHandler<MessageEventArgs>)

Declaration

ReturnPackageImport ImportReturnPackage(string returnPackageFilePath, EventHandler<ProgressEventArgs> statusEventHandler, EventHandler<MessageEventArgs> messageEventHandler)

Parameters

Type	Name	Description
System.String	returnPackageFilePath
System.EventHandler<ProgressEventArgs>	statusEventHandler
System.EventHandler<MessageEventArgs>	messageEventHandler

Returns

Type	Description
ReturnPackageImport

OpenProjectFileStream(Guid)

Declaration

Stream OpenProjectFileStream(Guid projectFileId)

Parameters

Type	Name	Description
System.Guid	projectFileId

Returns

Type	Description
System.IO.Stream

RemoveBilingualReferenceFile(Guid)

Declaration

void RemoveBilingualReferenceFile(Guid ProjectTargetFileId)

Parameters

Type	Name	Description
System.Guid	ProjectTargetFileId

RunAutomaticTask(Guid[], String)

Declaration

AutomaticTask RunAutomaticTask(Guid[] projectFileIds, string taskTemplateId)

Parameters

Type	Name	Description
System.Guid[]	projectFileIds
System.String	taskTemplateId

Returns

Type	Description
AutomaticTask

RunAutomaticTask(Guid[], String, EventHandler<TaskStatusEventArgs>, EventHandler<TaskMessageEventArgs>)

Declaration

AutomaticTask RunAutomaticTask(Guid[] projectFileIds, string taskTemplateId, EventHandler<TaskStatusEventArgs> statusEventHandler, EventHandler<TaskMessageEventArgs> messageEventHandler)

Parameters

Type	Name	Description
System.Guid[]	projectFileIds
System.String	taskTemplateId
System.EventHandler<TaskStatusEventArgs>	statusEventHandler
System.EventHandler<TaskMessageEventArgs>	messageEventHandler

Returns

Type	Description
AutomaticTask

SavePackageAs(Guid, String)

Declaration

void SavePackageAs(Guid packageId, string path)

Parameters

Type	Name	Description
System.Guid	packageId
System.String	path

SaveProjectFileAs(Guid, String)

Declaration

void SaveProjectFileAs(Guid projectFileId, string outputFilePath)

Parameters

Type	Name	Description
System.Guid	projectFileId
System.String	outputFilePath

SaveTaskReportAs(Guid, String, ReportFormat)

Declaration

void SaveTaskReportAs(Guid reportId, string path, ReportFormat reportFormat)

Parameters

Type	Name	Description
System.Guid	reportId
System.String	path
ReportFormat	reportFormat

SetFileRole(Guid[], FileRole)

Declaration

void SetFileRole(Guid[] projectFileIds, FileRole fileRole)

Parameters

Type	Name	Description
System.Guid[]	projectFileIds
FileRole	fileRole

UpdateProject(ProjectInfo)

Declaration

ProjectInfo UpdateProject(ProjectInfo projectInfo)

Parameters

Type	Name	Description
ProjectInfo	projectInfo

Returns

Type	Description
ProjectInfo

UpdateSettings(Language, ISettingsBundle)

Declaration

void UpdateSettings(Language targetLanguage, ISettingsBundle settings)

Parameters

Type	Name	Description
Language	targetLanguage
ISettingsBundle	settings

UpdateSettings(ISettingsBundle)

Declaration

void UpdateSettings(ISettingsBundle settings)

Parameters

Type	Name	Description
ISettingsBundle	settings

UpdateTermbaseConfiguration(TermbaseConfiguration)

Declaration

void UpdateTermbaseConfiguration(TermbaseConfiguration termbaseConfiguration)

Parameters

Type	Name	Description
TermbaseConfiguration	termbaseConfiguration

UpdateTranslationProviderConfiguration(Language, TranslationProviderConfiguration)

Declaration

void UpdateTranslationProviderConfiguration(Language targetLanguage, TranslationProviderConfiguration translationProviderConfiguration)

Parameters

Type	Name	Description
Language	targetLanguage
TranslationProviderConfiguration	translationProviderConfiguration

UpdateTranslationProviderConfiguration(TranslationProviderConfiguration)

Declaration

void UpdateTranslationProviderConfiguration(TranslationProviderConfiguration translationProviderConfiguration)

Parameters

Type	Name	Description
TranslationProviderConfiguration	translationProviderConfiguration