Package com.vk.api.sdk.queries.messages

Class MessagesSearchQuery

    • Constructor Detail

      • MessagesSearchQuery

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

      • MessagesSearchQuery

        public MessagesSearchQuery​(VkApiClient client,
                           GroupActor 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 MessagesSearchQuery q​(java.lang.String value)
        Search query string.
        Parameters:
        value - value of "q" parameter.
        Returns:
        a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.

      • peerId

        public MessagesSearchQuery peerId​(java.lang.Integer value)
        Destination ID. "For user: 'User ID', e.g. '12345'. For chat: '2000000000' + 'chat_id', e.g. '2000000001'. For community: '- community ID', e.g. '-12345'. "
        Parameters:
        value - value of "peer id" parameter.
        Returns:
        a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.

      • date

        public MessagesSearchQuery date​(java.lang.Integer value)
        Date to search message before in Unixtime.
        Parameters:
        value - value of "date" parameter. Minimum is 0.
        Returns:
        a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.

      • previewLength

        public MessagesSearchQuery previewLength​(java.lang.Integer value)
        Number of characters after which to truncate a previewed message. To preview the full message, specify '0'. "NOTE: Messages are not truncated by default. Messages are truncated by words."
        Parameters:
        value - value of "preview length" parameter. Minimum is 0. By default 0.
        Returns:
        a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.

      • offset

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

      • count

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

      • extended

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

      • groupId

        public MessagesSearchQuery groupId​(java.lang.Integer value)
        Group ID (for group messages with group access token)
        Parameters:
        value - value of "group id" parameter. Minimum is 0.
        Returns:
        a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.

      • fields

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

      • fields

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