EventBuilder.h

Go to the documentation of this file.

/*
 * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License").
 * You may not use this file except in compliance with the License.
 * A copy of the License is located at
 *
 *     http://aws.amazon.com/apache2.0/
 *
 * or in the "license" file accompanying this file. This file is distributed
 * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
 * express or implied. See the License for the specific language governing
 * permissions and limitations under the License.
 */

#ifndef ALEXA_CLIENT_SDK_AVSCOMMON_AVS_INCLUDE_AVSCOMMON_AVS_EVENTBUILDER_H_
#define ALEXA_CLIENT_SDK_AVSCOMMON_AVS_INCLUDE_AVSCOMMON_AVS_EVENTBUILDER_H_

#include <string>
#include <unordered_set>
#include <utility>

#include <AVSCommon/Utils/Optional.h>

#include "AVSCommon/AVS/AVSContext.h"
#include "AVSCommon/AVS/AVSMessageEndpoint.h"
#include "AVSCommon/AVS/AVSMessageHeader.h"
#include "AVSCommon/AVS/CapabilityConfiguration.h"

namespace alexaClientSDK {
namespace avsCommon {
namespace avs {
namespace constants {

static const std::string NAMESPACE_KEY_STRING = "namespace";

static const std::string NAME_KEY_STRING = "name";

static const std::string HEADER_KEY_STRING = "header";

static const std::string PAYLOAD_KEY_STRING = "payload";

}  // namespace constants

const std::pair<std::string, std::string> buildJsonEventString(
    const std::string& nameSpace,
    const std::string& eventName,
    const std::string& dialogRequestIdValue = "",
    const std::string& jsonPayloadValue = "{}",
    const std::string& jsonContext = "");

std::string buildJsonEventString(
    const AVSMessageHeader& eventHeader,
    const utils::Optional<AVSMessageEndpoint>& endpoint,
    const std::string& jsonPayloadValue,
    const std::string& jsonContext);

std::string buildJsonEventString(
    const AVSMessageHeader& eventHeader,
    const utils::Optional<AVSMessageEndpoint>& endpoint = utils::Optional<AVSMessageEndpoint>(),
    const std::string& jsonPayloadValue = "{}",
    const utils::Optional<AVSContext>& context = utils::Optional<AVSContext>());

}  // namespace avs
}  // namespace avsCommon
}  // namespace alexaClientSDK

#endif  // ALEXA_CLIENT_SDK_AVSCOMMON_AVS_INCLUDE_AVSCOMMON_AVS_EVENTBUILDER_H_