at.margin.preferences Documentation (EN)

main record

User preferences for the Margin application.

Record Key literal:self Fixed literal value

Properties

createdAt string datetime Required

An RFC 3339 formatted timestamp.

disableExternalLinkWarning boolean Optional

If true, do not show the confirmation modal when opening external links.

externalLinkSkippedHostnames array of string Optional

List of hostnames to skip the external link warning modal for.

maxLength: 100 items

labelPreferences array of ref #labelPreference Optional

Per-label visibility preferences for subscribed labelers.

maxLength: 500 items

subscribedLabelers array of ref #labelerSubscription Optional

List of labeler services the user subscribes to for content moderation.

maxLength: 50 items

View raw schema

{
  "key": "literal:self",
  "type": "record",
  "record": {
    "type": "object",
    "required": [
      "createdAt"
    ],
    "properties": {
      "createdAt": {
        "type": "string",
        "format": "datetime"
      },
      "labelPreferences": {
        "type": "array",
        "items": {
          "ref": "#labelPreference",
          "type": "ref"
        },
        "maxLength": 500,
        "description": "Per-label visibility preferences for subscribed labelers."
      },
      "subscribedLabelers": {
        "type": "array",
        "items": {
          "ref": "#labelerSubscription",
          "type": "ref"
        },
        "maxLength": 50,
        "description": "List of labeler services the user subscribes to for content moderation."
      },
      "disableExternalLinkWarning": {
        "type": "boolean",
        "description": "If true, do not show the confirmation modal when opening external links."
      },
      "externalLinkSkippedHostnames": {
        "type": "array",
        "items": {
          "type": "string",
          "maxLength": 255
        },
        "maxLength": 100,
        "description": "List of hostnames to skip the external link warning modal for."
      }
    }
  },
  "description": "User preferences for the Margin application."
}

labelPreference object

No description available.

Properties

label string Required

The label identifier (e.g. sexual, violence, spam).

labelerDid string Required

DID of the labeler service.

visibility string Required

How to handle content with this label: hide, warn, or ignore.

Known values: hide, warn, ignore

View raw schema

{
  "type": "object",
  "required": [
    "labelerDid",
    "label",
    "visibility"
  ],
  "properties": {
    "label": {
      "type": "string",
      "description": "The label identifier (e.g. sexual, violence, spam)."
    },
    "labelerDid": {
      "type": "string",
      "description": "DID of the labeler service."
    },
    "visibility": {
      "type": "string",
      "description": "How to handle content with this label: hide, warn, or ignore.",
      "knownValues": [
        "hide",
        "warn",
        "ignore"
      ]
    }
  }
}

labelerSubscription object

No description available.

Properties

did string Required

DID of the labeler service.

View raw schema

{
  "type": "object",
  "required": [
    "did"
  ],
  "properties": {
    "did": {
      "type": "string",
      "description": "DID of the labeler service."
    }
  }
}