Class Exchanges

constructor

• new Exchanges(client: SignifyClient): Exchanges

  Exchanges

  Parameters

  • client: SignifyClient

  Returns Exchanges

client

createExchangeMessage

• createExchangeMessage(
      sender: HabState,
      route: string,
      payload: Dict<any>,
      embeds: Dict<any>,
      recipient: string,
      datetime?: string,
      dig?: string,
  ): Promise<[Serder, string[], string]>

  Create exn message

  Parameters

  • sender: HabState
  • 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: HabState,
      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: HabState
  • 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