tenduke::se::licensing::FluentLicenseHeartbeat Class Reference

#include <FluentLicenseHeartbeat.h>

Detailed Description

Heartbeats licenses, building the request fluently.

Call execute() to execute the request.

See the superclass tenduke::se::licensing::FluentHeartbeatBuilder for the fluent building methods.

Inheritance diagram for tenduke::se::licensing::FluentLicenseHeartbeat:

Public Member Functions
	FluentLicenseHeartbeat (const ::tenduke::se::licensing::LicensingClient &client, const std::string &licenseKey="")
	Constructs new instance.
::tenduke::se::licensing::LicenseHeartbeatResponse	execute ()
	Heartbeats the licenses.
Public Member Functions inherited from tenduke::se::licensing::FluentHeartbeatBuilder<::tenduke::se::licensing::FluentLicenseHeartbeat >
	FluentHeartbeatBuilder (std::string licenseKey="")
	Constructs new instance.
::tenduke::se::licensing::FluentLicenseHeartbeat &	lease (const ::tenduke::se::licensing::Lease &lease)
	Adds a lease to heartbeat.
::tenduke::se::licensing::FluentLicenseHeartbeat &	lease (const std::string &leaseId, std::string clientVersion="")
	Adds a lease id to heart beat.
::tenduke::se::licensing::FluentLicenseHeartbeat &	lease (const std::string &leaseId, std::int64_t usedQty, bool treatAsIncrementalQty=false, std::string clientVersion="")
	Adds a lease id to heartbeat updating usage.
::tenduke::se::licensing::FluentLicenseHeartbeat &	leases (const std::vector<::tenduke::se::licensing::Lease > &licenses)
	Adds multiple leases to heartbeat.
	FluentHeartbeatBuilder (std::string licenseKey="")
	Constructs new instance.
::tenduke::se::licensing::FluentLicenseHeartbeat &	lease (const ::tenduke::se::licensing::Lease &lease)
	Adds a lease to heartbeat.
::tenduke::se::licensing::FluentLicenseHeartbeat &	lease (const std::string &leaseId, std::string clientVersion="")
	Adds a lease id to heart beat.
::tenduke::se::licensing::FluentLicenseHeartbeat &	lease (const std::string &leaseId, std::int64_t usedQty, bool treatAsIncrementalQty=false, std::string clientVersion="")
	Adds a lease id to heartbeat updating usage.
::tenduke::se::licensing::FluentLicenseHeartbeat &	leases (const std::vector<::tenduke::se::licensing::Lease > &licenses)
	Adds multiple leases to heartbeat.
	FluentHeartbeatBuilder (std::string licenseKey="")
	Constructs new instance.
::tenduke::se::licensing::FluentLicenseHeartbeat &	lease (const ::tenduke::se::licensing::Lease &lease)
	Adds a lease to heartbeat.
::tenduke::se::licensing::FluentLicenseHeartbeat &	lease (const std::string &leaseId, std::string clientVersion="")
	Adds a lease id to heart beat.
::tenduke::se::licensing::FluentLicenseHeartbeat &	lease (const std::string &leaseId, std::int64_t usedQty, bool treatAsIncrementalQty=false, std::string clientVersion="")
	Adds a lease id to heartbeat updating usage.
::tenduke::se::licensing::FluentLicenseHeartbeat &	leases (const std::vector<::tenduke::se::licensing::Lease > &licenses)
	Adds multiple leases to heartbeat.

Additional Inherited Members
Protected Attributes inherited from tenduke::se::licensing::FluentHeartbeatBuilder<::tenduke::se::licensing::FluentLicenseHeartbeat >
const std::string	licenseKey
	Licensekey.
std::vector<::tenduke::se::licensing::LicenseHeartbeatArguments >	arguments
	The individual arguments.
const std::string	licenseKey
	Licensekey.
std::vector<::tenduke::se::licensing::LicenseHeartbeatArguments >	arguments
	The individual arguments.
const std::string	licenseKey
	Licensekey.
std::vector<::tenduke::se::licensing::LicenseHeartbeatArguments >	arguments
	The individual arguments.

Constructor & Destructor Documentation

FluentLicenseHeartbeat()

tenduke::se::licensing::FluentLicenseHeartbeat::FluentLicenseHeartbeat ( 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::LicenseHeartbeatResponse tenduke::se::licensing::FluentLicenseHeartbeat::execute

(

)

Heartbeats the licenses.

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/heartbeat/FluentLicenseHeartbeat.h
• api/src/licensing/api/licenses/heartbeat/FluentLicenseHeartbeat.cpp