ApiSchemasVariables
Variable: knock
const knock: object & Typed<{
invite: string;
name: string;
space: string;
username?: string;
}>;Defined in: packages/core/src/schemas/contacts.ts:95
A knock you left on someone's inbox, waiting for them to join the space for
two. You don't know who they are until they do; then it becomes a
std.contact, and this goes.
Type Declaration
description
readonly description: "A knock left on an inbox, waiting for them to join." = 'A knock left on an inbox, waiting for them to join.';name
readonly name: "std.knock" = 'std.knock';rules
readonly rules: object;rules.onePer
readonly onePer: readonly ["space"];schema
readonly schema: object;schema.properties
readonly properties: object;schema.properties.invite
readonly invite: object;schema.properties.invite.description
readonly description: "The invite sent, to close once they join" = 'The invite sent, to close once they join';schema.properties.invite.maxLength
readonly maxLength: 12000 = 12000;schema.properties.invite.type
readonly type: "string" = 'string';schema.properties.name
readonly name: object;schema.properties.name.description
readonly description: "The name their inbox code gave" = 'The name their inbox code gave';schema.properties.name.maxLength
readonly maxLength: 64 = 64;schema.properties.name.type
readonly type: "string" = 'string';schema.properties.space
readonly space: object;schema.properties.space.description
readonly description: "The space for two it invites them to" = 'The space for two it invites them to';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: "The username you knocked on, when it was one" = 'The username you knocked on, when it was one';schema.properties.username.maxLength
readonly maxLength: 320 = 320;schema.properties.username.type
readonly type: "string" = 'string';schema.required
readonly required: readonly ["space", "name", "invite"];schema.type
readonly type: "object" = 'object';title
readonly title: "Knock" = 'Knock';