tenduke::se::licensing::FluentStartMeteredUse Class Reference

#include <FluentStartMeteredUse.h>

Detailed Description

Starts metered license use, building the request fluently.

Call execute() to execute the request.

See superclass tenduke::se::licensing::FluentConsumptionBuilder for the methods.

Inheritance diagram for tenduke::se::licensing::FluentStartMeteredUse:

Public Member Functions
	FluentStartMeteredUse (const ::tenduke::se::licensing::LicensingClient &client, const std::string &licenseKey="")
	Constructs new instance.
::tenduke::se::licensing::StartMeteredUseResponse	execute ()
	Starts metered license use.
Public Member Functions inherited from tenduke::se::licensing::FluentConsumptionBuilder<::tenduke::se::licensing::FluentStartMeteredUse >
	FluentConsumptionBuilder (std::string licenseKey)
	Constructs new instance.
::tenduke::se::licensing::FluentStartMeteredUse &	seats (const std::string &pProductName, std::int64_t numSeats)
	Start building a license-consumption for seats.
::tenduke::se::licensing::FluentStartMeteredUse &	seat (const std::string &pProductName)
	Start building a license-consumption for one seat.
::tenduke::se::licensing::FluentStartMeteredUse &	count (const std::string &pProductName, std::int64_t useCount)
	Start building a license consumption for use count.
::tenduke::se::licensing::FluentStartMeteredUse &	count (const std::string &pProductName)
	Starts building a license consumption for one use count.
::tenduke::se::licensing::FluentStartMeteredUse &	time (const std::string &pProductName, std::int64_t useTime)
	Starts building a license consumption of use time.
::tenduke::se::licensing::FluentStartMeteredUse &	version (const std::string &pClientVersion)
	Set the client version.
::tenduke::se::licensing::FluentStartMeteredUse &	licenseId (const std::string &pLicenseId)
	Sets the license id to consume.

Additional Inherited Members
Protected Member Functions inherited from tenduke::se::licensing::FluentConsumptionBuilder<::tenduke::se::licensing::FluentStartMeteredUse >
void	buildArgument ()
	Builds one argument.
void	startArgument (::tenduke::se::licensing::License::QuantityDimension pQtyDimension, const std::string &pProductName, std::int64_t pQty)
	Starts building new argument.
Protected Attributes inherited from tenduke::se::licensing::FluentConsumptionBuilder<::tenduke::se::licensing::FluentStartMeteredUse >
const std::string	licenseKey
	License key to use in checkout.
std::vector<::tenduke::se::licensing::LicenseCheckoutArguments >	arguments
	Arguments.

Constructor & Destructor Documentation

FluentStartMeteredUse()

tenduke::se::licensing::FluentStartMeteredUse::FluentStartMeteredUse ( const ::tenduke::se::licensing::LicensingClient &  client, const std::string &  licenseKey = ""  )

explicit

Constructs new instance.

Parameters

client	licensing client
licenseKey	license key. Pass empty string, if this is not a license key operation.

Member Function Documentation

execute()

xdlic::StartMeteredUseResponse tenduke::se::licensing::FluentStartMeteredUse::execute

(

)

Starts metered license use.

Returns

-

Exceptions

tenduke::net::NetworkingException	(and subclasses) on networking issues (no network, host not found etc)
tenduke::jwt::JWTValidationException	when any returned license token fails to validate
tenduke::se::http::APIException	(and subclasses) when the request failed

---

The documentation for this class was generated from the following files:

• api/src/licensing/api/licenses/metered/FluentStartMeteredUse.h
• api/src/licensing/api/licenses/metered/FluentStartMeteredUse.cpp