Class Groups

constructor

• new Groups(client): Groups

• Groups

  Parameters

  • client: SignifyClient

  Returns Groups

client

getRequest

• getRequest(said?): Promise<any>

• Get group request messages

  Parameters

  • Optional said: string

    SAID of exn message to load

  Returns Promise<any>

  A promise to the list of replay messages

  Async

join

• join(name?, rot?, sigs?, gid?, smids?, rmids?): 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

  • Optional name: string

    human readable name of group AID

  • Optional rot: any

    rotation event

  • Optional sigs: any

    signatures

  • Optional gid: string

    prefix

  • Optional smids: string[]

    array of particpants

  • Optional rmids: string[]

    array of particpants

  Returns Promise<any>

  A promise to the list of replay messages

  Async

sendRequest

• sendRequest(name?, exn?, sigs?, atc?): Promise<any>

• Send multisig exn request messages to other group members

  Parameters

  • Optional name: string

    human readable name of group AID

  • Optional exn: Dict<any>

    exn message to send to other members

  • Optional sigs: string[]

    signature of the participant over the exn

  • Optional atc: string

    additional attachments from embedded events in exn

  Returns Promise<any>

  A promise to the list of replay messages

  Async