Class Metered

Class Metered

Namespace: Aspose.Words
Assembly: Aspose.Words.dll (25.12.0)

Provides methods to set metered key.

public class Metered

Inheritance

object Metered

Inherited Members

object.GetType() , object.MemberwiseClone() , object.ToString() , object.Equals(object?) , object.Equals(object?, object?) , object.ReferenceEquals(object?, object?) , object.GetHashCode()

Examples

In this example, an attempt will be made to set metered public and private key

Metered matered = new Metered();
matered.SetMeteredKey("PublicKey", "PrivateKey");
Dim matered As Metered = New Metered
matered.SetMeteredKey("PublicKey", "PrivateKey")

Shows how to activate a Metered license and track credit/consumption.

// Create a new Metered license, and then print its usage statistics.
                                                                                Metered metered = new Metered();
                                                                                metered.SetMeteredKey("MyPublicKey", "MyPrivateKey");

                                                                                Console.WriteLine($"Is metered license accepted: {Metered.IsMeteredLicensed()}");
                                                                                Console.WriteLine($"Product name: {metered.GetProductName()}");
                                                                                Console.WriteLine($"Credit before operation: {Metered.GetConsumptionCredit()}");
                                                                                Console.WriteLine($"Consumption quantity before operation: {Metered.GetConsumptionQuantity()}");

                                                                                // Operate using Aspose.Words, and then print our metered stats again to see how much we spent.
                                                                                Document doc = new Document(MyDir + "Document.docx");
                                                                                doc.Save(ArtifactsDir + "Metered.Usage.pdf");

                                                                                // Aspose Metered Licensing mechanism does not send the usage data to purchase server every time,
                                                                                // you need to use waiting.
                                                                                System.Threading.Thread.Sleep(10000);

                                                                                Console.WriteLine($"Credit after operation: {Metered.GetConsumptionCredit()}");
                                                                                Console.WriteLine($"Consumption quantity after operation: {Metered.GetConsumptionQuantity()}");

Constructors

Metered()

Initializes a new instance of this class.

public Metered()

Examples

Shows how to activate a Metered license and track credit/consumption.

// Create a new Metered license, and then print its usage statistics.
                                                                                Metered metered = new Metered();
                                                                                metered.SetMeteredKey("MyPublicKey", "MyPrivateKey");

                                                                                Console.WriteLine($"Is metered license accepted: {Metered.IsMeteredLicensed()}");
                                                                                Console.WriteLine($"Product name: {metered.GetProductName()}");
                                                                                Console.WriteLine($"Credit before operation: {Metered.GetConsumptionCredit()}");
                                                                                Console.WriteLine($"Consumption quantity before operation: {Metered.GetConsumptionQuantity()}");

                                                                                // Operate using Aspose.Words, and then print our metered stats again to see how much we spent.
                                                                                Document doc = new Document(MyDir + "Document.docx");
                                                                                doc.Save(ArtifactsDir + "Metered.Usage.pdf");

                                                                                // Aspose Metered Licensing mechanism does not send the usage data to purchase server every time,
                                                                                // you need to use waiting.
                                                                                System.Threading.Thread.Sleep(10000);

                                                                                Console.WriteLine($"Credit after operation: {Metered.GetConsumptionCredit()}");
                                                                                Console.WriteLine($"Consumption quantity after operation: {Metered.GetConsumptionQuantity()}");

Methods

GetConsumptionCredit()

Gets consumption credit

public static decimal GetConsumptionCredit()

Returns

decimal

consumption quantity

Examples

Shows how to activate a Metered license and track credit/consumption.

// Create a new Metered license, and then print its usage statistics.
                                                                                Metered metered = new Metered();
                                                                                metered.SetMeteredKey("MyPublicKey", "MyPrivateKey");

                                                                                Console.WriteLine($"Is metered license accepted: {Metered.IsMeteredLicensed()}");
                                                                                Console.WriteLine($"Product name: {metered.GetProductName()}");
                                                                                Console.WriteLine($"Credit before operation: {Metered.GetConsumptionCredit()}");
                                                                                Console.WriteLine($"Consumption quantity before operation: {Metered.GetConsumptionQuantity()}");

                                                                                // Operate using Aspose.Words, and then print our metered stats again to see how much we spent.
                                                                                Document doc = new Document(MyDir + "Document.docx");
                                                                                doc.Save(ArtifactsDir + "Metered.Usage.pdf");

                                                                                // Aspose Metered Licensing mechanism does not send the usage data to purchase server every time,
                                                                                // you need to use waiting.
                                                                                System.Threading.Thread.Sleep(10000);

                                                                                Console.WriteLine($"Credit after operation: {Metered.GetConsumptionCredit()}");
                                                                                Console.WriteLine($"Consumption quantity after operation: {Metered.GetConsumptionQuantity()}");

GetConsumptionQuantity()

Gets consumption file size

public static decimal GetConsumptionQuantity()

Returns

decimal

consumption quantity

Examples

Shows how to activate a Metered license and track credit/consumption.

// Create a new Metered license, and then print its usage statistics.
                                                                                Metered metered = new Metered();
                                                                                metered.SetMeteredKey("MyPublicKey", "MyPrivateKey");

                                                                                Console.WriteLine($"Is metered license accepted: {Metered.IsMeteredLicensed()}");
                                                                                Console.WriteLine($"Product name: {metered.GetProductName()}");
                                                                                Console.WriteLine($"Credit before operation: {Metered.GetConsumptionCredit()}");
                                                                                Console.WriteLine($"Consumption quantity before operation: {Metered.GetConsumptionQuantity()}");

                                                                                // Operate using Aspose.Words, and then print our metered stats again to see how much we spent.
                                                                                Document doc = new Document(MyDir + "Document.docx");
                                                                                doc.Save(ArtifactsDir + "Metered.Usage.pdf");

                                                                                // Aspose Metered Licensing mechanism does not send the usage data to purchase server every time,
                                                                                // you need to use waiting.
                                                                                System.Threading.Thread.Sleep(10000);

                                                                                Console.WriteLine($"Credit after operation: {Metered.GetConsumptionCredit()}");
                                                                                Console.WriteLine($"Consumption quantity after operation: {Metered.GetConsumptionQuantity()}");

GetProductName()

Returns Product name

public string GetProductName()

Returns

string

Product name

Examples

Shows how to activate a Metered license and track credit/consumption.

// Create a new Metered license, and then print its usage statistics.
                                                                                Metered metered = new Metered();
                                                                                metered.SetMeteredKey("MyPublicKey", "MyPrivateKey");

                                                                                Console.WriteLine($"Is metered license accepted: {Metered.IsMeteredLicensed()}");
                                                                                Console.WriteLine($"Product name: {metered.GetProductName()}");
                                                                                Console.WriteLine($"Credit before operation: {Metered.GetConsumptionCredit()}");
                                                                                Console.WriteLine($"Consumption quantity before operation: {Metered.GetConsumptionQuantity()}");

                                                                                // Operate using Aspose.Words, and then print our metered stats again to see how much we spent.
                                                                                Document doc = new Document(MyDir + "Document.docx");
                                                                                doc.Save(ArtifactsDir + "Metered.Usage.pdf");

                                                                                // Aspose Metered Licensing mechanism does not send the usage data to purchase server every time,
                                                                                // you need to use waiting.
                                                                                System.Threading.Thread.Sleep(10000);

                                                                                Console.WriteLine($"Credit after operation: {Metered.GetConsumptionCredit()}");
                                                                                Console.WriteLine($"Consumption quantity after operation: {Metered.GetConsumptionQuantity()}");

IsMeteredLicensed()

Check whether metered is licensed

public static bool IsMeteredLicensed()

Returns

bool

True or false

Examples

Shows how to activate a Metered license and track credit/consumption.

// Create a new Metered license, and then print its usage statistics.
                                                                                Metered metered = new Metered();
                                                                                metered.SetMeteredKey("MyPublicKey", "MyPrivateKey");

                                                                                Console.WriteLine($"Is metered license accepted: {Metered.IsMeteredLicensed()}");
                                                                                Console.WriteLine($"Product name: {metered.GetProductName()}");
                                                                                Console.WriteLine($"Credit before operation: {Metered.GetConsumptionCredit()}");
                                                                                Console.WriteLine($"Consumption quantity before operation: {Metered.GetConsumptionQuantity()}");

                                                                                // Operate using Aspose.Words, and then print our metered stats again to see how much we spent.
                                                                                Document doc = new Document(MyDir + "Document.docx");
                                                                                doc.Save(ArtifactsDir + "Metered.Usage.pdf");

                                                                                // Aspose Metered Licensing mechanism does not send the usage data to purchase server every time,
                                                                                // you need to use waiting.
                                                                                System.Threading.Thread.Sleep(10000);

                                                                                Console.WriteLine($"Credit after operation: {Metered.GetConsumptionCredit()}");
                                                                                Console.WriteLine($"Consumption quantity after operation: {Metered.GetConsumptionQuantity()}");

SetMeteredKey(string, string)

Sets metered public and private key. If you purchase metered license, when start application, this API should be called, normally, this is enough. However, if always fail to upload consumption data and exceed 24 hours, the license will be set to evaluation status, to avoid such case, you should regularly check the license status, if it is evaluation status, call this API again.

public void SetMeteredKey(string publicKey, string privateKey)

Parameters

publicKey string

public key

privateKey string

private key

Examples

Shows how to activate a Metered license and track credit/consumption.

// Create a new Metered license, and then print its usage statistics.
                                                                                Metered metered = new Metered();
                                                                                metered.SetMeteredKey("MyPublicKey", "MyPrivateKey");

                                                                                Console.WriteLine($"Is metered license accepted: {Metered.IsMeteredLicensed()}");
                                                                                Console.WriteLine($"Product name: {metered.GetProductName()}");
                                                                                Console.WriteLine($"Credit before operation: {Metered.GetConsumptionCredit()}");
                                                                                Console.WriteLine($"Consumption quantity before operation: {Metered.GetConsumptionQuantity()}");

                                                                                // Operate using Aspose.Words, and then print our metered stats again to see how much we spent.
                                                                                Document doc = new Document(MyDir + "Document.docx");
                                                                                doc.Save(ArtifactsDir + "Metered.Usage.pdf");

                                                                                // Aspose Metered Licensing mechanism does not send the usage data to purchase server every time,
                                                                                // you need to use waiting.
                                                                                System.Threading.Thread.Sleep(10000);

                                                                                Console.WriteLine($"Credit after operation: {Metered.GetConsumptionCredit()}");
                                                                                Console.WriteLine($"Consumption quantity after operation: {Metered.GetConsumptionQuantity()}");
 English