AlexaClientSDK  3.0.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
Public Member Functions | Static Public Member Functions | List of all members
alexaClientSDK::avsCommon::avs::initialization::InitializationParametersBuilder Class Reference

#include <InitializationParametersBuilder.h>

Public Member Functions

InitializationParametersBuilderwithJsonStreams (const std::shared_ptr< std::vector< std::shared_ptr< std::istream >>> &jsonStreams)
 
InitializationParametersBuilderwithPowerResourceManager (const std::shared_ptr< avsCommon::sdkInterfaces::PowerResourceManagerInterface > &powerResourceManager)
 
InitializationParametersBuilderwithTimerDelegateFactory (const std::shared_ptr< avsCommon::sdkInterfaces::timing::TimerDelegateFactoryInterface > &timerDelegateFactory)
 
std::unique_ptr< InitializationParametersbuild ()
 

Static Public Member Functions

static std::unique_ptr< InitializationParametersBuildercreate ()
 

Detailed Description

A class to contain the various parameters that are needed to initialize AlexaClientSDKInit.

Member Function Documentation

◆ build()

std::unique_ptr<InitializationParameters> alexaClientSDK::avsCommon::avs::initialization::InitializationParametersBuilder::build ( )

Build the InitializationParameters object.

Returns
If valid, an InitializationParameters object, otherwise nullptr.

◆ create()

static std::unique_ptr<InitializationParametersBuilder> alexaClientSDK::avsCommon::avs::initialization::InitializationParametersBuilder::create ( )
static

Creates an instance of the InitializationParametersBuilder.

Returns
A ptr to this builder.

◆ withJsonStreams()

InitializationParametersBuilder& alexaClientSDK::avsCommon::avs::initialization::InitializationParametersBuilder::withJsonStreams ( const std::shared_ptr< std::vector< std::shared_ptr< std::istream >>> &  jsonStreams)

Add JSON streams.

Parameters
jsonStreams.
Returns
This instance of the builder.

◆ withPowerResourceManager()

InitializationParametersBuilder& alexaClientSDK::avsCommon::avs::initialization::InitializationParametersBuilder::withPowerResourceManager ( const std::shared_ptr< avsCommon::sdkInterfaces::PowerResourceManagerInterface > &  powerResourceManager)

Add PowerResourceManagerInterface.

Parameters
powerResourceManagerThe PowerResourceManagerInterface.
Returns
This instance of the builder.

◆ withTimerDelegateFactory()

InitializationParametersBuilder& alexaClientSDK::avsCommon::avs::initialization::InitializationParametersBuilder::withTimerDelegateFactory ( const std::shared_ptr< avsCommon::sdkInterfaces::timing::TimerDelegateFactoryInterface > &  timerDelegateFactory)

Add TimerDelegateFactoryInterface.

Parameters
timerDelegateFactoryThe TimerDelegateFactoryInterface.
Returns
This instance of the builder.

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