1 /** 2 * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. 3 * SPDX-License-Identifier: Apache-2.0. 4 */ 5 6 #pragma once 7 #include <aws/pinpoint/Pinpoint_EXPORTS.h> 8 #include <aws/core/utils/memory/stl/AWSString.h> 9 #include <utility> 10 11 namespace Aws 12 { 13 namespace Utils 14 { 15 namespace Json 16 { 17 class JsonValue; 18 class JsonView; 19 } // namespace Json 20 } // namespace Utils 21 namespace Pinpoint 22 { 23 namespace Model 24 { 25 26 /** 27 * <p>Provides information about the status and settings of the APNs (Apple Push 28 * Notification service) VoIP sandbox channel for an application.</p><p><h3>See 29 * Also:</h3> <a 30 * href="http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/APNSVoipSandboxChannelResponse">AWS 31 * API Reference</a></p> 32 */ 33 class AWS_PINPOINT_API APNSVoipSandboxChannelResponse 34 { 35 public: 36 APNSVoipSandboxChannelResponse(); 37 APNSVoipSandboxChannelResponse(Aws::Utils::Json::JsonView jsonValue); 38 APNSVoipSandboxChannelResponse& operator=(Aws::Utils::Json::JsonView jsonValue); 39 Aws::Utils::Json::JsonValue Jsonize() const; 40 41 42 /** 43 * <p>The unique identifier for the application that the APNs VoIP sandbox channel 44 * applies to.</p> 45 */ GetApplicationId()46 inline const Aws::String& GetApplicationId() const{ return m_applicationId; } 47 48 /** 49 * <p>The unique identifier for the application that the APNs VoIP sandbox channel 50 * applies to.</p> 51 */ ApplicationIdHasBeenSet()52 inline bool ApplicationIdHasBeenSet() const { return m_applicationIdHasBeenSet; } 53 54 /** 55 * <p>The unique identifier for the application that the APNs VoIP sandbox channel 56 * applies to.</p> 57 */ SetApplicationId(const Aws::String & value)58 inline void SetApplicationId(const Aws::String& value) { m_applicationIdHasBeenSet = true; m_applicationId = value; } 59 60 /** 61 * <p>The unique identifier for the application that the APNs VoIP sandbox channel 62 * applies to.</p> 63 */ SetApplicationId(Aws::String && value)64 inline void SetApplicationId(Aws::String&& value) { m_applicationIdHasBeenSet = true; m_applicationId = std::move(value); } 65 66 /** 67 * <p>The unique identifier for the application that the APNs VoIP sandbox channel 68 * applies to.</p> 69 */ SetApplicationId(const char * value)70 inline void SetApplicationId(const char* value) { m_applicationIdHasBeenSet = true; m_applicationId.assign(value); } 71 72 /** 73 * <p>The unique identifier for the application that the APNs VoIP sandbox channel 74 * applies to.</p> 75 */ WithApplicationId(const Aws::String & value)76 inline APNSVoipSandboxChannelResponse& WithApplicationId(const Aws::String& value) { SetApplicationId(value); return *this;} 77 78 /** 79 * <p>The unique identifier for the application that the APNs VoIP sandbox channel 80 * applies to.</p> 81 */ WithApplicationId(Aws::String && value)82 inline APNSVoipSandboxChannelResponse& WithApplicationId(Aws::String&& value) { SetApplicationId(std::move(value)); return *this;} 83 84 /** 85 * <p>The unique identifier for the application that the APNs VoIP sandbox channel 86 * applies to.</p> 87 */ WithApplicationId(const char * value)88 inline APNSVoipSandboxChannelResponse& WithApplicationId(const char* value) { SetApplicationId(value); return *this;} 89 90 91 /** 92 * <p>The date and time when the APNs VoIP sandbox channel was enabled.</p> 93 */ GetCreationDate()94 inline const Aws::String& GetCreationDate() const{ return m_creationDate; } 95 96 /** 97 * <p>The date and time when the APNs VoIP sandbox channel was enabled.</p> 98 */ CreationDateHasBeenSet()99 inline bool CreationDateHasBeenSet() const { return m_creationDateHasBeenSet; } 100 101 /** 102 * <p>The date and time when the APNs VoIP sandbox channel was enabled.</p> 103 */ SetCreationDate(const Aws::String & value)104 inline void SetCreationDate(const Aws::String& value) { m_creationDateHasBeenSet = true; m_creationDate = value; } 105 106 /** 107 * <p>The date and time when the APNs VoIP sandbox channel was enabled.</p> 108 */ SetCreationDate(Aws::String && value)109 inline void SetCreationDate(Aws::String&& value) { m_creationDateHasBeenSet = true; m_creationDate = std::move(value); } 110 111 /** 112 * <p>The date and time when the APNs VoIP sandbox channel was enabled.</p> 113 */ SetCreationDate(const char * value)114 inline void SetCreationDate(const char* value) { m_creationDateHasBeenSet = true; m_creationDate.assign(value); } 115 116 /** 117 * <p>The date and time when the APNs VoIP sandbox channel was enabled.</p> 118 */ WithCreationDate(const Aws::String & value)119 inline APNSVoipSandboxChannelResponse& WithCreationDate(const Aws::String& value) { SetCreationDate(value); return *this;} 120 121 /** 122 * <p>The date and time when the APNs VoIP sandbox channel was enabled.</p> 123 */ WithCreationDate(Aws::String && value)124 inline APNSVoipSandboxChannelResponse& WithCreationDate(Aws::String&& value) { SetCreationDate(std::move(value)); return *this;} 125 126 /** 127 * <p>The date and time when the APNs VoIP sandbox channel was enabled.</p> 128 */ WithCreationDate(const char * value)129 inline APNSVoipSandboxChannelResponse& WithCreationDate(const char* value) { SetCreationDate(value); return *this;} 130 131 132 /** 133 * <p>The default authentication method that Amazon Pinpoint uses to authenticate 134 * with the APNs sandbox environment for this channel, key or certificate.</p> 135 */ GetDefaultAuthenticationMethod()136 inline const Aws::String& GetDefaultAuthenticationMethod() const{ return m_defaultAuthenticationMethod; } 137 138 /** 139 * <p>The default authentication method that Amazon Pinpoint uses to authenticate 140 * with the APNs sandbox environment for this channel, key or certificate.</p> 141 */ DefaultAuthenticationMethodHasBeenSet()142 inline bool DefaultAuthenticationMethodHasBeenSet() const { return m_defaultAuthenticationMethodHasBeenSet; } 143 144 /** 145 * <p>The default authentication method that Amazon Pinpoint uses to authenticate 146 * with the APNs sandbox environment for this channel, key or certificate.</p> 147 */ SetDefaultAuthenticationMethod(const Aws::String & value)148 inline void SetDefaultAuthenticationMethod(const Aws::String& value) { m_defaultAuthenticationMethodHasBeenSet = true; m_defaultAuthenticationMethod = value; } 149 150 /** 151 * <p>The default authentication method that Amazon Pinpoint uses to authenticate 152 * with the APNs sandbox environment for this channel, key or certificate.</p> 153 */ SetDefaultAuthenticationMethod(Aws::String && value)154 inline void SetDefaultAuthenticationMethod(Aws::String&& value) { m_defaultAuthenticationMethodHasBeenSet = true; m_defaultAuthenticationMethod = std::move(value); } 155 156 /** 157 * <p>The default authentication method that Amazon Pinpoint uses to authenticate 158 * with the APNs sandbox environment for this channel, key or certificate.</p> 159 */ SetDefaultAuthenticationMethod(const char * value)160 inline void SetDefaultAuthenticationMethod(const char* value) { m_defaultAuthenticationMethodHasBeenSet = true; m_defaultAuthenticationMethod.assign(value); } 161 162 /** 163 * <p>The default authentication method that Amazon Pinpoint uses to authenticate 164 * with the APNs sandbox environment for this channel, key or certificate.</p> 165 */ WithDefaultAuthenticationMethod(const Aws::String & value)166 inline APNSVoipSandboxChannelResponse& WithDefaultAuthenticationMethod(const Aws::String& value) { SetDefaultAuthenticationMethod(value); return *this;} 167 168 /** 169 * <p>The default authentication method that Amazon Pinpoint uses to authenticate 170 * with the APNs sandbox environment for this channel, key or certificate.</p> 171 */ WithDefaultAuthenticationMethod(Aws::String && value)172 inline APNSVoipSandboxChannelResponse& WithDefaultAuthenticationMethod(Aws::String&& value) { SetDefaultAuthenticationMethod(std::move(value)); return *this;} 173 174 /** 175 * <p>The default authentication method that Amazon Pinpoint uses to authenticate 176 * with the APNs sandbox environment for this channel, key or certificate.</p> 177 */ WithDefaultAuthenticationMethod(const char * value)178 inline APNSVoipSandboxChannelResponse& WithDefaultAuthenticationMethod(const char* value) { SetDefaultAuthenticationMethod(value); return *this;} 179 180 181 /** 182 * <p>Specifies whether the APNs VoIP sandbox channel is enabled for the 183 * application.</p> 184 */ GetEnabled()185 inline bool GetEnabled() const{ return m_enabled; } 186 187 /** 188 * <p>Specifies whether the APNs VoIP sandbox channel is enabled for the 189 * application.</p> 190 */ EnabledHasBeenSet()191 inline bool EnabledHasBeenSet() const { return m_enabledHasBeenSet; } 192 193 /** 194 * <p>Specifies whether the APNs VoIP sandbox channel is enabled for the 195 * application.</p> 196 */ SetEnabled(bool value)197 inline void SetEnabled(bool value) { m_enabledHasBeenSet = true; m_enabled = value; } 198 199 /** 200 * <p>Specifies whether the APNs VoIP sandbox channel is enabled for the 201 * application.</p> 202 */ WithEnabled(bool value)203 inline APNSVoipSandboxChannelResponse& WithEnabled(bool value) { SetEnabled(value); return *this;} 204 205 206 /** 207 * <p>(Not used) This property is retained only for backward compatibility.</p> 208 */ GetHasCredential()209 inline bool GetHasCredential() const{ return m_hasCredential; } 210 211 /** 212 * <p>(Not used) This property is retained only for backward compatibility.</p> 213 */ HasCredentialHasBeenSet()214 inline bool HasCredentialHasBeenSet() const { return m_hasCredentialHasBeenSet; } 215 216 /** 217 * <p>(Not used) This property is retained only for backward compatibility.</p> 218 */ SetHasCredential(bool value)219 inline void SetHasCredential(bool value) { m_hasCredentialHasBeenSet = true; m_hasCredential = value; } 220 221 /** 222 * <p>(Not used) This property is retained only for backward compatibility.</p> 223 */ WithHasCredential(bool value)224 inline APNSVoipSandboxChannelResponse& WithHasCredential(bool value) { SetHasCredential(value); return *this;} 225 226 227 /** 228 * <p>Specifies whether the APNs VoIP sandbox channel is configured to communicate 229 * with APNs by using APNs tokens. To provide an authentication key for APNs 230 * tokens, set the TokenKey property of the channel.</p> 231 */ GetHasTokenKey()232 inline bool GetHasTokenKey() const{ return m_hasTokenKey; } 233 234 /** 235 * <p>Specifies whether the APNs VoIP sandbox channel is configured to communicate 236 * with APNs by using APNs tokens. To provide an authentication key for APNs 237 * tokens, set the TokenKey property of the channel.</p> 238 */ HasTokenKeyHasBeenSet()239 inline bool HasTokenKeyHasBeenSet() const { return m_hasTokenKeyHasBeenSet; } 240 241 /** 242 * <p>Specifies whether the APNs VoIP sandbox channel is configured to communicate 243 * with APNs by using APNs tokens. To provide an authentication key for APNs 244 * tokens, set the TokenKey property of the channel.</p> 245 */ SetHasTokenKey(bool value)246 inline void SetHasTokenKey(bool value) { m_hasTokenKeyHasBeenSet = true; m_hasTokenKey = value; } 247 248 /** 249 * <p>Specifies whether the APNs VoIP sandbox channel is configured to communicate 250 * with APNs by using APNs tokens. To provide an authentication key for APNs 251 * tokens, set the TokenKey property of the channel.</p> 252 */ WithHasTokenKey(bool value)253 inline APNSVoipSandboxChannelResponse& WithHasTokenKey(bool value) { SetHasTokenKey(value); return *this;} 254 255 256 /** 257 * <p>(Deprecated) An identifier for the APNs VoIP sandbox channel. This property 258 * is retained only for backward compatibility.</p> 259 */ GetId()260 inline const Aws::String& GetId() const{ return m_id; } 261 262 /** 263 * <p>(Deprecated) An identifier for the APNs VoIP sandbox channel. This property 264 * is retained only for backward compatibility.</p> 265 */ IdHasBeenSet()266 inline bool IdHasBeenSet() const { return m_idHasBeenSet; } 267 268 /** 269 * <p>(Deprecated) An identifier for the APNs VoIP sandbox channel. This property 270 * is retained only for backward compatibility.</p> 271 */ SetId(const Aws::String & value)272 inline void SetId(const Aws::String& value) { m_idHasBeenSet = true; m_id = value; } 273 274 /** 275 * <p>(Deprecated) An identifier for the APNs VoIP sandbox channel. This property 276 * is retained only for backward compatibility.</p> 277 */ SetId(Aws::String && value)278 inline void SetId(Aws::String&& value) { m_idHasBeenSet = true; m_id = std::move(value); } 279 280 /** 281 * <p>(Deprecated) An identifier for the APNs VoIP sandbox channel. This property 282 * is retained only for backward compatibility.</p> 283 */ SetId(const char * value)284 inline void SetId(const char* value) { m_idHasBeenSet = true; m_id.assign(value); } 285 286 /** 287 * <p>(Deprecated) An identifier for the APNs VoIP sandbox channel. This property 288 * is retained only for backward compatibility.</p> 289 */ WithId(const Aws::String & value)290 inline APNSVoipSandboxChannelResponse& WithId(const Aws::String& value) { SetId(value); return *this;} 291 292 /** 293 * <p>(Deprecated) An identifier for the APNs VoIP sandbox channel. This property 294 * is retained only for backward compatibility.</p> 295 */ WithId(Aws::String && value)296 inline APNSVoipSandboxChannelResponse& WithId(Aws::String&& value) { SetId(std::move(value)); return *this;} 297 298 /** 299 * <p>(Deprecated) An identifier for the APNs VoIP sandbox channel. This property 300 * is retained only for backward compatibility.</p> 301 */ WithId(const char * value)302 inline APNSVoipSandboxChannelResponse& WithId(const char* value) { SetId(value); return *this;} 303 304 305 /** 306 * <p>Specifies whether the APNs VoIP sandbox channel is archived.</p> 307 */ GetIsArchived()308 inline bool GetIsArchived() const{ return m_isArchived; } 309 310 /** 311 * <p>Specifies whether the APNs VoIP sandbox channel is archived.</p> 312 */ IsArchivedHasBeenSet()313 inline bool IsArchivedHasBeenSet() const { return m_isArchivedHasBeenSet; } 314 315 /** 316 * <p>Specifies whether the APNs VoIP sandbox channel is archived.</p> 317 */ SetIsArchived(bool value)318 inline void SetIsArchived(bool value) { m_isArchivedHasBeenSet = true; m_isArchived = value; } 319 320 /** 321 * <p>Specifies whether the APNs VoIP sandbox channel is archived.</p> 322 */ WithIsArchived(bool value)323 inline APNSVoipSandboxChannelResponse& WithIsArchived(bool value) { SetIsArchived(value); return *this;} 324 325 326 /** 327 * <p>The user who last modified the APNs VoIP sandbox channel.</p> 328 */ GetLastModifiedBy()329 inline const Aws::String& GetLastModifiedBy() const{ return m_lastModifiedBy; } 330 331 /** 332 * <p>The user who last modified the APNs VoIP sandbox channel.</p> 333 */ LastModifiedByHasBeenSet()334 inline bool LastModifiedByHasBeenSet() const { return m_lastModifiedByHasBeenSet; } 335 336 /** 337 * <p>The user who last modified the APNs VoIP sandbox channel.</p> 338 */ SetLastModifiedBy(const Aws::String & value)339 inline void SetLastModifiedBy(const Aws::String& value) { m_lastModifiedByHasBeenSet = true; m_lastModifiedBy = value; } 340 341 /** 342 * <p>The user who last modified the APNs VoIP sandbox channel.</p> 343 */ SetLastModifiedBy(Aws::String && value)344 inline void SetLastModifiedBy(Aws::String&& value) { m_lastModifiedByHasBeenSet = true; m_lastModifiedBy = std::move(value); } 345 346 /** 347 * <p>The user who last modified the APNs VoIP sandbox channel.</p> 348 */ SetLastModifiedBy(const char * value)349 inline void SetLastModifiedBy(const char* value) { m_lastModifiedByHasBeenSet = true; m_lastModifiedBy.assign(value); } 350 351 /** 352 * <p>The user who last modified the APNs VoIP sandbox channel.</p> 353 */ WithLastModifiedBy(const Aws::String & value)354 inline APNSVoipSandboxChannelResponse& WithLastModifiedBy(const Aws::String& value) { SetLastModifiedBy(value); return *this;} 355 356 /** 357 * <p>The user who last modified the APNs VoIP sandbox channel.</p> 358 */ WithLastModifiedBy(Aws::String && value)359 inline APNSVoipSandboxChannelResponse& WithLastModifiedBy(Aws::String&& value) { SetLastModifiedBy(std::move(value)); return *this;} 360 361 /** 362 * <p>The user who last modified the APNs VoIP sandbox channel.</p> 363 */ WithLastModifiedBy(const char * value)364 inline APNSVoipSandboxChannelResponse& WithLastModifiedBy(const char* value) { SetLastModifiedBy(value); return *this;} 365 366 367 /** 368 * <p>The date and time when the APNs VoIP sandbox channel was last modified.</p> 369 */ GetLastModifiedDate()370 inline const Aws::String& GetLastModifiedDate() const{ return m_lastModifiedDate; } 371 372 /** 373 * <p>The date and time when the APNs VoIP sandbox channel was last modified.</p> 374 */ LastModifiedDateHasBeenSet()375 inline bool LastModifiedDateHasBeenSet() const { return m_lastModifiedDateHasBeenSet; } 376 377 /** 378 * <p>The date and time when the APNs VoIP sandbox channel was last modified.</p> 379 */ SetLastModifiedDate(const Aws::String & value)380 inline void SetLastModifiedDate(const Aws::String& value) { m_lastModifiedDateHasBeenSet = true; m_lastModifiedDate = value; } 381 382 /** 383 * <p>The date and time when the APNs VoIP sandbox channel was last modified.</p> 384 */ SetLastModifiedDate(Aws::String && value)385 inline void SetLastModifiedDate(Aws::String&& value) { m_lastModifiedDateHasBeenSet = true; m_lastModifiedDate = std::move(value); } 386 387 /** 388 * <p>The date and time when the APNs VoIP sandbox channel was last modified.</p> 389 */ SetLastModifiedDate(const char * value)390 inline void SetLastModifiedDate(const char* value) { m_lastModifiedDateHasBeenSet = true; m_lastModifiedDate.assign(value); } 391 392 /** 393 * <p>The date and time when the APNs VoIP sandbox channel was last modified.</p> 394 */ WithLastModifiedDate(const Aws::String & value)395 inline APNSVoipSandboxChannelResponse& WithLastModifiedDate(const Aws::String& value) { SetLastModifiedDate(value); return *this;} 396 397 /** 398 * <p>The date and time when the APNs VoIP sandbox channel was last modified.</p> 399 */ WithLastModifiedDate(Aws::String && value)400 inline APNSVoipSandboxChannelResponse& WithLastModifiedDate(Aws::String&& value) { SetLastModifiedDate(std::move(value)); return *this;} 401 402 /** 403 * <p>The date and time when the APNs VoIP sandbox channel was last modified.</p> 404 */ WithLastModifiedDate(const char * value)405 inline APNSVoipSandboxChannelResponse& WithLastModifiedDate(const char* value) { SetLastModifiedDate(value); return *this;} 406 407 408 /** 409 * <p>The type of messaging or notification platform for the channel. For the APNs 410 * VoIP sandbox channel, this value is APNS_VOIP_SANDBOX.</p> 411 */ GetPlatform()412 inline const Aws::String& GetPlatform() const{ return m_platform; } 413 414 /** 415 * <p>The type of messaging or notification platform for the channel. For the APNs 416 * VoIP sandbox channel, this value is APNS_VOIP_SANDBOX.</p> 417 */ PlatformHasBeenSet()418 inline bool PlatformHasBeenSet() const { return m_platformHasBeenSet; } 419 420 /** 421 * <p>The type of messaging or notification platform for the channel. For the APNs 422 * VoIP sandbox channel, this value is APNS_VOIP_SANDBOX.</p> 423 */ SetPlatform(const Aws::String & value)424 inline void SetPlatform(const Aws::String& value) { m_platformHasBeenSet = true; m_platform = value; } 425 426 /** 427 * <p>The type of messaging or notification platform for the channel. For the APNs 428 * VoIP sandbox channel, this value is APNS_VOIP_SANDBOX.</p> 429 */ SetPlatform(Aws::String && value)430 inline void SetPlatform(Aws::String&& value) { m_platformHasBeenSet = true; m_platform = std::move(value); } 431 432 /** 433 * <p>The type of messaging or notification platform for the channel. For the APNs 434 * VoIP sandbox channel, this value is APNS_VOIP_SANDBOX.</p> 435 */ SetPlatform(const char * value)436 inline void SetPlatform(const char* value) { m_platformHasBeenSet = true; m_platform.assign(value); } 437 438 /** 439 * <p>The type of messaging or notification platform for the channel. For the APNs 440 * VoIP sandbox channel, this value is APNS_VOIP_SANDBOX.</p> 441 */ WithPlatform(const Aws::String & value)442 inline APNSVoipSandboxChannelResponse& WithPlatform(const Aws::String& value) { SetPlatform(value); return *this;} 443 444 /** 445 * <p>The type of messaging or notification platform for the channel. For the APNs 446 * VoIP sandbox channel, this value is APNS_VOIP_SANDBOX.</p> 447 */ WithPlatform(Aws::String && value)448 inline APNSVoipSandboxChannelResponse& WithPlatform(Aws::String&& value) { SetPlatform(std::move(value)); return *this;} 449 450 /** 451 * <p>The type of messaging or notification platform for the channel. For the APNs 452 * VoIP sandbox channel, this value is APNS_VOIP_SANDBOX.</p> 453 */ WithPlatform(const char * value)454 inline APNSVoipSandboxChannelResponse& WithPlatform(const char* value) { SetPlatform(value); return *this;} 455 456 457 /** 458 * <p>The current version of the APNs VoIP sandbox channel.</p> 459 */ GetVersion()460 inline int GetVersion() const{ return m_version; } 461 462 /** 463 * <p>The current version of the APNs VoIP sandbox channel.</p> 464 */ VersionHasBeenSet()465 inline bool VersionHasBeenSet() const { return m_versionHasBeenSet; } 466 467 /** 468 * <p>The current version of the APNs VoIP sandbox channel.</p> 469 */ SetVersion(int value)470 inline void SetVersion(int value) { m_versionHasBeenSet = true; m_version = value; } 471 472 /** 473 * <p>The current version of the APNs VoIP sandbox channel.</p> 474 */ WithVersion(int value)475 inline APNSVoipSandboxChannelResponse& WithVersion(int value) { SetVersion(value); return *this;} 476 477 private: 478 479 Aws::String m_applicationId; 480 bool m_applicationIdHasBeenSet; 481 482 Aws::String m_creationDate; 483 bool m_creationDateHasBeenSet; 484 485 Aws::String m_defaultAuthenticationMethod; 486 bool m_defaultAuthenticationMethodHasBeenSet; 487 488 bool m_enabled; 489 bool m_enabledHasBeenSet; 490 491 bool m_hasCredential; 492 bool m_hasCredentialHasBeenSet; 493 494 bool m_hasTokenKey; 495 bool m_hasTokenKeyHasBeenSet; 496 497 Aws::String m_id; 498 bool m_idHasBeenSet; 499 500 bool m_isArchived; 501 bool m_isArchivedHasBeenSet; 502 503 Aws::String m_lastModifiedBy; 504 bool m_lastModifiedByHasBeenSet; 505 506 Aws::String m_lastModifiedDate; 507 bool m_lastModifiedDateHasBeenSet; 508 509 Aws::String m_platform; 510 bool m_platformHasBeenSet; 511 512 int m_version; 513 bool m_versionHasBeenSet; 514 }; 515 516 } // namespace Model 517 } // namespace Pinpoint 518 } // namespace Aws 519