Project Class

Namespace: SynergyServerScripting.Entities
Assembly: SynergyServerScripting (in SynergyServerScripting.dll)
VB
C#
F#
C++
JScript
Copy 
<Obfuscation(Exclude = true, ApplyToMembers = true)> _ 
Public Class Project
This language is not supported or no code example is available.
VB
C#
F#
C++
JScript
Copy 
[Obfuscation(Exclude = true, ApplyToMembers = true)] 
public static class Project
This language is not supported or no code example is available.
VB
C#
F#
C++
JScript
Copy 
[Obfuscation(Exclude = true, ApplyToMembers = true)] 
public ref class Project 
This language is not supported or no code example is available.
VB
C#
F#
C++
JScript
Copy 
public  
   Obfuscation(Exclude = true, ApplyToMembers = true) 
class Project
This language is not supported or no code example is available.
Methods
 
Name Description
Public method Static AddProjectToCategory(EntityID, EntityID, IDatabase) Add a category to a project
Public method Static AssignUserAccess(EntityID, EntityID, RoleAccessType, EntityID, IDatabase) Assign user access to a project
Public method Static AttachAttributeToProject(EntityID, EntityID, bool, bool, IDatabase) Attach an attribute for a project
Public method Static AttachAttributeToProject(EntityID, EntityID, bool, bool, int, long, IDatabase) Attach an attribute for a project
Public method Static AttachAttributeToProject(EntityID, EntityID, bool, bool, int, long, bool, IDatabase) Attach an attribute for a project
Public method Static CanUserAccess(EntityID, EntityID, bool, IDatabase) Does a user have _any_ access roles to this project, or a parent project?
Public method Static CreateProject(ServerID, string, string, EntityID, byte[], EntityID, IDatabase) Create a top level project
Public method Static DoesProjectHaveIssuedFiles(EntityID, IDatabase) Does a project have issued files?
Public method Equals(Object) Determines whether the specified object is equal to the current object. (inherited from Object).
Public method Static ExportProjectFileStructure(ProjectInfo, bool, bool, bool, string, EntityID, IDatabase, IClient) Export a project to some directory on the server
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (inherited from Object).
Public method Static FindAttributesByName(string, IDatabase) Find project attributes by name
Public method Static FindProjectByAttribute(EntityID, EntityID, object, IDatabase) Given some attribute, try find the first project that has this attribute
Public method Static FindProjectByAttribute(EntityID, object, IDatabase) Given some attribute, try find the first project that has this attribute
Public method Static GetAllFolderIDs(EntityID, IDatabase)
Public method Static GetAllGroupAccess(EntityID, IDatabase) Get information about all groups who can access a Job (at the Job level only)
Public method Static GetAllRoleAccess(EntityID, IDatabase) Get information about all roles that can access a project
Public method Static GetAllUserAccess(EntityID, IDatabase) Get information about all users who can access a Job (at the Job level only)
Public method Static GetChangedFolderIDs(EntityID, EntityID, DateTime, IDatabase) Get all the ids of changed folders since a given date (in utc)
Public method Static GetChangedProjectAttributes(EntityID, DateTime, IDatabase, out List<AttributeInfo>, out List<EntityID>) Get any project attributes that have changed
Public method Static GetChangedProjects(DateTime, IDatabase) Get any projects that have changed since a specific date
Public method Static GetDefaultDashboardHeader(IDatabase) Get the default dashboard header
Public method Static GetEntityPath(EntityID, EntityID, IDatabase) Get the path to a project of a given id
Public method Static GetFileList(EntityID, EntityID, IDatabase) Given a project id, list out all the files on the project and provide their path relative to the project, latest version, and size.
Public method Static GetGroupAccess(EntityID, EntityID, IDatabase) Get group access to a project
Public method GetHashCode Serves as the default hash function. (inherited from Object).
Public method Static GetLocationFromURIPath(string, EntityID, EntityID, IDatabase) Helper method to get a location from a uri path
Public method Static GetParentProjectID(EntityID, IDatabase) Get the ID of the parent project
Public method Static GetPathToProject(EntityID, IDatabase) Given a project, work out its path
Public method Static GetProjectAttributeValue(EntityID, EntityID, IDatabase) Get a project attribute value, based on an attribute id and project id
Public method Static GetProjectAttributeValue(EntityID, string, IDatabase) Get a project attribute value, based on a name and project id
Public method Static GetProjectAttributeValues(HashSet<EntityID>, HashSet<EntityID>, IDatabase) Get attribute Values for a given list of jobs and list of attributes
Public method Static GetProjectCategories(EntityID, IDatabase) Get the list of all the categories this Job belongs to
Public method Static GetProjectCoverImage(EntityID, IDatabase) Get the cover image for a project
Public method Static GetProjectDashboardHeader(EntityID, bool, IDatabase) Get the dashboard header for a project
Public method Static GetProjectDashboardHeader(EntityID, bool, bool, IDatabase) Get the dashboard header for a project
Public method Static GetProjectDisplayAttributes(IDatabase) Get the standard set of project search attributes
Public method Static GetProjectFileAttributeExtensions(EntityID, EntityID, IDatabase) Given a Job file attribute, find what extensions exist for it
Public method Static GetProjectFileAttributes(EntityID, string, bool, IDatabase) Get initial attributes for a file change
Public method Static GetProjectFileAttributesAndExtensions(EntityID, IDatabase) Given a project, get all file attributes and their extensions
Public method Static GetProjectFileChangeAttributes(EntityID, bool, IDatabase) Get initial attributes for a file change
Public method Static GetProjectID(string, EntityID, IDatabase) Get the id of a project based on its name
Public method Static GetProjectIDFromPath(string, bool, IDatabase) Given a Job path, work out its ID
Public method Static GetProjectInfo(EntityID, bool, IDatabase) Get info about some project
Public method Static GetProjectName(EntityID, IDatabase) Get the project name of a given project
Public method Static GetProjectOwnerID(EntityID, IDatabase) Get the user id of the owner of a project
Public method Static GetProjects(EntityID, bool, IDatabase) Get all projects belonging to a project
Public method Static GetSourceProjectID(EntityID, IDatabase) Get the source project id for a project
Public method Static GetStandardSearchAttributes(IDatabase) Get the standard set of project search attributes
Public method Static GetSubProjectIDs(EntityID, IDatabase) Get the IDs of the child projects
Public method Static GetSystemProjectAttributes(bool, IDatabase) Get all attributes that apply to all projects
Public method Static GetTDProjectID(string, EntityID, IDatabase) Get the id of a 12d model project by name
Public method Static GetTemplateIDForProject(EntityID, IDatabase) Attempt to get the id of a project template for a project
Public method GetType Gets the Type of the current instance. (inherited from Object).
Public method Static GetUserAccess(EntityID, EntityID, IDatabase) Get the access type a user has
Public method Static GetUserAccess(EntityID, EntityID, List<EntityID>, List<EntityID>, IDatabase) Get the access type a user has
Public method Static GetVisibleProjects(EntityID, EntityID, bool, IDatabase)
Public method Static GetVisibleProjects(EntityID, EntityID, IDatabase) Get a list of all visible projects belonging to a project or a root project
Public method Static GetVisibleTDProjects(EntityID, EntityID, TDConnectionContext, IDatabase) Get a list of all 12d projects inside a parent Job that a user has access to
Public method Static HasProjectAttribute(EntityID, EntityID, IDatabase) Does a project have a particular project attribute
Public method Static HasProjectChanged(EntityID, DateTime, IDatabase) Has the basic project info changed?
Public method Static Index(EntityID, bool, bool, bool, bool, IDatabase) Index a server project
Public method Static Index(EntityID, bool, bool, bool, bool, bool, IDatabase) Index a server project
Public method Static Index(EntityID, bool, bool, bool, IDatabase) Index a server project
Public method Static Index(ProjectInfo, bool, bool, bool, bool, bool, IDatabase) Index a server project
Public method Static InheritsFromParent(EntityID, IDatabase) Check if a Job inherits access permissions from the parent
Public method Static MatchTemplate(AttributeValueCollection, EntityID, IDatabase) Match a template from some attributes
Protected method MemberwiseClone Creates a shallow copy of the current Object. (inherited from Object).
Public method Static ProcessDashboardHTML(EntityID, string, bool, IDatabase)
Public method Static PurgeProject(EntityID, EntityID, IDatabase, IClient) Purge a project (and all folders and files) completely from the system - dangerous
Public method Static RegenAllFilePreviews(EntityID, bool, IDatabase) Regen all file previews - very slow on large data sets
Public method Static RemoveProjectFromCategory(EntityID, EntityID, IDatabase) Remove a category to a project
Public method Static RemoveSystemProjectAttribute(EntityID, EntityID, IDatabase) Delete a system wide Job attribute attribute
Public method Static RenameProject(EntityID, string, IDatabase) Renames project
Public method Static ReplicateProject(EntityID, EntityID, EntityID, IDatabase, IClient) Replicate a project
Public method Static ReplicateProject(string, string, long, EntityID, EntityID, EntityID, IDatabase, IClient) Replicate a project
Public method Static SearchProjects(SearchQuery, EntityID, IDatabase) Search for projects
Public method Static SetProjectAttribute(EntityID, AttributeInfo, EntityID, IDatabase) Set some project attributes
Public method Static SetProjectAttributeValue(EntityID, AttributeInfo, IDatabase) Set a project attribute value
Public method Static SetProjectDashboardHeader(EntityID, string, IDatabase) Set a project dashboard hedaer
Public method Static SetProjectDisplayAttributes(List<EntityID>, IDatabase) Set the standard set of display attributes for project searches
Public method Static SetProjectRootFolder(EntityID, EntityID, IDatabase) Set a project root folder
Public method Static SetStandardSearchAttributes(List<EntityID>, IDatabase) Set the standard set of search attributes for project searches
Public method Static SetSystemProjectAttribute(AttributeInfo, EntityID, IDatabase) Set a system Job attribute
Public method Static SubmitProject(ProjectInfo, EntityID, IDatabase) Submit a change to a project
Public method ToString Returns a string that represents the current object. (inherited from Object).
Public method Static UpdateProjectInfo(EntityID, string, string, bool, IDatabase) Update some basic project information
Public method Static UpdateProjectInfo(EntityID, string, string, bool, bool, bool, IDatabase) Update some basic project information
Top
Inheritance Hierarchy
 
SynergyServerScripting.Entities.Project
Applies to
 

.NET Framework

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

In this article

Definition