This repository has been archived on 2025-09-14. You can view files and clone it, but cannot push or open issues or pull requests.
Files
pxz-hos-client-cpp-module/support/aws-sdk-cpp-master/aws-cpp-sdk-pinpoint/include/aws/pinpoint/model/APNSSandboxChannelRequest.h

442 lines
17 KiB
C
Raw Normal View History

/**
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
* SPDX-License-Identifier: Apache-2.0.
*/
#pragma once
#include <aws/pinpoint/Pinpoint_EXPORTS.h>
#include <aws/core/utils/memory/stl/AWSString.h>
#include <utility>
namespace Aws
{
namespace Utils
{
namespace Json
{
class JsonValue;
class JsonView;
} // namespace Json
} // namespace Utils
namespace Pinpoint
{
namespace Model
{
/**
* <p>Specifies the status and settings of the APNs (Apple Push Notification
* service) sandbox channel for an application.</p><p><h3>See Also:</h3> <a
* href="http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/APNSSandboxChannelRequest">AWS
* API Reference</a></p>
*/
class AWS_PINPOINT_API APNSSandboxChannelRequest
{
public:
APNSSandboxChannelRequest();
APNSSandboxChannelRequest(Aws::Utils::Json::JsonView jsonValue);
APNSSandboxChannelRequest& operator=(Aws::Utils::Json::JsonView jsonValue);
Aws::Utils::Json::JsonValue Jsonize() const;
/**
* <p>The bundle identifier that's assigned to your iOS app. This identifier is
* used for APNs tokens.</p>
*/
inline const Aws::String& GetBundleId() const{ return m_bundleId; }
/**
* <p>The bundle identifier that's assigned to your iOS app. This identifier is
* used for APNs tokens.</p>
*/
inline bool BundleIdHasBeenSet() const { return m_bundleIdHasBeenSet; }
/**
* <p>The bundle identifier that's assigned to your iOS app. This identifier is
* used for APNs tokens.</p>
*/
inline void SetBundleId(const Aws::String& value) { m_bundleIdHasBeenSet = true; m_bundleId = value; }
/**
* <p>The bundle identifier that's assigned to your iOS app. This identifier is
* used for APNs tokens.</p>
*/
inline void SetBundleId(Aws::String&& value) { m_bundleIdHasBeenSet = true; m_bundleId = std::move(value); }
/**
* <p>The bundle identifier that's assigned to your iOS app. This identifier is
* used for APNs tokens.</p>
*/
inline void SetBundleId(const char* value) { m_bundleIdHasBeenSet = true; m_bundleId.assign(value); }
/**
* <p>The bundle identifier that's assigned to your iOS app. This identifier is
* used for APNs tokens.</p>
*/
inline APNSSandboxChannelRequest& WithBundleId(const Aws::String& value) { SetBundleId(value); return *this;}
/**
* <p>The bundle identifier that's assigned to your iOS app. This identifier is
* used for APNs tokens.</p>
*/
inline APNSSandboxChannelRequest& WithBundleId(Aws::String&& value) { SetBundleId(std::move(value)); return *this;}
/**
* <p>The bundle identifier that's assigned to your iOS app. This identifier is
* used for APNs tokens.</p>
*/
inline APNSSandboxChannelRequest& WithBundleId(const char* value) { SetBundleId(value); return *this;}
/**
* <p>The APNs client certificate that you received from Apple, if you want Amazon
* Pinpoint to communicate with the APNs sandbox environment by using an APNs
* certificate.</p>
*/
inline const Aws::String& GetCertificate() const{ return m_certificate; }
/**
* <p>The APNs client certificate that you received from Apple, if you want Amazon
* Pinpoint to communicate with the APNs sandbox environment by using an APNs
* certificate.</p>
*/
inline bool CertificateHasBeenSet() const { return m_certificateHasBeenSet; }
/**
* <p>The APNs client certificate that you received from Apple, if you want Amazon
* Pinpoint to communicate with the APNs sandbox environment by using an APNs
* certificate.</p>
*/
inline void SetCertificate(const Aws::String& value) { m_certificateHasBeenSet = true; m_certificate = value; }
/**
* <p>The APNs client certificate that you received from Apple, if you want Amazon
* Pinpoint to communicate with the APNs sandbox environment by using an APNs
* certificate.</p>
*/
inline void SetCertificate(Aws::String&& value) { m_certificateHasBeenSet = true; m_certificate = std::move(value); }
/**
* <p>The APNs client certificate that you received from Apple, if you want Amazon
* Pinpoint to communicate with the APNs sandbox environment by using an APNs
* certificate.</p>
*/
inline void SetCertificate(const char* value) { m_certificateHasBeenSet = true; m_certificate.assign(value); }
/**
* <p>The APNs client certificate that you received from Apple, if you want Amazon
* Pinpoint to communicate with the APNs sandbox environment by using an APNs
* certificate.</p>
*/
inline APNSSandboxChannelRequest& WithCertificate(const Aws::String& value) { SetCertificate(value); return *this;}
/**
* <p>The APNs client certificate that you received from Apple, if you want Amazon
* Pinpoint to communicate with the APNs sandbox environment by using an APNs
* certificate.</p>
*/
inline APNSSandboxChannelRequest& WithCertificate(Aws::String&& value) { SetCertificate(std::move(value)); return *this;}
/**
* <p>The APNs client certificate that you received from Apple, if you want Amazon
* Pinpoint to communicate with the APNs sandbox environment by using an APNs
* certificate.</p>
*/
inline APNSSandboxChannelRequest& WithCertificate(const char* value) { SetCertificate(value); return *this;}
/**
* <p>The default authentication method that you want Amazon Pinpoint to use when
* authenticating with the APNs sandbox environment, key or certificate.</p>
*/
inline const Aws::String& GetDefaultAuthenticationMethod() const{ return m_defaultAuthenticationMethod; }
/**
* <p>The default authentication method that you want Amazon Pinpoint to use when
* authenticating with the APNs sandbox environment, key or certificate.</p>
*/
inline bool DefaultAuthenticationMethodHasBeenSet() const { return m_defaultAuthenticationMethodHasBeenSet; }
/**
* <p>The default authentication method that you want Amazon Pinpoint to use when
* authenticating with the APNs sandbox environment, key or certificate.</p>
*/
inline void SetDefaultAuthenticationMethod(const Aws::String& value) { m_defaultAuthenticationMethodHasBeenSet = true; m_defaultAuthenticationMethod = value; }
/**
* <p>The default authentication method that you want Amazon Pinpoint to use when
* authenticating with the APNs sandbox environment, key or certificate.</p>
*/
inline void SetDefaultAuthenticationMethod(Aws::String&& value) { m_defaultAuthenticationMethodHasBeenSet = true; m_defaultAuthenticationMethod = std::move(value); }
/**
* <p>The default authentication method that you want Amazon Pinpoint to use when
* authenticating with the APNs sandbox environment, key or certificate.</p>
*/
inline void SetDefaultAuthenticationMethod(const char* value) { m_defaultAuthenticationMethodHasBeenSet = true; m_defaultAuthenticationMethod.assign(value); }
/**
* <p>The default authentication method that you want Amazon Pinpoint to use when
* authenticating with the APNs sandbox environment, key or certificate.</p>
*/
inline APNSSandboxChannelRequest& WithDefaultAuthenticationMethod(const Aws::String& value) { SetDefaultAuthenticationMethod(value); return *this;}
/**
* <p>The default authentication method that you want Amazon Pinpoint to use when
* authenticating with the APNs sandbox environment, key or certificate.</p>
*/
inline APNSSandboxChannelRequest& WithDefaultAuthenticationMethod(Aws::String&& value) { SetDefaultAuthenticationMethod(std::move(value)); return *this;}
/**
* <p>The default authentication method that you want Amazon Pinpoint to use when
* authenticating with the APNs sandbox environment, key or certificate.</p>
*/
inline APNSSandboxChannelRequest& WithDefaultAuthenticationMethod(const char* value) { SetDefaultAuthenticationMethod(value); return *this;}
/**
* <p>Specifies whether to enable the APNs sandbox channel for the application.</p>
*/
inline bool GetEnabled() const{ return m_enabled; }
/**
* <p>Specifies whether to enable the APNs sandbox channel for the application.</p>
*/
inline bool EnabledHasBeenSet() const { return m_enabledHasBeenSet; }
/**
* <p>Specifies whether to enable the APNs sandbox channel for the application.</p>
*/
inline void SetEnabled(bool value) { m_enabledHasBeenSet = true; m_enabled = value; }
/**
* <p>Specifies whether to enable the APNs sandbox channel for the application.</p>
*/
inline APNSSandboxChannelRequest& WithEnabled(bool value) { SetEnabled(value); return *this;}
/**
* <p>The private key for the APNs client certificate that you want Amazon Pinpoint
* to use to communicate with the APNs sandbox environment.</p>
*/
inline const Aws::String& GetPrivateKey() const{ return m_privateKey; }
/**
* <p>The private key for the APNs client certificate that you want Amazon Pinpoint
* to use to communicate with the APNs sandbox environment.</p>
*/
inline bool PrivateKeyHasBeenSet() const { return m_privateKeyHasBeenSet; }
/**
* <p>The private key for the APNs client certificate that you want Amazon Pinpoint
* to use to communicate with the APNs sandbox environment.</p>
*/
inline void SetPrivateKey(const Aws::String& value) { m_privateKeyHasBeenSet = true; m_privateKey = value; }
/**
* <p>The private key for the APNs client certificate that you want Amazon Pinpoint
* to use to communicate with the APNs sandbox environment.</p>
*/
inline void SetPrivateKey(Aws::String&& value) { m_privateKeyHasBeenSet = true; m_privateKey = std::move(value); }
/**
* <p>The private key for the APNs client certificate that you want Amazon Pinpoint
* to use to communicate with the APNs sandbox environment.</p>
*/
inline void SetPrivateKey(const char* value) { m_privateKeyHasBeenSet = true; m_privateKey.assign(value); }
/**
* <p>The private key for the APNs client certificate that you want Amazon Pinpoint
* to use to communicate with the APNs sandbox environment.</p>
*/
inline APNSSandboxChannelRequest& WithPrivateKey(const Aws::String& value) { SetPrivateKey(value); return *this;}
/**
* <p>The private key for the APNs client certificate that you want Amazon Pinpoint
* to use to communicate with the APNs sandbox environment.</p>
*/
inline APNSSandboxChannelRequest& WithPrivateKey(Aws::String&& value) { SetPrivateKey(std::move(value)); return *this;}
/**
* <p>The private key for the APNs client certificate that you want Amazon Pinpoint
* to use to communicate with the APNs sandbox environment.</p>
*/
inline APNSSandboxChannelRequest& WithPrivateKey(const char* value) { SetPrivateKey(value); return *this;}
/**
* <p>The identifier that's assigned to your Apple developer account team. This
* identifier is used for APNs tokens.</p>
*/
inline const Aws::String& GetTeamId() const{ return m_teamId; }
/**
* <p>The identifier that's assigned to your Apple developer account team. This
* identifier is used for APNs tokens.</p>
*/
inline bool TeamIdHasBeenSet() const { return m_teamIdHasBeenSet; }
/**
* <p>The identifier that's assigned to your Apple developer account team. This
* identifier is used for APNs tokens.</p>
*/
inline void SetTeamId(const Aws::String& value) { m_teamIdHasBeenSet = true; m_teamId = value; }
/**
* <p>The identifier that's assigned to your Apple developer account team. This
* identifier is used for APNs tokens.</p>
*/
inline void SetTeamId(Aws::String&& value) { m_teamIdHasBeenSet = true; m_teamId = std::move(value); }
/**
* <p>The identifier that's assigned to your Apple developer account team. This
* identifier is used for APNs tokens.</p>
*/
inline void SetTeamId(const char* value) { m_teamIdHasBeenSet = true; m_teamId.assign(value); }
/**
* <p>The identifier that's assigned to your Apple developer account team. This
* identifier is used for APNs tokens.</p>
*/
inline APNSSandboxChannelRequest& WithTeamId(const Aws::String& value) { SetTeamId(value); return *this;}
/**
* <p>The identifier that's assigned to your Apple developer account team. This
* identifier is used for APNs tokens.</p>
*/
inline APNSSandboxChannelRequest& WithTeamId(Aws::String&& value) { SetTeamId(std::move(value)); return *this;}
/**
* <p>The identifier that's assigned to your Apple developer account team. This
* identifier is used for APNs tokens.</p>
*/
inline APNSSandboxChannelRequest& WithTeamId(const char* value) { SetTeamId(value); return *this;}
/**
* <p>The authentication key to use for APNs tokens.</p>
*/
inline const Aws::String& GetTokenKey() const{ return m_tokenKey; }
/**
* <p>The authentication key to use for APNs tokens.</p>
*/
inline bool TokenKeyHasBeenSet() const { return m_tokenKeyHasBeenSet; }
/**
* <p>The authentication key to use for APNs tokens.</p>
*/
inline void SetTokenKey(const Aws::String& value) { m_tokenKeyHasBeenSet = true; m_tokenKey = value; }
/**
* <p>The authentication key to use for APNs tokens.</p>
*/
inline void SetTokenKey(Aws::String&& value) { m_tokenKeyHasBeenSet = true; m_tokenKey = std::move(value); }
/**
* <p>The authentication key to use for APNs tokens.</p>
*/
inline void SetTokenKey(const char* value) { m_tokenKeyHasBeenSet = true; m_tokenKey.assign(value); }
/**
* <p>The authentication key to use for APNs tokens.</p>
*/
inline APNSSandboxChannelRequest& WithTokenKey(const Aws::String& value) { SetTokenKey(value); return *this;}
/**
* <p>The authentication key to use for APNs tokens.</p>
*/
inline APNSSandboxChannelRequest& WithTokenKey(Aws::String&& value) { SetTokenKey(std::move(value)); return *this;}
/**
* <p>The authentication key to use for APNs tokens.</p>
*/
inline APNSSandboxChannelRequest& WithTokenKey(const char* value) { SetTokenKey(value); return *this;}
/**
* <p>The key identifier that's assigned to your APNs signing key, if you want
* Amazon Pinpoint to communicate with the APNs sandbox environment by using APNs
* tokens.</p>
*/
inline const Aws::String& GetTokenKeyId() const{ return m_tokenKeyId; }
/**
* <p>The key identifier that's assigned to your APNs signing key, if you want
* Amazon Pinpoint to communicate with the APNs sandbox environment by using APNs
* tokens.</p>
*/
inline bool TokenKeyIdHasBeenSet() const { return m_tokenKeyIdHasBeenSet; }
/**
* <p>The key identifier that's assigned to your APNs signing key, if you want
* Amazon Pinpoint to communicate with the APNs sandbox environment by using APNs
* tokens.</p>
*/
inline void SetTokenKeyId(const Aws::String& value) { m_tokenKeyIdHasBeenSet = true; m_tokenKeyId = value; }
/**
* <p>The key identifier that's assigned to your APNs signing key, if you want
* Amazon Pinpoint to communicate with the APNs sandbox environment by using APNs
* tokens.</p>
*/
inline void SetTokenKeyId(Aws::String&& value) { m_tokenKeyIdHasBeenSet = true; m_tokenKeyId = std::move(value); }
/**
* <p>The key identifier that's assigned to your APNs signing key, if you want
* Amazon Pinpoint to communicate with the APNs sandbox environment by using APNs
* tokens.</p>
*/
inline void SetTokenKeyId(const char* value) { m_tokenKeyIdHasBeenSet = true; m_tokenKeyId.assign(value); }
/**
* <p>The key identifier that's assigned to your APNs signing key, if you want
* Amazon Pinpoint to communicate with the APNs sandbox environment by using APNs
* tokens.</p>
*/
inline APNSSandboxChannelRequest& WithTokenKeyId(const Aws::String& value) { SetTokenKeyId(value); return *this;}
/**
* <p>The key identifier that's assigned to your APNs signing key, if you want
* Amazon Pinpoint to communicate with the APNs sandbox environment by using APNs
* tokens.</p>
*/
inline APNSSandboxChannelRequest& WithTokenKeyId(Aws::String&& value) { SetTokenKeyId(std::move(value)); return *this;}
/**
* <p>The key identifier that's assigned to your APNs signing key, if you want
* Amazon Pinpoint to communicate with the APNs sandbox environment by using APNs
* tokens.</p>
*/
inline APNSSandboxChannelRequest& WithTokenKeyId(const char* value) { SetTokenKeyId(value); return *this;}
private:
Aws::String m_bundleId;
bool m_bundleIdHasBeenSet;
Aws::String m_certificate;
bool m_certificateHasBeenSet;
Aws::String m_defaultAuthenticationMethod;
bool m_defaultAuthenticationMethodHasBeenSet;
bool m_enabled;
bool m_enabledHasBeenSet;
Aws::String m_privateKey;
bool m_privateKeyHasBeenSet;
Aws::String m_teamId;
bool m_teamIdHasBeenSet;
Aws::String m_tokenKey;
bool m_tokenKeyHasBeenSet;
Aws::String m_tokenKeyId;
bool m_tokenKeyIdHasBeenSet;
};
} // namespace Model
} // namespace Pinpoint
} // namespace Aws