com.amazonaws.mobileconnectors.cognitoidentityprovider.CognitoUserCodeDeliveryDetails Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of aws-android-sdk-cognitoidentityprovider Show documentation

The AWS Android SDK for Amazon Cognito Identity Provider module holds the client classes that are used for communicating with Amazon Cognito Identity Provider Service

There is a newer version: 2.79.0

Show newest version

/*
 * Copyright 2013-2016 Amazon.com,
 * Inc. or its affiliates. All Rights Reserved.
 *
 * Licensed under the Amazon Software License (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/asl/
 *
 * or in the "license" file accompanying this file. This file is
 * distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
 * CONDITIONS OF ANY KIND, express or implied. See the License
 * for the specific language governing permissions and
 * limitations under the License.
 */

package com.amazonaws.mobileconnectors.cognitoidentityprovider;

import com.amazonaws.services.cognitoidentityprovider.model.CodeDeliveryDetailsType;
import com.amazonaws.services.cognitoidentityprovider.model.MFAOptionType;

/**
 * This class encapsulates all the information that represent where and in what form a verification
 * code will be delivered.
 */
public class CognitoUserCodeDeliveryDetails {
    /**
     * This will contain the masked information indicating where the code will be delivered. i.e. which email/phone number
     */

    private final String destination;

    /**
     * This indicated how the code will be delivered. i.e. email/sms/voice call etc.
     */
    private final String deliveryMedium;

    /**
     * This is will represent what mode - Email/Phone number.
     */
    private final String attributeName;

    /**
     * Constructs this object with CodeDeliveryDetailsType.
     *
     * @param codeDeliveryDetails       REQUIRED: Cognito code delivery details.
     */
    protected CognitoUserCodeDeliveryDetails(CodeDeliveryDetailsType codeDeliveryDetails) {
    	/**
    	 * If the codeDeliveryDetails is null, a code was not sent to the user.
    	 * When codeDeliveryDetails is not null, construct this object with the delivery details.
    	 * When codeDeliveryDetails is null, construct this as an empty object. 
    	 */
    	if (codeDeliveryDetails != null) {
	        destination = codeDeliveryDetails.getDestination();
	        deliveryMedium = codeDeliveryDetails.getDeliveryMedium();
	        attributeName = codeDeliveryDetails.getAttributeName();
    	} else {
    		destination = null;
    		deliveryMedium = null;
    		attributeName = null;
    	}
    }

    /**
     * Constructs this object with MFAOptionType.
     * @param mfaOptionType    REQUIRED: MFA delivery options.
     */
    protected CognitoUserCodeDeliveryDetails(MFAOptionType mfaOptionType) {
    	/**
    	 * If the mfaOptionType is null, an MFA code was not sent to the user.
    	 * When mfaOptionType is not null, construct this object with the MFA delivery details from mfaOptionType.
    	 * When mfaOptionType is null, construct this as an empty object. 
    	 */
    	if (mfaOptionType != null) {
	        destination = null;
	        deliveryMedium = mfaOptionType.getDeliveryMedium();
	        attributeName = mfaOptionType.getAttributeName();
    	} else {
    		destination = null;
	        deliveryMedium = null;
	        attributeName = null;
    	}
    }

    /**
     * Returns the destination for code delivery.
     *
     * @return code delivery destination.
     */
    public String getDestination() {
        return destination;
    }

    /**
     * Returns the delivery medium for code delivery.
     *
     * @return code delivery medium.
     */
    public String getDeliveryMedium() {
        return deliveryMedium;
    }

    /**
     * Returns how will the code be delivered.
     *
     * @return code delivery mode.
     */
    public String getAttributeName() {
        return attributeName;
    }
}