org.swappulse.story

bridge.swappulse.org

Documentation

An ephemeral story with one or more media segments.

main record

An ephemeral story with one or more media segments.

Record Key tid Timestamp-based ID

Properties

audience string Required

No description available.

Known values: friends, public
authorDid string did Optional

A decentralized identifier (DID).

authorHandle string Optional

No description available.

authorName string Optional

No description available.

bgGradient string Optional

No description available.

Known values: purple, sunset, ocean
content string Optional

No description available.

maxLength: 280 bytes
createdAt string datetime Required

An RFC 3339 formatted timestamp.

expiresAt string datetime Required

An RFC 3339 formatted timestamp.

imageUri string uri Optional

A valid URI.

segments array of object Optional

No description available.

maxLength: 20 itemsminLength: 1 items
storyGroup string Optional

No description available.

viewedBy array of string did Optional

No description available.

View raw schema
{
  "key": "tid",
  "type": "record",
  "record": {
    "type": "object",
    "required": [
      "expiresAt",
      "audience",
      "createdAt"
    ],
    "properties": {
      "content": {
        "type": "string",
        "maxLength": 280
      },
      "audience": {
        "type": "string",
        "knownValues": [
          "friends",
          "public"
        ]
      },
      "imageUri": {
        "type": "string",
        "format": "uri"
      },
      "segments": {
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "order": {
              "type": "integer",
              "minimum": 0
            },
            "cardName": {
              "type": "string"
            },
            "duration": {
              "type": "integer",
              "maximum": 15,
              "minimum": 3
            },
            "cardImage": {
              "type": "string",
              "format": "uri"
            },
            "mediaBlob": {
              "type": "string",
              "format": "uri"
            },
            "mediaType": {
              "type": "string",
              "knownValues": [
                "image",
                "video",
                "text",
                "card"
              ]
            },
            "textOverlay": {
              "type": "string",
              "maxLength": 200
            },
            "cardEmbedUri": {
              "type": "string"
            },
            "textPosition": {
              "type": "string",
              "knownValues": [
                "top",
                "center",
                "bottom"
              ]
            },
            "backgroundColor": {
              "type": "string"
            }
          }
        },
        "maxLength": 20,
        "minLength": 1
      },
      "viewedBy": {
        "type": "array",
        "items": {
          "type": "string",
          "format": "did"
        }
      },
      "authorDid": {
        "type": "string",
        "format": "did"
      },
      "createdAt": {
        "type": "string",
        "format": "datetime"
      },
      "expiresAt": {
        "type": "string",
        "format": "datetime"
      },
      "authorName": {
        "type": "string"
      },
      "bgGradient": {
        "type": "string",
        "knownValues": [
          "purple",
          "sunset",
          "ocean"
        ]
      },
      "storyGroup": {
        "type": "string"
      },
      "authorHandle": {
        "type": "string"
      }
    }
  },
  "description": "An ephemeral story with one or more media segments."
}

Lexicon Garden

@