matrix-spec-proposals/api/client-server/definitions/sync_filter.json

{
  "type": "object",
  "properties": {
    "room": {
      "type": "object",
      "properties": {
        "state": {
          "description":
            "The state events to include for rooms.",
          "allOf": [{"$ref": "room_event_filter.json"}]
        },
        "timeline": {
          "description":
            "The message and state update events to include for rooms.",
          "allOf": [{"$ref": "room_event_filter.json"}]
        },
        "ephemeral": {
          "description":
            "The events that aren't recorded in the room history, e.g. typing and receipts, to include for rooms.",
          "allOf": [{"$ref": "room_event_filter.json"}]
        }
      }
    },
    "presence": {
      "description":
        "The presence updates to include.",
      "allOf": [{"$ref": "event_filter.json"}]
    },
    "event_format": {
      "description":
        "The format to use for events. 'client' will return the events in a format suitable for clients. 'federation' will return the raw event as receieved over federation. The default is 'client'.",
      "type": "string",
      "enum": ["client", "federation"]
    },
    "event_fields": {
      "type": "array",
      "description":
        "List of event fields to include. If this list is absent then all fields are included. The entries may include '.' charaters to indicate sub-fields. So ['content.body'] will include the 'body' field of the 'content' object. A literal '.' character in a field name may be escaped using a '\\'. A server may include more fields than were requested.",
      "items": {
        "type": "string"
      }
    }
  }
}