minca
ApiSchemasVariables

Variable: card

const card: object & Typed<{
  addresses?: readonly object[];
  birthday?: string;
  emails?: readonly object[];
  jobTitle?: string;
  name?: {
     family?: string;
     full?: string;
     given?: string;
  };
  note?: string;
  organization?: string;
  phones?: readonly object[];
  photo?: {
     hash: string;
     key?: string;
     mime: string;
     name?: string;
     salt?: string;
     size: number;
  };
  urls?: readonly string[];
}>;

Defined in: packages/core/src/schemas/library/social.ts:89

A person who may not be on Minca: a subset of JSContact (RFC 9553). For people who are, std.contact keeps their DID.

Type Declaration

description

readonly description: "An address-book entry for anyone, on Minca or not. Your own public self is std.profile; a Minca account you can message is std.contact." = 'An address-book entry for anyone, on Minca or not. Your own public self is std.profile; a Minca account you can message is std.contact.';

name

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

schema

readonly schema: object;

schema.properties

readonly properties: object;

schema.properties.addresses

readonly addresses: object;

schema.properties.addresses.items

items: object;

schema.properties.addresses.items.properties

properties: object & object;
Type Declaration
address
readonly address: object;
address.properties
properties: object;
address.properties.country
country: object;
address.properties.country.maxLength
maxLength: ... = max;
address.properties.country.minLength?
minLength?: ... = min;
address.properties.country.type
type: ...;
address.properties.locality
locality: object;
address.properties.locality.maxLength
maxLength: ... = max;
address.properties.locality.minLength?
minLength?: ... = min;
address.properties.locality.type
type: ...;
address.properties.postcode
postcode: object;
address.properties.postcode.maxLength
maxLength: ... = max;
address.properties.postcode.minLength?
minLength?: ... = min;
address.properties.postcode.type
type: ...;
address.properties.region
region: object;
address.properties.region.maxLength
maxLength: ... = max;
address.properties.region.minLength?
minLength?: ... = min;
address.properties.region.type
type: ...;
address.properties.street
street: object;
address.properties.street.maxLength
maxLength: ... = max;
address.properties.street.minLength?
minLength?: ... = min;
address.properties.street.type
type: ...;
address.type
type: "object";
label
label: object;
label.maxLength
maxLength: number = max;
label.minLength?
minLength?: number = min;
label.type
type: "string";

schema.properties.addresses.items.required

required: readonly ["address"];

schema.properties.addresses.items.type

type: "object";

schema.properties.addresses.maxItems

maxItems: number = 16;

schema.properties.addresses.type

type: "array";

schema.properties.birthday

readonly birthday: object & object;
Type Declaration
maxLength
maxLength: number = 10;
minLength
minLength: number = 10;
type
type: "string";
x-kind
readonly "x-kind": "day";

schema.properties.emails

readonly emails: object;

schema.properties.emails.items

items: object;

schema.properties.emails.items.properties

properties: object & object;
Type Declaration
address
readonly address: object;
address.maxLength
maxLength: number = max;
address.minLength?
minLength?: number = min;
address.type
type: "string";
label
label: object;
label.maxLength
maxLength: number = max;
label.minLength?
minLength?: number = min;
label.type
type: "string";

schema.properties.emails.items.required

required: readonly ["address"];

schema.properties.emails.items.type

type: "object";

schema.properties.emails.maxItems

maxItems: number = 16;

schema.properties.emails.type

type: "array";

schema.properties.jobTitle

readonly jobTitle: object;

schema.properties.jobTitle.maxLength

maxLength: number = max;

schema.properties.jobTitle.minLength?

minLength?: number = min;

schema.properties.jobTitle.type

type: "string";

schema.properties.name

readonly name: object;

schema.properties.name.properties

readonly properties: object;

schema.properties.name.properties.family

readonly family: object;

schema.properties.name.properties.family.maxLength

maxLength: number = max;

schema.properties.name.properties.family.minLength?

minLength?: number = min;

schema.properties.name.properties.family.type

type: "string";

schema.properties.name.properties.full

readonly full: object;

schema.properties.name.properties.full.maxLength

maxLength: number = max;

schema.properties.name.properties.full.minLength?

minLength?: number = min;

schema.properties.name.properties.full.type

type: "string";

schema.properties.name.properties.given

readonly given: object;

schema.properties.name.properties.given.maxLength

maxLength: number = max;

schema.properties.name.properties.given.minLength?

minLength?: number = min;

schema.properties.name.properties.given.type

type: "string";

schema.properties.name.type

readonly type: "object" = 'object';

schema.properties.note

readonly note: object;

schema.properties.note.maxLength

maxLength: number = max;

schema.properties.note.minLength?

minLength?: number = min;

schema.properties.note.type

type: "string";

schema.properties.organization

readonly organization: object;

schema.properties.organization.maxLength

maxLength: number = max;

schema.properties.organization.minLength?

minLength?: number = min;

schema.properties.organization.type

type: "string";

schema.properties.phones

readonly phones: object;

schema.properties.phones.items

items: object;

schema.properties.phones.items.properties

properties: object & object;
Type Declaration
number
readonly number: object;
number.maxLength
maxLength: number = max;
number.minLength?
minLength?: number = min;
number.type
type: "string";
label
label: object;
label.maxLength
maxLength: number = max;
label.minLength?
minLength?: number = min;
label.type
type: "string";

schema.properties.phones.items.required

required: readonly ["number"];

schema.properties.phones.items.type

type: "object";

schema.properties.phones.maxItems

maxItems: number = 16;

schema.properties.phones.type

type: "array";

schema.properties.photo

readonly photo: object & object;
Type Declaration
properties
properties: object;
properties.hash
hash: object;
properties.hash.maxLength
maxLength: number = 64;
properties.hash.minLength
minLength: number = 64;
properties.hash.type
type: "string";
properties.key
key: object;
properties.key.maxLength
maxLength: number = 22;
properties.key.minLength
minLength: number = 22;
properties.key.type
type: "string";
properties.mime
mime: object;
properties.mime.maxLength
maxLength: number = max;
properties.mime.minLength?
minLength?: number = min;
properties.mime.type
type: "string";
properties.name
name: object;
properties.name.maxLength
maxLength: number = max;
properties.name.minLength?
minLength?: number = min;
properties.name.type
type: "string";
properties.salt
salt: object;
properties.salt.maxLength
maxLength: number = 22;
properties.salt.minLength
minLength: number = 22;
properties.salt.type
type: "string";
properties.size
size: object;
properties.size.minimum
minimum: number = 0;
properties.size.type
type: "integer";
required
required: readonly ["hash", "size", "mime"];
type
type: "object";
x-kind
readonly "x-kind": "file";

schema.properties.urls

readonly urls: object;

schema.properties.urls.items

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

schema.properties.urls.maxItems

readonly maxItems: 16 = 16;

schema.properties.urls.type

readonly type: "array" = 'array';

schema.type

readonly type: "object" = 'object';

title

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

On this page

Type Declarationdescriptionnameschemaschema.propertiesschema.properties.addressesschema.properties.addresses.itemsschema.properties.addresses.items.propertiesType Declarationaddressaddress.propertiesaddress.properties.countryaddress.properties.country.maxLengthaddress.properties.country.minLength?address.properties.country.typeaddress.properties.localityaddress.properties.locality.maxLengthaddress.properties.locality.minLength?address.properties.locality.typeaddress.properties.postcodeaddress.properties.postcode.maxLengthaddress.properties.postcode.minLength?address.properties.postcode.typeaddress.properties.regionaddress.properties.region.maxLengthaddress.properties.region.minLength?address.properties.region.typeaddress.properties.streetaddress.properties.street.maxLengthaddress.properties.street.minLength?address.properties.street.typeaddress.typelabellabel.maxLengthlabel.minLength?label.typeschema.properties.addresses.items.requiredschema.properties.addresses.items.typeschema.properties.addresses.maxItemsschema.properties.addresses.typeschema.properties.birthdayType DeclarationmaxLengthminLengthtypex-kindschema.properties.emailsschema.properties.emails.itemsschema.properties.emails.items.propertiesType Declarationaddressaddress.maxLengthaddress.minLength?address.typelabellabel.maxLengthlabel.minLength?label.typeschema.properties.emails.items.requiredschema.properties.emails.items.typeschema.properties.emails.maxItemsschema.properties.emails.typeschema.properties.jobTitleschema.properties.jobTitle.maxLengthschema.properties.jobTitle.minLength?schema.properties.jobTitle.typeschema.properties.nameschema.properties.name.propertiesschema.properties.name.properties.familyschema.properties.name.properties.family.maxLengthschema.properties.name.properties.family.minLength?schema.properties.name.properties.family.typeschema.properties.name.properties.fullschema.properties.name.properties.full.maxLengthschema.properties.name.properties.full.minLength?schema.properties.name.properties.full.typeschema.properties.name.properties.givenschema.properties.name.properties.given.maxLengthschema.properties.name.properties.given.minLength?schema.properties.name.properties.given.typeschema.properties.name.typeschema.properties.noteschema.properties.note.maxLengthschema.properties.note.minLength?schema.properties.note.typeschema.properties.organizationschema.properties.organization.maxLengthschema.properties.organization.minLength?schema.properties.organization.typeschema.properties.phonesschema.properties.phones.itemsschema.properties.phones.items.propertiesType Declarationnumbernumber.maxLengthnumber.minLength?number.typelabellabel.maxLengthlabel.minLength?label.typeschema.properties.phones.items.requiredschema.properties.phones.items.typeschema.properties.phones.maxItemsschema.properties.phones.typeschema.properties.photoType Declarationpropertiesproperties.hashproperties.hash.maxLengthproperties.hash.minLengthproperties.hash.typeproperties.keyproperties.key.maxLengthproperties.key.minLengthproperties.key.typeproperties.mimeproperties.mime.maxLengthproperties.mime.minLength?properties.mime.typeproperties.nameproperties.name.maxLengthproperties.name.minLength?properties.name.typeproperties.saltproperties.salt.maxLengthproperties.salt.minLengthproperties.salt.typeproperties.sizeproperties.size.minimumproperties.size.typerequiredtypex-kindschema.properties.urlsschema.properties.urls.itemsType DeclarationmaxLengthminLength?typex-kindschema.properties.urls.maxItemsschema.properties.urls.typeschema.typetitle