record.detach.promise(options)

Method Description	Detaches a record from another record asynchronously. Note: The parameters and errors thrown for this method are the same as those for record.detach(options). For more information about promises, see Promise Object.
Returns	Promise Object
Synchronous Version	record.detach(options)
Supported Script Types	Client scripts For more information, see SuiteScript 2.x Client Script Type.
Governance	10 units
Module	N/record Module
Since	2015.2

Parameters

Note:

The options parameter is a JavaScript object.

Parameter	Type	Required / Optional	Description	Since
options.record	record.Record	required	The record to be detached.	2015.2
options.record.type	string	required	The type of record to be detached. Set this value using the record.Type enum.	2015.2
options.record.id	number | string	required	The ID of the record to be detached.	2015.2
options.from	record.Record	required	The destination record that options.record should be detached from.	2015.2
options.from.type	string	required	The type of the destination. Set this value using the record.Type enum.	2015.2
options.from.id	number | string	required	The ID of the destination.	2015.2
options.attributes	Object	optional	Name-value pairs containing default values of fields in the new record. By default, this value is null.	2015.2

Errors

Error Code	Thrown If
SSS_MISSING_REQD_ARGUMENT	A required argument is missing or undefined.

Syntax

Important:

The following code sample shows the syntax for this member. It is not a functional example. For a complete promise script example, see Promise Object.

          // Add additional code
...
function detachRecord() {
    var detachRecordPromise = record.detach.promise({
        record: {
            type: record.Type.CONTACT,
            id: '98'
        },
        from: {
            type: record.Type.OPPORTUNITY,
         id: '16'
     }
    });
    
    detachRecordPromise.then(function() {
                
        // Add any other needed logic that shouldn't execute until
        // after the contact record is detached from the opportunity.
               
        log.debug({
            title: 'Record updated', 
            details: 'Contact record detached'
        });
                 
    }, function(e) {
        log.error({
            title: e.name, 
            details: e.message
        });
    });
}
... 
// Add additional code 

        

Related Topics

• N/record Module
• SuiteScript 2.x Modules
• SuiteScript 2.x

General Notices