AgileApps Support Wiki Pre Release

Difference between revisions of "ChangeOwnerShipInfo"

From AgileApps Support Wiki
imported>Aeric
imported>Aeric
Line 14: Line 14:
Result result;
Result result;
result = Functions.changeOwnerShipInfo(String objectId, String recordId,
result = Functions.changeOwnerShipInfo(String objectId, String recordId,
                                       String ownerId [, Parameters params] );
                                       String ownerId [, Boolean notifyEmail] );
</syntaxhighlight>
</syntaxhighlight>


Line 21: Line 21:
:'''recordId -''' The record identifier
:'''recordId -''' The record identifier
:'''ownerId -''' User ID of the new owner.
:'''ownerId -''' User ID of the new owner.
:'''params -''' An optional [[Parameters Class|Parameters]] object that contains additional parameters:
:'''notifyEmail-''' An optional parameter. Set to true to send the new owner an email notification.
::*'''notifyEmail -''' A Boolean. Set to true to send the new user an email notification.


;Returns:
;Returns:

Revision as of 21:23, 16 September 2011

Change the owner of a record.

Requirements

To perform this operation, you must either:

Notepad.png

Note: When adding a record with the addRecord method, it is only necessary to specify the owner in the requestParams:
  requestParams.add("owner_id", "new user id");

Syntax
<syntaxhighlight lang="java" enclose="div">

Result result; result = Functions.changeOwnerShipInfo(String objectId, String recordId,

                                      String ownerId [, Boolean notifyEmail] );

</syntaxhighlight>

Parameters
objectId - The object identifier
recordId - The record identifier
ownerId - User ID of the new owner.
notifyEmail- An optional parameter. Set to true to send the new owner an email notification.
Returns
Result object
Throws
Exception