Class: RecordReference

RecordReference

(protected) new RecordReference(conn, type, id)

Remote reference to record information
Parameters:
Name Type Description
conn Connection Connection object
type String SObject type
id String Record ID
Source:

Methods

blob(fieldName) → {stream.Stream}

Get blob field as stream
Parameters:
Name Type Description
fieldName String Blob field name
Source:
Returns:
Type
stream.Stream

del(callbackopt) → {Promise.<RecordResult>}

Synonym of Record#destroy()
Parameters:
Name Type Attributes Description
callback Callback.<RecordResult> <optional>
 Callback function
Source:
Returns:
Type
Promise.<RecordResult>

delete(optionsopt, callbackopt) → {Promise.<RecordResult>}

Synonym of Record#destroy()
Parameters:
Name Type Attributes Description
options Object <optional>
 Options for rest api.
callback Callback.<RecordResult> <optional>
 Callback function
Source:
Returns:
Type
Promise.<RecordResult>

destroy(optionsopt, callbackopt) → {Promise.<RecordResult>}

Delete record field
Parameters:
Name Type Attributes Description
options Object <optional>
 Options for rest api.
callback Callback.<RecordResult> <optional>
 Callback function
Source:
Returns:
Type
Promise.<RecordResult>

retrieve(optionsopt, callbackopt) → {Promise.<Record>}

Retrieve record field information
Parameters:
Name Type Attributes Description
options Object <optional>
 Options for rest api.
callback Callback.<Record> <optional>
 Callback function
Source:
Returns:
Type
Promise.<Record>

update(record, optionsopt, callbackopt) → {Promise.<RecordResult>}

Update record field information
Parameters:
Name Type Attributes Description
record Record A Record which includes fields to update
options Object <optional>
 Options for rest api.
callback Callback.<RecordResult> <optional>
 Callback function
Source:
Returns:
Type
Promise.<RecordResult>