// snippet-start:[SNS.dotnetv3.CheckIfOptedOut]
/// <summary>
/// Checks to see if the supplied phone number has been opted out.
/// </summary>
/// <param name="client">The initialized Amazon SNS Client object used
/// to check if the phone number has been opted out.</param>
/// <param name="phoneNumber">A string representing the phone number
/// to check.</param>
public static async Task CheckIfOptedOutAsync(IAmazonSimpleNotificationService client, string phoneNumber)
{
var request = new CheckIfPhoneNumberIsOptedOutRequest
{
PhoneNumber = phoneNumber,
};
try
{
var response = await client.CheckIfPhoneNumberIsOptedOutAsync(request);
if (response.HttpStatusCode == System.Net.HttpStatusCode.OK)
{
string optOutStatus = response.IsOptedOut ? "opted out" : "not opted out.";
Console.WriteLine($"The phone number: {phoneNumber} is {optOutStatus}");
}
}
catch (AuthorizationErrorException ex)
{
Console.WriteLine($"{ex.Message}");
}
}
/// <summary>
/// Initiates the asynchronous execution of the CheckIfPhoneNumberIsOptedOut operation.
/// </summary>
///
/// <param name="request">Container for the necessary parameters to execute the CheckIfPhoneNumberIsOptedOut operation on AmazonSimpleNotificationServiceClient.</param>
/// <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param>
/// <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.</param>
///
/// <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCheckIfPhoneNumberIsOptedOut
/// operation.</returns>
public IAsyncResult BeginCheckIfPhoneNumberIsOptedOut(CheckIfPhoneNumberIsOptedOutRequest request, AsyncCallback callback, object state)
{
var marshaller = new CheckIfPhoneNumberIsOptedOutRequestMarshaller();
var unmarshaller = CheckIfPhoneNumberIsOptedOutResponseUnmarshaller.Instance;
return BeginInvoke<CheckIfPhoneNumberIsOptedOutRequest>(request, marshaller, unmarshaller,
callback, state);
}
/// <summary>
/// Accepts a phone number and indicates whether the phone holder has opted out of receiving
/// SMS messages from your account. You cannot send SMS messages to a number that is opted
/// out.
///
///
/// <para>
/// To resume sending messages, you can opt in the number by using the <code>OptInPhoneNumber</code>
/// action.
/// </para>
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the CheckIfPhoneNumberIsOptedOut service method.</param>
///
/// <returns>The response from the CheckIfPhoneNumberIsOptedOut service method, as returned by SimpleNotificationService.</returns>
/// <exception cref="Amazon.SimpleNotificationService.Model.AuthorizationErrorException">
/// Indicates that the user has been denied access to the requested resource.
/// </exception>
/// <exception cref="Amazon.SimpleNotificationService.Model.InternalErrorException">
/// Indicates an internal service error.
/// </exception>
/// <exception cref="Amazon.SimpleNotificationService.Model.InvalidParameterException">
/// Indicates that a request parameter does not comply with the associated constraints.
/// </exception>
/// <exception cref="Amazon.SimpleNotificationService.Model.ThrottledException">
/// Indicates that the rate at which requests have been submitted for this action exceeds
/// the limit for your account.
/// </exception>
public CheckIfPhoneNumberIsOptedOutResponse CheckIfPhoneNumberIsOptedOut(CheckIfPhoneNumberIsOptedOutRequest request)
{
var marshaller = new CheckIfPhoneNumberIsOptedOutRequestMarshaller();
var unmarshaller = CheckIfPhoneNumberIsOptedOutResponseUnmarshaller.Instance;
return Invoke<CheckIfPhoneNumberIsOptedOutRequest,CheckIfPhoneNumberIsOptedOutResponse>(request, marshaller, unmarshaller);
}
/// <summary>
/// Initiates the asynchronous execution of the CheckIfPhoneNumberIsOptedOut operation.
/// </summary>
///
/// <param name="request">Container for the necessary parameters to execute the CheckIfPhoneNumberIsOptedOut operation on AmazonSimpleNotificationServiceClient.</param>
/// <param name="callback">An Action delegate that is invoked when the operation completes.</param>
/// <param name="options">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.</param>
public void CheckIfPhoneNumberIsOptedOutAsync(CheckIfPhoneNumberIsOptedOutRequest request, AmazonServiceCallback<CheckIfPhoneNumberIsOptedOutRequest, CheckIfPhoneNumberIsOptedOutResponse> callback, AsyncOptions options = null)
{
options = options == null?new AsyncOptions():options;
var marshaller = new CheckIfPhoneNumberIsOptedOutRequestMarshaller();
var unmarshaller = CheckIfPhoneNumberIsOptedOutResponseUnmarshaller.Instance;
Action<AmazonWebServiceRequest, AmazonWebServiceResponse, Exception, AsyncOptions> callbackHelper = null;
if(callback !=null )
callbackHelper = (AmazonWebServiceRequest req, AmazonWebServiceResponse res, Exception ex, AsyncOptions ao) => {
AmazonServiceResult<CheckIfPhoneNumberIsOptedOutRequest,CheckIfPhoneNumberIsOptedOutResponse> responseObject
= new AmazonServiceResult<CheckIfPhoneNumberIsOptedOutRequest,CheckIfPhoneNumberIsOptedOutResponse>((CheckIfPhoneNumberIsOptedOutRequest)req, (CheckIfPhoneNumberIsOptedOutResponse)res, ex , ao.State);
callback(responseObject);
};
BeginInvoke<CheckIfPhoneNumberIsOptedOutRequest>(request, marshaller, unmarshaller, options, callbackHelper);
}
public Task <CheckIfPhoneNumberIsOptedOutResponse> CheckIfPhoneNumberIsOptedOutAsync(CheckIfPhoneNumberIsOptedOutRequest request, CancellationToken cancellationToken = default(CancellationToken))
{
throw new System.NotImplementedException();
}
public CheckIfPhoneNumberIsOptedOutResponse CheckIfPhoneNumberIsOptedOut(CheckIfPhoneNumberIsOptedOutRequest request)
{
throw new System.NotImplementedException();
}
public void CheckIfPhoneNumberIsOptedOutAsync(CheckIfPhoneNumberIsOptedOutRequest request, AmazonServiceCallback <CheckIfPhoneNumberIsOptedOutRequest, CheckIfPhoneNumberIsOptedOutResponse> callback, AsyncOptions options = null)
{
throw new System.NotImplementedException();
}
/// <summary>
/// Initiates the asynchronous execution of the CheckIfPhoneNumberIsOptedOut operation.
/// </summary>
///
/// <param name="request">Container for the necessary parameters to execute the CheckIfPhoneNumberIsOptedOut operation.</param>
/// <param name="cancellationToken">
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
/// </param>
/// <returns>The task object representing the asynchronous operation.</returns>
public Task<CheckIfPhoneNumberIsOptedOutResponse> CheckIfPhoneNumberIsOptedOutAsync(CheckIfPhoneNumberIsOptedOutRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var marshaller = new CheckIfPhoneNumberIsOptedOutRequestMarshaller();
var unmarshaller = CheckIfPhoneNumberIsOptedOutResponseUnmarshaller.Instance;
return InvokeAsync<CheckIfPhoneNumberIsOptedOutRequest,CheckIfPhoneNumberIsOptedOutResponse>(request, marshaller,
unmarshaller, cancellationToken);
}
