Method deleteRecords

packages/widget-sdk/src/model/datasheet.ts:585–594

* Delete the given records. * * @param recordIds array of recordIds. * @returns * * * #### Description * Delete the given record by recordIds. * * Throws an error if the user does not have permission to delete the given record. * * #### Example * ```js * async

(recordIds: string[])

   * ```
   */
  async deleteRecords(recordIds: string[]) {
    const result: ICollaCommandExecuteResult<any> = await cmdExecute({
      cmd: CollaCommandName.DeleteRecords,
      datasheetId: this.datasheetId,
      data: recordIds,
    }, this.wCtx.id);
    if (result.result === ExecuteResult.Fail) {
      throw new Error(result.reason);
    }
  }

  /**
   * Creates a new field.