Class Oobis

constructor

• new Oobis(client: SignifyClient): Oobis

  Oobis

  Parameters

  • client: SignifyClient

  Returns Oobis

client

endroles

• endroles(
      aid: string,
      role?: string,
  ): Promise<{ cid: string; eid: string; role: string }[]>

  Get end roles for an AID by prefix

  Parameters

  • aid: string

    AID prefix

  • Optionalrole: string

    Optional role to filter by

  Returns Promise<{ cid: string; eid: string; role: string }[]>

  A promise to the list of end roles

get

• get(name: string, role?: string): Promise<{ oobis: string[]; role: OOBIRole }>

  Get the OOBI(s) for a managed indentifier for a given role

  Parameters

  • name: string

    Name or alias of the identifier

  • role: string = 'agent'

    Authorized role

  Returns Promise<{ oobis: string[]; role: OOBIRole }>

  A promise to the OOBI(s)

resolve

• resolve(
      oobi: string,
      alias?: string,
  ): Promise<
      | { done: false; metadata?: { oobi: string }; name: string }
      | {
          done: true;
          metadata?: { oobi: string };
          name: string;
          response: {
              b: string[];
              bt: string;
              c: string[];
              d: string;
              di: string;
              dt: string;
              ee: { ba?: unknown[]; br?: unknown[]; d: string; s: string };
              et: string;
              f: string;
              i: string;
              k: string[];
              kt: string | string[];
              n: string[];
              nt: string | string[];
              p: string;
              s: string;
              vn?: number[];
          };
      }
      | {
          done: true;
          error: {
              code: number;
              details?: null
              | { [key: string]: unknown };
              message: string;
          };
          metadata?: { oobi: string };
          name: string;
      },
  >

  Resolve an OOBI

  Parameters

  • oobi: string

    The OOBI to be resolver

  • Optionalalias: string

    Optional name or alias to link the OOBI resolution to a contact

  Returns Promise<
      | { done: false; metadata?: { oobi: string }; name: string }
      | {
          done: true;
          metadata?: { oobi: string };
          name: string;
          response: {
              b: string[];
              bt: string;
              c: string[];
              d: string;
              di: string;
              dt: string;
              ee: { ba?: unknown[]; br?: unknown[]; d: string; s: string };
              et: string;
              f: string;
              i: string;
              k: string[];
              kt: string | string[];
              n: string[];
              nt: string | string[];
              p: string;
              s: string;
              vn?: number[];
          };
      }
      | {
          done: true;
          error: {
              code: number;
              details?: null
              | { [key: string]: unknown };
              message: string;
          };
          metadata?: { oobi: string };
          name: string;
      },
  >

  A promise to the long-running operation

  Async