Package com.vk.api.sdk.queries.users

Class UsersSearchQuery

    • Constructor Detail

      • UsersSearchQuery

        public UsersSearchQuery​(VkApiClient client,
                        UserActor actor)
        Creates a AbstractQueryBuilder instance that can be used to build api request with various parameters
        Parameters:
        client - VK API client
        actor - actor with access token

    • Method Detail

      • q

        public UsersSearchQuery q​(java.lang.String value)
        Search query string (e.g., 'Vasya Babich').
        Parameters:
        value - value of "q" parameter.
        Returns:
        a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.

      • sort

        public UsersSearchQuery sort​(SearchSort value)
        Sort order: '1' — by date registered, '0' — by rating
        Parameters:
        value - value of "sort" parameter.
        Returns:
        a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.

      • offset

        public UsersSearchQuery offset​(java.lang.Integer value)
        Offset needed to return a specific subset of users.
        Parameters:
        value - value of "offset" parameter. Minimum is 0.
        Returns:
        a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.

      • count

        public UsersSearchQuery count​(java.lang.Integer value)
        Number of users to return.
        Parameters:
        value - value of "count" parameter. Maximum is 1000. Minimum is 0. By default 20.
        Returns:
        a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.

      • city

        public UsersSearchQuery city​(java.lang.Integer value)
        City ID.
        Parameters:
        value - value of "city" parameter. Minimum is 0.
        Returns:
        a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.

      • country

        public UsersSearchQuery country​(java.lang.Integer value)
        Country ID.
        Parameters:
        value - value of "country" parameter. Minimum is 0.
        Returns:
        a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.

      • hometown

        public UsersSearchQuery hometown​(java.lang.String value)
        City name in a string.
        Parameters:
        value - value of "hometown" parameter.
        Returns:
        a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.

      • universityCountry

        public UsersSearchQuery universityCountry​(java.lang.Integer value)
        ID of the country where the user graduated.
        Parameters:
        value - value of "university country" parameter. Minimum is 0.
        Returns:
        a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.

      • university

        public UsersSearchQuery university​(java.lang.Integer value)
        ID of the institution of higher education.
        Parameters:
        value - value of "university" parameter. Minimum is 0.
        Returns:
        a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.

      • universityYear

        public UsersSearchQuery universityYear​(java.lang.Integer value)
        Year of graduation from an institution of higher education.
        Parameters:
        value - value of "university year" parameter. Minimum is 0.
        Returns:
        a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.

      • universityFaculty

        public UsersSearchQuery universityFaculty​(java.lang.Integer value)
        Faculty ID.
        Parameters:
        value - value of "university faculty" parameter. Minimum is 0.
        Returns:
        a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.

      • universityChair

        public UsersSearchQuery universityChair​(java.lang.Integer value)
        Chair ID.
        Parameters:
        value - value of "university chair" parameter. Minimum is 0.
        Returns:
        a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.

      • sex

        public UsersSearchQuery sex​(SearchSex value)
        '1' — female, '2' — male, '0' — any (default)
        Parameters:
        value - value of "sex" parameter. Minimum is 0.
        Returns:
        a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.

      • status

        public UsersSearchQuery status​(SearchStatus value)
        Relationship status: '1' — Not married, '2' — In a relationship, '3' — Engaged, '4' — Married, '5' — It's complicated, '6' — Actively searching, '7' — In love
        Parameters:
        value - value of "status" parameter. Minimum is 0.
        Returns:
        a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.

      • ageFrom

        public UsersSearchQuery ageFrom​(java.lang.Integer value)
        Minimum age.
        Parameters:
        value - value of "age from" parameter. Minimum is 0.
        Returns:
        a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.

      • ageTo

        public UsersSearchQuery ageTo​(java.lang.Integer value)
        Maximum age.
        Parameters:
        value - value of "age to" parameter. Minimum is 0.
        Returns:
        a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.

      • birthDay

        public UsersSearchQuery birthDay​(java.lang.Integer value)
        Day of birth.
        Parameters:
        value - value of "birth day" parameter. Minimum is 0.
        Returns:
        a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.

      • birthMonth

        public UsersSearchQuery birthMonth​(java.lang.Integer value)
        Month of birth.
        Parameters:
        value - value of "birth month" parameter. Minimum is 0.
        Returns:
        a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.

      • birthYear

        public UsersSearchQuery birthYear​(java.lang.Integer value)
        Year of birth.
        Parameters:
        value - value of "birth year" parameter. Maximum is 2100. Minimum is 1900.
        Returns:
        a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.

      • online

        public UsersSearchQuery online​(java.lang.Boolean value)
        '1' — online only, '0' — all users
        Parameters:
        value - value of "online" parameter.
        Returns:
        a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.

      • hasPhoto

        public UsersSearchQuery hasPhoto​(java.lang.Boolean value)
        '1' — with photo only, '0' — all users
        Parameters:
        value - value of "has photo" parameter.
        Returns:
        a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.

      • schoolCountry

        public UsersSearchQuery schoolCountry​(java.lang.Integer value)
        ID of the country where users finished school.
        Parameters:
        value - value of "school country" parameter. Minimum is 0.
        Returns:
        a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.

      • schoolCity

        public UsersSearchQuery schoolCity​(java.lang.Integer value)
        ID of the city where users finished school.
        Parameters:
        value - value of "school city" parameter. Minimum is 0.
        Returns:
        a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.

      • schoolClass

        public UsersSearchQuery schoolClass​(java.lang.Integer value)
        Set school class
        Parameters:
        value - value of "school class" parameter. Minimum is 0.
        Returns:
        a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.

      • school

        public UsersSearchQuery school​(java.lang.Integer value)
        ID of the school.
        Parameters:
        value - value of "school" parameter. Minimum is 0.
        Returns:
        a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.

      • schoolYear

        public UsersSearchQuery schoolYear​(java.lang.Integer value)
        School graduation year.
        Parameters:
        value - value of "school year" parameter. Minimum is 0.
        Returns:
        a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.

      • religion

        public UsersSearchQuery religion​(java.lang.String value)
        Users' religious affiliation.
        Parameters:
        value - value of "religion" parameter.
        Returns:
        a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.

      • company

        public UsersSearchQuery company​(java.lang.String value)
        Name of the company where users work.
        Parameters:
        value - value of "company" parameter.
        Returns:
        a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.

      • position

        public UsersSearchQuery position​(java.lang.String value)
        Job position.
        Parameters:
        value - value of "position" parameter.
        Returns:
        a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.

      • groupId

        public UsersSearchQuery groupId​(java.lang.Integer value)
        ID of a community to search in communities.
        Parameters:
        value - value of "group id" parameter. Minimum is 0.
        Returns:
        a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.

      • fromList

        public UsersSearchQuery fromList​(java.lang.String... value)
        from_list Set from list
        Parameters:
        value - value of "from list" parameter.
        Returns:
        a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.

      • fromList

        public UsersSearchQuery fromList​(java.util.List<java.lang.String> value)
        Set from list
        Parameters:
        value - value of "from list" parameter.
        Returns:
        a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.

      • fields

        public UsersSearchQuery fields​(Fields... value)
        fields Profile fields to return. Sample values: 'nickname', 'screen_name', 'sex', 'bdate' (birthdate), 'city', 'country', 'timezone', 'photo', 'photo_medium', 'photo_big', 'has_mobile', 'rate', 'contacts', 'education', 'online',
        Parameters:
        value - value of "fields" parameter.
        Returns:
        a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.

      • fields

        public UsersSearchQuery fields​(java.util.List<Fields> value)
        Profile fields to return. Sample values: 'nickname', 'screen_name', 'sex', 'bdate' (birthdate), 'city', 'country', 'timezone', 'photo', 'photo_medium', 'photo_big', 'has_mobile', 'rate', 'contacts', 'education', 'online',
        Parameters:
        value - value of "fields" parameter.
        Returns:
        a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.