Class ProjectInfo

Holds information about a project. This class is used when accessing information about an existing project, and for updating a project with new information. It is also used when creating a new project. Not all properties are supported for project updating.

Inheritance

System.Object

ProjectInfo

Inherited Members

System.Object.ToString()

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: Sdl.ProjectAutomation.Core

Assembly: Sdl.ProjectAutomation.Core.dll

Syntax

public class ProjectInfo

Constructors

ProjectInfo()

Declaration

public ProjectInfo()

Properties

CreatedAt

Gets the date/time the project was created.

Declaration

public DateTime CreatedAt { get; }

Property Value

Type	Description
System.DateTime

CreatedBy

The ID of the user that created this project

Declaration

public string CreatedBy { get; set; }

Property Value

Type	Description
System.String

CurrentUserId

The ID of the current user for this project. For local projects this is identical to the user under which the API is running locally. For server-based projects this returns the user that is currently logged on to the server

Declaration

public string CurrentUserId { get; set; }

Property Value

Type	Description
System.String

Description

The description of the project.

Declaration

public string Description { get; set; }

Property Value

Type	Description
System.String

DueDate

Gets or sets the due date for this project.

Declaration

public DateTime? DueDate { get; set; }

Property Value

Type	Description
System.Nullable<System.DateTime>

IconPath

Gets or sets the physical path of the project icon

Declaration

public string IconPath { get; set; }

Property Value

Type	Description
System.String

Id

The ID of the project

Declaration

public Guid Id { get; }

Property Value

Type	Description
System.Guid

IsCompleted

Set when the project has been completed

Declaration

public bool IsCompleted { get; }

Property Value

Type	Description
System.Boolean

LocalProjectFolder

The local folder used to store project files.

Declaration

public string LocalProjectFolder { get; set; }

Property Value

Type	Description
System.String

Remarks

This property can only be set for use during project creation. It is not valid to set for project updating.

Name

The name of the project.

Declaration

public string Name { get; set; }

Property Value

Type	Description
System.String	The name.

Remarks

This property can only be set for use during project creation. It is not valid to set for project updating.

OrganizationPath

Gets the organization path on the server to where the project is published.

Declaration

public string OrganizationPath { get; }

Property Value

Type	Description
System.String

ProjectOrigin

Gets or sets the source of the project

Declaration

public string ProjectOrigin { get; set; }

Property Value

Type	Description
System.String

ProjectType

Gets or sets the current project type

Declaration

public ProjectType ProjectType { get; }

Property Value

Type	Description
ProjectType

PublicationStatus

Gets the status of publication for this project on a project server

Declaration

public PublicationStatus PublicationStatus { get; }

Property Value

Type	Description
PublicationStatus

ServerUri

Gets the Uri of the server

Declaration

public Uri ServerUri { get; }

Property Value

Type	Description
System.Uri

SourceLanguage

The source language of the project

Declaration

public Language SourceLanguage { get; set; }

Property Value

Type	Description
Language

Remarks

It is optional to set this property during project creation. If it is not set, the source language of the reference project or template is used. If a template has more than one source language, the first one is used.

This property can only be set for use during project creation. It is not valid to set for project updating.

Status

Gets or sets the current status of the project

Declaration

public ProjectStatus Status { get; }

Property Value

Type	Description
ProjectStatus

TargetLanguages

The target languages of the project.

Declaration

public Language[] TargetLanguages { get; set; }

Property Value

Type	Description
Language[]

Remarks

It is optional to set this property during project creation. If it is not set, the target languages of the reference project or template are used.

This property can only be set for use during project creation. It is not valid to set for project updating.

Uri

The URI of the project

Declaration

public Uri Uri { get; }

Property Value

Type	Description
System.Uri