AgileApps Support Wiki Pre Release

Difference between revisions of "ChangeOwnerShipInfo"

From AgileApps Support Wiki
imported>Aeric
imported>Aeric
Line 22: Line 22:
:;ownerId:User ID of the new owner.
:;ownerId:User ID of the new owner.
:;params: Optional. A [[Parameters Class|Parameters]] object that contains additional parameters.
:;params: Optional. A [[Parameters Class|Parameters]] object that contains additional parameters.
::*''' -notifyEmail -''' A Boolean. Set to true to send the new user an email notification.
:::*'''notifyEmail -''' A Boolean. Set to true to send the new user an email notification.


;Returns:
;Returns:

Revision as of 01:27, 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 [, Parameters params] );

</syntaxhighlight>

Parameters
objectId
The object identifier
recordId
The record identifier
ownerId
User ID of the new owner.
params
Optional. A Parameters object that contains additional parameters.
  • notifyEmail - A Boolean. Set to true to send the new user an email notification.
Returns
Result object

--or--

An integer containing ...
A string containing ...
Throws
Exception