matrix-spec/data/api/client-server/definitions/timeline_batch.yaml

# Copyright 2016 OpenMarket Ltd
# Copyright 2018 New Vector Ltd
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
properties:
  limited:
    description: True if the number of events returned was limited by the `limit`
      on the filter.
    type: boolean
  prev_batch:
    description: A token that can be supplied to the `from` parameter of the
      [`/rooms/<room_id>/messages`](#get_matrixclientv3roomsroomidmessages)
      endpoint in order to retrieve earlier events.

      If no earlier events are available, this property may be omitted from
      the response.
    type: string
  events:
    description: List of events.
    type: array
    items:
      $ref: "client_event_without_room_id.yaml"
type: object
title: TimelineBatch
required:
  - events