Class Groups

constructor

• new Groups(client: SignifyClient): Groups

  Groups

  Parameters

  • client: SignifyClient

  Returns Groups

client

getRequest

• getRequest(said?: string): Promise<any>

  Get group request messages

  Parameters

  • Optionalsaid: string

    SAID of exn message to load

  Returns Promise<any>

  A promise to the list of replay messages

  Async

join

• join(
      name?: string,
      rot?: any,
      sigs?: any,
      gid?: string,
      smids?: string[],
      rmids?: string[],
  ): Promise<any>

  Join multisig group using rotation event. This can be used by participants being asked to contribute keys to a rotation event to join an existing group.

  Parameters

  • Optionalname: string

    human readable name of group AID
  • Optionalrot: any

    rotation event
  • Optionalsigs: any

    signatures
  • Optionalgid: string

    prefix
  • Optionalsmids: string[]

    array of particpants
  • Optionalrmids: string[]

    array of particpants

  Returns Promise<any>

  A promise to the list of replay messages

  Async

sendRequest

• sendRequest(
      name?: string,
      exn?: Dict<any>,
      sigs?: string[],
      atc?: string,
  ): Promise<any>

  Send multisig exn request messages to other group members

  Parameters

  • Optionalname: string

    human readable name of group AID
  • Optionalexn: Dict<any>

    exn message to send to other members
  • Optionalsigs: string[]

    signature of the participant over the exn
  • Optionalatc: string

    additional attachments from embedded events in exn

  Returns Promise<any>

  A promise to the list of replay messages

  Async