AlexaClientSDK  3.0.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
Public Member Functions | List of all members
alexaClientSDK::acsdkAuthorizationInterfaces::lwa::LWAAuthorizationInterface Class Referenceabstract

#include <LWAAuthorizationInterface.h>

Inheritance diagram for alexaClientSDK::acsdkAuthorizationInterfaces::lwa::LWAAuthorizationInterface:
Inheritance graph
[legend]
Collaboration diagram for alexaClientSDK::acsdkAuthorizationInterfaces::lwa::LWAAuthorizationInterface:
Collaboration graph
[legend]

Public Member Functions

virtual ~LWAAuthorizationInterface ()=default
 Destructor. More...
 
virtual bool authorizeUsingCBL (const std::shared_ptr< CBLAuthorizationObserverInterface > &observer)=0
 
virtual bool authorizeUsingCBLWithCustomerProfile (const std::shared_ptr< CBLAuthorizationObserverInterface > &observer)=0
 
- Public Member Functions inherited from alexaClientSDK::acsdkAuthorizationInterfaces::AuthorizationInterface
virtual ~AuthorizationInterface ()=default
 Destructor. More...
 
virtual std::string getId ()=0
 

Detailed Description

This adapter provides mechanisms to authorize with LWA.

Constructor & Destructor Documentation

◆ ~LWAAuthorizationInterface()

virtual alexaClientSDK::acsdkAuthorizationInterfaces::lwa::LWAAuthorizationInterface::~LWAAuthorizationInterface ( )
virtualdefault

Destructor.

Member Function Documentation

◆ authorizeUsingCBL()

virtual bool alexaClientSDK::acsdkAuthorizationInterfaces::lwa::LWAAuthorizationInterface::authorizeUsingCBL ( const std::shared_ptr< CBLAuthorizationObserverInterface > &  observer)
pure virtual

Authorize using LWA and the Code Based Linking method.

Parameters
observerThe CBL observer which will receive a callback to display information back to the user. This will be be sent in an CBLAuthorizationObserverInterface callback.

◆ authorizeUsingCBLWithCustomerProfile()

virtual bool alexaClientSDK::acsdkAuthorizationInterfaces::lwa::LWAAuthorizationInterface::authorizeUsingCBLWithCustomerProfile ( const std::shared_ptr< CBLAuthorizationObserverInterface > &  observer)
pure virtual

Authorize using LWA and the Code Based Linking method. This API additionally requets customer profile information (name, email).

Attention
THE USER MUST CONSENT (EX. UI DIALOG) BEFORE APPLICATION CAN REQUEST CUSTOMER PROFILE INFORMATION.
Parameters
observerThe CBL observer which will receive a callback to display information back to the user. This will be sent in an CBLAuthorizationObserverInterface callback.

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

AlexaClientSDK 3.0.0 - Copyright 2016-2022 Amazon.com, Inc. or its affiliates. All Rights Reserved. Licensed under the Apache License, Version 2.0