public function RestClientInterface::objectDelete in Salesforce Suite 5.0.x

Same name and namespace in other branches

1. 8.4 src/Rest/RestClientInterface.php \Drupal\salesforce\Rest\RestClientInterface::objectDelete()
2. 8.3 src/Rest/RestClientInterface.php \Drupal\salesforce\Rest\RestClientInterface::objectDelete()

Delete a Salesforce object.

Note: if Object with given $id doesn't exist, objectDelete() will assume success unless $throw_exception is given.

Parameters

string $name: Object type name, E.g., Contact, Account.

string $id: Salesforce id of the object.

bool $throw_exception: (optional) If TRUE, 404 response code will cause RequestException to be thrown. Otherwise, hide those errors. Default is FALSE.

Return value

null Delete() doesn't return any data. Examine HTTP response or Exception.

1 method overrides RestClientInterface::objectDelete()

RestClient::objectDelete in src/Rest/RestClient.php

Delete a Salesforce object.

File

src/Rest/RestClientInterface.php, line 315

Class

RestClientInterface

Objects, properties, and methods to communicate with the Salesforce REST API.

Namespace

Drupal\salesforce\Rest

Code

public function objectDelete($name, $id, $throw_exception = FALSE);