minca
ApiSchemasVariables

Variable: contact

const contact: object & Typed<{
  blocked?: boolean;
  did: string;
  name: string;
  note?: string;
  space?: string;
  username?: string;
}>;

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

Someone you can reach, and the space you share with them. One per person.

Type Declaration

description

readonly description: "Someone you can reach, and the space you share with them." = 'Someone you can reach, and the space you share with them.';

name

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

rules

readonly rules: object;

rules.onePer

readonly onePer: readonly ["did"];

schema

readonly schema: object;

schema.properties

readonly properties: object;

schema.properties.blocked

readonly blocked: object;

schema.properties.blocked.description

readonly description: "Their knocks are hidden, in every space and in your inbox" = 'Their knocks are hidden, in every space and in your inbox';

schema.properties.blocked.type

readonly type: "boolean" = 'boolean';

schema.properties.did

readonly did: object;

schema.properties.did.description

readonly description: "Their account" = 'Their account';

schema.properties.did.maxLength

readonly maxLength: 256 = 256;

schema.properties.did.type

readonly type: "string" = 'string';

schema.properties.name

readonly name: object;

schema.properties.name.description

readonly description: "What you call them" = 'What you call them';

schema.properties.name.maxLength

readonly maxLength: 200 = 200;

schema.properties.name.type

readonly type: "string" = 'string';

schema.properties.note

readonly note: object;

schema.properties.note.maxLength

readonly maxLength: 2000 = 2000;

schema.properties.note.type

readonly type: "string" = 'string';

schema.properties.space

readonly space: object;

schema.properties.space.description

readonly description: "The id of your space for two" = 'The id of your space for two';

schema.properties.space.maxLength

readonly maxLength: 256 = 256;

schema.properties.space.type

readonly type: "string" = 'string';

schema.properties.username

readonly username: object;

schema.properties.username.description

readonly description: "Their username, when you found them by it: name@domain" = 'Their username, when you found them by it: name@domain';

schema.properties.username.maxLength

readonly maxLength: 320 = 320;

schema.properties.username.type

readonly type: "string" = 'string';

schema.required

readonly required: readonly ["did", "name"];

schema.type

readonly type: "object" = 'object';

title

readonly title: "Contact" = 'Contact';

On this page