| DatStat Illume 4.5 SDK Class Reference |
|
WebServiceContext.AddParticipant Method (SDK_ParticipantList, Int32, String, String, String, String, Hashtable, Boolean, Boolean, Boolean, Boolean, SDK_Participant[]&, Boolean)
The update parameter dictates what happens if a collision is found for this overload method.
public
SDK_Participant[] AddParticipant(
SDK_ParticipantList list,
Int32 lcid,
String email,
String lastName,
String firstName,
String customId,
Hashtable dataHash,
Boolean isTest,
Boolean lastFirstNameUnique,
Boolean emailUnique,
Boolean customIdUnique,
ref SDK_Participant[]&
collisions,
Boolean update);
Parameters
-
list
- The SDK_ParticipantList that the participant is being added to.
-
lcid
- The localization Id for this participant.
-
email
- The email address of the participant.
-
lastName
- The last name of the participant.
-
firstName
- The first name of the participant.
-
customId
- A custom identifier for this participant.
-
dataHash
- A Hashtable of custom data for the participant.
-
isTest
- Boolean indicating if this participant is a test user.
-
lastFirstNameUnique
- Boolean indicating if the system should check that the full name of the participant is unique.
-
emailUnique
- Boolean indicating if the system should check that the email address of the participant is unique.
-
customIdUnique
- Boolean indicating if the system should check that the customId is unique.
-
collisions
- Ref parameter that will contain an array of SDK_Participant objects for each collision that occurs.
-
update
- Dictates what to do when collisions are found. If set to true, the existing participant will be updated with the new information. If set to false, the method will throw.
Return Value
SDK_Participant
Remarks
If a collision is found, one of two things will happen. If the parameter update is set to true, the system will try to update the existing participant with the values you have provided. If update is false, the method will throw. In either case, the collisions will be returned by the incoming ref parameter collisions. It is possible for more than one participant to be returned if update is specified as true and there is more then one collision.
See Also
WebServiceContext Class | DatStat.SDK.WebServiceWrappers Namespace | WebServiceContext.AddParticipant Overload List