minca
ApiSchemasVariables

Variable: contactRequest

const contactRequest: object & Typed<{
  sealed: string;
  to: string;
}>;

Defined in: packages/core/src/schemas/contacts.ts:42

A knock left in a space both belong to: sealed to their contact key, so only they open it.

Type Declaration

description

readonly description: "A knock left for someone in a space you share, sealed so only they can open it." = 'A knock left for someone in a space you share, sealed so only they can open it.';

name

readonly name: "std.contact-request" = 'std.contact-request';

schema

readonly schema: object;

schema.properties

readonly properties: object;

schema.properties.sealed

readonly sealed: object;

schema.properties.sealed.description

readonly description: "The knock, sealed to it (spec 07 §6)" = 'The knock, sealed to it (spec 07 §6)';

schema.properties.sealed.maxLength

readonly maxLength: 16000 = 16000;

schema.properties.sealed.type

readonly type: "string" = 'string';

schema.properties.to

readonly to: object;

schema.properties.to.description

readonly description: "Their contact key, as on their profile here" = 'Their contact key, as on their profile here';

schema.properties.to.maxLength

readonly maxLength: 64 = 64;

schema.properties.to.type

readonly type: "string" = 'string';

schema.required

readonly required: readonly ["to", "sealed"];

schema.type

readonly type: "object" = 'object';

title

readonly title: "Contact request" = 'Contact request';

On this page