ProjectServerCredentials.h

#pragma once
//-----------------------------------------------------------------------
// <copyright file="ProjectServerCredentials.cs" company="Aspose Pty Ltd">
//   Copyright (c) 2002-2024 Aspose Pty Ltd. All Rights Reserved.
// </copyright>
//-----------------------------------------------------------------------
 
#include <system/string.h>
 
#include "aspose.tasks.cpp/aspose_tasks_api_defs.h"
 
namespace Aspose
{
namespace Tasks
{
namespace IO
{
namespace Pwa
{
class ProjectServerConnection;
} // namespace Pwa
} // namespace IO
} // namespace Tasks
} // namespace Aspose
namespace System
{
namespace Net
{
class NetworkCredential;
} // namespace Net
} // namespace System
 
namespace Aspose {
 
namespace Tasks {
 
/// <summary>
/// Credentials which are used to connect to Project Online or on-premise instance of Project Server.
/// </summary>
class ASPOSE_TASKS_SHARED_CLASS ProjectServerCredentials final : public System::Object
{
    typedef ProjectServerCredentials ThisType;
    typedef System::Object BaseType;
    
    typedef ::System::BaseTypesInfo<BaseType> ThisTypeBaseTypesInfo;
    ASPOSE_TASKS_SHARED_RTTI_INFO_DECL();
    
    friend class Aspose::Tasks::IO::Pwa::ProjectServerConnection;
    
public:
 
    /// <summary>
    /// Gets the URL of PWA at SharePoint site or URL of on-premise Project Server.
    /// For example, https://your_company_name.sharepoint.com/sites/pwa";
    /// </summary>
    ASPOSE_TASKS_SHARED_API System::String get_SiteUrl() const;
    /// <summary>
    /// Gets the authorization token for the SharePoint instance.
    /// </summary>
    ASPOSE_TASKS_SHARED_API System::String get_AuthToken() const;
    /// <summary>
    /// Gets the user name for SharePoint site.
    /// </summary>
    ASPOSE_TASKS_SHARED_API System::String get_UserName() const;
    
    /// <summary>
    /// Initializes a new instance of the <see cref="ProjectServerCredentials"></see> class using URL of SharePoint site and valid SPOIDCRL authorization token for SharePoint's PWA (Project Web Access) site.
    /// </summary>
    /// <param name="siteUrl">The URL of PWA (Project Web Access) API of Project Online.</param>
    /// <param name="authToken">The authorization token (SPOIDCRL) for SharePoint's PWA (Project Web Access) site.</param>
    /// <remarks>Use this constructor to connect to ProjectOnline when you already have AuthToken for your SharePoint Online site.</remarks>
    ASPOSE_TASKS_SHARED_API ProjectServerCredentials(const System::String& siteUrl, const System::String& authToken);
    /// <summary>
    /// Initializes a new instance of the <see cref="ProjectServerCredentials"></see> class using URL of SharePoint site, user name and password.
    /// </summary>
    /// <param name="siteUrl">The URL of PWA (Project Web Access) API of Project Online.</param>
    /// <param name="userName">The user name for the SharePoint site.</param>
    /// <param name="password">The password for the SharePoint site.</param>
    /// <remarks>Use this constructor to connect to ProjectOnline. Please note that legacy authentication should be enabled in your Azure portal and Office 365 Admin center.</remarks>
    ASPOSE_TASKS_SHARED_API ProjectServerCredentials(const System::String& siteUrl, const System::String& userName, const System::String& password);
    /// <summary>
    /// Initializes a new instance of the <see cref="ProjectServerCredentials"></see> class using URL of Project Web Access endpoint and network credentials.
    /// </summary>
    /// <param name="siteUrl">The URL of project web access endpoint.</param>
    /// <param name="credentials">The credentials used to login to Project Web Access endpoint.</param>
    /// <remarks>Use this constructor to connect to on-premise instance of Project Server via PWA.</remarks>
    /// <example>
    /// In this example the instance of <see cref="ProjectServerManager"></see> class is used to read a list of project from Project Server instance located at http://project_server_instance.local  
    /// <code>
    /// string site = "http://project_server_instance.local/sites/pwa";
    /// var windowsCredentials = new NetworkCredential("Administrator", "my_password", "DOMAIN");
    /// var projectServerCredentials = new ProjectServerCredentials(site, windowsCredentials);
    /// ProjectServerManager manager = new ProjectServerManager(projectServerCredentials);
    /// 
    /// var list = manager.GetProjectList();
    /// foreach (var projectInfo in list)
    /// {
    ///     Console.WriteLine("{0} - {1} - {2}", projectInfo.Id, projectInfo.CreatedDate, projectInfo.Name);
    /// }
    /// </code>
    /// </example>
    ASPOSE_TASKS_SHARED_API ProjectServerCredentials(const System::String& siteUrl, const System::SharedPtr<System::Net::NetworkCredential>& credentials);
    
    /// <summary>
    /// Returns a string representation of this instance.
    /// </summary>
    /// <returns>a string representation of this instance.</returns>
    ASPOSE_TASKS_SHARED_API System::String ToString() const override;
    
protected:
 
    /// <summary>
    /// Gets the authorization token for the SharePoint instance.
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_AuthToken(const System::String& value);
    ASPOSE_TASKS_SHARED_API System::String get_Password() const;
    ASPOSE_TASKS_SHARED_API void set_Password(const System::String& value);
    ASPOSE_TASKS_SHARED_API const System::SharedPtr<System::Net::NetworkCredential>& get_NtlmCredentials() const;
    ASPOSE_TASKS_SHARED_API bool get_IsProjectOnlineCredentials();
    
    #ifdef ASPOSE_GET_SHARED_MEMBERS
    ASPOSE_TASKS_SHARED_API void GetSharedMembers(System::Object::shared_members_type& result) const override;
    #endif
    
    
private:
 
    System::String pr_SiteUrl;
    
    /// <summary>
    /// Gets the URL of PWA at SharePoint site or URL of on-premise Project Server.
    /// For example, https://your_company_name.sharepoint.com/sites/pwa";
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_SiteUrl(const System::String& value);
    
    System::String pr_AuthToken;
    System::String pr_UserName;
    
    /// <summary>
    /// Gets the user name for SharePoint site.
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_UserName(const System::String& value);
    
    System::String pr_Password;
    System::SharedPtr<System::Net::NetworkCredential> pr_NtlmCredentials;
    
    ASPOSE_TASKS_SHARED_API void set_NtlmCredentials(const System::SharedPtr<System::Net::NetworkCredential>& value);
    
};
 
} // namespace Tasks
} // namespace Aspose