ProtectionEngine::Observer Class Reference

Interface that receives notifications related to ProtectionEngine. More...

#include <src/api/mip/protection/protection_engine.h>

Public Member Functions
virtual void	OnCreateDelegatedLicensesFailure (const std::exception_ptr &error, const std::shared_ptr< void > &context)
	Called when create delegated license fails.
virtual void	OnCreateDelegatedLicensesSuccess (std::vector< std::shared_ptr< DelegationLicense > > delegatedLicenses, const std::shared_ptr< void > &context)
	Called when create delegated license is successful.
virtual void	OnGetLicenseRightsDataFailure (const std::exception_ptr &error, const std::shared_ptr< void > &context)
	Called when retrieving license rights data fails.
virtual void	OnGetLicenseRightsDataSuccess (const std::shared_ptr< LicenseRightsData > &licenseRightsData, const std::shared_ptr< void > &context)
	Called when license rights data were retrieved successfully.
virtual void	OnGetRightsForLabelIdFailure (const std::exception_ptr &error, const std::shared_ptr< void > &context)
	Called when retrieving rights for a label ID for the user.
virtual void	OnGetRightsForLabelIdSuccess (const std::shared_ptr< std::vector< std::string > > &rights, const std::shared_ptr< void > &context)
	Called when rights were retrieved successfully.
virtual void	OnGetTemplatesFailure (const std::exception_ptr &error, const std::shared_ptr< void > &context)
	Called when retrieving templates generated an error.
virtual void	OnGetTemplatesSuccess (const std::vector< std::shared_ptr< TemplateDescriptor > > &templateDescriptors, const std::shared_ptr< void > &context)
	Called when templates were retrieved successfully.
virtual void	OnGetTenantInformationAsyncFailure (const std::exception_ptr &error, const std::shared_ptr< void > &context)
	Called when GetTenantInformationAsync fails.
virtual void	OnGetTenantInformationAsyncSuccess (const std::shared_ptr< TenantInformation > &tenantInformation, const std::shared_ptr< void > &context)
	Called when GetTenantInformationAsync is successful.
virtual void	OnLoadUserCertFailure (const std::exception_ptr &error, const std::shared_ptr< void > &context)
	Called when user cert loaded failed.
virtual void	OnLoadUserCertSuccess (const std::shared_ptr< void > &context)
	Called when user cert loaded successfully.
virtual void	OnRegisterContentForTrackingAndRevocationFailure (const std::exception_ptr &error, const std::shared_ptr< void > &context)
	Called when registration of content for tracking & revocation fails.
virtual void	OnRegisterContentForTrackingAndRevocationSuccess (const std::shared_ptr< void > &context)
	Called when registration of content for tracking & revocation is successful.
virtual void	OnRevokeContentFailure (const std::exception_ptr &error, const std::shared_ptr< void > &context)
	Called when revocation of content is fails.
virtual void	OnRevokeContentSuccess (const std::shared_ptr< void > &context)
	Called when revocation of is successful.

Detailed Description

Interface that receives notifications related to ProtectionEngine.

Note

This interface must be implemented by applications using the protection SDK

Definition at line 81 of file protection_engine.h.

Member Function Documentation

OnCreateDelegatedLicensesFailure()

virtual void ProtectionEngine::Observer::OnCreateDelegatedLicensesFailure ( const std::exception_ptr & error, const std::shared_ptr< void > & context )

inlinevirtual

Called when create delegated license fails.

Parameters

error	Error that occurred
context	The same context that was passed to ProtectionEngine::CreateDelegationLicensesAsync

Note

An application can pass any type of context (for example, std::promise, std::function) to ProtectionEngine::CreateDelegationLicensesAsync and that same context will be forwarded as-is to ProtectionEngine::Observer::OnCreateDelegatedLicensesSuccess or ProtectionEngine::Observer::OnCreateDelegatedLicensesFailure

Definition at line 240 of file protection_engine.h.

                                            { UNUSED(error); UNUSED(context); }

OnCreateDelegatedLicensesSuccess()

virtual void ProtectionEngine::Observer::OnCreateDelegatedLicensesSuccess ( std::vector< std::shared_ptr< DelegationLicense > > delegatedLicenses, const std::shared_ptr< void > & context )

inlinevirtual

Called when create delegated license is successful.

Parameters

context

The same context that was passed to ProtectionEngine::CreateDelegationLicensesAsync

Note

An application can pass any type of context (for example, std::promise, std::function) to ProtectionEngine::CreateDelegationLicensesAsync and that same context will be forwarded as-is to ProtectionEngine::Observer::OnCreateDelegatedLicensesSuccess or ProtectionEngine::Observer::OnCreateDelegatedLicensesFailure

Definition at line 226 of file protection_engine.h.

                                            { UNUSED(delegatedLicenses); UNUSED(context); }

OnGetLicenseRightsDataFailure()

virtual void ProtectionEngine::Observer::OnGetLicenseRightsDataFailure ( const std::exception_ptr & error, const std::shared_ptr< void > & context )

inlinevirtual

Called when retrieving license rights data fails.

Parameters

error	Error that occurred while retrieving license rights data
context	The same context that was passed to ProtectionEngine::GetLicenseRightsDataAsync

Note

An application can pass any type of context (for example, std::promise, std::function) to ProtectionEngine::GetLicenseRightsDataAsync and that same context will be forwarded as-is to ProtectionEngine::Observer::OnGetLicenseRightsDataSuccess or ProtectionEngine::Observer::OnGetLicenseRightsDataFailure

Definition at line 295 of file protection_engine.h.

                                            { UNUSED(error); UNUSED(context); }

OnGetLicenseRightsDataSuccess()

virtual void ProtectionEngine::Observer::OnGetLicenseRightsDataSuccess ( const std::shared_ptr< LicenseRightsData > & licenseRightsData, const std::shared_ptr< void > & context )

inlinevirtual

Called when license rights data were retrieved successfully.

Parameters

rights	A reference to the license rights data retrieved
context	The same context that was passed to ProtectionEngine::GetLicenseRightsDataAsync

Note

An application can pass any type of context (for example, std::promise, std::function) to ProtectionEngine::GetLicenseRightsDataAsync and that same context will be forwarded as-is to ProtectionEngine::Observer::OnGetLicenseRightsDataSuccess or ProtectionEngine::Observer::OnGetLicenseRightsDataFailure

Definition at line 281 of file protection_engine.h.

                                            { UNUSED(licenseRightsData); UNUSED(context); }

OnGetRightsForLabelIdFailure()

virtual void ProtectionEngine::Observer::OnGetRightsForLabelIdFailure ( const std::exception_ptr & error, const std::shared_ptr< void > & context )

inlinevirtual

Called when retrieving rights for a label ID for the user.

Parameters

error	Error that occurred while retrieving rights
context	The same context that was passed to ProtectionEngine::GetRightsForLabelIdAsync

Note

An application can pass any type of context (for example, std::promise, std::function) to ProtectionEngine::GetRightsForLabelIdAsync and that same context will be forwarded as-is to ProtectionEngine::Observer::OnGetRightsForLabelIdSuccess or ProtectionEngine::Observer::OnGetRightsForLabelIdFailure

Definition at line 135 of file protection_engine.h.

                                            { UNUSED(error); UNUSED(context); }

OnGetRightsForLabelIdSuccess()

virtual void ProtectionEngine::Observer::OnGetRightsForLabelIdSuccess ( const std::shared_ptr< std::vector< std::string > > & rights, const std::shared_ptr< void > & context )

inlinevirtual

Called when rights were retrieved successfully.

Parameters

rights	A reference to the list of rights retrieved
context	The same context that was passed to ProtectionEngine::GetRightsForLabelIdAsync

Note

An application can pass any type of context (for example, std::promise, std::function) to ProtectionEngine::GetRightsForLabelIdAsync and that same context will be forwarded as-is to ProtectionEngine::Observer::OnGetRightsForLabelIdSuccess or ProtectionEngine::Observer::OnGetRightsForLabelIdFailure

Definition at line 121 of file protection_engine.h.

                                            { UNUSED(rights); UNUSED(context); }

OnGetTemplatesFailure()

virtual void ProtectionEngine::Observer::OnGetTemplatesFailure ( const std::exception_ptr & error, const std::shared_ptr< void > & context )

inlinevirtual

Called when retrieving templates generated an error.

Parameters

error	Error that occurred while retrieving templates
context	The same context that was passed to ProtectionEngine::GetTemplatesAsync

Note

An application can pass any type of context (for example, std::promise, std::function) to ProtectionEngine::GetTemplatesAsync and that same context will be forwarded as-is to ProtectionEngine::Observer::OnGetTemplatesSuccess or ProtectionEngine::Observer::OnGetTemplatesFailure

Definition at line 107 of file protection_engine.h.

                                            { UNUSED(error); UNUSED(context); }

OnGetTemplatesSuccess()

virtual void ProtectionEngine::Observer::OnGetTemplatesSuccess ( const std::vector< std::shared_ptr< TemplateDescriptor > > & templateDescriptors, const std::shared_ptr< void > & context )

inlinevirtual

Called when templates were retrieved successfully.

Parameters

templateDescriptors	A reference to the list of templates descriptors
context	The same context that was passed to ProtectionEngine::GetTemplatesAsync

Note

An application can pass any type of context (for example, std::promise, std::function) to ProtectionEngine::GetTemplatesAsync and that same context will be forwarded as-is to ProtectionEngine::Observer::OnGetTemplatesSuccess or ProtectionEngine::Observer::OnGetTemplatesFailure

Definition at line 93 of file protection_engine.h.

                                            { UNUSED(templateDescriptors); UNUSED(context); }

OnGetTenantInformationAsyncFailure()

virtual void ProtectionEngine::Observer::OnGetTenantInformationAsyncFailure ( const std::exception_ptr & error, const std::shared_ptr< void > & context )

inlinevirtual

Called when GetTenantInformationAsync fails.

Parameters

error	Error that occurred
context	The same context that was passed to ProtectionEngine::GetTenantInformationAsync

Note

An application can pass any type of context (for example, std::promise, std::function) to ProtectionEngine::GetTenantInformationAsync and that same context will be forwarded as-is to ProtectionEngine::Observer::OnGetTenantInformationAsyncSuccess or ProtectionEngine::Observer::OnGetTenantInformationAsyncFailure

Definition at line 267 of file protection_engine.h.

                                            { UNUSED(error); UNUSED(context); }

OnGetTenantInformationAsyncSuccess()

virtual void ProtectionEngine::Observer::OnGetTenantInformationAsyncSuccess ( const std::shared_ptr< TenantInformation > & tenantInformation, const std::shared_ptr< void > & context )

inlinevirtual

Called when GetTenantInformationAsync is successful.

Parameters

context

The same context that was passed to ProtectionEngine::GetTenantInformationAsync

Note

An application can pass any type of context (for example, std::promise, std::function) to ProtectionEngine::GetTenantInformationAsync and that same context will be forwarded as-is to ProtectionEngine::Observer::OnGetTenantInformationAsyncSuccess or ProtectionEngine::Observer::OnGetTenantInformationAsyncFailure

Definition at line 253 of file protection_engine.h.

                                            { UNUSED(tenantInformation); UNUSED(context); }

OnLoadUserCertFailure()

virtual void ProtectionEngine::Observer::OnLoadUserCertFailure ( const std::exception_ptr & error, const std::shared_ptr< void > & context )

inlinevirtual

Called when user cert loaded failed.

Parameters

error	Error that occurred while retrieving rights
context	The same context that was passed to ProtectionEngine::LoadUserCert

Note

An application can pass any type of context (for example, std::promise, std::function) to ProtectionEngine::LoadUserCertAsync and that same context will be forwarded as-is to ProtectionEngine::Observer::OnLoadUserCertSuccess or ProtectionEngine::Observer::OnLoadUserCertFailure

Definition at line 161 of file protection_engine.h.

                                            { UNUSED(error); UNUSED(context); }

OnLoadUserCertSuccess()

virtual void ProtectionEngine::Observer::OnLoadUserCertSuccess ( const std::shared_ptr< void > & context )

inlinevirtual

Called when user cert loaded successfully.

Parameters

context

The same context that was passed to ProtectionEngine::LoadUserCert

Note

An application can pass any type of context (for example, std::promise, std::function) to ProtectionEngine::LoadUserCertAsync and that same context will be forwarded as-is to ProtectionEngine::Observer::OnLoadUserCertSuccess or ProtectionEngine::Observer::OnLoadUserCertFailure

Definition at line 148 of file protection_engine.h.

                                            { UNUSED(context); }

OnRegisterContentForTrackingAndRevocationFailure()

virtual void ProtectionEngine::Observer::OnRegisterContentForTrackingAndRevocationFailure ( const std::exception_ptr & error, const std::shared_ptr< void > & context )

inlinevirtual

Called when registration of content for tracking & revocation fails.

Parameters

error	Error that occurred while registering content
context	The same context that was passed to ProtectionEngine::RegisterContentForTrackingAndRevocationAsync

Note

An application can pass any type of context (for example, std::promise, std::function) to ProtectionEngine::RegisterContentForTrackingAndRevocationAsync and that same context will be forwarded as-is to ProtectionEngine::Observer::OnRegisterContentForTrackingAndRevocationSuccess or ProtectionEngine::Observer::OnRegisterContentForTrackingAndRevocationFailure

Definition at line 187 of file protection_engine.h.

                                            { UNUSED(error); UNUSED(context); }

OnRegisterContentForTrackingAndRevocationSuccess()

virtual void ProtectionEngine::Observer::OnRegisterContentForTrackingAndRevocationSuccess ( const std::shared_ptr< void > & context )

inlinevirtual

Called when registration of content for tracking & revocation is successful.

Parameters

context

The same context that was passed to ProtectionEngine::RegisterContentForTrackingAndRevocationAsync

Note

An application can pass any type of context (for example, std::promise, std::function) to ProtectionEngine::RegisterContentForTrackingAndRevocationAsync and that same context will be forwarded as-is to ProtectionEngine::Observer::OnRegisterContentForTrackingAndRevocationSuccess or ProtectionEngine::Observer::OnRegisterContentForTrackingAndRevocationFailure

Definition at line 174 of file protection_engine.h.

                                            { UNUSED(context); }

OnRevokeContentFailure()

virtual void ProtectionEngine::Observer::OnRevokeContentFailure ( const std::exception_ptr & error, const std::shared_ptr< void > & context )

inlinevirtual

Called when revocation of content is fails.

Parameters

error	Error that occurred while revoking content
context	The same context that was passed to ProtectionEngine::RevokeContentAsync

Note

An application can pass any type of context (for example, std::promise, std::function) to ProtectionEngine::RevokeContentAsync and that same context will be forwarded as-is to ProtectionEngine::Observer::OnRevokeContentSuccess or ProtectionEngine::Observer::OnRevokeContentFailure

Definition at line 213 of file protection_engine.h.

                                            { UNUSED(error); UNUSED(context); }

OnRevokeContentSuccess()

virtual void ProtectionEngine::Observer::OnRevokeContentSuccess ( const std::shared_ptr< void > & context )

inlinevirtual

Called when revocation of is successful.

Parameters

context

The same context that was passed to ProtectionEngine::RevokeContentAsync

Note

An application can pass any type of context (for example, std::promise, std::function) to ProtectionEngine::RevokeContentAsync and that same context will be forwarded as-is to ProtectionEngine::Observer::OnRevokeContentSuccess or ProtectionEngine::Observer::OnRevokeContentFailure

Definition at line 200 of file protection_engine.h.

                                            { UNUSED(context); }

---

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

• src/api/mip/protection/protection_engine.h