chat.sprk.convo.defs

sprk.so

Documentation

convoView object

No description available.

Properties

id string Required

No description available.

muted boolean Required

No description available.

rev string Required

No description available.

status string Optional

No description available.

Known values: request, accepted
unreadCount integer Required

No description available.

View raw schema 
{
  "type": "object",
  "required": [
    "id",
    "rev",
    "members",
    "muted",
    "unreadCount"
  ],
  "properties": {
    "id": {
      "type": "string"
    },
    "rev": {
      "type": "string"
    },
    "muted": {
      "type": "boolean"
    },
    "status": {
      "type": "string",
      "knownValues": [
        "request",
        "accepted"
      ]
    },
    "members": {
      "type": "array",
      "items": {
        "ref": "chat.sprk.actor.defs#profileViewBasic",
        "type": "ref"
      }
    },
    "lastMessage": {
      "refs": [
        "#messageView",
        "#deletedMessageView"
      ],
      "type": "union"
    },
    "unreadCount": {
      "type": "integer"
    },
    "lastReaction": {
      "refs": [
        "#messageAndReactionView"
      ],
      "type": "union"
    }
  }
}
deletedMessageView object

No description available.

Properties

id string Required

No description available.

rev string Required

No description available.

sentAt string datetime Required

An RFC 3339 formatted timestamp.

View raw schema 
{
  "type": "object",
  "required": [
    "id",
    "rev",
    "sender",
    "sentAt"
  ],
  "properties": {
    "id": {
      "type": "string"
    },
    "rev": {
      "type": "string"
    },
    "sender": {
      "ref": "#messageViewSender",
      "type": "ref"
    },
    "sentAt": {
      "type": "string",
      "format": "datetime"
    }
  }
}
logAcceptConvo object

No description available.

Properties

convoId string Required

No description available.

rev string Required

No description available.

View raw schema 
{
  "type": "object",
  "required": [
    "rev",
    "convoId"
  ],
  "properties": {
    "rev": {
      "type": "string"
    },
    "convoId": {
      "type": "string"
    }
  }
}
logAddReaction object

No description available.

Properties

convoId string Required

No description available.

rev string Required

No description available.

View raw schema 
{
  "type": "object",
  "required": [
    "rev",
    "convoId",
    "message",
    "reaction"
  ],
  "properties": {
    "rev": {
      "type": "string"
    },
    "convoId": {
      "type": "string"
    },
    "message": {
      "refs": [
        "#messageView",
        "#deletedMessageView"
      ],
      "type": "union"
    },
    "reaction": {
      "ref": "#reactionView",
      "type": "ref"
    }
  }
}
logBeginConvo object

No description available.

Properties

convoId string Required

No description available.

rev string Required

No description available.

View raw schema 
{
  "type": "object",
  "required": [
    "rev",
    "convoId"
  ],
  "properties": {
    "rev": {
      "type": "string"
    },
    "convoId": {
      "type": "string"
    }
  }
}
logCreateMessage object

No description available.

Properties

convoId string Required

No description available.

rev string Required

No description available.

View raw schema 
{
  "type": "object",
  "required": [
    "rev",
    "convoId",
    "message"
  ],
  "properties": {
    "rev": {
      "type": "string"
    },
    "convoId": {
      "type": "string"
    },
    "message": {
      "refs": [
        "#messageView",
        "#deletedMessageView"
      ],
      "type": "union"
    }
  }
}
logDeleteMessage object

No description available.

Properties

convoId string Required

No description available.

rev string Required

No description available.

View raw schema 
{
  "type": "object",
  "required": [
    "rev",
    "convoId",
    "message"
  ],
  "properties": {
    "rev": {
      "type": "string"
    },
    "convoId": {
      "type": "string"
    },
    "message": {
      "refs": [
        "#messageView",
        "#deletedMessageView"
      ],
      "type": "union"
    }
  }
}
logLeaveConvo object

No description available.

Properties

convoId string Required

No description available.

rev string Required

No description available.

View raw schema 
{
  "type": "object",
  "required": [
    "rev",
    "convoId"
  ],
  "properties": {
    "rev": {
      "type": "string"
    },
    "convoId": {
      "type": "string"
    }
  }
}
logMuteConvo object

No description available.

Properties

convoId string Required

No description available.

rev string Required

No description available.

View raw schema 
{
  "type": "object",
  "required": [
    "rev",
    "convoId"
  ],
  "properties": {
    "rev": {
      "type": "string"
    },
    "convoId": {
      "type": "string"
    }
  }
}
logReadMessage object

No description available.

Properties

convoId string Required

No description available.

rev string Required

No description available.

View raw schema 
{
  "type": "object",
  "required": [
    "rev",
    "convoId",
    "message"
  ],
  "properties": {
    "rev": {
      "type": "string"
    },
    "convoId": {
      "type": "string"
    },
    "message": {
      "refs": [
        "#messageView",
        "#deletedMessageView"
      ],
      "type": "union"
    }
  }
}
logRemoveReaction object

No description available.

Properties

convoId string Required

No description available.

rev string Required

No description available.

View raw schema 
{
  "type": "object",
  "required": [
    "rev",
    "convoId",
    "message",
    "reaction"
  ],
  "properties": {
    "rev": {
      "type": "string"
    },
    "convoId": {
      "type": "string"
    },
    "message": {
      "refs": [
        "#messageView",
        "#deletedMessageView"
      ],
      "type": "union"
    },
    "reaction": {
      "ref": "#reactionView",
      "type": "ref"
    }
  }
}
logUnmuteConvo object

No description available.

Properties

convoId string Required

No description available.

rev string Required

No description available.

View raw schema 
{
  "type": "object",
  "required": [
    "rev",
    "convoId"
  ],
  "properties": {
    "rev": {
      "type": "string"
    },
    "convoId": {
      "type": "string"
    }
  }
}
messageAndReactionView object

No description available.

Properties

message ref #messageView Required

No description available.

View raw schema 
{
  "type": "object",
  "required": [
    "message",
    "reaction"
  ],
  "properties": {
    "message": {
      "ref": "#messageView",
      "type": "ref"
    },
    "reaction": {
      "ref": "#reactionView",
      "type": "ref"
    }
  }
}
messageInput object

No description available.

Properties

embed string at-uri Optional

An AT Protocol URI (e.g., at://did:plc:xyz/app.bsky.feed.post/abc).

text string Required

No description available.

maxLength: 10000 bytesmaxGraphemes: 1000 graphemes
View raw schema 
{
  "type": "object",
  "required": [
    "text"
  ],
  "properties": {
    "text": {
      "type": "string",
      "maxLength": 10000,
      "maxGraphemes": 1000
    },
    "embed": {
      "type": "string",
      "format": "at-uri"
    }
  }
}
messageRef object

No description available.

Properties

convoId string Required

No description available.

did string did Required

A decentralized identifier (DID).

messageId string Required

No description available.

View raw schema 
{
  "type": "object",
  "required": [
    "did",
    "messageId",
    "convoId"
  ],
  "properties": {
    "did": {
      "type": "string",
      "format": "did"
    },
    "convoId": {
      "type": "string"
    },
    "messageId": {
      "type": "string"
    }
  }
}
messageView object

No description available.

Properties

embed string at-uri Optional

An AT Protocol URI (e.g., at://did:plc:xyz/app.bsky.feed.post/abc).

id string Required

No description available.

reactions array of ref#reactionView Optional

Reactions to this message, in ascending order of creation time.

rev string Required

No description available.

sentAt string datetime Required

An RFC 3339 formatted timestamp.

text string Required

No description available.

maxLength: 10000 bytesmaxGraphemes: 1000 graphemes
View raw schema 
{
  "type": "object",
  "required": [
    "id",
    "rev",
    "text",
    "sender",
    "sentAt"
  ],
  "properties": {
    "id": {
      "type": "string"
    },
    "rev": {
      "type": "string"
    },
    "text": {
      "type": "string",
      "maxLength": 10000,
      "maxGraphemes": 1000
    },
    "embed": {
      "type": "string",
      "format": "at-uri"
    },
    "sender": {
      "ref": "#messageViewSender",
      "type": "ref"
    },
    "sentAt": {
      "type": "string",
      "format": "datetime"
    },
    "reactions": {
      "type": "array",
      "items": {
        "ref": "#reactionView",
        "type": "ref"
      },
      "description": "Reactions to this message, in ascending order of creation time."
    }
  }
}
messageViewSender object

No description available.

Properties

did string did Required

A decentralized identifier (DID).

View raw schema 
{
  "type": "object",
  "required": [
    "did"
  ],
  "properties": {
    "did": {
      "type": "string",
      "format": "did"
    }
  }
}
reactionView object

No description available.

Properties

createdAt string datetime Required

An RFC 3339 formatted timestamp.

value string Required

No description available.

View raw schema 
{
  "type": "object",
  "required": [
    "value",
    "sender",
    "createdAt"
  ],
  "properties": {
    "value": {
      "type": "string"
    },
    "sender": {
      "ref": "#reactionViewSender",
      "type": "ref"
    },
    "createdAt": {
      "type": "string",
      "format": "datetime"
    }
  }
}
reactionViewSender object

No description available.

Properties

did string did Required

A decentralized identifier (DID).

View raw schema 
{
  "type": "object",
  "required": [
    "did"
  ],
  "properties": {
    "did": {
      "type": "string",
      "format": "did"
    }
  }
}

Lexicon Garden

@