License.h

#pragma once
//-----------------------------------------------------------------------
// <copyright file="License.cs" company="Aspose Pty Ltd">
//   Copyright (c) 2002-2024 Aspose Pty Ltd. All Rights Reserved.
// </copyright>
//-----------------------------------------------------------------------







#include <system/object.h>
 
#include "aspose.tasks.cpp/aspose_tasks_api_defs.h"
 
namespace Aspose
{
namespace LicenseV2
{
class LicenseInternal;
} // namespace LicenseV2
} // namespace Aspose
namespace System
{
namespace IO
{
class Stream;
} // namespace IO
class String;
} // namespace System
 
namespace Aspose {
 
namespace Tasks {
 
/// <summary>
/// Provides methods to license the component.
/// </summary>
/// <example>
/// In this example, an attempt will be made to find a license file named MyLicense.lic
/// in the folder that contains 
/// <ms>
/// the component, in the folder that contains the calling assembly,
/// in the folder of the entry assembly and then in the embedded resources of the calling assembly.
/// <code>
/// [C#]
/// 
/// License license = new License();
/// license.SetLicense("MyLicense.lic");
/// 
/// 
/// [Visual Basic]
/// 
/// Dim license As license = New license
/// License.SetLicense("MyLicense.lic")
/// </code>
/// </ms>
/// <java>
/// the component jar file:
/// <code>
/// License license = new License();
/// license.setLicense("MyLicense.lic");
/// </code>
/// </java>
/// </example>
class ASPOSE_TASKS_SHARED_CLASS License final : public System::Object
{
    typedef License ThisType;
    typedef System::Object BaseType;
    
    typedef ::System::BaseTypesInfo<BaseType> ThisTypeBaseTypesInfo;
    ASPOSE_TASKS_SHARED_RTTI_INFO_DECL();
    
public:
 
    /// <summary>
    /// Initializes a new instance of the <see cref="License"></see> class. 
    /// </summary>
    /// <example>
    /// In this example, an attempt will be made to find a license file named MyLicense.lic
    /// in the folder that contains 
    /// <ms>
    /// the component, in the folder that contains the calling assembly,
    /// in the folder of the entry assembly and then in the embedded resources of the calling assembly.
    /// <code>
    /// [C#]
    /// 
    /// License license = new License();
    /// license.SetLicense("MyLicense.lic");
    /// 
    /// 
    /// [Visual Basic]
    /// 
    /// Dim license As license = New license
    /// License.SetLicense("MyLicense.lic")
    /// </code>
    /// </ms>
    /// <java>
    /// the component jar file:
    /// <code>
    /// License license = new License();
    /// license.setLicense("MyLicense.lic");
    /// </code>
    /// </java>
    /// </example>
    // ReSharper disable once EmptyConstructor
    ASPOSE_TASKS_SHARED_API License();
    
    /// <summary>
    /// Licenses the component.
    /// </summary>
    /// <param name="licenseName">Can be a full or short file name or name of an embedded resource.
    /// Use an empty string to switch to evaluation mode.</param>
    /// <remarks>
    /// <p>Tries to find the license in the following locations:</p>
    /// <p>1. Explicit path.</p>
    /// <ms>
    /// <p>2. The folder that contains the Aspose component assembly.</p>
    /// <p>3. The folder that contains the client's calling assembly.</p>
    /// <p>4. The folder that contains the entry (startup) assembly.</p>
    /// <p>5. An embedded resource in the client's calling assembly.</p>
    /// <p><b>Note:</b>On the .NET Compact Framework, tries to find the license only in these locations:</p>
    /// <p>1. Explicit path.</p>
    /// <p>2. An embedded resource in the client's calling assembly.</p>
    /// </ms>
    /// <java>
    /// <p>2. The folder that contains the Aspose component JAR file.</p>
    /// <p>3. The folder that contains the client's calling JAR file.</p>
    /// </java>
    /// </remarks>
    /// <example>
    /// In this example, an attempt will be made to find a license file named MyLicense.lic
    /// in the folder that contains 
    /// <ms>
    /// the component, in the folder that contains the calling assembly,
    /// in the folder of the entry assembly and then in the embedded resources of the calling assembly.
    /// <code>
    /// [C#]
    /// 
    /// License license = new License();
    /// license.SetLicense("MyLicense.lic");
    /// </code>
    /// </ms>
    /// <java>
    /// the component jar file:
    /// <code>
    /// License license = new License();
    /// license.setLicense("MyLicense.lic");
    /// </code>
    /// </java>
    /// </example>
    ASPOSE_TASKS_SHARED_API void SetLicense(const System::String& licenseName);
    /// <summary>
    /// Licenses the component.
    /// </summary>
    /// <param name="stream">A stream that contains the license.</param>
    /// <remarks>
    /// <p>Use this method to load a license from a stream.</p>
    /// </remarks>
    /// <example>
    /// <code>
    /// <ms>
    /// [C#]
    /// 
    /// License license = new License();
    /// license.SetLicense(myStream);
    /// 
    /// 
    /// [Visual Basic]
    /// 
    /// Dim license as License = new License
    /// license.SetLicense(myStream)
    /// </ms>
    /// <java>
    /// License license = new License();
    /// license.setLicense(myStream);
    /// </java>
    /// </code>
    /// </example>
    /// <javaName>void setLicense(java.io.InputStream stream)</javaName>
    ASPOSE_TASKS_SHARED_API void SetLicense(const System::SharedPtr<System::IO::Stream>& stream);
    
protected:
 
    #ifdef ASPOSE_GET_SHARED_MEMBERS
    ASPOSE_TASKS_SHARED_API void GetSharedMembers(System::Object::shared_members_type& result) const override;
    #endif
    
    
private:
 
    System::SharedPtr<Aspose::LicenseV2::LicenseInternal> licenseInternal;
    
};
 
} // namespace Tasks
} // namespace Aspose