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

Class MessagesGetHistoryQuery

    • Constructor Detail

      • MessagesGetHistoryQuery

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

      • MessagesGetHistoryQuery

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

      • offset

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

      • count

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

      • userId

        public MessagesGetHistoryQuery userId​(java.lang.Integer value)
        ID of the user whose message history you want to return.
        Parameters:
        value - value of "user id" parameter.
        Returns:
        a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.

      • peerId

        public MessagesGetHistoryQuery peerId​(java.lang.Integer value)
        Set peer id
        Parameters:
        value - value of "peer id" parameter.
        Returns:
        a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.

      • startMessageId

        public MessagesGetHistoryQuery startMessageId​(java.lang.Integer value)
        Starting message ID from which to return history.
        Parameters:
        value - value of "start message id" parameter. Minimum is 0.
        Returns:
        a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.

      • rev

        public MessagesGetHistoryQuery rev​(GetHistoryRev value)
        Sort order: '1' — return messages in chronological order. '0' — return messages in reverse chronological order.
        Parameters:
        value - value of "rev" parameter.
        Returns:
        a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.

      • extended

        public MessagesGetHistoryQuery extended​(java.lang.Boolean value)
        Information whether the response should be extended
        Parameters:
        value - value of "extended" parameter.
        Returns:
        a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.

      • groupId

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

      • fields

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