/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include namespace Aws { namespace Utils { namespace Json { class JsonValue; class JsonView; } // namespace Json } // namespace Utils namespace Pinpoint { namespace Model { /** *

Provides information about the status and settings of the GCM channel for an * application. The GCM channel enables Amazon Pinpoint to send push notifications * through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging * (GCM), service.

See Also:

AWS * API Reference

*/ class GCMChannelResponse { public: AWS_PINPOINT_API GCMChannelResponse(); AWS_PINPOINT_API GCMChannelResponse(Aws::Utils::Json::JsonView jsonValue); AWS_PINPOINT_API GCMChannelResponse& operator=(Aws::Utils::Json::JsonView jsonValue); AWS_PINPOINT_API Aws::Utils::Json::JsonValue Jsonize() const; /** *

The unique identifier for the application that the GCM channel applies * to.

*/ inline const Aws::String& GetApplicationId() const{ return m_applicationId; } /** *

The unique identifier for the application that the GCM channel applies * to.

*/ inline bool ApplicationIdHasBeenSet() const { return m_applicationIdHasBeenSet; } /** *

The unique identifier for the application that the GCM channel applies * to.

*/ inline void SetApplicationId(const Aws::String& value) { m_applicationIdHasBeenSet = true; m_applicationId = value; } /** *

The unique identifier for the application that the GCM channel applies * to.

*/ inline void SetApplicationId(Aws::String&& value) { m_applicationIdHasBeenSet = true; m_applicationId = std::move(value); } /** *

The unique identifier for the application that the GCM channel applies * to.

*/ inline void SetApplicationId(const char* value) { m_applicationIdHasBeenSet = true; m_applicationId.assign(value); } /** *

The unique identifier for the application that the GCM channel applies * to.

*/ inline GCMChannelResponse& WithApplicationId(const Aws::String& value) { SetApplicationId(value); return *this;} /** *

The unique identifier for the application that the GCM channel applies * to.

*/ inline GCMChannelResponse& WithApplicationId(Aws::String&& value) { SetApplicationId(std::move(value)); return *this;} /** *

The unique identifier for the application that the GCM channel applies * to.

*/ inline GCMChannelResponse& WithApplicationId(const char* value) { SetApplicationId(value); return *this;} /** *

The date and time when the GCM channel was enabled.

*/ inline const Aws::String& GetCreationDate() const{ return m_creationDate; } /** *

The date and time when the GCM channel was enabled.

*/ inline bool CreationDateHasBeenSet() const { return m_creationDateHasBeenSet; } /** *

The date and time when the GCM channel was enabled.

*/ inline void SetCreationDate(const Aws::String& value) { m_creationDateHasBeenSet = true; m_creationDate = value; } /** *

The date and time when the GCM channel was enabled.

*/ inline void SetCreationDate(Aws::String&& value) { m_creationDateHasBeenSet = true; m_creationDate = std::move(value); } /** *

The date and time when the GCM channel was enabled.

*/ inline void SetCreationDate(const char* value) { m_creationDateHasBeenSet = true; m_creationDate.assign(value); } /** *

The date and time when the GCM channel was enabled.

*/ inline GCMChannelResponse& WithCreationDate(const Aws::String& value) { SetCreationDate(value); return *this;} /** *

The date and time when the GCM channel was enabled.

*/ inline GCMChannelResponse& WithCreationDate(Aws::String&& value) { SetCreationDate(std::move(value)); return *this;} /** *

The date and time when the GCM channel was enabled.

*/ inline GCMChannelResponse& WithCreationDate(const char* value) { SetCreationDate(value); return *this;} /** *

The Web API Key, also referred to as an API_KEY or server key, * that you received from Google to communicate with Google services.

*/ inline const Aws::String& GetCredential() const{ return m_credential; } /** *

The Web API Key, also referred to as an API_KEY or server key, * that you received from Google to communicate with Google services.

*/ inline bool CredentialHasBeenSet() const { return m_credentialHasBeenSet; } /** *

The Web API Key, also referred to as an API_KEY or server key, * that you received from Google to communicate with Google services.

*/ inline void SetCredential(const Aws::String& value) { m_credentialHasBeenSet = true; m_credential = value; } /** *

The Web API Key, also referred to as an API_KEY or server key, * that you received from Google to communicate with Google services.

*/ inline void SetCredential(Aws::String&& value) { m_credentialHasBeenSet = true; m_credential = std::move(value); } /** *

The Web API Key, also referred to as an API_KEY or server key, * that you received from Google to communicate with Google services.

*/ inline void SetCredential(const char* value) { m_credentialHasBeenSet = true; m_credential.assign(value); } /** *

The Web API Key, also referred to as an API_KEY or server key, * that you received from Google to communicate with Google services.

*/ inline GCMChannelResponse& WithCredential(const Aws::String& value) { SetCredential(value); return *this;} /** *

The Web API Key, also referred to as an API_KEY or server key, * that you received from Google to communicate with Google services.

*/ inline GCMChannelResponse& WithCredential(Aws::String&& value) { SetCredential(std::move(value)); return *this;} /** *

The Web API Key, also referred to as an API_KEY or server key, * that you received from Google to communicate with Google services.

*/ inline GCMChannelResponse& WithCredential(const char* value) { SetCredential(value); return *this;} /** *

The default authentication method used for GCM. Values are either "TOKEN" or * "KEY". Defaults to "KEY".

*/ inline const Aws::String& GetDefaultAuthenticationMethod() const{ return m_defaultAuthenticationMethod; } /** *

The default authentication method used for GCM. Values are either "TOKEN" or * "KEY". Defaults to "KEY".

*/ inline bool DefaultAuthenticationMethodHasBeenSet() const { return m_defaultAuthenticationMethodHasBeenSet; } /** *

The default authentication method used for GCM. Values are either "TOKEN" or * "KEY". Defaults to "KEY".

*/ inline void SetDefaultAuthenticationMethod(const Aws::String& value) { m_defaultAuthenticationMethodHasBeenSet = true; m_defaultAuthenticationMethod = value; } /** *

The default authentication method used for GCM. Values are either "TOKEN" or * "KEY". Defaults to "KEY".

*/ inline void SetDefaultAuthenticationMethod(Aws::String&& value) { m_defaultAuthenticationMethodHasBeenSet = true; m_defaultAuthenticationMethod = std::move(value); } /** *

The default authentication method used for GCM. Values are either "TOKEN" or * "KEY". Defaults to "KEY".

*/ inline void SetDefaultAuthenticationMethod(const char* value) { m_defaultAuthenticationMethodHasBeenSet = true; m_defaultAuthenticationMethod.assign(value); } /** *

The default authentication method used for GCM. Values are either "TOKEN" or * "KEY". Defaults to "KEY".

*/ inline GCMChannelResponse& WithDefaultAuthenticationMethod(const Aws::String& value) { SetDefaultAuthenticationMethod(value); return *this;} /** *

The default authentication method used for GCM. Values are either "TOKEN" or * "KEY". Defaults to "KEY".

*/ inline GCMChannelResponse& WithDefaultAuthenticationMethod(Aws::String&& value) { SetDefaultAuthenticationMethod(std::move(value)); return *this;} /** *

The default authentication method used for GCM. Values are either "TOKEN" or * "KEY". Defaults to "KEY".

*/ inline GCMChannelResponse& WithDefaultAuthenticationMethod(const char* value) { SetDefaultAuthenticationMethod(value); return *this;} /** *

Specifies whether the GCM channel is enabled for the application.

*/ inline bool GetEnabled() const{ return m_enabled; } /** *

Specifies whether the GCM channel is enabled for the application.

*/ inline bool EnabledHasBeenSet() const { return m_enabledHasBeenSet; } /** *

Specifies whether the GCM channel is enabled for the application.

*/ inline void SetEnabled(bool value) { m_enabledHasBeenSet = true; m_enabled = value; } /** *

Specifies whether the GCM channel is enabled for the application.

*/ inline GCMChannelResponse& WithEnabled(bool value) { SetEnabled(value); return *this;} /** *

(Not used) This property is retained only for backward compatibility.

*/ inline bool GetHasCredential() const{ return m_hasCredential; } /** *

(Not used) This property is retained only for backward compatibility.

*/ inline bool HasCredentialHasBeenSet() const { return m_hasCredentialHasBeenSet; } /** *

(Not used) This property is retained only for backward compatibility.

*/ inline void SetHasCredential(bool value) { m_hasCredentialHasBeenSet = true; m_hasCredential = value; } /** *

(Not used) This property is retained only for backward compatibility.

*/ inline GCMChannelResponse& WithHasCredential(bool value) { SetHasCredential(value); return *this;} /** *

Returns true if the JSON file provided by Google during registration process * was used in the ServiceJson field of the request.

*/ inline bool GetHasFcmServiceCredentials() const{ return m_hasFcmServiceCredentials; } /** *

Returns true if the JSON file provided by Google during registration process * was used in the ServiceJson field of the request.

*/ inline bool HasFcmServiceCredentialsHasBeenSet() const { return m_hasFcmServiceCredentialsHasBeenSet; } /** *

Returns true if the JSON file provided by Google during registration process * was used in the ServiceJson field of the request.

*/ inline void SetHasFcmServiceCredentials(bool value) { m_hasFcmServiceCredentialsHasBeenSet = true; m_hasFcmServiceCredentials = value; } /** *

Returns true if the JSON file provided by Google during registration process * was used in the ServiceJson field of the request.

*/ inline GCMChannelResponse& WithHasFcmServiceCredentials(bool value) { SetHasFcmServiceCredentials(value); return *this;} /** *

(Deprecated) An identifier for the GCM channel. This property is retained * only for backward compatibility.

*/ inline const Aws::String& GetId() const{ return m_id; } /** *

(Deprecated) An identifier for the GCM channel. This property is retained * only for backward compatibility.

*/ inline bool IdHasBeenSet() const { return m_idHasBeenSet; } /** *

(Deprecated) An identifier for the GCM channel. This property is retained * only for backward compatibility.

*/ inline void SetId(const Aws::String& value) { m_idHasBeenSet = true; m_id = value; } /** *

(Deprecated) An identifier for the GCM channel. This property is retained * only for backward compatibility.

*/ inline void SetId(Aws::String&& value) { m_idHasBeenSet = true; m_id = std::move(value); } /** *

(Deprecated) An identifier for the GCM channel. This property is retained * only for backward compatibility.

*/ inline void SetId(const char* value) { m_idHasBeenSet = true; m_id.assign(value); } /** *

(Deprecated) An identifier for the GCM channel. This property is retained * only for backward compatibility.

*/ inline GCMChannelResponse& WithId(const Aws::String& value) { SetId(value); return *this;} /** *

(Deprecated) An identifier for the GCM channel. This property is retained * only for backward compatibility.

*/ inline GCMChannelResponse& WithId(Aws::String&& value) { SetId(std::move(value)); return *this;} /** *

(Deprecated) An identifier for the GCM channel. This property is retained * only for backward compatibility.

*/ inline GCMChannelResponse& WithId(const char* value) { SetId(value); return *this;} /** *

Specifies whether the GCM channel is archived.

*/ inline bool GetIsArchived() const{ return m_isArchived; } /** *

Specifies whether the GCM channel is archived.

*/ inline bool IsArchivedHasBeenSet() const { return m_isArchivedHasBeenSet; } /** *

Specifies whether the GCM channel is archived.

*/ inline void SetIsArchived(bool value) { m_isArchivedHasBeenSet = true; m_isArchived = value; } /** *

Specifies whether the GCM channel is archived.

*/ inline GCMChannelResponse& WithIsArchived(bool value) { SetIsArchived(value); return *this;} /** *

The user who last modified the GCM channel.

*/ inline const Aws::String& GetLastModifiedBy() const{ return m_lastModifiedBy; } /** *

The user who last modified the GCM channel.

*/ inline bool LastModifiedByHasBeenSet() const { return m_lastModifiedByHasBeenSet; } /** *

The user who last modified the GCM channel.

*/ inline void SetLastModifiedBy(const Aws::String& value) { m_lastModifiedByHasBeenSet = true; m_lastModifiedBy = value; } /** *

The user who last modified the GCM channel.

*/ inline void SetLastModifiedBy(Aws::String&& value) { m_lastModifiedByHasBeenSet = true; m_lastModifiedBy = std::move(value); } /** *

The user who last modified the GCM channel.

*/ inline void SetLastModifiedBy(const char* value) { m_lastModifiedByHasBeenSet = true; m_lastModifiedBy.assign(value); } /** *

The user who last modified the GCM channel.

*/ inline GCMChannelResponse& WithLastModifiedBy(const Aws::String& value) { SetLastModifiedBy(value); return *this;} /** *

The user who last modified the GCM channel.

*/ inline GCMChannelResponse& WithLastModifiedBy(Aws::String&& value) { SetLastModifiedBy(std::move(value)); return *this;} /** *

The user who last modified the GCM channel.

*/ inline GCMChannelResponse& WithLastModifiedBy(const char* value) { SetLastModifiedBy(value); return *this;} /** *

The date and time when the GCM channel was last modified.

*/ inline const Aws::String& GetLastModifiedDate() const{ return m_lastModifiedDate; } /** *

The date and time when the GCM channel was last modified.

*/ inline bool LastModifiedDateHasBeenSet() const { return m_lastModifiedDateHasBeenSet; } /** *

The date and time when the GCM channel was last modified.

*/ inline void SetLastModifiedDate(const Aws::String& value) { m_lastModifiedDateHasBeenSet = true; m_lastModifiedDate = value; } /** *

The date and time when the GCM channel was last modified.

*/ inline void SetLastModifiedDate(Aws::String&& value) { m_lastModifiedDateHasBeenSet = true; m_lastModifiedDate = std::move(value); } /** *

The date and time when the GCM channel was last modified.

*/ inline void SetLastModifiedDate(const char* value) { m_lastModifiedDateHasBeenSet = true; m_lastModifiedDate.assign(value); } /** *

The date and time when the GCM channel was last modified.

*/ inline GCMChannelResponse& WithLastModifiedDate(const Aws::String& value) { SetLastModifiedDate(value); return *this;} /** *

The date and time when the GCM channel was last modified.

*/ inline GCMChannelResponse& WithLastModifiedDate(Aws::String&& value) { SetLastModifiedDate(std::move(value)); return *this;} /** *

The date and time when the GCM channel was last modified.

*/ inline GCMChannelResponse& WithLastModifiedDate(const char* value) { SetLastModifiedDate(value); return *this;} /** *

The type of messaging or notification platform for the channel. For the GCM * channel, this value is GCM.

*/ inline const Aws::String& GetPlatform() const{ return m_platform; } /** *

The type of messaging or notification platform for the channel. For the GCM * channel, this value is GCM.

*/ inline bool PlatformHasBeenSet() const { return m_platformHasBeenSet; } /** *

The type of messaging or notification platform for the channel. For the GCM * channel, this value is GCM.

*/ inline void SetPlatform(const Aws::String& value) { m_platformHasBeenSet = true; m_platform = value; } /** *

The type of messaging or notification platform for the channel. For the GCM * channel, this value is GCM.

*/ inline void SetPlatform(Aws::String&& value) { m_platformHasBeenSet = true; m_platform = std::move(value); } /** *

The type of messaging or notification platform for the channel. For the GCM * channel, this value is GCM.

*/ inline void SetPlatform(const char* value) { m_platformHasBeenSet = true; m_platform.assign(value); } /** *

The type of messaging or notification platform for the channel. For the GCM * channel, this value is GCM.

*/ inline GCMChannelResponse& WithPlatform(const Aws::String& value) { SetPlatform(value); return *this;} /** *

The type of messaging or notification platform for the channel. For the GCM * channel, this value is GCM.

*/ inline GCMChannelResponse& WithPlatform(Aws::String&& value) { SetPlatform(std::move(value)); return *this;} /** *

The type of messaging or notification platform for the channel. For the GCM * channel, this value is GCM.

*/ inline GCMChannelResponse& WithPlatform(const char* value) { SetPlatform(value); return *this;} /** *

The current version of the GCM channel.

*/ inline int GetVersion() const{ return m_version; } /** *

The current version of the GCM channel.

*/ inline bool VersionHasBeenSet() const { return m_versionHasBeenSet; } /** *

The current version of the GCM channel.

*/ inline void SetVersion(int value) { m_versionHasBeenSet = true; m_version = value; } /** *

The current version of the GCM channel.

*/ inline GCMChannelResponse& WithVersion(int value) { SetVersion(value); return *this;} private: Aws::String m_applicationId; bool m_applicationIdHasBeenSet = false; Aws::String m_creationDate; bool m_creationDateHasBeenSet = false; Aws::String m_credential; bool m_credentialHasBeenSet = false; Aws::String m_defaultAuthenticationMethod; bool m_defaultAuthenticationMethodHasBeenSet = false; bool m_enabled; bool m_enabledHasBeenSet = false; bool m_hasCredential; bool m_hasCredentialHasBeenSet = false; bool m_hasFcmServiceCredentials; bool m_hasFcmServiceCredentialsHasBeenSet = false; Aws::String m_id; bool m_idHasBeenSet = false; bool m_isArchived; bool m_isArchivedHasBeenSet = false; Aws::String m_lastModifiedBy; bool m_lastModifiedByHasBeenSet = false; Aws::String m_lastModifiedDate; bool m_lastModifiedDateHasBeenSet = false; Aws::String m_platform; bool m_platformHasBeenSet = false; int m_version; bool m_versionHasBeenSet = false; }; } // namespace Model } // namespace Pinpoint } // namespace Aws