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

Class FriendsGetRequestsQuery

    • Constructor Detail

      • FriendsGetRequestsQuery

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

      • offset

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

      • count

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

      • extended

        public FriendsGetRequestsQuery extended​(java.lang.Boolean value)
        '1' — to return response messages from users who have sent a friend request or, if 'suggested' is set to '1', to return a list of suggested friends
        Parameters:
        value - value of "extended" parameter.
        Returns:
        a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.

      • needMutual

        public FriendsGetRequestsQuery needMutual​(java.lang.Boolean value)
        '1' — to return a list of mutual friends (up to 20), if any
        Parameters:
        value - value of "need mutual" parameter.
        Returns:
        a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.

      • out

        public FriendsGetRequestsQuery out​(java.lang.Boolean value)
        '1' — to return outgoing requests, '0' — to return incoming requests (default)
        Parameters:
        value - value of "out" parameter.
        Returns:
        a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.

      • sort

        public FriendsGetRequestsQuery sort​(GetRequestsSort value)
        Sort order: '1' — by number of mutual friends, '0' — by date
        Parameters:
        value - value of "sort" parameter. Minimum is 0.
        Returns:
        a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.

      • needViewed

        public FriendsGetRequestsQuery needViewed​(java.lang.Boolean value)
        Set need viewed
        Parameters:
        value - value of "need viewed" parameter. By default 0.
        Returns:
        a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.

      • suggested

        public FriendsGetRequestsQuery suggested​(java.lang.Boolean value)
        '1' — to return a list of suggested friends, '0' — to return friend requests (default)
        Parameters:
        value - value of "suggested" parameter.
        Returns:
        a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.

      • ref

        public FriendsGetRequestsQuery 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 FriendsGetRequestsQuery fields​(Fields... value)
        fields Set fields
        Parameters:
        value - value of "fields" parameter.
        Returns:
        a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.

      • fields

        public FriendsGetRequestsQuery fields​(java.util.List<Fields> value)
        Set fields
        Parameters:
        value - value of "fields" parameter.
        Returns:
        a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.