social.colibri.beta.embed.defs

colibri.social

Documentation

embedImage object

A preview image.

Properties

alt string Optional

Alternative text.

height integer Optional

Intrinsic pixel height.

url string uri Required

URL served by this AppView's image proxy.

width integer Optional

Intrinsic pixel width.

View raw schema 
{
  "type": "object",
  "required": [
    "url"
  ],
  "properties": {
    "alt": {
      "type": "string",
      "description": "Alternative text."
    },
    "url": {
      "type": "string",
      "format": "uri",
      "description": "URL served by this AppView's image proxy."
    },
    "width": {
      "type": "integer",
      "description": "Intrinsic pixel width."
    },
    "height": {
      "type": "integer",
      "description": "Intrinsic pixel height."
    }
  },
  "description": "A preview image."
}
embedVideo object

A playable video.

Properties

duration integer Optional

Duration in seconds.

height integer Optional

Intrinsic pixel height.

mimeType string Required

Content type.

Known values: video/mp4, video/webm
url string uri Required

URL served by this AppView's video proxy.

width integer Optional

Intrinsic pixel width.

View raw schema 
{
  "type": "object",
  "required": [
    "url",
    "mimeType"
  ],
  "properties": {
    "url": {
      "type": "string",
      "format": "uri",
      "description": "URL served by this AppView's video proxy."
    },
    "width": {
      "type": "integer",
      "description": "Intrinsic pixel width."
    },
    "height": {
      "type": "integer",
      "description": "Intrinsic pixel height."
    },
    "duration": {
      "type": "integer",
      "description": "Duration in seconds."
    },
    "mimeType": {
      "type": "string",
      "description": "Content type.",
      "knownValues": [
        "video/mp4",
        "video/webm"
      ]
    }
  },
  "description": "A playable video."
}
gifCategory object

A category in the GIF picker.

Properties

name string Required

Category name.

previewUrl string uri Optional

Representative image for the category.

View raw schema 
{
  "type": "object",
  "required": [
    "name"
  ],
  "properties": {
    "name": {
      "type": "string",
      "description": "Category name."
    },
    "previewUrl": {
      "type": "string",
      "format": "uri",
      "description": "Representative image for the category."
    }
  },
  "description": "A category in the GIF picker."
}
gifView object

A GIF from the picker.

Properties

height integer Required

Intrinsic pixel height.

id string Required

Provider identifier, stable enough to save as a favourite.

previewUrl string uri Required

Smaller preview URL for the picker grid.

title string Optional

Human-readable title.

url string uri Required

Full-size GIF URL.

width integer Required

Intrinsic pixel width.

View raw schema 
{
  "type": "object",
  "required": [
    "id",
    "url",
    "previewUrl",
    "width",
    "height"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "Provider identifier, stable enough to save as a favourite."
    },
    "url": {
      "type": "string",
      "format": "uri",
      "description": "Full-size GIF URL."
    },
    "title": {
      "type": "string",
      "description": "Human-readable title."
    },
    "width": {
      "type": "integer",
      "description": "Intrinsic pixel width."
    },
    "height": {
      "type": "integer",
      "description": "Intrinsic pixel height."
    },
    "previewUrl": {
      "type": "string",
      "format": "uri",
      "description": "Smaller preview URL for the picker grid."
    }
  },
  "description": "A GIF from the picker."
}
linkEmbed object

A link preview.

Properties

description string Optional

Page description.

siteName string Optional

Publisher name.

title string Optional

Page title.

uri string uri Required

The URL previewed.

View raw schema 
{
  "type": "object",
  "required": [
    "uri"
  ],
  "properties": {
    "uri": {
      "type": "string",
      "format": "uri",
      "description": "The URL previewed."
    },
    "image": {
      "ref": "#embedImage",
      "type": "ref",
      "description": "Preview image."
    },
    "title": {
      "type": "string",
      "description": "Page title."
    },
    "video": {
      "ref": "#embedVideo",
      "type": "ref",
      "description": "Playable video."
    },
    "siteName": {
      "type": "string",
      "description": "Publisher name."
    },
    "description": {
      "type": "string",
      "description": "Page description."
    }
  },
  "description": "A link preview."
}

Lexicon Garden

@