sh.diffuse.output.playlistItem

diffuse.sh

Documentation

main record

No description available.

Properties

createdAt string datetime Optional

An RFC 3339 formatted timestamp.

criteria array of ref #criterion Required

Criteria for matching this item against a set of tracks

ephemeral boolean Optional

No description available.

id string Required

No description available.

playlist string Required

The name of the playlist

positionedAfter string Optional

Id of the item that this item should be positioned after

updatedAt string datetime Optional

An RFC 3339 formatted timestamp.

View raw schema

{
  "type": "record",
  "record": {
    "type": "object",
    "required": [
      "id",
      "criteria",
      "playlist"
    ],
    "properties": {
      "id": {
        "type": "string"
      },
      "criteria": {
        "type": "array",
        "items": {
          "ref": "#criterion",
          "type": "ref"
        },
        "description": "Criteria for matching this item against a set of tracks"
      },
      "playlist": {
        "type": "string",
        "description": "The name of the playlist"
      },
      "createdAt": {
        "type": "string",
        "format": "datetime"
      },
      "ephemeral": {
        "type": "boolean"
      },
      "updatedAt": {
        "type": "string",
        "format": "datetime"
      },
      "positionedAfter": {
        "type": "string",
        "description": "Id of the item that this item should be positioned after"
      }
    }
  }
}

criterion object

No description available.

Properties

amount integer Optional

No description available.

minimum: 0

field string Required

No description available.

mode string Optional

No description available.

Known values: include, exclude

transformations array of ref#transformation Optional

No description available.

value unknown Required

Value that should be matched belonging to the given field

View raw schema

{
  "type": "object",
  "required": [
    "field",
    "value"
  ],
  "properties": {
    "mode": {
      "type": "string",
      "default": "include",
      "knownValues": [
        "include",
        "exclude"
      ]
    },
    "field": {
      "type": "string"
    },
    "value": {
      "type": "unknown",
      "description": "Value that should be matched belonging to the given field"
    },
    "amount": {
      "type": "integer",
      "minimum": 0
    },
    "transformations": {
      "type": "array",
      "items": {
        "ref": "#transformation",
        "type": "ref"
      }
    }
  }
}

transformation string

Transformation to apply to the field value before comparison. This transformation is method to call on the value. For example, `toString`

View raw schema

{
  "type": "string",
  "description": "Transformation to apply to the field value before comparison. This transformation is method to call on the value. For example, `toString`"
}