minca
ApiSchemasVariables

Variable: message

const message: object & Typed<{
  mentions?: readonly string[];
  replyingTo?: string;
  text: string;
}>;

Defined in: packages/core/src/schemas/library/publishing.ts:33

A chat message. The space is the room, or it links the channel it is in; order is by when it was written. It can share one record — a poll to vote on, a task — which a chat that knows the record's kind shows in place. The text should still make sense alone ("Poll: Where to?"), for chats that don't.

mentions names who it calls on ("@Sam"), and replyingTo whose message it answers. With its channel they are its topics, so "mentions me", "replies to me" and "in #design" can be asked of a keeper that can't read it.

Type Declaration

description

readonly description: "A chat message, in order with the rest, optionally in a std.channel, replying to another or sharing a record. Posts to a feed are std.post; remarks on a record are std.comment." = 'A chat message, in order with the rest, optionally in a std.channel, replying to another or sharing a record. Posts to a feed are std.post; remarks on a record are std.comment.';
readonly links: object;

links.in

readonly in: LinkDeclaration;

links.replyTo

readonly replyTo: object;

links.replyTo.cardinality

readonly cardinality: "one" = 'one';

links.replyTo.description

readonly description: "The message this replies to" = 'The message this replies to';

links.replyTo.to

readonly to: readonly ["std.message"];

links.shares

readonly shares: object;

links.shares.cardinality

readonly cardinality: "one" = 'one';

links.shares.description

readonly description: "A record this message shares, like a poll" = 'A record this message shares, like a poll';

links.shares.to

readonly to: "*" = '*';

name

readonly name: "std.message" = 'std.message';

schema

readonly schema: object;

schema.properties

readonly properties: object;

schema.properties.mentions

readonly mentions: object;

schema.properties.mentions.items

items: object & object;
Type Declaration
maxLength
maxLength: number = max;
minLength?
minLength?: number = min;
type
type: "string";
x-kind
readonly "x-kind": "did";

schema.properties.mentions.maxItems

maxItems: number = max;

schema.properties.mentions.type

type: "array";

schema.properties.replyingTo

readonly replyingTo: object & object;
Type Declaration
maxLength
maxLength: number = max;
minLength?
minLength?: number = min;
type
type: "string";
x-kind
readonly "x-kind": "did";

schema.properties.text

readonly text: object;

schema.properties.text.maxLength

readonly maxLength: 10000 = 10000;

schema.properties.text.minLength

readonly minLength: 1 = 1;

schema.properties.text.type

readonly type: "string" = 'string';

schema.required

readonly required: readonly ["text"];

schema.type

readonly type: "object" = 'object';

title

readonly title: "Message" = 'Message';

topics

readonly topics: readonly ["link:in", "mentions", "replyingTo"];

On this page