Who wrote a record on another service. The community writes every bridged record, and the AppView honours this attribution only on records the community itself wrote.
Properties
The author's avatar, uploaded to the community's repo.
maxSize: 1.0 MB
Set on messages a bridge imported from the room's earlier history. The AppView sends no notifications for them, and marks their live events as imported.
The author's display name on the other service when the record was written.
maxLength: 128 bytes
The service the author is on, as its bridge names it.
maxLength: 64 bytes
Record key of the registration the record was written for.
The author's id on the other service. Opaque to Colibri.
maxLength: 256 bytes
The id of the message on the other service, which lets a bridge find its own records again.
maxLength: 256 bytes
View raw schema
{
"description": "Who wrote a record on another service. The community writes every bridged record, and the AppView honours this attribution only on records the community itself wrote.",
"properties": {
"avatar": {
"accept": [
"image/png",
"image/jpeg",
"image/gif",
"image/webp"
],
"description": "The author's avatar, uploaded to the community's repo.",
"maxSize": 1000000,
"type": "blob"
},
"imported": {
"description": "Set on messages a bridge imported from the room's earlier history. The AppView sends no notifications for them, and marks their live events as imported.",
"type": "boolean"
},
"name": {
"description": "The author's display name on the other service when the record was written.",
"maxLength": 128,
"type": "string"
},
"platform": {
"description": "The service the author is on, as its bridge names it.",
"maxLength": 64,
"type": "string"
},
"registration": {
"description": "Record key of the registration the record was written for.",
"format": "tid",
"type": "string"
},
"remoteId": {
"description": "The author's id on the other service. Opaque to Colibri.",
"maxLength": 256,
"type": "string"
},
"remoteMessage": {
"description": "The id of the message on the other service, which lets a bridge find its own records again.",
"maxLength": 256,
"type": "string"
}
},
"required": [
"registration",
"platform",
"remoteId",
"name"
],
"type": "object"
}
A request to import a linked room's earlier messages.
Properties
When an admin asked for the import. Messages after this were relayed live.
The oldest message to import. Absent imports the room's whole history.
View raw schema
{
"description": "A request to import a linked room's earlier messages.",
"properties": {
"requestedAt": {
"description": "When an admin asked for the import. Messages after this were relayed live.",
"format": "datetime",
"type": "string"
},
"since": {
"description": "The oldest message to import. Absent imports the room's whole history.",
"format": "datetime",
"type": "string"
}
},
"required": [
"requestedAt"
],
"type": "object"
}
Progress of a history import, as the bridge last reported it.
Properties
The linked channel being filled.
The start of the time range being imported.
How many messages the bridge has imported so far.
minimum: 0
When the newest imported message in the channel was sent.
The request this status belongs to.
How far the import is.
Known values: running, done, failed
The end of the time range being imported.
When the bridge last reported.
View raw schema
{
"description": "Progress of a history import, as the bridge last reported it.",
"properties": {
"channel": {
"description": "The linked channel being filled.",
"format": "space-ref",
"type": "string"
},
"from": {
"description": "The start of the time range being imported.",
"format": "datetime",
"type": "string"
},
"imported": {
"description": "How many messages the bridge has imported so far.",
"minimum": 0,
"type": "integer"
},
"reached": {
"description": "When the newest imported message in the channel was sent.",
"format": "datetime",
"type": "string"
},
"requestedAt": {
"description": "The request this status belongs to.",
"format": "datetime",
"type": "string"
},
"state": {
"description": "How far the import is.",
"knownValues": [
"running",
"done",
"failed"
],
"type": "string"
},
"until": {
"description": "The end of the time range being imported.",
"format": "datetime",
"type": "string"
},
"updatedAt": {
"description": "When the bridge last reported.",
"format": "datetime",
"type": "string"
}
},
"required": [
"channel",
"requestedAt",
"state",
"imported",
"from",
"until",
"updatedAt"
],
"type": "object"
}
Marks a profile view as someone on another service whose messages a bridge relays.
Properties
The service the person is on.
maxLength: 64 bytes
Record key of the registration the record was written for.
Their id on that service.
maxLength: 256 bytes
View raw schema
{
"description": "Marks a profile view as someone on another service whose messages a bridge relays.",
"properties": {
"platform": {
"description": "The service the person is on.",
"maxLength": 64,
"type": "string"
},
"registration": {
"description": "Record key of the registration the record was written for.",
"format": "tid",
"type": "string"
},
"remoteId": {
"description": "Their id on that service.",
"maxLength": 256,
"type": "string"
}
},
"required": [
"registration",
"platform",
"remoteId"
],
"type": "object"
}
Someone on another service who reacted to a message through a bridge.
Properties
Their display name on that service when they reacted.
maxLength: 128 bytes
The service the person is on.
maxLength: 64 bytes
Record key of the registration the reaction was written for.
Their id on that service.
maxLength: 256 bytes
View raw schema
{
"description": "Someone on another service who reacted to a message through a bridge.",
"properties": {
"name": {
"description": "Their display name on that service when they reacted.",
"maxLength": 128,
"type": "string"
},
"platform": {
"description": "The service the person is on.",
"maxLength": 64,
"type": "string"
},
"registration": {
"description": "Record key of the registration the reaction was written for.",
"format": "tid",
"type": "string"
},
"remoteId": {
"description": "Their id on that service.",
"maxLength": 256,
"type": "string"
}
},
"required": [
"registration",
"platform",
"remoteId",
"name"
],
"type": "object"
}
A Colibri channel kept in sync with a room on another service.
Properties
The latest history import an admin asked for.
The room's name on the other service when the link was made.
maxLength: 128 bytes
The id of the room on the other service.
maxLength: 256 bytes
View raw schema
{
"description": "A Colibri channel kept in sync with a room on another service.",
"properties": {
"backfill": {
"description": "The latest history import an admin asked for.",
"ref": "#backfill",
"type": "ref"
},
"channel": {
"description": "The Colibri channel.",
"format": "space-ref",
"type": "string"
},
"remoteName": {
"description": "The room's name on the other service when the link was made.",
"maxLength": 128,
"type": "string"
},
"remoteRoom": {
"description": "The id of the room on the other service.",
"maxLength": 256,
"type": "string"
}
},
"required": [
"channel",
"remoteRoom",
"remoteName"
],
"type": "object"
}
A pending pairing, shown to an admin before they confirm it.
Properties
The bridge that asked to pair.
The bridge's handle, when it resolves.
When the code stops working.
The service the bridge connects to.
maxLength: 64 bytes
The id of the server, workspace or network on the other service.
maxLength: 256 bytes
Its name on the other service.
maxLength: 128 bytes
View raw schema
{
"description": "A pending pairing, shown to an admin before they confirm it.",
"properties": {
"bridge": {
"description": "The bridge that asked to pair.",
"format": "did",
"type": "string"
},
"bridgeHandle": {
"description": "The bridge's handle, when it resolves.",
"format": "handle",
"type": "string"
},
"expiresAt": {
"description": "When the code stops working.",
"format": "datetime",
"type": "string"
},
"platform": {
"description": "The service the bridge connects to.",
"maxLength": 64,
"type": "string"
},
"remoteSpace": {
"description": "The id of the server, workspace or network on the other service.",
"maxLength": 256,
"type": "string"
},
"remoteSpaceName": {
"description": "Its name on the other service.",
"maxLength": 128,
"type": "string"
}
},
"required": [
"bridge",
"platform",
"remoteSpace",
"remoteSpaceName",
"expiresAt"
],
"type": "object"
}
A bridge registered with a community.
Properties
Progress of each linked channel's latest history import.
The bridge's handle, when it resolves.
When the bridge was paired.
The admin who paired the bridge.
Whether the bridge may currently write.
Record key of the registration.
Whether moderation crosses the bridge. When on, hiding a bridged message removes its original on the other service, and a moderator removing a relayed message there hides it here.
The service the bridge connects to.
maxLength: 64 bytes
The id of the server, workspace or network on the other service.
maxLength: 256 bytes
Its name on the other service.
maxLength: 128 bytes
When the registration last changed.
View raw schema
{
"description": "A bridge registered with a community.",
"properties": {
"backfills": {
"description": "Progress of each linked channel's latest history import.",
"items": {
"description": "A history import.",
"ref": "#backfillStatus",
"type": "ref"
},
"type": "array"
},
"bridge": {
"description": "The bridge's DID.",
"format": "did",
"type": "string"
},
"bridgeHandle": {
"description": "The bridge's handle, when it resolves.",
"format": "handle",
"type": "string"
},
"community": {
"description": "The community the registration belongs to.",
"format": "did",
"type": "string"
},
"createdAt": {
"description": "When the bridge was paired.",
"format": "datetime",
"type": "string"
},
"createdBy": {
"description": "The admin who paired the bridge.",
"format": "did",
"type": "string"
},
"enabled": {
"description": "Whether the bridge may currently write.",
"type": "boolean"
},
"id": {
"description": "Record key of the registration.",
"format": "tid",
"type": "string"
},
"links": {
"description": "Channels kept in sync.",
"items": {
"description": "A linked channel.",
"ref": "#link",
"type": "ref"
},
"type": "array"
},
"mirrorModeration": {
"description": "Whether moderation crosses the bridge. When on, hiding a bridged message removes its original on the other service, and a moderator removing a relayed message there hides it here.",
"type": "boolean"
},
"platform": {
"description": "The service the bridge connects to.",
"maxLength": 64,
"type": "string"
},
"remoteSpace": {
"description": "The id of the server, workspace or network on the other service.",
"maxLength": 256,
"type": "string"
},
"remoteSpaceName": {
"description": "Its name on the other service.",
"maxLength": 128,
"type": "string"
},
"updatedAt": {
"description": "When the registration last changed.",
"format": "datetime",
"type": "string"
}
},
"required": [
"id",
"community",
"bridge",
"platform",
"remoteSpace",
"remoteSpaceName",
"links",
"enabled",
"createdBy",
"createdAt"
],
"type": "object"
}
The person on the other service a bridge is writing for.
Properties
An avatar uploaded earlier with uploadBlob.
maxSize: 1.0 MB
The author's id on the other service.
maxLength: 256 bytes
The author's display name on the other service.
maxLength: 128 bytes
View raw schema
{
"description": "The person on the other service a bridge is writing for.",
"properties": {
"avatar": {
"accept": [
"image/png",
"image/jpeg",
"image/gif",
"image/webp"
],
"description": "An avatar uploaded earlier with uploadBlob.",
"maxSize": 1000000,
"type": "blob"
},
"id": {
"description": "The author's id on the other service.",
"maxLength": 256,
"type": "string"
},
"name": {
"description": "The author's display name on the other service.",
"maxLength": 128,
"type": "string"
}
},
"required": [
"id",
"name"
],
"type": "object"
}
A room a bridge can see on the other service, offered to admins when linking channels.
Properties
The room's id on the other service.
maxLength: 256 bytes
What sort of room it is.
Known values: text, voice, announcement, forum, other
The room's name.
maxLength: 128 bytes
Name of the group or category the room sits in, if any.
maxLength: 128 bytes
View raw schema
{
"description": "A room a bridge can see on the other service, offered to admins when linking channels.",
"properties": {
"id": {
"description": "The room's id on the other service.",
"maxLength": 256,
"type": "string"
},
"kind": {
"description": "What sort of room it is.",
"knownValues": [
"text",
"voice",
"announcement",
"forum",
"other"
],
"type": "string"
},
"name": {
"description": "The room's name.",
"maxLength": 128,
"type": "string"
},
"parent": {
"description": "Name of the group or category the room sits in, if any.",
"maxLength": 128,
"type": "string"
}
},
"required": [
"id",
"name"
],
"type": "object"
}