Search Results for

    Show / Hide Table of Contents

    Class ProjectServer

    Inheritance
    object
    ProjectServer
    Inherited Members
    object.ToString()
    object.Equals(object)
    object.Equals(object, object)
    object.ReferenceEquals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    Namespace: Sdl.ProjectAutomation.FileBased
    Assembly: Sdl.ProjectAutomation.FileBased.dll
    Syntax
    public class ProjectServer

    Constructors

    ProjectServer(Uri, bool, string, string)

    Creates a new project server.

    Declaration
    public ProjectServer(Uri serverUri, bool useWindowsAuthentication, string userName, string password)
    Parameters
    Type Name Description
    Uri serverUri

    The URI of the server

    bool useWindowsAuthentication

    Whether to use Windows authentication. When set to false, userName and password have to be specified. When set to true, either pass null for userName and password in order to log on as the currently logged on Windows user, or set userName to a domain-qualified Windows user name and password to the matching password to log on using basic Windows authentication.

    string userName

    When using custom authentication or basic Windows authentication, the user name of the user. Pass null to use integrated Windows authentication(see useWindowsAuthentication).

    string password

    When using custom authentication or basic Windows authentication the password of the user. Pass null to use integrated Windows authentication (see useWindowsAuthentication).

    Methods

    DeleteProject(Guid)

    Delete a project from the remote server.

    Declaration
    public void DeleteProject(Guid projectId)
    Parameters
    Type Name Description
    Guid projectId

    The unique id to identify the project to delete

    GetServerProject(string)

    Given the qualified ( organisationPath/projectName ) name of a server project returns the project details if present on the server otherwise null

    Declaration
    public ServerProjectInfo GetServerProject(string qualifiedName)
    Parameters
    Type Name Description
    string qualifiedName

    A name in the form organizationPath/ProjectName for example /MyCompany/Project1

    Returns
    Type Description
    ServerProjectInfo

    Details of the project

    GetServerProjects(string, bool, bool)

    Returns the project list from the remote server.

    Declaration
    public ServerProjectInfo[] GetServerProjects(string organizationPath, bool includeProjectsInSubOrganizations, bool includeCompletedProjects)
    Parameters
    Type Name Description
    string organizationPath
    bool includeProjectsInSubOrganizations
    bool includeCompletedProjects
    Returns
    Type Description
    ServerProjectInfo[]

    OpenProject(Guid, string)

    The method opens the project with the specified id

    Declaration
    public FileBasedProject OpenProject(Guid projectId, string localProjectFolder)
    Parameters
    Type Name Description
    Guid projectId

    The project unique id

    string localProjectFolder

    The local project folder

    Returns
    Type Description
    FileBasedProject
    In this article
    • Constructors
      • ProjectServer(Uri, bool, string, string)
    • Methods
      • DeleteProject(Guid)
      • GetServerProject(string)
      • GetServerProjects(string, bool, bool)
      • OpenProject(Guid, string)
    Back to top Generated by DocFX