Wix Users

User - Wix Code API References

wix-users contains functions for working with the users of your website via client-side script. We have three kinds of users: Visitors - A visitor who is not registered on your website. Affiliate - A member who is registered with your site. In order to use the users API, you must load wixUsers from the wix-users module:

wix-users provides only partial API functionality when you preview your website. wix-users can only use the wix-users api once the page is up. Therefore, you must use them in arbitrary source codes that are included in or invoked by the onReady() events handlers or any item events handlers. Retrieves the actual visitor to the site.

Retrieves a credential that contains information about the current Web site visitor. wix-users provides only partial API functionality when you preview your website. wix-users can only use the wix-users api once the page is up. Therefore, you must use them in arbitrary source codes that are included in or invoked by the onReady() events handlers or any item events handlers.

Log the actual visitor on to the website with the specified sessionsoken. appliesSessionToken () will return a promise that is resolved when the specified Session Tokens is used and the actual users are signed in to the site. Hand the return sessionoken to your client-side source and use it by invoking applySessionToken() to finish the operation initiated by one of the above mentioned operations. sessionTokenStringThe Session Tokens to be used.

Transmits a triggered e-mail to the currently registered site member. For more information about triggered emails, see: You must create at least one triggered e-mail before you can use the emailUser() feature. Indicate which e-mail to be sent by specifying the e-mail ID in the e-mailId parameters. Indicate to which member the e-mail is sent by specifying the member's ID in the member field of the parameters window topoUser.

Please note that you can only e-mail the currently registered member. When the specified Triggered E-mail contains tags, you can use the option variable to specify a value for those tags.

Unless the item you specify in the option parameters contains a key:value couple for a Triggered E-mail tag, the Triggered E-mail tag will be replaced by the default value of the Triggered E-mail fall-back. Notice that Triggered Emails creates a piece of HTML for each of your e-mail template.

How to use the created snapshot in your source is explained in How to submit a triggered e-mail with source in it. wix-users provides only partial API functionalities when you preview your website. Check a released copy of your website to see its full features. emailIdStringThe e-mail ID of the triggered e-mail to be sent. anUserStringThe user ID of the currently logged in member. AvailableChoices ( optional)TriggeredEmailOptionsVariable value that can be inserted into the e-mail.

In case of fulfilmentWhen the e-mail is sent. StringError refusal messages. Log in a username on the basis of e-mail and username. Logon () will return a promise that will be resolved if the specified logon e-mail addresses and passwords are used. wix-users provides only partial API functionality when you preview your website.

Check a released copy of your site to see its full functionalities. emailStringThe e-mail addresses that you must use when the users log in. passwordString The passwords that you must use when the users log in. At fulfillmentvoidWhen the username is registered. StringError refusal messages. Removes the active subscriber from the website.

To log off the actual visitor from the website, use the logout() command. wix-users provides only partial API functionality when you preview your website. wix-users can only use the wix-users api once the page is up. Therefore, you must use them in arbitrary source codes that are included in or invoked by the onReady() events handlers or any item events handlers.

Set the operation that is executed when a logon is made. You can use the onLogin() command to execute arbitrary codes after a successful login to your website. Normally, you want to call the onLogin() feature on the Site page of the source control so that the onLogin() events handlers are executed regardless of which page on your site a visitor signs in with.

wix-users provides only partial API functionality when you preview your website. wix-users can only use the wix-users api once the page is up. Therefore, you must use it in coding that is included in or invoked by the onReady() Event Handlers or any item Eventhandler. handlerfunction(user)The name of the command or command phrase to execute when a users logon. userUser The person who logs on.

Requests the actual website owner with a passwort resets. has a Promise that will be resolved if the end users have filled out the forgotten passwords again. You cannot call the promptForgotPassword() feature until the page is finished. wix-users provides only partial API functionality when you preview your website. wix-users can only use the wix-users api once the page is up.

Therefore, you must use them in and call arbitrary eventhandler codes included in the onReady() events handlers or any item events handlers. StringThe speech of the reset password form. xguage ( optional)StringThe speech of the reset password form. xguage( optional)StringThe speech of the reset password form. rejectedStringMessage that the dialogue was aborted, the current login has been performed or for some other reasons the resets fail.

Invites the actual website owner to register as a member of the website. prompLogin () will return a promise that dissolves for the new logon when the logon is complete. You cannot call the promptLogin() command until the page is finished. wix-users provides only partial API functionality when you preview your website.

wix-users can only use the wix-users api once the page is up. Therefore, you must use them in coding that is included in or invoked by the onReady() events handlers or any item events handlers. optionsLoginOptionsThe options, which control how the logon prompt is displayed. On- fulfillmentUserInformation about the new registered users.

StringMessage that the dialogue was aborted or for another cause for which the end users did not login. Registers () will return a promise that will be resolved into a RegistrationResult item if the subscriber is either enrolled or awaiting enrollment. Once the register() feature is set for auto-permission, it will return an " Activated " state and the end users will become members of the site.

Once the register() feature is set for hand permission, it will return the outstanding state and the visitor will become a outstanding member of the site. To enable a outstanding username, the site holder can authorize the username using the Contacts utility or you can call the approveByToken() or approveByEmail() checkbox.

wix-users provides only partial API functionality when you preview your website. If member enrollment is configured for automatic permission, the call to the register() feature on the clients side is just as safe as the call from the back-end is. emailStringThe e-mail to be used when signing up the visitor as a member of the site. passwordStringThe passphrase used by the new member of the site to login. options ( optional) RegistrationOptionsRegistration option.

This is an item used by the promptLogin() feature to specify how the logon prompt is displayed. StringWhat kind of logon information to present: By default, the selected item in the Member Registration Settings area of the Editor is selected. long (optional) StringThe two-digit locale identifier of the locale in which the registration forms are displayed.

This is an item that contains information about the results of a page registry. statusStringRegistrationState. ApprovalToken (optional) StringA flag to release the site member as a site member with the approveByToken() feature. You can securely transfer the password by e-mail or from the client-side security key to the back-end security key.

Available only when the state is " Outstanding ". Operator The operator who has been logged in. VariableObjectAn Object with key:value pairs, whereby each of the keys is a value in the e-mail templates generated in Triggered Emails and the corresponding value is the value to be inserted in the templates instead of a number.