User Service Event Handlers¶
User Registration API
beforeRegister
*argument blocks: *
Request User - user object with all the properties for the user registration.
afterRegister
return value block:
Response User - user object representing registered user.
User Login API
beforeLogin
*argument blocks: *
Request Login - contains user identity property.
Request Password - contains user's password used for logging in.
afterLogin
return value block:
Response User - contains the User object if the login operation is successful.
User Update API
beforeUpdate
*argument blocks: *
Request User - user object with the updated properties.
afterUpdate
return value block:
Response User - updated user object.
User Deletion API
beforeRemove
*argument blocks: *
Request User ID - objectId of the user object to delete.
afterRemove
return value block:
Response Result - a timestamp when the object is deleted.
Get Users Table Schema API
beforeDescribe
*argument blocks: *
None
afterDescribe
return value block:
Response UserProperties - a collection of objects describing columns of the Users table. For the details on the response see the Retrieving Schema Definition section in the REST API documentation.
Restore Password API
beforeRestorePassword
*argument blocks: *
Request Email - email address of the user requesting password recovery.
afterRestorePassword
return value block:
None
User Logout API
beforeLogout
*argument blocks: *
None
afterLogout
return value block:
None
Update Multiple Users API
beforeUpdateBulk
*argument blocks: *
Request WhereClause - the whereClause statement defining the condition for the objects which must be updated.
Request Changes - an object containing property values which will be applied to all objects matching the provided whereClause.
afterUpdateBulk
return value block:
Response Result - number of updated objects.
Remove Multiple Users API
beforeRemoveBulk
*argument blocks: *
Request WhereClause - the whereClause statement defining the condition for the objects which must be deleted.
afterRemoveBulk
return value block:
Response Result - number of deleted objects.
User Confirms Email Address
beforeEmailConfirmed
*argument blocks: *
Request EmailConfirmKey - a key identifying the user account, is a part of the link the user clicks to confirm the email.
afterEmailConfirmed
return value block:
None
User Registers through a Social Network
beforeSocialRegister
*argument blocks: *
Request UserProperties - an object with the key/value pairs defining the user.
Request SocialType - a string value identifying the social network. Possible values are "TWITTER", "FACEBOOK", "GOOGLE_PLUS".
afterSocialRegister
return value block:
Response Result - registered user object
User Logs in through a Social Network
beforeSocialLogin
*argument blocks: *
Request UserProperties - an object with the key/value pairs identifying the user.
Request SocialType - a string value identifying the social network. Possible values are "TWITTER", "FACEBOOK", "GOOGLE_PLUS".
afterSocialLogin
return value block:
Response Result - logged in user object