Class Exchanges

constructor

• new Exchanges(client: SignifyClient): Exchanges

  Exchanges

  Parameters

  • client: SignifyClient

  Returns Exchanges

client

createExchangeMessage

• createExchangeMessage(
      sender: {
          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 | string[];
              n: string[];
              nt: string | string[];
              p: string;
              s: string;
              vn?: number[];
          };
          transferable: boolean;
          windexes: 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 | string[]; k: string[]; nt: string | string[]; ... 5 more ...; di: string; }; transferable: boolean; windexes: string[]; } & ({ ...; } | ... 2...;
                  ndigs: string[];
              };
          }
          | {
              extern: { extern_type: string; pidx: number } & {
                  [key: string]: unknown;
              };
          }
      ),
      route: string,
      payload: Dict<any>,
      embeds: Dict<any>,
      recipient: string,
      datetime?: string,
      dig?: string,
  ): Promise<[Serder, string[], string]>

  Create exn message

  Parameters

  • sender: {
        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 | string[];
            n: string[];
            nt: string | string[];
            p: string;
            s: string;
            vn?: number[];
        };
        transferable: boolean;
        windexes: 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 | string[]; k: string[]; nt: string | string[]; ... 5 more ...; di: string; }; transferable: boolean; windexes: string[]; } & ({ ...; } | ... 2...;
                ndigs: string[];
            };
        }
        | {
            extern: { extern_type: string; pidx: number } & {
                [key: string]: unknown;
            };
        }
    )
  • route: string
  • payload: Dict<any>
  • embeds: Dict<any>
  • recipient: string
  • Optionaldatetime: string
  • Optionaldig: string

  Returns Promise<[Serder, string[], string]>

  A promise to the list of replay messages

  Async

get

• get(said: string): Promise<ExchangeResourceV1>

  Get exn message by said

  Parameters

  • said: string

    The said of the exn message

  Returns Promise<ExchangeResourceV1>

  A promise to the exn message

  Async

send

• send(
      name: string,
      topic: string,
      sender: {
          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 | string[];
              n: string[];
              nt: string | string[];
              p: string;
              s: string;
              vn?: number[];
          };
          transferable: boolean;
          windexes: 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 | string[]; k: string[]; nt: string | string[]; ... 5 more ...; di: string; }; transferable: boolean; windexes: string[]; } & ({ ...; } | ... 2...;
                  ndigs: string[];
              };
          }
          | {
              extern: { extern_type: string; pidx: number } & {
                  [key: string]: unknown;
              };
          }
      ),
      route: string,
      payload: Dict<any>,
      embeds: Dict<any>,
      recipients: string[],
  ): Promise<
      | {
          a: unknown;
          d: string;
          dt: string;
          e: { [key: string]: unknown };
          i: string;
          p: string;
          q: { [key: string]: unknown };
          r: string;
          rp: string;
          t: string;
          v: string;
      }
      | {
          a: unknown;
          d: string;
          dt: string;
          i: string;
          p: string;
          q: { [key: string]: unknown };
          r: string;
          t: string;
          v: string;
          x: string;
      },
  >

  Send exn messages to list of recipients

  Parameters

  • name: string
  • topic: string
  • sender: {
        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 | string[];
            n: string[];
            nt: string | string[];
            p: string;
            s: string;
            vn?: number[];
        };
        transferable: boolean;
        windexes: 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 | string[]; k: string[]; nt: string | string[]; ... 5 more ...; di: string; }; transferable: boolean; windexes: string[]; } & ({ ...; } | ... 2...;
                ndigs: string[];
            };
        }
        | {
            extern: { extern_type: string; pidx: number } & {
                [key: string]: unknown;
            };
        }
    )
  • route: string
  • payload: Dict<any>
  • embeds: Dict<any>
  • recipients: string[]

  Returns Promise<
      | {
          a: unknown;
          d: string;
          dt: string;
          e: { [key: string]: unknown };
          i: string;
          p: string;
          q: { [key: string]: unknown };
          r: string;
          rp: string;
          t: string;
          v: string;
      }
      | {
          a: unknown;
          d: string;
          dt: string;
          i: string;
          p: string;
          q: { [key: string]: unknown };
          r: string;
          t: string;
          v: string;
          x: string;
      },
  >

  A promise to the list of replay messages

  Async

sendFromEvents

• sendFromEvents(
      name: string,
      topic: string,
      exn: Serder,
      sigs: string[],
      atc: string,
      recipients: string[],
  ): Promise<
      | {
          a: unknown;
          d: string;
          dt: string;
          e: { [key: string]: unknown };
          i: string;
          p: string;
          q: { [key: string]: unknown };
          r: string;
          rp: string;
          t: string;
          v: string;
      }
      | {
          a: unknown;
          d: string;
          dt: string;
          i: string;
          p: string;
          q: { [key: string]: unknown };
          r: string;
          t: string;
          v: string;
          x: string;
      },
  >

  Send exn message to list of recipients

  Parameters

  • name: string
  • topic: string
  • exn: Serder
  • sigs: string[]
  • atc: string
  • recipients: string[]

  Returns Promise<
      | {
          a: unknown;
          d: string;
          dt: string;
          e: { [key: string]: unknown };
          i: string;
          p: string;
          q: { [key: string]: unknown };
          r: string;
          rp: string;
          t: string;
          v: string;
      }
      | {
          a: unknown;
          d: string;
          dt: string;
          i: string;
          p: string;
          q: { [key: string]: unknown };
          r: string;
          t: string;
          v: string;
          x: string;
      },
  >

  A promise to the list of replay messages

  Async