Package com.cheetahdigital.corekit.authentication.core.api

Class AuthenticationFieldParams

  • All Implemented Interfaces:
    android.os.Parcelable
    public class AuthenticationFieldParams
extends BaseListQueryParams
    Class for setting the field parameters of Authentication API. All Nullable parameters means you can remove the parameter by passing a null value.

    • Constructor Detail

      • AuthenticationFieldParams

        public AuthenticationFieldParams​(android.os.Parcel in)

      • AuthenticationFieldParams

        public AuthenticationFieldParams()

    • Method Detail

      • getClientId

        @Nullable
public java.lang.String getClientId()
        Get the client id from query map
        Returns:
        client id data from the query map "client_id"

      • setClientId

        public void setClientId​(@Nullable
                        java.lang.String clientId)
        Set the client id of the environment
        Parameters:
        clientId - client id of the environment

      • getClientSecret

        @Nullable
public java.lang.String getClientSecret()
        Get the client secret from query map
        Returns:
        client secret data from the query map "client_secret"

      • setClientSecret

        public void setClientSecret​(@Nullable
                            java.lang.String clientSecret)
        Set the client secret of the environment
        Parameters:
        clientSecret - client secret of the environment

      • getMobilePhone

        @Nullable
public java.lang.String getMobilePhone()
        Get the mobile phone from query map
        Returns:
        mobile phone data from the query map "mobile_phone"

      • setMobilePhone

        public void setMobilePhone​(@Nullable
                           java.lang.String mobilePhone)
        Set the mobile phone of the user
        Parameters:
        mobilePhone - user's mobile phone

      • getPassword

        @Nullable
public java.lang.String getPassword()
        Get the password from query map
        Returns:
        password data from the query map "password"

      • setPassword

        public void setPassword​(@Nullable
                        java.lang.String password)
        Set the password of the user
        Parameters:
        password - user's password

      • getEmail

        @Nullable
public java.lang.String getEmail()
        Get email
        Returns:
        email data from the query map "email"

      • setEmail

        public void setEmail​(@Nullable
                     java.lang.String email)
        Set the email
        Parameters:
        email - user's email

      • getCardId

        @Nullable
public java.lang.String getCardId()
        Get the card id from query map
        Returns:
        card id data from the query map "card_id"

      • setCardId

        public void setCardId​(@Nullable
                      java.lang.String cardId)
        Set the card Id
        Parameters:
        cardId - user's card number

      • getProvider

        @Nullable
public java.lang.String getProvider()
        Get the Provider from query map
        Returns:
        Provider data from the query map "provider"

      • setProvider

        public void setProvider​(@Nullable
                        java.lang.String provider)
        Set the provider The social media type. Values can be facebook, twitter, google or instagram
        Parameters:
        provider - name of the provider. Values can be facebook, twitter, google or instagram

      • getAssertion

        @Nullable
public java.lang.String getAssertion()
        Get the Assertion from query map
        Returns:
        Assertion data from the query map "assertion"

      • setAssertion

        public void setAssertion​(@Nullable
                         java.lang.String assertion)
        Set the assertion
        Parameters:
        assertion - The access token gathered from integrating the social media’s login API

      • getGrantType

        @Nullable
public java.lang.String getGrantType()
        Get the Grant Type from query map
        Returns:
        Grant Type data from the query map "grant_type"

      • setGrantType

        public void setGrantType​(@Nullable
                         java.lang.String grantType)
        Set grant type
        Parameters:
        grantType - For the social login, this value should be assertion. For regular sign-in, this value should be password

      • getRefreshToken

        @Nullable
public java.lang.String getRefreshToken()
        Get the Refresh Token from query map
        Returns:
        Refresh Token data from the query map "refresh_token"

      • setRefreshToken

        public void setRefreshToken​(@Nullable
                            java.lang.String refreshToken)
        Set refresh token
        Parameters:
        refreshToken - The refresh_token value gathered from earlier logins or when token refreshes

      • getDeviceId

        @Nullable
public java.lang.String getDeviceId()
        Get the Device Id from query map
        Returns:
        Device Id data from the query map "device_id"

      • setDeviceId

        public void setDeviceId​(@Nullable
                        java.lang.String deviceId)
        Set device id
        Parameters:
        deviceId - The unique device id

      • getToken

        @Nullable
public java.lang.String getToken()
        Get the Token from query map
        Returns:
        Token data from the query map "token"

      • setToken

        public void setToken​(@Nullable
                     java.lang.String token)
        Set device specific token Used when registering the device to receive notification
        Parameters:
        token - The device specific token

      • getCurrentPassword

        @Nullable
public java.lang.String getCurrentPassword()
        Get the Current Password from query map
        Returns:
        Current Password data from the query map "current_password"

      • setCurrentPassword

        public void setCurrentPassword​(@Nullable
                               java.lang.String currentPassword)
        Set current password
        Parameters:
        currentPassword - current password of the user

      • getPasswordConfirmation

        @Nullable
public java.lang.String getPasswordConfirmation()
        Get the Password Confirmation from query map
        Returns:
        Password Confirmation data from the query map "password_confirmation"

      • setPasswordConfirmation

        public void setPasswordConfirmation​(@Nullable
                                    java.lang.String password)
        Set password confirmation
        Parameters:
        password - password confirmation that should match password

      • getMessageName

        @Nullable
public java.lang.String getMessageName()
        Get the Message Name from query map
        Returns:
        Message Name data from the query map "message_name"

      • setMessageName

        public void setMessageName​(@Nullable
                           java.lang.String messageName)
        Set message name
        Parameters:
        messageName - message name

      • getFirstName

        @Nullable
public java.lang.String getFirstName()
        Get the First Name from query map
        Returns:
        First Name data from the query map "first_name"

      • setFirstName

        public void setFirstName​(@Nullable
                         java.lang.String firstName)
        Set the user's first name
        Parameters:
        firstName - The user’s last name

      • getLastName

        @Nullable
public java.lang.String getLastName()
        Get the Last Name from query map
        Returns:
        Last Name data from the query map "last_name"

      • setLastName

        public void setLastName​(@Nullable
                        java.lang.String lastName)
        Set the user's Last name
        Parameters:
        lastName - The user’s surname

      • getBirthdate

        @Nullable
public java.lang.String getBirthdate()
        Get the Birthdate from query map
        Returns:
        Birthdate data from the query map "birthdate"

      • setBirthdate

        public void setBirthdate​(@Nullable
                         java.lang.String birthdate)
        Set the user's birthdate
        Parameters:
        birthdate - user's birthday

      • getMailingStreet

        @Nullable
public java.lang.String getMailingStreet()
        Get the Mailing Street from query map
        Returns:
        Mailing Street data from the query map "mailing_street"

      • setMailingStreet

        public void setMailingStreet​(@Nullable
                             java.lang.String mailingStreet)
        Set the user's mailing street
        Parameters:
        mailingStreet - user's maling street address

      • getMailingCity

        @Nullable
public java.lang.String getMailingCity()
        Get the Mailing City from query map
        Returns:
        Mailing City data from the query map "mailing_city"

      • setMailingCity

        public void setMailingCity​(@Nullable
                           java.lang.String mailingCity)
        Set the user's mailing city
        Parameters:
        mailingCity - user's mailing city

      • getMailingState

        @Nullable
public java.lang.String getMailingState()
        Get the Mailing State from query map
        Returns:
        Mailing State data from the query map "mailing_state"

      • setMailingState

        public void setMailingState​(@Nullable
                            java.lang.String mailingState)
        Set the user's mailing state
        Parameters:
        mailingState - user's mailing state

      • getMailingPostalCode

        @Nullable
public java.lang.String getMailingPostalCode()
        Get the Mailing Postal Code from query map
        Returns:
        Mailing Postal Code data from the query map "mailing_postal_code"

      • setMailingPostalCode

        public void setMailingPostalCode​(@Nullable
                                 java.lang.String mailingPostalCode)
        Set the user's mailing postal code
        Parameters:
        mailingPostalCode - user's mailing postal code

      • getReferralCode

        @Nullable
public java.lang.String getReferralCode()
        Get the Referral Code from query map
        Returns:
        Referral Code data from the query map "referral_code"

      • setReferralCode

        public void setReferralCode​(@Nullable
                            java.lang.String referralCode)
        Set the user's referral code If provided and valid, will link referral to member that shared the code
        Parameters:
        referralCode - user's referral code

      • getPlaceIntegrationId

        @Nullable
public java.lang.String getPlaceIntegrationId()
        Get the Place Integration Id from query map
        Returns:
        Place Integration Id data from the query map "place_integration_id"

      • setPlaceIntegrationId

        public void setPlaceIntegrationId​(@Nullable
                                  java.lang.String placeIntegrationId)
        Set the user's place integration id
        Parameters:
        placeIntegrationId - user's place integration id

      • setFields

        public void setFields​(@Nullable
                      java.util.Map<java.lang.String,​java.lang.Object> fields)
        Set additional fields for the user
        Parameters:
        fields - additional fields which will be set. This is in Map format

      • getEmailAlias

        @Nullable
public java.lang.String getEmailAlias()
        Get the email alias from query map
        Returns:
        the user's email alias

      • setEmailAlias

        public void setEmailAlias​(@Nullable
                          java.lang.String emailAlias)
        Set the user's email alias
        Parameters:
        emailAlias - user's email alias

      • getResetPasswordToken

        @Nullable
public java.lang.String getResetPasswordToken()
        Get the reset password token
        Returns:
        reset password token

      • setResetPasswordToken

        public void setResetPasswordToken​(@Nullable
                                  java.lang.String resetPasswordToken)
        Set reset password token from URL param
        Parameters:
        resetPasswordToken - reset password token