Basic APIs

quip.apps.Record.prototype​

The below methods are instance methods of Record and can be called on any subclass instance of a Record.

getId​

Function() => string

Returns the ID for this Record. This ID is guaranteed to be unique within this app instance, but if you are planning to store this ID in a datastore external to Quip, please use quip.apps.Record.prototype.getUniqueId instead.

getUniqueId​

Function() => string

Returns an ID for this Record that is safe to store in an external datastore. For Record references that are stored with Quip, please use quip.apps.Record.prototype.getId instead.

isDeleted​

Function() => boolean

Returns whether or not this Record instance has been deleted.

delete​

Function() => void

Sets this Record as deleted. If this Record is in a RecordList, it will be removed from the list. All Record and RecordList properties of this Record are also deleted.

initialize​

Function() => void

Override this method to do initialization for this Record instance upon instantiation.

listen​

Function(listener: (record: quip.apps.Record) => void) => void

Subscribe to changes to this Record. The listener function will be called for both local and remote changes to this Record.

unlisten​

Function(listener: (record: quip.apps.Record) => void) => void

Unsubscribe from changes to this Record.