SalesforceSoapClient

# Class: SforcePartnerClient Source Location: /soapclient/SforcePartnerClient.php
### Class Overview
    SforceBaseClient
       |
       --SforcePartnerClient
SforcePartnerClient class. | ### Constants PARTNER_NAMESPACE | ### Methods SforcePartnerClient create merge sendMassEmail sendSingleEmail update upsert
### Inherited Variables #### Class: SforceBaseClient SforceBaseClient::$assignmentRuleHeader SforceBaseClient::$callOptions SforceBaseClient::$client_id SforceBaseClient::$emailHeader SforceBaseClient::$location SforceBaseClient::$loginScopeHeader SforceBaseClient::$mruHeader SforceBaseClient::$namespace SforceBaseClient::$queryHeader SforceBaseClient::$sessionHeader SforceBaseClient::$sessionId SforceBaseClient::$sforce SforceBaseClient::$userTerritoryDeleteHeader SforceBaseClient::$version | ### Inherited Methods #### Class: SforceBaseClient SforceBaseClient::convertLead() Converts a Lead into an Account, Contact, or (optionally) an Opportunity. SforceBaseClient::createConnection() Connect method to www.salesforce.com SforceBaseClient::delete() Deletes one or more new individual objects to your organization's data. SforceBaseClient::describeGlobal() Retrieves a list of available objects for your organization's data. SforceBaseClient::describeLayout() Use describeLayout to retrieve information about the layout (presentation SforceBaseClient::describeSObject() Describes metadata (field list and object properties) for the specified object. SforceBaseClient::describeSObjects() An array-based version of describeSObject; describes metadata (field list and object properties) for the specified object or array of objects. SforceBaseClient::describeTabs() The describeTabs call returns information about the standard apps and custom apps, if any, available for the user who sends the call, including the list of tabs defined for each app. SforceBaseClient::emptyRecycleBin() Deletes one or more new individual objects to your organization's data. SforceBaseClient::getConnection() SforceBaseClient::getDeleted() Retrieves the list of individual objects that have been deleted within the given timespan for the specified object. SforceBaseClient::getFunctions() SforceBaseClient::getLastRequest() SforceBaseClient::getLastRequestHeaders() SforceBaseClient::getLastResponse() SforceBaseClient::getLastResponseHeaders() SforceBaseClient::getLocation() SforceBaseClient::getNamespace() SforceBaseClient::getServerTimestamp() Retrieves the current system timestamp (GMT) from the Web service. SforceBaseClient::getSessionId() SforceBaseClient::getTypes() SforceBaseClient::getUpdated() Retrieves the list of individual objects that have been updated (added or changed) within the given timespan for the specified object. SforceBaseClient::getUserInfo() SforceBaseClient::login() Login to Salesforce.com and starts a client session. SforceBaseClient::printDebugInfo() SforceBaseClient::processSubmitRequest() Process Submit Request for Approval SforceBaseClient::processWorkitemRequest() Process Work Item Request for Approval SforceBaseClient::query() Executes a query against the specified object and returns data that matches the specified criteria. SforceBaseClient::queryAll() Retrieves data from specified objects, whether or not they have been deleted. SforceBaseClient::queryMore() Retrieves the next batch of objects from a query. SforceBaseClient::resetPassword() Changes a user's password to a system-generated value. SforceBaseClient::retrieve() Retrieves one or more objects based on the specified object IDs. SforceBaseClient::search() Executes a text search in your organization's data. SforceBaseClient::sendMassEmail() SforceBaseClient::sendSingleEmail() SforceBaseClient::setAssignmentRuleHeader() SforceBaseClient::setCallOptions() SforceBaseClient::setEmailHeader() SforceBaseClient::setEndpoint() Set the endpoint. SforceBaseClient::setLoginScopeHeader() SforceBaseClient::setMruHeader() SforceBaseClient::setPassword() Sets the specified user's password to the specified value. SforceBaseClient::setQueryOptions() SforceBaseClient::setSessionHeader() SforceBaseClient::setUserTerritoryDeleteHeader() SforceBaseClient::undelete() Deletes one or more new individual objects to your organization's data. SforceBaseClient::_convertToAny() SforceBaseClient::_create() SforceBaseClient::_merge() SforceBaseClient::_process() SforceBaseClient::_sendEmail() SforceBaseClient::_setLoginHeader() Specifies the session ID returned from the login server after a successful login. SforceBaseClient::_update() SforceBaseClient::_upsert()
### Class Details [line 40] SforcePartnerClient class. [ Top ] ### Class Methods ### constructor SforcePartnerClient [line 43]
`SforcePartnerClient SforcePartnerClient( )`
[ Top ] ### method create [line 54]
`SaveResult create( array $sObjects, AssignmentRuleHeader $assignment_header, MruHeader $mru_header)`
Adds one or more new individual objects to your organization's data. #### Tags:
access: | public
#### Parameters:
array | $sObjects | Array of one or more sObjects (up to 200) to create.
AssignmentRuleHeader | $assignment_header | is optional. Defaults to NULL
MruHeader | $mru_header | is optional. Defaults to NULL
[ Top ] ### method merge [line 72]
`unknown merge( stdclass $mergeRequest, String $type)`
Merge records #### Tags:
access: | public
#### Parameters:
stdclass | $mergeRequest |
String | $type |
[ Top ] ### method sendMassEmail [line 98]
`void sendMassEmail( $request)`
#### Tags:
access: | public
Overrides SforceBaseClient::sendMassEmail() (parent method not documented) #### Parameters:
| $request |
[ Top ] ### method sendSingleEmail [line 83]
`void sendSingleEmail( $request)`
#### Tags:
access: | public
Overrides SforceBaseClient::sendSingleEmail() (parent method not documented) #### Parameters:
| $request |
[ Top ] ### method update [line 120]
`UpdateResult update( array $sObjects, AssignmentRuleHeader $assignment_header, MruHeader $mru_header)`
Updates one or more new individual objects to your organization's data. #### Tags:
access: | public
#### Parameters:
AssignmentRuleHeader | $assignment_header | is optional. Defaults to NULL
MruHeader | $mru_header | is optional. Defaults to NULL
array | $sObjects | sObjects Array of sObjects
[ Top ] ### method upsert [line 141]
`UpsertResult upsert( string $ext_Id, array $sObjects)`
Creates new objects and updates existing objects; uses a custom field to determine the presence of existing objects. In most cases, we recommend that you use upsert instead of create because upsert is idempotent. Available in the API version 7.0 and later. #### Tags:
access: | public
#### Parameters:
string | $ext_Id | External Id
array | $sObjects | Array of sObjects
[ Top ] ### Class Constants #### PARTNER_NAMESPACE = 'urn:partner.soap.sforce.com' [line 41] [ Top ] Documentation generated on Fri, 15 Feb 2008 14:42:34 -0800 by phpDocumentor 1.3.1