community.lexicon.app.defs Documentation (EN)

accountIndicator object

A record whose presence in an account can indicate that the account probably uses this app.

Properties

collection string nsid Required

Record collection to look for in an account repository.

rkey string record-key Optional

Optional record key to look for within the collection.

View raw schema

{
  "type": "object",
  "required": [
    "collection"
  ],
  "properties": {
    "rkey": {
      "type": "string",
      "format": "record-key",
      "description": "Optional record key to look for within the collection."
    },
    "collection": {
      "type": "string",
      "format": "nsid",
      "description": "Record collection to look for in an account repository."
    }
  },
  "description": "A record whose presence in an account can indicate that the account probably uses this app."
}

aspectRatio object

width:height represents an aspect ratio. It may be approximate.

Properties

height integer Required

No description available.

minimum: 1

width integer Required

No description available.

minimum: 1

View raw schema

{
  "type": "object",
  "required": [
    "width",
    "height"
  ],
  "properties": {
    "width": {
      "type": "integer",
      "minimum": 1
    },
    "height": {
      "type": "integer",
      "minimum": 1
    }
  },
  "description": "width:height represents an aspect ratio. It may be approximate."
}

discontinued token

The app is no longer available or supported.

Referencecommunity.lexicon.app.defs#discontinued

Tokens have no data representation. Use the reference string as a value.

View raw schema

{
  "type": "token",
  "description": "The app is no longer available or supported."
}

image object

An image associated with an app, including accessibility and display metadata. Exactly one of `image` (ATProto blob) or `uri` (remote URL) MUST be present. Consumers SHOULD ignore image items that have neither or both.

Properties

alt string Required

Alt text description of the image, for accessibility.

maxLength: 1000 bytesmaxGraphemes: 300 graphemes

aspectRatio ref #aspectRatio Optional

No description available.

image blob Optional

The raw image file.

maxSize: 2.0 MB

purpose string Optional

How directories and stores should use the image. Omit this field when no known purpose fits.

Known values: community.lexicon.app.defs#purposeIcon, community.lexicon.app.defs#purposeLogo, community.lexicon.app.defs#purposeHero, community.lexicon.app.defs#purposeScreenshot, community.lexicon.app.defs#purposeBanner, community.lexicon.app.defs#purposeSocialCard, community.lexicon.app.defs#purposeAppStore, community.lexicon.app.defs#purposeAd

uri string uri Optional

Remote image URI.

View raw schema

{
  "type": "object",
  "required": [
    "alt"
  ],
  "properties": {
    "alt": {
      "type": "string",
      "maxLength": 1000,
      "description": "Alt text description of the image, for accessibility.",
      "maxGraphemes": 300
    },
    "uri": {
      "type": "string",
      "format": "uri",
      "description": "Remote image URI."
    },
    "image": {
      "type": "blob",
      "accept": [
        "image/*"
      ],
      "maxSize": 2000000,
      "description": "The raw image file."
    },
    "purpose": {
      "type": "string",
      "description": "How directories and stores should use the image. Omit this field when no known purpose fits.",
      "knownValues": [
        "community.lexicon.app.defs#purposeIcon",
        "community.lexicon.app.defs#purposeLogo",
        "community.lexicon.app.defs#purposeHero",
        "community.lexicon.app.defs#purposeScreenshot",
        "community.lexicon.app.defs#purposeBanner",
        "community.lexicon.app.defs#purposeSocialCard",
        "community.lexicon.app.defs#purposeAppStore",
        "community.lexicon.app.defs#purposeAd"
      ]
    },
    "aspectRatio": {
      "ref": "#aspectRatio",
      "type": "ref"
    }
  },
  "description": "An image associated with an app, including accessibility and display metadata. Exactly one of `image` (ATProto blob) or `uri` (remote URL) MUST be present. Consumers SHOULD ignore image items that have neither or both."
}

lexiconInterop object

Self-declared AT Protocol lexicon interoperability signals.

Properties

consumes array of stringnsid Optional

Lexicon collections this app reads, displays, imports, or otherwise consumes.

produces array of stringnsid Optional

Lexicon collections this app creates or publishes records for.

View raw schema

{
  "type": "object",
  "properties": {
    "consumes": {
      "type": "array",
      "items": {
        "type": "string",
        "format": "nsid"
      },
      "description": "Lexicon collections this app reads, displays, imports, or otherwise consumes."
    },
    "produces": {
      "type": "array",
      "items": {
        "type": "string",
        "format": "nsid"
      },
      "description": "Lexicon collections this app creates or publishes records for."
    }
  },
  "description": "Self-declared AT Protocol lexicon interoperability signals."
}

link object

A labeled URI associated with an app.

Properties

label string Optional

Human-readable label for the URI.

maxLength: 100 bytesmaxGraphemes: 50 graphemes

role ref #linkRole Optional

Known role of this link, if any.

uri string uri Required

Destination URI.

View raw schema

{
  "type": "object",
  "required": [
    "uri"
  ],
  "properties": {
    "uri": {
      "type": "string",
      "format": "uri",
      "description": "Destination URI."
    },
    "role": {
      "ref": "#linkRole",
      "type": "ref",
      "description": "Known role of this link, if any."
    },
    "label": {
      "type": "string",
      "maxLength": 100,
      "description": "Human-readable label for the URI.",
      "maxGraphemes": 50
    }
  },
  "description": "A labeled URI associated with an app."
}

linkRole string

Known role of a link associated with an app.

Known Values (other values may be valid)

community.lexicon.app.defs#linkRoleWebsite(token) community.lexicon.app.defs#linkRoleWebManifest(token) community.lexicon.app.defs#linkRolePrivacyPolicy(token) community.lexicon.app.defs#linkRoleTermsOfService(token) community.lexicon.app.defs#linkRoleSupport(token) community.lexicon.app.defs#linkRoleSourceCode(token) community.lexicon.app.defs#linkRoleDocs(token) community.lexicon.app.defs#linkRoleChangelog(token) community.lexicon.app.defs#linkRoleStatus(token) community.lexicon.app.defs#linkRoleAppStore(token) community.lexicon.app.defs#linkRolePlayStore(token) community.lexicon.app.defs#linkRoleFDroid(token)

View raw schema

{
  "type": "string",
  "description": "Known role of a link associated with an app.",
  "knownValues": [
    "community.lexicon.app.defs#linkRoleWebsite",
    "community.lexicon.app.defs#linkRoleWebManifest",
    "community.lexicon.app.defs#linkRolePrivacyPolicy",
    "community.lexicon.app.defs#linkRoleTermsOfService",
    "community.lexicon.app.defs#linkRoleSupport",
    "community.lexicon.app.defs#linkRoleSourceCode",
    "community.lexicon.app.defs#linkRoleDocs",
    "community.lexicon.app.defs#linkRoleChangelog",
    "community.lexicon.app.defs#linkRoleStatus",
    "community.lexicon.app.defs#linkRoleAppStore",
    "community.lexicon.app.defs#linkRolePlayStore",
    "community.lexicon.app.defs#linkRoleFDroid"
  ]
}

linkRoleAppStore token

Apple App Store listing.

Referencecommunity.lexicon.app.defs#linkRoleAppStore

Tokens have no data representation. Use the reference string as a value.

View raw schema

{
  "type": "token",
  "description": "Apple App Store listing."
}

linkRoleChangelog token

Changelog or release notes.

Referencecommunity.lexicon.app.defs#linkRoleChangelog

Tokens have no data representation. Use the reference string as a value.

View raw schema

{
  "type": "token",
  "description": "Changelog or release notes."
}

linkRoleDocs token

Documentation.

Referencecommunity.lexicon.app.defs#linkRoleDocs

Tokens have no data representation. Use the reference string as a value.

View raw schema

{
  "type": "token",
  "description": "Documentation."
}

linkRoleFDroid token

F-Droid listing.

Referencecommunity.lexicon.app.defs#linkRoleFDroid

Tokens have no data representation. Use the reference string as a value.

View raw schema

{
  "type": "token",
  "description": "F-Droid listing."
}

linkRolePlayStore token

Google Play Store listing.

Referencecommunity.lexicon.app.defs#linkRolePlayStore

Tokens have no data representation. Use the reference string as a value.

View raw schema

{
  "type": "token",
  "description": "Google Play Store listing."
}

linkRolePrivacyPolicy token

Privacy policy.

Referencecommunity.lexicon.app.defs#linkRolePrivacyPolicy

Tokens have no data representation. Use the reference string as a value.

View raw schema

{
  "type": "token",
  "description": "Privacy policy."
}

linkRoleSourceCode token

Source code repository or source distribution.

Referencecommunity.lexicon.app.defs#linkRoleSourceCode

Tokens have no data representation. Use the reference string as a value.

View raw schema

{
  "type": "token",
  "description": "Source code repository or source distribution."
}

linkRoleStatus token

Service status page.

Referencecommunity.lexicon.app.defs#linkRoleStatus

Tokens have no data representation. Use the reference string as a value.

View raw schema

{
  "type": "token",
  "description": "Service status page."
}

linkRoleSupport token

Support, help, or contact page.

Referencecommunity.lexicon.app.defs#linkRoleSupport

Tokens have no data representation. Use the reference string as a value.

View raw schema

{
  "type": "token",
  "description": "Support, help, or contact page."
}

linkRoleTermsOfService token

Terms of service.

Referencecommunity.lexicon.app.defs#linkRoleTermsOfService

Tokens have no data representation. Use the reference string as a value.

View raw schema

{
  "type": "token",
  "description": "Terms of service."
}

linkRoleWebManifest token

Web App Manifest.

Referencecommunity.lexicon.app.defs#linkRoleWebManifest

Tokens have no data representation. Use the reference string as a value.

View raw schema

{
  "type": "token",
  "description": "Web App Manifest."
}

linkRoleWebsite token

Primary website or landing page.

Referencecommunity.lexicon.app.defs#linkRoleWebsite

Tokens have no data representation. Use the reference string as a value.

View raw schema

{
  "type": "token",
  "description": "Primary website or landing page."
}

platform string

Platform where an app is available.

Known Values (other values may be valid)

community.lexicon.app.defs#platformWeb(token) community.lexicon.app.defs#platformIOS(token) community.lexicon.app.defs#platformAndroid(token) community.lexicon.app.defs#platformMacOS(token) community.lexicon.app.defs#platformWindows(token) community.lexicon.app.defs#platformLinux(token) community.lexicon.app.defs#platformCLI(token)

View raw schema

{
  "type": "string",
  "description": "Platform where an app is available.",
  "knownValues": [
    "community.lexicon.app.defs#platformWeb",
    "community.lexicon.app.defs#platformIOS",
    "community.lexicon.app.defs#platformAndroid",
    "community.lexicon.app.defs#platformMacOS",
    "community.lexicon.app.defs#platformWindows",
    "community.lexicon.app.defs#platformLinux",
    "community.lexicon.app.defs#platformCLI"
  ]
}

platformAndroid token

Android app.

Referencecommunity.lexicon.app.defs#platformAndroid

Tokens have no data representation. Use the reference string as a value.

View raw schema

{
  "type": "token",
  "description": "Android app."
}

platformCLI token

Command line interface.

Referencecommunity.lexicon.app.defs#platformCLI

Tokens have no data representation. Use the reference string as a value.

View raw schema

{
  "type": "token",
  "description": "Command line interface."
}

platformIOS token

iOS app.

Referencecommunity.lexicon.app.defs#platformIOS

Tokens have no data representation. Use the reference string as a value.

View raw schema

{
  "type": "token",
  "description": "iOS app."
}

platformLinux token

Linux app.

Referencecommunity.lexicon.app.defs#platformLinux

Tokens have no data representation. Use the reference string as a value.

View raw schema

{
  "type": "token",
  "description": "Linux app."
}

platformMacOS token

macOS app.

Referencecommunity.lexicon.app.defs#platformMacOS

Tokens have no data representation. Use the reference string as a value.

View raw schema

{
  "type": "token",
  "description": "macOS app."
}

platformWeb token

Web app or website.

Referencecommunity.lexicon.app.defs#platformWeb

Tokens have no data representation. Use the reference string as a value.

View raw schema

{
  "type": "token",
  "description": "Web app or website."
}

platformWindows token

Windows app.

Referencecommunity.lexicon.app.defs#platformWindows

Tokens have no data representation. Use the reference string as a value.

View raw schema

{
  "type": "token",
  "description": "Windows app."
}

preview token

The app is available as an alpha, beta, early access, or preview release.

Referencecommunity.lexicon.app.defs#preview

Tokens have no data representation. Use the reference string as a value.

View raw schema

{
  "type": "token",
  "description": "The app is available as an alpha, beta, early access, or preview release."
}

purposeAd token

A promotional or advertising image.

Referencecommunity.lexicon.app.defs#purposeAd

Tokens have no data representation. Use the reference string as a value.

View raw schema

{
  "type": "token",
  "description": "A promotional or advertising image."
}

purposeAppStore token

A promotional image formatted for a native app store listing.

Referencecommunity.lexicon.app.defs#purposeAppStore

Tokens have no data representation. Use the reference string as a value.

View raw schema

{
  "type": "token",
  "description": "A promotional image formatted for a native app store listing."
}

purposeBanner token

A wide banner image, such as a header image for a profile or listing page.

Referencecommunity.lexicon.app.defs#purposeBanner

Tokens have no data representation. Use the reference string as a value.

View raw schema

{
  "type": "token",
  "description": "A wide banner image, such as a header image for a profile or listing page."
}

purposeHero token

A large promotional or feature image, typically used at the top of a directory listing.

Referencecommunity.lexicon.app.defs#purposeHero

Tokens have no data representation. Use the reference string as a value.

View raw schema

{
  "type": "token",
  "description": "A large promotional or feature image, typically used at the top of a directory listing."
}

purposeIcon token

A small square icon representing the app, typically used in launchers, lists, and tab bars.

Referencecommunity.lexicon.app.defs#purposeIcon

Tokens have no data representation. Use the reference string as a value.

View raw schema

{
  "type": "token",
  "description": "A small square icon representing the app, typically used in launchers, lists, and tab bars."
}

purposeLogo token

A logotype or wordmark for the app.

Referencecommunity.lexicon.app.defs#purposeLogo

Tokens have no data representation. Use the reference string as a value.

View raw schema

{
  "type": "token",
  "description": "A logotype or wordmark for the app."
}

purposeScreenshot token

A screenshot of the app's UI, used in directory and store listings.

Referencecommunity.lexicon.app.defs#purposeScreenshot

Tokens have no data representation. Use the reference string as a value.

View raw schema

{
  "type": "token",
  "description": "A screenshot of the app's UI, used in directory and store listings."
}

purposeSocialCard token

An image sized and formatted for social media sharing previews (Open Graph, Twitter Card, etc.).

Referencecommunity.lexicon.app.defs#purposeSocialCard

Tokens have no data representation. Use the reference string as a value.

View raw schema

{
  "type": "token",
  "description": "An image sized and formatted for social media sharing previews (Open Graph, Twitter Card, etc.)."
}

released token

The app is generally available.

Referencecommunity.lexicon.app.defs#released

Tokens have no data representation. Use the reference string as a value.

View raw schema

{
  "type": "token",
  "description": "The app is generally available."
}

status string

Current release or maintenance status of an app.

Known Values (other values may be valid)

community.lexicon.app.defs#unreleased(token) community.lexicon.app.defs#preview(token) community.lexicon.app.defs#released(token) community.lexicon.app.defs#unmaintained(token) community.lexicon.app.defs#discontinued(token)

View raw schema

{
  "type": "string",
  "description": "Current release or maintenance status of an app.",
  "knownValues": [
    "community.lexicon.app.defs#unreleased",
    "community.lexicon.app.defs#preview",
    "community.lexicon.app.defs#released",
    "community.lexicon.app.defs#unmaintained",
    "community.lexicon.app.defs#discontinued"
  ]
}

unmaintained token

The app may still be available, but is no longer actively maintained.

Referencecommunity.lexicon.app.defs#unmaintained

Tokens have no data representation. Use the reference string as a value.

View raw schema

{
  "type": "token",
  "description": "The app may still be available, but is no longer actively maintained."
}

unreleased token

The app has been announced but is not yet available.

Referencecommunity.lexicon.app.defs#unreleased

Tokens have no data representation. Use the reference string as a value.

View raw schema

{
  "type": "token",
  "description": "The app has been announced but is not yet available."
}