ProjectServerManager.h

#pragma once
//-----------------------------------------------------------------------
// <copyright file="ProjectServerManager.cs" company="Aspose Pty Ltd">
//   Copyright (c) 2002-2024 Aspose Pty Ltd. All Rights Reserved.
// </copyright>
//-----------------------------------------------------------------------
 
#include <system/object.h>
#include <system/eventhandler.h>
 
#include "aspose.tasks.cpp/IO/Pwa/WebRequestEventArgs.h"
#include "aspose.tasks.cpp/aspose_tasks_api_defs.h"
 
namespace Aspose
{
namespace Tasks
{
class ILogger;
namespace IO
{
namespace Pwa
{
class IProjectServerConnection;
} // namespace Pwa
} // namespace IO
class Project;
class ProjectInfo;
class ProjectServerCredentials;
class ProjectServerSaveOptions;
} // namespace Tasks
} // namespace Aspose
namespace System
{
namespace Collections
{
namespace Generic
{
template <typename> class IEnumerable;
} // namespace Generic
} // namespace Collections
class Guid;
namespace IO
{
class Stream;
} // namespace IO
} // namespace System
 
namespace Aspose {
 
namespace Tasks {
 
/// <summary>
/// The class which provides the methods to read and to perform operations on projects in the specified Project Online account or
/// in the specified on-premise Project Server instance (Project Server's versions 2016 and 2019 are supported).
/// </summary>
class ASPOSE_TASKS_SHARED_CLASS ProjectServerManager final : public System::Object
{
    typedef ProjectServerManager ThisType;
    typedef System::Object BaseType;
    
    typedef ::System::BaseTypesInfo<BaseType> ThisTypeBaseTypesInfo;
    ASPOSE_TASKS_SHARED_RTTI_INFO_DECL();
    
public:
 
    /// <summary>
    /// An event that is raised when the web request is sent to Project Server's web API.
    /// </summary>
    System::EventHandler<System::SharedPtr<WebRequestEventArgs>> ExecutingWebRequest;
    
    /// <summary>
    /// Initializes a new instance of the <see cref="ProjectServerManager"></see> class.
    /// </summary>
    /// <param name="credentials">Credentials used to connect to Project Online account.</param>
    /// <example>
    /// This example shows how to create instance of ProjectServerManager to access on-premise instance of Project Server.
    /// <code>
    /// [C#]
    /// string site = "http://project_server_instance.local/";
    /// var windowsCredentials = new NetworkCredential("Administrator", "my_password", "DOMAIN");
    /// var projectServerCredentials = new ProjectServerCredentials(site, windowsCredentials);
    /// ProjectServerManager manager = new ProjectServerManager(projectServerCredentials);
    /// </code>
    /// </example>
    /// <example>
    /// This example shows how to create instance of ProjectServerManager to access account in Project Online service.
    /// <code>
    /// [C#]
    /// var credentials = new ProjectServerCredentials("https://xxxxxx.sharepoint.com", "yyyyy@xxxxxxx.onmicrosoft.com", "password");
    /// ProjectServerManager manager = new ProjectServerManager(projectServerCredentials);
    /// </code>
    /// </example>
    ASPOSE_TASKS_SHARED_API ProjectServerManager(const System::SharedPtr<ProjectServerCredentials>& credentials);
    
    /// <summary>
    /// Gets the project with the specified guid from the Project Online account \ Project Server instance.
    /// </summary>
    /// <returns>Instance of <see cref="Project"></see> class which represents project read from Project Online \ Project Server.</returns>
    /// <param name="projectGuid">The Guid of the project to read.</param>
    ASPOSE_TASKS_SHARED_API System::SharedPtr<Project> GetProject(System::Guid projectGuid);
    /// <summary>
    /// Gets the project's binary data for troubleshooting purposes.
    /// </summary>
    /// <returns>Stream containing raw project's data.</returns>
    /// <param name="projectGuid">The Guid of the project to read.</param>
    /// <example>
    /// <code>
    /// In this example the debug info for the specific project is retrieved. You can pass the resulting "debug.zip" to the support team for troubleshooting purposes.
    /// [C#]
    /// var credentials = new ProjectServerCredentials("https://xxxxxx.sharepoint.com", "yyyyy@xxxxxxx.onmicrosoft.com", "password");
    /// // Guid of project you are trying to get.
    /// var projectGuid = new Guid("e0294bfb-5657-45c8-9cc5-82169fb95d69");
    /// ProjectServerManager manager = new ProjectServerManager(credentials);
    /// using (var fileStream = File.OpenWrite(@"c:\debug.zip"))
    /// {
    ///     using (var stream = manager.GetProjectRawData(projectGuid))
    ///     {
    ///         stream.CopyTo(fileStream);
    ///     }
    /// }
    /// </code>
    /// </example>
    ASPOSE_TASKS_SHARED_API System::SharedPtr<System::IO::Stream> GetProjectRawData(System::Guid projectGuid);
    /// <summary>
    /// Gets the list of projects from 'Working' store of the current Project Online account \ Project Server instance.
    /// </summary>
    /// <returns>An enumeration of projects in the current Project Online account \ Project Server instance.</returns>
    ASPOSE_TASKS_SHARED_API System::SharedPtr<System::Collections::Generic::IEnumerable<System::SharedPtr<ProjectInfo>>> GetProjectList();
    /// <summary>
    /// Updates existing project in Project Server\Project Online instance using default save options. The existing project will be overwritten.
    /// </summary>
    /// <param name="project">The project to save to Project Server\Project Online instance.</param>
    /// <exception cref="ProjectOnlineException">In case of communication error or error returned by a server.</exception>
    /// <remarks> Project's property 'project.Get(Prj.Guid)' should be a valid guid of a project which exists in Project Server account \ Project Online instance.</remarks>
    /// <example>
    /// In this example the project is loaded from Project Online account, modified and saved back to Project Online account.
    /// <code>
    /// [C#]
    /// var credentials = new ProjectServerCredentials("https://xxxxxx.sharepoint.com", "yyyyy@xxxxxxx.onmicrosoft.com", "password");
    /// ProjectServerManager manager = new ProjectServerManager(credentials);
    /// var projectList = manager.GetProjectList();
    /// var projectGuid = projectList.First().Id;
    /// var project = manager.GetProject(projectGuid);
    /// var task = project.RootTask.Children.Add("New task");
    /// manager.UpdateProject(project);
    /// </code>
    /// </example>
    ASPOSE_TASKS_SHARED_API void UpdateProject(const System::SharedPtr<Project>& project);
    /// <summary>
    /// Updates existing project in Project Server\Project Online instance using the specified save options. The existing project will be overwritten.
    /// </summary>
    /// <param name="project">The project to save to Project Server\Project Online instance.</param>
    /// <param name="saveOptions"> Instance of <see cref="ProjectServerSaveOptions"></see> class.</param>
    /// <exception cref="ProjectOnlineException">In case of communication error or error returned by a server.</exception>
    /// <remarks>saveOptions.ProjectGuid should be set to a guid of a project which exists on Project Server\ Project Online instance.</remarks>
    /// <example>
    /// In this example the project is loaded from Project Online account, modified and saved back to Project Online account.
    /// <code>
    /// [C#]
    /// var credentials = new ProjectServerCredentials("https://xxxxxx.sharepoint.com", "yyyyy@xxxxxxx.onmicrosoft.com", "password");
    /// ProjectServerManager manager = new ProjectServerManager(credentials);
    /// var projectList = manager.GetProjectList();
    /// var projectGuid = projectList.First().Id;
    /// var project = manager.GetProject(projectGuid);
    /// var task = project.RootTask.Children.Add("New task");
    /// manager.UpdateProject(project, new ProjectServerSaveOptions
    /// {
    ///     ProjectGuid = projectGuid
    /// });
    /// </code>
    /// </example>
    ASPOSE_TASKS_SHARED_API void UpdateProject(const System::SharedPtr<Project>& project, const System::SharedPtr<ProjectServerSaveOptions>& saveOptions);
    /// <summary>
    /// Creates new project in Project Server\Project Online instance using default save options.
    /// </summary>
    /// <param name="project">The project to save to Project Server\Project Online instance.</param>
    /// <exception cref="ProjectOnlineException">In case of communication error or error returned by a server.</exception>
    /// <example>
    /// In this example the project is loaded from .mpp file and saved to Project Online account.
    /// <code>
    /// [C#]
    /// var credentials = new ProjectServerCredentials("https://xxxxxx.sharepoint.com", "yyyyy@xxxxxxx.onmicrosoft.com", "password");
    /// var project = new Project(@"sample.mpp");
    /// ProjectServerManager manager = new ProjectServerManager(credentials);
    /// manager.CreateNewProject(project);
    /// </code>
    /// </example>
    ASPOSE_TASKS_SHARED_API void CreateNewProject(const System::SharedPtr<Project>& project);
    /// <summary>
    /// Creates new project in Project Server\Project Online instance using the specified save options.
    /// </summary>
    /// <param name="project">The project to save to Project Server\Project Online instance.</param>
    /// <param name="saveOptions"> Instance of <see cref="ProjectServerSaveOptions"></see> class.</param>
    /// <exception cref="ProjectOnlineException">In case of communication error or error returned by a server.</exception>
    /// <example>
    /// In this example the project is loaded from .mpp file and saved to Project Online account.
    /// <code>
    /// [C#]
    /// var credentials = new ProjectServerCredentials("https://xxxxxx.sharepoint.com", "yyyyy@xxxxxxx.onmicrosoft.com", "password");
    /// var project = new Project(@"sample.mpp");
    /// ProjectServerManager manager = new ProjectServerManager(credentials);
    /// manager.CreateNewProject(project, new ProjectServerSaveOptions
    /// {
    ///     ProjectName = "My new project"
    /// });
    /// </code>
    /// </example>
    ASPOSE_TASKS_SHARED_API void CreateNewProject(const System::SharedPtr<Project>& project, const System::SharedPtr<ProjectServerSaveOptions>& saveOptions);
    
protected:
 
    ASPOSE_TASKS_SHARED_API ProjectServerManager(const System::SharedPtr<IO::Pwa::IProjectServerConnection>& connection);
    
    ASPOSE_TASKS_SHARED_API MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION(ProjectServerManager, CODEPORTING_ARGS(const System::SharedPtr<IO::Pwa::IProjectServerConnection>& connection));
    ASPOSE_TASKS_SHARED_API void DeleteProject(System::Guid projectGuid);
    
    virtual ASPOSE_TASKS_SHARED_API ~ProjectServerManager();
    
    #ifdef ASPOSE_GET_SHARED_MEMBERS
    ASPOSE_TASKS_SHARED_API void GetSharedMembers(System::Object::shared_members_type& result) const override;
    #endif
    
    
private:
 
    System::SharedPtr<IO::Pwa::IProjectServerConnection> connection;
    System::SharedPtr<ILogger> logger;
    
    void ConnectionOnExecutingWebRequest(const System::SharedPtr<System::Object>& sender, const System::SharedPtr<WebRequestEventArgs>& e);
    
};
 
} // namespace Tasks
} // namespace Aspose