matrix-spec/data/event-schemas/schema/m.room.message$m.location.yaml

51 lines
1.6 KiB
YAML
Raw Normal View History

---
$schema: https://json-schema.org/draft/2020-12/schema
allOf:
- $ref: core-event-schema/room_event.yaml
description: This message represents a real-world location.
properties:
content:
properties:
body:
description: "A description of the location e.g. 'Big Ben, London, UK', or some kind of content description for accessibility e.g. 'location attachment'."
type: string
geo_uri:
description: A [geo URI (RFC5870)](https://datatracker.ietf.org/doc/html/rfc5870) representing this location.
type: string
msgtype:
enum:
- m.location
type: string
info:
type: object
properties:
thumbnail_url:
2018-08-31 18:59:57 +02:00
description: |-
The URL to a thumbnail of the location being represented.
Only present if the thumbnail is unencrypted.
type: string
thumbnail_file:
description: |-
Information on the encrypted thumbnail file, as specified in
2021-01-29 01:00:39 +01:00
[End-to-end encryption](/client-server-api/#sending-encrypted-attachments).
Only present if the thumbnail is encrypted.
title: EncryptedFile
type: object
2016-11-07 15:54:59 +01:00
thumbnail_info:
allOf:
- $ref: core-event-schema/msgtype_infos/thumbnail_info.yaml
description: Metadata about the image referred to in `thumbnail_url`.
title: LocationInfo
required:
- msgtype
- body
- geo_uri
type: object
type:
enum:
- m.room.message
type: string
title: LocationMessage
type: object