Class Contacts

constructor

• new Contacts(client: SignifyClient): Contacts

  Contacts

  Parameters

  • client: SignifyClient

  Returns Contacts

client

add

• add(
      pre: string,
      info: ContactInfo,
  ): Promise<
      {
          alias?: string;
          challenges?: {
              authenticated?: boolean;
              dt?: string;
              said?: string;
              words: string[];
          }[];
          ends?: {
              agent: null
              | { [key: string]: string };
              controller: null | { [key: string]: string };
              judge: null | { [key: string]: string };
              juror: null | { [key: string]: string };
              mailbox: null | { [key: string]: string };
              peer: null | { [key: string]: string };
              registrar: null | { [key: string]: string };
              watcher: null | { [key: string]: string };
              witness: null | { [key: string]: string };
          };
          id: string;
          oobi?: string;
          wellKnowns?: { dt: string; url: string }[];
      } & { [key: string]: unknown },
  >

  Add a contact

  Parameters

  • pre: string

    Prefix of the contact

  • info: ContactInfo

    Information about the contact

  Returns Promise<
      {
          alias?: string;
          challenges?: {
              authenticated?: boolean;
              dt?: string;
              said?: string;
              words: string[];
          }[];
          ends?: {
              agent: null
              | { [key: string]: string };
              controller: null | { [key: string]: string };
              judge: null | { [key: string]: string };
              juror: null | { [key: string]: string };
              mailbox: null | { [key: string]: string };
              peer: null | { [key: string]: string };
              registrar: null | { [key: string]: string };
              watcher: null | { [key: string]: string };
              witness: null | { [key: string]: string };
          };
          id: string;
          oobi?: string;
          wellKnowns?: { dt: string; url: string }[];
      } & { [key: string]: unknown },
  >

  A promise to the result of the addition

  Async

delete

• delete(pre: string): Promise<void>

  Delete a contact

  Parameters

  • pre: string

    Prefix of the contact

  Returns Promise<void>

  Async

get

• get(
      pre: string,
  ): Promise<
      {
          alias?: string;
          challenges?: {
              authenticated?: boolean;
              dt?: string;
              said?: string;
              words: string[];
          }[];
          ends?: {
              agent: null
              | { [key: string]: string };
              controller: null | { [key: string]: string };
              judge: null | { [key: string]: string };
              juror: null | { [key: string]: string };
              mailbox: null | { [key: string]: string };
              peer: null | { [key: string]: string };
              registrar: null | { [key: string]: string };
              watcher: null | { [key: string]: string };
              witness: null | { [key: string]: string };
          };
          id: string;
          oobi?: string;
          wellKnowns?: { dt: string; url: string }[];
      } & { [key: string]: unknown },
  >

  Get a contact

  Parameters

  • pre: string

    Prefix of the contact

  Returns Promise<
      {
          alias?: string;
          challenges?: {
              authenticated?: boolean;
              dt?: string;
              said?: string;
              words: string[];
          }[];
          ends?: {
              agent: null
              | { [key: string]: string };
              controller: null | { [key: string]: string };
              judge: null | { [key: string]: string };
              juror: null | { [key: string]: string };
              mailbox: null | { [key: string]: string };
              peer: null | { [key: string]: string };
              registrar: null | { [key: string]: string };
              watcher: null | { [key: string]: string };
              witness: null | { [key: string]: string };
          };
          id: string;
          oobi?: string;
          wellKnowns?: { dt: string; url: string }[];
      } & { [key: string]: unknown },
  >

  A promise to the contact

  Async

list

• list(
      group?: string,
      filterField?: string,
      filterValue?: string,
  ): Promise<
      (
          {
              alias?: string;
              challenges?: {
                  authenticated?: boolean;
                  dt?: string;
                  said?: string;
                  words: string[];
              }[];
              ends?: {
                  agent: null
                  | { [key: string]: string };
                  controller: null | { [key: string]: string };
                  judge: null | { [key: string]: string };
                  juror: null | { [key: string]: string };
                  mailbox: null | { [key: string]: string };
                  peer: null | { [key: string]: string };
                  registrar: null | { [key: string]: string };
                  watcher: null | { [key: string]: string };
                  witness: null | { [key: string]: string };
              };
              id: string;
              oobi?: string;
              wellKnowns?: { dt: string; url: string }[];
          } & { [key: string]: unknown }
      )[],
  >

  List contacts

  Parameters

  • Optionalgroup: string

    Optional group name to filter contacts

  • OptionalfilterField: string

    Optional field name to filter contacts

  • OptionalfilterValue: string

    Optional field value to filter contacts

  Returns Promise<
      (
          {
              alias?: string;
              challenges?: {
                  authenticated?: boolean;
                  dt?: string;
                  said?: string;
                  words: string[];
              }[];
              ends?: {
                  agent: null
                  | { [key: string]: string };
                  controller: null | { [key: string]: string };
                  judge: null | { [key: string]: string };
                  juror: null | { [key: string]: string };
                  mailbox: null | { [key: string]: string };
                  peer: null | { [key: string]: string };
                  registrar: null | { [key: string]: string };
                  watcher: null | { [key: string]: string };
                  witness: null | { [key: string]: string };
              };
              id: string;
              oobi?: string;
              wellKnowns?: { dt: string; url: string }[];
          } & { [key: string]: unknown }
      )[],
  >

  A promise to the list of contacts

  Async

update

• update(
      pre: string,
      info: ContactInfo,
  ): Promise<
      {
          alias?: string;
          challenges?: {
              authenticated?: boolean;
              dt?: string;
              said?: string;
              words: string[];
          }[];
          ends?: {
              agent: null
              | { [key: string]: string };
              controller: null | { [key: string]: string };
              judge: null | { [key: string]: string };
              juror: null | { [key: string]: string };
              mailbox: null | { [key: string]: string };
              peer: null | { [key: string]: string };
              registrar: null | { [key: string]: string };
              watcher: null | { [key: string]: string };
              witness: null | { [key: string]: string };
          };
          id: string;
          oobi?: string;
          wellKnowns?: { dt: string; url: string }[];
      } & { [key: string]: unknown },
  >

  Update a contact

  Parameters

  • pre: string

    Prefix of the contact

  • info: ContactInfo

    Updated information about the contact

  Returns Promise<
      {
          alias?: string;
          challenges?: {
              authenticated?: boolean;
              dt?: string;
              said?: string;
              words: string[];
          }[];
          ends?: {
              agent: null
              | { [key: string]: string };
              controller: null | { [key: string]: string };
              judge: null | { [key: string]: string };
              juror: null | { [key: string]: string };
              mailbox: null | { [key: string]: string };
              peer: null | { [key: string]: string };
              registrar: null | { [key: string]: string };
              watcher: null | { [key: string]: string };
              witness: null | { [key: string]: string };
          };
          id: string;
          oobi?: string;
          wellKnowns?: { dt: string; url: string }[];
      } & { [key: string]: unknown },
  >

  A promise to the result of the update

  Async