Class Registries

constructor

• new Registries(client: SignifyClient): Registries

  Registries

  Parameters

  • client: SignifyClient

  Returns Registries

client

create

• create(__namedParameters: CreateRegistryArgs): Promise<RegistryResult>

  Create a registry

  Parameters

  • __namedParameters: CreateRegistryArgs

  Returns Promise<RegistryResult>

  A promise to the long-running operation

  Async

createFromEvents

• createFromEvents(
      hab: {
          icp_dt: string;
          name: string;
          prefix: string;
          state: {
              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;
              n: string[];
              nt: string;
              p: string;
              s: string;
              vn?: number[];
          };
          transferable: null
          | boolean;
          windexes: null | string[];
      } & (
          | {
              salty: {
                  dcode: string;
                  icodes: string[];
                  kidx: number;
                  ncodes: string[];
                  pidx: number;
                  stem: string;
                  sxlt: string;
                  tier: Tier;
                  transferable: boolean;
              };
          }
          | { randy: { nxts: string[]; prxs: string[] } }
          | {
              group: {
                  keys: string[];
                  mhab: { name: string; prefix: string; icp_dt: string; state: { vn?: number[] | undefined; i: string; s: string; p: string; d: string; f: string; dt: string; et: string; kt: string; k: string[]; nt: string; n: string[]; bt: string; b: string[]; c: string[]; ee: { ...; }; di: string; }; transferable: boolean | null; windexe...;
                  ndigs: string[];
              };
          }
          | {
              extern: { extern_type: string; pidx: number } & {
                  [key: string]: unknown;
              };
          }
      ),
      name: string,
      registryName: string,
      vcp: Dict<any>,
      ixn: Dict<any>,
      sigs: any[],
  ): Promise<Response>

  Parameters

  • hab: {
        icp_dt: string;
        name: string;
        prefix: string;
        state: {
            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;
            n: string[];
            nt: string;
            p: string;
            s: string;
            vn?: number[];
        };
        transferable: null
        | boolean;
        windexes: null | string[];
    } & (
        | {
            salty: {
                dcode: string;
                icodes: string[];
                kidx: number;
                ncodes: string[];
                pidx: number;
                stem: string;
                sxlt: string;
                tier: Tier;
                transferable: boolean;
            };
        }
        | { randy: { nxts: string[]; prxs: string[] } }
        | {
            group: {
                keys: string[];
                mhab: { name: string; prefix: string; icp_dt: string; state: { vn?: number[] | undefined; i: string; s: string; p: string; d: string; f: string; dt: string; et: string; kt: string; k: string[]; nt: string; n: string[]; bt: string; b: string[]; c: string[]; ee: { ...; }; di: string; }; transferable: boolean | null; windexe...;
                ndigs: string[];
            };
        }
        | {
            extern: { extern_type: string; pidx: number } & {
                [key: string]: unknown;
            };
        }
    )

    • icp_dt: string

    • name: string

    • prefix: string

    • state: {
          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;
          n: string[];
          nt: string;
          p: string;
          s: string;
          vn?: number[];
      }

      • b: string[]

      • bt: string

        Default

        0
        Copy

      • c: string[]

      • d: string

        Default

        
        Copy

      • di: string

        Default

        
        Copy

      • dt: string

        Default

        
        Copy

      • ee: { ba?: unknown[]; br?: unknown[]; d: string; s: string }

        • Optionalba?: unknown[]

        • Optionalbr?: unknown[]

        • d: string

          Default

          
          Copy

        • s: string

          Default

          0
          Copy

      • et: string

        Default

        
        Copy

      • f: string

        Default

        0
        Copy

      • i: string

        Default

        
        Copy

      • k: string[]

      • kt: string

        Default

        0
        Copy

      • n: string[]

      • nt: string

        Default

        0
        Copy

      • p: string

        Default

        
        Copy

      • s: string

        Default

        0
        Copy

      • Optionalvn?: number[]

    • transferable: null | boolean

      Default

      null
      Copy

    • windexes: null | string[]

      Default

      null
      Copy

    • {
          salty: {
              dcode: string;
              icodes: string[];
              kidx: number;
              ncodes: string[];
              pidx: number;
              stem: string;
              sxlt: string;
              tier: Tier;
              transferable: boolean;
          };
      }
    • { randy: { nxts: string[]; prxs: string[] } }
    • {
          group: {
              keys: string[];
              mhab: { name: string; prefix: string; icp_dt: string; state: { vn?: number[] | undefined; i: string; s: string; p: string; d: string; f: string; dt: string; et: string; kt: string; k: string[]; nt: string; n: string[]; bt: string; b: string[]; c: string[]; ee: { ...; }; di: string; }; transferable: boolean | null; windexe...;
              ndigs: string[];
          };
      }
    • { extern: { extern_type: string; pidx: number } & { [key: string]: unknown } }
  • name: string
  • registryName: string
  • vcp: Dict<any>
  • ixn: Dict<any>
  • sigs: any[]

  Returns Promise<Response>

list

• list(
      name: string,
  ): Promise<
      {
          name: string;
          pre: string;
          regk: string;
          state: | {
              a: { d: string; i?: string; s: string };
              d: string;
              dt: string;
              et: CredentialStateIssOrRevEt;
              i: string;
              ra: Record<string, never>;
              ri: string;
              s: string;
              vn: unknown;
          }
          | {
              a: { d: string; i?: string; s: string };
              d: string;
              dt: string;
              et: CredentialStateBisOrBrvEt;
              i: string;
              ra: { d: string; i: string; s: string };
              ri: string;
              s: string;
              vn: unknown;
          };
      }[],
  >

  List registries

  Parameters

  • name: string

    Name or alias of the identifier

  Returns Promise<
      {
          name: string;
          pre: string;
          regk: string;
          state: | {
              a: { d: string; i?: string; s: string };
              d: string;
              dt: string;
              et: CredentialStateIssOrRevEt;
              i: string;
              ra: Record<string, never>;
              ri: string;
              s: string;
              vn: unknown;
          }
          | {
              a: { d: string; i?: string; s: string };
              d: string;
              dt: string;
              et: CredentialStateBisOrBrvEt;
              i: string;
              ra: { d: string; i: string; s: string };
              ri: string;
              s: string;
              vn: unknown;
          };
      }[],
  >

  A promise to the list of registries

  Async

rename

• rename(
      name: string,
      registryName: string,
      newName: string,
  ): Promise<
      {
          name: string;
          pre: string;
          regk: string;
          state: | {
              a: { d: string; i?: string; s: string };
              d: string;
              dt: string;
              et: CredentialStateIssOrRevEt;
              i: string;
              ra: Record<string, never>;
              ri: string;
              s: string;
              vn: unknown;
          }
          | {
              a: { d: string; i?: string; s: string };
              d: string;
              dt: string;
              et: CredentialStateBisOrBrvEt;
              i: string;
              ra: { d: string; i: string; s: string };
              ri: string;
              s: string;
              vn: unknown;
          };
      },
  >

  Rename a registry

  Parameters

  • name: string

    Name or alias of the identifier

  • registryName: string

    Current registry name

  • newName: string

    New registry name

  Returns Promise<
      {
          name: string;
          pre: string;
          regk: string;
          state: | {
              a: { d: string; i?: string; s: string };
              d: string;
              dt: string;
              et: CredentialStateIssOrRevEt;
              i: string;
              ra: Record<string, never>;
              ri: string;
              s: string;
              vn: unknown;
          }
          | {
              a: { d: string; i?: string; s: string };
              d: string;
              dt: string;
              et: CredentialStateBisOrBrvEt;
              i: string;
              ra: { d: string; i: string; s: string };
              ri: string;
              s: string;
              vn: unknown;
          };
      },
  >

  A promise to the registry record

  Async