tenduke::se::licensing::FluentHeartbeatBuilder< Builder > Class Template Reference

#include <FluentHeartbeatBuilder.h>

Detailed Description

template<typename Builder>
class tenduke::se::licensing::FluentHeartbeatBuilder< Builder >

Base for fluent builder of hearbeat parameters.

Template Parameters

Builder

type of the concrete builder.

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

Protected Attributes
const std::string	licenseKey
	Licensekey.
std::vector<::tenduke::se::licensing::LicenseHeartbeatArguments >	arguments
	The individual arguments.

Constructor & Destructor Documentation

FluentHeartbeatBuilder()

template<typename Builder>

tenduke::se::licensing::FluentHeartbeatBuilder< Builder >::FluentHeartbeatBuilder ( std::string licenseKey = "" )

inlineexplicit

Constructs new instance.

Parameters

licenseKey

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

Member Function Documentation

lease() [1/3]

template<typename Builder>

Builder & tenduke::se::licensing::FluentHeartbeatBuilder< Builder >::lease ( const ::tenduke::se::licensing::Lease & lease )

inline

Adds a lease to heartbeat.

Parameters

lease

-

Returns

this instance for fluent method chaining

lease() [2/3]

template<typename Builder>

Builder & tenduke::se::licensing::FluentHeartbeatBuilder< Builder >::lease ( const std::string & leaseId, std::int64_t usedQty, bool treatAsIncrementalQty = false, std::string clientVersion = "" )

inline

Adds a lease id to heartbeat updating usage.

Parameters

leaseId	Lease id value as it was returned in last heartbeat response or initial license checkout if no heartbeat has been done before this heartbeat request.
usedQty	The amount used since initial license checkout / previous heartbeat. The usage quantity is an absolute value by default. Set field treatAsIncrementalQty = true to use an incremental tracking algorithm instead. NOTE: does NOT APPLY when using SEAT based licensing.
treatAsIncrementalQty	The amount used since initial license checkout / previous heartbeat. The usage quantity is an absolute value by default. Set field treatAsIncrementalQty = true to use an incremental tracking algorithm instead. NOTE: does NOT APPLY when using SEAT based licensing.
clientVersion	Client application version. Note: required when consuming licenses that have an allowed version range specified. Recommendation: client applications are encouraged to always send their version.

Returns

this instance for fluent method chaining

lease() [3/3]

template<typename Builder>

Builder & tenduke::se::licensing::FluentHeartbeatBuilder< Builder >::lease ( const std::string & leaseId, std::string clientVersion = "" )

inline

Adds a lease id to heart beat.

Uses 1 as quantity and false for treatAsIncrementalQty.

Parameters

leaseId	Lease id value as it was returned in last heartbeat response or initial license checkout if no heartbeat has been done before this heartbeat request.
clientVersion	Client application version. Note: required when consuming licenses that have an allowed version range specified. Recommendation: client applications are encouraged to always send their version.

Returns

this instance for fluent method chaining

leases()

template<typename Builder>

Builder & tenduke::se::licensing::FluentHeartbeatBuilder< Builder >::leases ( const std::vector<::tenduke::se::licensing::Lease > & licenses )

inline

Adds multiple leases to heartbeat.

Parameters

licenses

-

Returns

this instance for fluent method chaining

Member Data Documentation

licenseKey

template<typename Builder>

const std::string tenduke::se::licensing::FluentHeartbeatBuilder< Builder >::licenseKey

protected

Licensekey.

If empty this is not license-key operation.

---

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

• api/src/licensing/api/licenses/heartbeat/FluentHeartbeatBuilder.h