rforcecom.getObjectDescription: The 'salesforcer' backwards compatible version of...

View source: R/compatibility.R

rforcecom.getObjectDescriptionR Documentation

The salesforcer backwards compatible version of RForcecom::rforcecom.getObjectDescription

Description

[Soft-deprecated]

Usage

rforcecom.getObjectDescription(session, objectName)

Arguments

session

list; a list containing "sessionID", "instanceURL", and "apiVersion" as returned by RForcecom::rforcecom.login. This argument is ignored in all backward compatible calls because the authorization credentials are stored in an environment internal to the salesforcer package, so it is no longer necessary to pass the session in each function call.

objectName

character; the name of the Salesforce object that the function is operating against (e.g. "Account", "Contact", "CustomObject__c").

Value

Object descriptions

Note

This function returns a data.frame with one row per field for an object.


salesforcer documentation built on March 18, 2022, 6:26 p.m.