client-cpp  0.0.1-SNAPSHOT
kaa::IEndpointRegistrationManager Class Referenceabstract

#include <IEndpointRegistrationManager.hpp>

+ Inheritance diagram for kaa::IEndpointRegistrationManager:

Public Member Functions

virtual void regenerateEndpointAccessToken ()=0
 
virtual const std::string & getEndpointAccessToken ()=0
 
virtual void attachEndpoint (const std::string &endpointAccessToken, IEndpointAttachStatusListener *listener=nullptr)=0
 
virtual void detachEndpoint (const std::string &endpointKeyHash, IEndpointAttachStatusListener *listener=nullptr)=0
 
virtual void detachEndpoint (IEndpointAttachStatusListener *listener=nullptr)=0
 
virtual void attachUser (const std::string &userExternalId, const std::string &userAccessToken, IEndpointAttachStatusListener *listener=nullptr)=0
 
virtual const AttachedEndpointsgetAttachedEndpoints ()=0
 
virtual void addAttachedEndpointListListener (IAttachedEndpointListListener *listener)=0
 
virtual void removeAttachedEndpointListListener (IAttachedEndpointListListener *listener)=0
 
virtual bool isCurrentEndpointAttached ()=0
 
virtual void setAttachStatusListener (IEndpointAttachStatusListener *listener)=0
 
virtual ~IEndpointRegistrationManager ()
 

Detailed Description

Manager which is responsible for Endpoints attach/detach.

Definition at line 33 of file IEndpointRegistrationManager.hpp.

Constructor & Destructor Documentation

virtual kaa::IEndpointRegistrationManager::~IEndpointRegistrationManager ( )
inlinevirtual

Definition at line 119 of file IEndpointRegistrationManager.hpp.

Member Function Documentation

virtual void kaa::IEndpointRegistrationManager::addAttachedEndpointListListener ( IAttachedEndpointListListener listener)
pure virtual

Adds listener of attached endpoint list changes

Parameters
listenerAttached endpoints list change listener

Implemented in kaa::EndpointRegistrationManager.

virtual void kaa::IEndpointRegistrationManager::attachEndpoint ( const std::string &  endpointAccessToken,
IEndpointAttachStatusListener listener = nullptr 
)
pure virtual

Adds new endpoint attach request

Parameters
endpointAccessTokenAccess token of the attaching endpoint
listenerOptional listener to notify about result of endpoint attaching. Set to null if is no need in it.

Implemented in kaa::EndpointRegistrationManager.

virtual void kaa::IEndpointRegistrationManager::attachUser ( const std::string &  userExternalId,
const std::string &  userAccessToken,
IEndpointAttachStatusListener listener = nullptr 
)
pure virtual

Creates user attach request

Parameters
userExternalId
userAccessToken
listenerOptional listener to notify about result of user attaching. Set to null if there is no need in it.

Implemented in kaa::EndpointRegistrationManager.

virtual void kaa::IEndpointRegistrationManager::detachEndpoint ( const std::string &  endpointKeyHash,
IEndpointAttachStatusListener listener = nullptr 
)
pure virtual

Adds new endpoint detach request

Parameters
endpointKeyHashKey hash of the attached endpoint
listenerOptional listener to notify about result of endpoint detaching. Set to null if is no need in it.

Implemented in kaa::EndpointRegistrationManager.

virtual void kaa::IEndpointRegistrationManager::detachEndpoint ( IEndpointAttachStatusListener listener = nullptr)
pure virtual

Adds current endpoint detach request

Parameters
listenerOptional listener to notify about result of endpoint detaching. Set to null if is no need in it.

Implemented in kaa::EndpointRegistrationManager.

virtual const AttachedEndpoints& kaa::IEndpointRegistrationManager::getAttachedEndpoints ( )
pure virtual

Retrieves list of attached endpoints

Returns
set of attached endpoint's "access token/key hash" pair

Implemented in kaa::EndpointRegistrationManager.

virtual const std::string& kaa::IEndpointRegistrationManager::getEndpointAccessToken ( )
pure virtual

Retrieve an access token for a current endpoint

Implemented in kaa::EndpointRegistrationManager.

virtual bool kaa::IEndpointRegistrationManager::isCurrentEndpointAttached ( )
pure virtual

Checks if current endpoint is already attached to some user

Implemented in kaa::EndpointRegistrationManager.

virtual void kaa::IEndpointRegistrationManager::regenerateEndpointAccessToken ( )
pure virtual

Generate new access token for a current endpoint

Implemented in kaa::EndpointRegistrationManager.

virtual void kaa::IEndpointRegistrationManager::removeAttachedEndpointListListener ( IAttachedEndpointListListener listener)
pure virtual

Removes listener of attached endpoint list changes

Parameters
listenerAttached endpoints list change listener

Implemented in kaa::EndpointRegistrationManager.

virtual void kaa::IEndpointRegistrationManager::setAttachStatusListener ( IEndpointAttachStatusListener listener)
pure virtual

Set lister to notify about attaching/detaching the current endpoint either by itself or another endpoint

Parameters
listenerAttach status listener

Implemented in kaa::EndpointRegistrationManager.


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