getEnclosingPrimaryTabObjectId()
Returns the object ID of the current primary tab, which contains a subtab. For example, a case ID or account ID. This method works within a primary tab or subtab. This method is only available in API version 24.0 or later.
| Name | Type | Description |
|---|---|---|
callback | function | JavaScript method that’s called upon completion of the method. |
To see this example in action, click the custom link on a case. For more information, see Define Custom Buttons and Links in Salesforce Help.
This method is asynchronous so it returns its response in an object in a callback method. The response object contains the following fields:
| Name | Type | Description |
|---|---|---|
id | string | The ID of the current primary tab that contains this subtab. |
success | boolean | true if returning the enclosing primary tab was successful; false if returning the enclosing primary tab wasn’t successful. |