GetUnsynchronisedUsers

From
(Difference between revisions)
Jump to: navigation, search
 
Line 1: Line 1:
******************Basic template for method description********************
 
 
== Method ==
 
== Method ==
Method
+
[[GetUnsynchronisedUsersResult]] getUnsynchronisedUsers([[UserIDBean]] userID, String synchronisationID, [[Calendar]] createdOnOrAfter)
  
 
== Description ==
 
== Description ==
Description
+
Gets all userswho have not been marked as synchronized, or who have been marked, but have since had their details changed or updated.  Once retrieved, a record can be marked as synchronised by calling the [[ackUserSynchronisation]] method.
  
 
== Parameters ==
 
== Parameters ==
Line 16: Line 15:
 
|The admin username and password.
 
|The admin username and password.
 
|---- bgcolor=#EDEDFF
 
|---- bgcolor=#EDEDFF
|[[Type]]
+
|String
|Name
+
|synchronisationID
|Description.
+
|The name of the flag used to check and see if the record has been marked as synchronised.
 +
|---- bgcolor=#EDEDFF
 +
|[[Calendar]]
 +
|createdOnOrAfter
 +
|Ensures that only users created on or after this time wil be retrieved.
 
|}
 
|}
  
 
== Return Value ==
 
== Return Value ==
[[ReturnValue]]
+
[[GetUnsynchronisedUsersResult]]

Revision as of 03:46, 9 June 2005

Contents

Method

GetUnsynchronisedUsersResult getUnsynchronisedUsers(UserIDBean userID, String synchronisationID, Calendar createdOnOrAfter)

Description

Gets all userswho have not been marked as synchronized, or who have been marked, but have since had their details changed or updated. Once retrieved, a record can be marked as synchronised by calling the ackUserSynchronisation method.

Parameters

Type Name Description
UserIDBean userID The admin username and password.
String synchronisationID The name of the flag used to check and see if the record has been marked as synchronised.
Calendar createdOnOrAfter Ensures that only users created on or after this time wil be retrieved.

Return Value

GetUnsynchronisedUsersResult

Personal tools
MediaWiki Appliance - Powered by TurnKey Linux