Package com.vk.api.sdk.queries.friends

Class FriendsGetQuery

    • Constructor Detail

      • FriendsGetQuery

        public FriendsGetQuery​(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

      • FriendsGetQuery

        public FriendsGetQuery​(VkApiClient client,
                       ServiceActor 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

      • userId

        public FriendsGetQuery userId​(java.lang.Integer value)
        User ID. By default, the current user ID.
        Parameters:
        value - value of "user id" parameter.
        Returns:
        a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.

      • order

        public FriendsGetQuery order​(GetOrder value)
        Sort order: , 'name' — by name (enabled only if the 'fields' parameter is used), 'hints' — by rating, similar to how friends are sorted in My friends section, , This parameter is available only for [vk.com/dev/standalone|desktop applications].
        Parameters:
        value - value of "order" parameter.
        Returns:
        a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.

      • listId

        public FriendsGetQuery listId​(java.lang.Integer value)
        ID of the friend list returned by the [vk.com/dev/friends.getLists|friends.getLists] method to be used as the source. This parameter is taken into account only when the uid parameter is set to the current user ID. This parameter is available only for [vk.com/dev/standalone|desktop applications].
        Parameters:
        value - value of "list id" parameter. Minimum is 0.
        Returns:
        a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.

      • count

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

      • offset

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

      • nameCase

        public FriendsGetQuery nameCase​(GetNameCase value)
        Case for declension of user name and surname: , 'nom' — nominative (default) , 'gen' — genitive , 'dat' — dative , 'acc' — accusative , 'ins' — instrumental , 'abl' — prepositional
        Parameters:
        value - value of "name case" parameter.
        Returns:
        a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.

      • ref

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

      • fields

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

      • fields

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