ApiSchemasVariables
Variable: direct
const direct: object & Typed<{
boxes: readonly object[];
data: string;
to: readonly string[];
}>;Defined in: packages/core/src/schemas/library/publishing.ts:105
A direct message between some members of a space: its text is sealed so
only the people in to and whoever wrote it can read it, with each one's
member key (docs/direct-messages.md). Other members see who wrote to whom and
when, not what. to is a topic, so "sent to me" can be asked of a keeper
that can't read it. Write and read it through node.direct.
Type Declaration
description
readonly description: "A message only the people it is sent to can read." = 'A message only the people it is sent to can read.';name
readonly name: "std.direct" = 'std.direct';schema
readonly schema: object;schema.properties
readonly properties: object;schema.properties.boxes
readonly boxes: object;schema.properties.boxes.description
readonly description: "The message key, sealed to each reader: everyone in `to`, and whoever wrote it" = 'The message key, sealed to each reader: everyone in `to`, and whoever wrote it';schema.properties.boxes.items
readonly items: object;schema.properties.boxes.items.properties
readonly properties: object;schema.properties.boxes.items.properties.sealed
readonly sealed: object;schema.properties.boxes.items.properties.sealed.maxLength
maxLength: number = max;schema.properties.boxes.items.properties.sealed.minLength?
minLength?: number = min;schema.properties.boxes.items.properties.sealed.type
type: "string";schema.properties.boxes.items.properties.to
readonly to: object & object;Type Declaration
maxLength
maxLength: number = max;minLength?
minLength?: number = min;type
type: "string";x-kind
readonly "x-kind": "did";schema.properties.boxes.items.required
readonly required: readonly ["to", "sealed"];schema.properties.boxes.items.type
readonly type: "object" = 'object';schema.properties.boxes.maxItems
readonly maxItems: 17 = 17;schema.properties.boxes.type
readonly type: "array" = 'array';schema.properties.data
readonly data: object;schema.properties.data.maxLength
maxLength: number = max;schema.properties.data.minLength?
minLength?: number = min;schema.properties.data.type
type: "string";schema.properties.to
readonly to: object;schema.properties.to.description
readonly description: "Who it is for, not whoever wrote it" = 'Who it is for, not whoever wrote it';schema.properties.to.items
readonly items: object & object;Type Declaration
maxLength
maxLength: number = max;minLength?
minLength?: number = min;type
type: "string";x-kind
readonly "x-kind": "did";schema.properties.to.maxItems
readonly maxItems: 16 = 16;schema.properties.to.minItems
readonly minItems: 1 = 1;schema.properties.to.type
readonly type: "array" = 'array';schema.required
readonly required: readonly ["to", "data", "boxes"];schema.type
readonly type: "object" = 'object';title
readonly title: "Direct message" = 'Direct message';topics
readonly topics: readonly ["to"];