Contents

deleteRecords

Deletes one or more records.

Declaration

Promise< CloudKit.RecordsResponse, CloudKit.CKError > deleteRecords(
	CloudKit.Record|CloudKit.Record[]|String|String[] records,
	optional Object options
);

Parameters

  • records:

    Possible values are:

    Type

    Description

    Cloudkit.record

    A dictionary or the record name of the record to delete.

    CloudKit.Record[]

    An array of records to delete.

    String

    The name of a record to delete.

    String[]

    An array of names of records to delete.

  • options:

    A dictionary containing a single zoneID key that identifies the zone (Cloudkit.zoneid) in the database where the record resides. If the options parameter is omitted, the default zone is used.

Return Value

A Promise object that resolves to a CloudKit.RecordsResponse object if the operation succeeds; otherwise, a CKError object.

See Also

Accessing Records