Package com.adcolony.sdk

Class AdColonyUserMetadata

    • Field Detail

      • USER_FEMALE

        public static final java.lang.String USER_FEMALE
        Deprecated.
        See Also:
        Constant Field Values

      • USER_SINGLE

        public static final java.lang.String USER_SINGLE
        Deprecated.
        See Also:
        Constant Field Values

      • USER_MARRIED

        public static final java.lang.String USER_MARRIED
        Deprecated.
        See Also:
        Constant Field Values

      • USER_EDUCATION_GRADE_SCHOOL

        public static final java.lang.String USER_EDUCATION_GRADE_SCHOOL
        Deprecated.
        See Also:
        Constant Field Values

      • USER_EDUCATION_SOME_HIGH_SCHOOL

        public static final java.lang.String USER_EDUCATION_SOME_HIGH_SCHOOL
        Deprecated.
        See Also:
        Constant Field Values

      • USER_EDUCATION_HIGH_SCHOOL_DIPLOMA

        public static final java.lang.String USER_EDUCATION_HIGH_SCHOOL_DIPLOMA
        Deprecated.
        See Also:
        Constant Field Values

      • USER_EDUCATION_SOME_COLLEGE

        public static final java.lang.String USER_EDUCATION_SOME_COLLEGE
        Deprecated.
        See Also:
        Constant Field Values

      • USER_EDUCATION_ASSOCIATES_DEGREE

        public static final java.lang.String USER_EDUCATION_ASSOCIATES_DEGREE
        Deprecated.
        See Also:
        Constant Field Values

      • USER_EDUCATION_BACHELORS_DEGREE

        public static final java.lang.String USER_EDUCATION_BACHELORS_DEGREE
        Deprecated.
        See Also:
        Constant Field Values

      • USER_EDUCATION_GRADUATE_DEGREE

        public static final java.lang.String USER_EDUCATION_GRADUATE_DEGREE
        Deprecated.
        See Also:
        Constant Field Values

    • Constructor Detail

      • AdColonyUserMetadata

        public AdColonyUserMetadata()
        Deprecated.

    • Method Detail

      • setUserGender

        public AdColonyUserMetadata setUserGender​(java.lang.String gender)
        Deprecated.
        Used to set the current user's gender.
        Parameters:
        gender - a constant representing the user's gender. Should be one of AdColonyUserMetadata.USER_MALE or AdColonyUserMetadata.USER_FEMALE.
        Returns:
        'this' for chaining calls.

      • getUserGender

        public java.lang.String getUserGender()
        Deprecated.
        Used to retrieve the user gender set in the user metadata.
        Returns:
        one of AdColonyUserMetadata.USER_MALE or AdColonyUserMetadata.USER_FEMALE. Will return an empty String if the user's gender has not been set.

      • setUserAge

        public AdColonyUserMetadata setUserAge​(int age)
        Deprecated.
        Used to set the current user's age.
        Parameters:
        age - the age of the current user.
        Returns:
        'this' for chaining calls.

      • getUserAge

        public int getUserAge()
        Deprecated.
        Used to retrieve the user age as set in the user metadata.
        Returns:
        the user's age, or 0 if it has not been set.

      • setUserMaritalStatus

        public AdColonyUserMetadata setUserMaritalStatus​(java.lang.String status)
        Deprecated.
        Used to set the current user's marital status.
        Parameters:
        status - the marital status of the current user. Should be one of AdColonyUserMetadata.USER_SINGLE or AdColonyUserMetadata.USER_MARRIED.
        Returns:
        'this' for chaining calls.

      • getUserMaritalStatus

        public java.lang.String getUserMaritalStatus()
        Deprecated.
        Used to retrieve the user's marital status as set in the user metadata.
        Returns:
        one of the String constants representing the user's marital status, or an empty String if it has not yet been set.

      • setUserAnnualHouseholdIncome

        public AdColonyUserMetadata setUserAnnualHouseholdIncome​(int income)
        Deprecated.
        Used to set the user's annual household income.
        Parameters:
        income - the current user's annual household income.
        Returns:
        'this' for chaining calls.

      • getUserAnnualHouseholdIncome

        public int getUserAnnualHouseholdIncome()
        Deprecated.
        Used to retrieve the user's annual household income as set in the user metadata.
        Returns:
        the current user's annual household income, or 0 if it has not been set.

      • setUserEducation

        public AdColonyUserMetadata setUserEducation​(java.lang.String education)
        Deprecated.
        Used to set the user's education level.
        Parameters:
        education - one of the String constants from AdColonyUserMetadata representing education level.
        Returns:
        'this' for chaining calls.

      • getUserEducation

        public java.lang.String getUserEducation()
        Deprecated.
        Used to retrieve the user's education as set in the user metadata.
        Returns:
        a String constant representing the user's education level, or an empty String if it has not been set.

      • setUserZipCode

        public AdColonyUserMetadata setUserZipCode​(java.lang.String zip)
        Deprecated.
        Used to set the current user's ZIP code.
        Parameters:
        zip - the current user's ZIP code.
        Returns:
        'this' for chaining calls.

      • getUserZipCode

        public java.lang.String getUserZipCode()
        Deprecated.
        Used to retrieve the user's ZIP code as set in the user metadata.
        Returns:
        the user's zip code, or an empty String if it has not been set.

      • setUserLocation

        public AdColonyUserMetadata setUserLocation​(Location location)
        Deprecated.
        Used to set the current user's location.
        Parameters:
        location - the location object usually generated by LocationManager.
        Returns:
        'this' for chaining calls.

      • getUserLocation

        public Location getUserLocation()
        Deprecated.
        Used to retrieve the current user's location as set in the user metadata.
        Returns:
        the Location object representing the user's location, or null if it has not been set.

      • addUserInterest

        public AdColonyUserMetadata addUserInterest​(java.lang.String interest)
        Deprecated.
        Used to add an arbitrary user interest.
        Parameters:
        interest - a String representing the user interest.
        Returns:
        'this' for chaining calls.

      • clearUserInterests

        public AdColonyUserMetadata clearUserInterests()
        Deprecated.
        Used to clear the current user's interests tied to this user metadata object.
        Returns:
        'this' for chaining calls.

      • getUserInterests

        public java.lang.String[] getUserInterests()
        Deprecated.
        Used to retrieve the user's interests as set in the user metadata.
        Returns:
        a String array of the user's interests.

      • setMetadata

        public AdColonyUserMetadata setMetadata​(java.lang.String key,
                                        boolean value)
        Deprecated.
        Optionally set an arbitrary key/value definition
        Parameters:
        key - the key for this option mapping.
        value - the value for this option mapping.
        Returns:
        'this' for chaining calls.

      • getMetadata

        public java.lang.Object getMetadata​(java.lang.String key)
        Deprecated.
        Used to retrieve an arbitrary option with the given key.
        Parameters:
        key - the key of the option you wish to retrieve.
        Returns:
        the value mapped to the provided key, or false if the mapping does not exist.

      • setMetadata

        public AdColonyUserMetadata setMetadata​(java.lang.String key,
                                        double value)
        Deprecated.
        Optionally set an arbitrary key/value definition
        Parameters:
        key - the key for this option mapping.
        value - the value for this option mapping.
        Returns:
        'this' for chaining calls.

      • setMetadata

        public AdColonyUserMetadata setMetadata​(java.lang.String key,
                                        java.lang.String value)
        Deprecated.
        Optionally set an arbitrary key/value definition
        Parameters:
        key - the key for ths option mapping.
        value - the value for this option mapping.
        Returns:
        'this' for chaining calls.