Given a unique id, find the user

Given an username (probably email address), find the user

Given a String representing the User ID, find the user

Insert this LocParam into your menu if you want the User's menu items to be inserted at the same level and after the item

replace the menu that has this LocParam with the User's menu items

Insert this LocParam into your menu if you want the User's menu items to be children of that menu

If you want to redirect a user to a different page after login, put the page here

Override this method to do something else after the user signs up

Append a DispatchPF function to LiftRules.dispatch. If the partial function is defined for a give Req it will construct a new Record based on the HTTP query string parameters and will pass this Record to the function returned by func parameter.

Encode a record instance into a JObject

Returns the JSON representation of inst record

Encode a record instance into a JValue

Returns the JSON representation of inst record, converts asJValue to JsObj

This function is given a chance to log in a user programmatically when needed

The base path for the user related URLs. Override this method to change the base path

Based on a FieldPointer, build a FieldPointerBridge

If there's any state that you want to capture pre-login to be set post-login (the session is destroyed), then set the state here. Just make a function that captures the state... that function will be applied post login.

The menu item for changing password (make this "Empty" to disable)

The LocParams for the menu item for changing password. Overwrite in order to add custom LocParams. Attention: Not calling super will change the default behavior!

The computed path for change password screen

The path suffix for the change password screen

Given a field pointer and an instance, get the field on that instance

Create a new instance of the User

Creates a new record

The menu item for creating the user/sign up (make this "Empty" to disable)

The LocParams for the menu item for creating the user/sign up. Overwrite in order to add custom LocParams. Attention: Not calling super will change the default behavior!

Creates a new record, setting the value of the fields from the original object but applying the new value for the specific field

By default, destroy the session on login. Change this is some of the session information needs to be preserved.

There may be times when you want to be another user for some stack frames. Here's how to do it.

The list of fields presented to the user for editing

The computed path for the edit screen

The path suffix for the edit screen

The menu item for editing the user (make this "Empty" to disable)

The LocParams for the menu item for editing the user. Overwrite in order to add custom LocParams. Attention: Not calling super will change the default behavior!

Get a field by the field name

Defines the order of the fields in this record

Obtain the fields for a particular Record or subclass instance by passing the instance itself. (added 14th August 2009, Tim Perrett)

Set this to use your own form template when rendering a Record to a form.

This template is any given XHtml that contains three nodes acting as placeholders such as:

<lift:field_label name="firstName"/> - the label for firstName field will be rendered here
<lift:field name="firstName"/> - the firstName field will be rendered here (typically an input field)
<lift:field_msg name="firstName"/> - the  will be rendered here having the id given by
                                            uniqueFieldId of the firstName field.


Example.

Having:

class MyRecord extends Record[MyRecord] {

	def meta = MyRecordMeta

	object firstName extends StringField(this, "John")

}

object MyRecordMeta extends MyRecord with MetaRecord[MyRecord] {
 override def mutable_? = false
}

...

val rec = MyRecordMeta.createRecord.firstName("McLoud")

val template =
<div>
	<div>
		<div><lift:field_label name="firstName"/></div>
		<div><lift:field name="firstName"/></div>
		<div><lift:field_msg name="firstName"/></div>
	</div>
</div>

MyRecordMeta.formTemplate = Full(template)
rec.toForm((r:MyRecord) => println(r));

Create a record by decoding a JValue which must be a JObject

Create a record with fields populated with values from the JSON construct

Create a record with fields populated with values from the request

Generate the mail bodies to send with the password reset link. By default, just an HTML mail body is generated by calling passwordResetMailBody but you can send additional or alternative mail by overriding this method.

Generate the mail bodies to send with the valdiation link. By default, just an HTML mail body is generated by calling signupMailBody but you can send additional or alternative mail by override this method.

If you want to include a LocParam (e.g. LocGroup) on all the User menus, add them here

The application's home page

Make a new record instance. This method can be overridden to provide caching behavior or what have you.

A Menu.LocParam for testing if the user is logged in and if they're not, redirect them to the login page

The menu item for login (make this "Empty" to disable)

The LocParams for the menu item for login. Overwrite in order to add custom LocParams. Attention: Not calling super will change the default behavior!

Return the URL of the "login" page

The computed path for the login screen

The path suffix for the login screen

The menu item for logout (make this "Empty" to disable)

The LocParams for the menu item for logout. Overwrite in order to add custom LocParams. Attention: Not calling super will change the default behavior!

The computed pat for logout

The path suffix for the logout screen

The menu item for lost password (make this "Empty" to disable)

The LocParams for the menu item for lost password. Overwrite in order to add custom LocParams. Attention: Not calling super will change the default behavior!

The computed path for the lost password screen

The path suffix for the lost password screen

If you have more than 1 ProtoUser in your application, you'll need to distinguish the menu names. Do so by changing the menu name suffix so that there are no name clashes

An alias for the sitemap property

Renamed from fields() due to a clash with fields() in Record. Use this method to obtain a list of fields defined in the meta companion objects. Possibly a breaking change? (added 14th August 2009, Tim Perrett)

Specifies if this Record is mutable or not

If there's any mutation to do to the user on retrieval for editing, override this method and mutate the user. This can be used to pull query parameters from the request and assign certain fields. Issue #722

If there's any mutation to do to the user on creation for signup, override this method and mutate the user. This can be used to pull query parameters from the request and assign certain fields. . Issue #722

Get a nice name for the user

Get an email link for the user

Inverted loggedIn_?

The computed path for the reset password screen

The path suffix for the reset password screen

Prepend a DispatchPF function to LiftRules.dispatch. If the partial function is defined for a give Req it will construct a new Record based on the HTTP query string parameters and will pass this Record to the function returned by func parameter.

The menu item for resetting the password (make this "Empty" to disable)

The LocParams for the menu item for resetting the password. Overwrite in order to add custom LocParams. Attention: Not calling super will change the default behavior!

What template are you going to wrap the various nodes in

Send password reset email to the user. The XHTML version of the mail body is generated by calling passwordResetMailBody. You can customize the mail sent to users by overriding generateResetEmailBodies to send non-HTML mail or alternative mail bodies.

Send validation email to the user. The XHTML version of the mail body is generated by calling signupMailBody. You can customize the mail sent to users by override generateValidationEmailBodies to send non-HTML mail or alternative mail bodies.

Attempt to decode a JValue, which must be a JObject, into a record instance

Set from a Json String using the lift-json parser

Populate the fields of the record with values from an existing record

Populate the fields of the record with values from the request

Get a nice name for the user

The computed path for the sign up screen

The path suffix for the sign up screen

The list of fields presented to the user at sign-up

The SiteMap mutator function

Is there a user logged in and are they a superUser?

A Menu.LocParam to test if the user is logged in

A Menu.LocParam to test if the user is a super user

Calculate the path given a suffix by prepending the basePath to the suffix

Returns the XHTML representation of inst Record. You must provide the Node template to represent this record in the proprietary layout.

Returns the XHTML representation of inst Record. If formTemplate is set, this template will be used otherwise a default template is considered.

Returns the HTML representation of inst Record.

Convert an instance of TheUserType to the Bridge trait

How do we prompt the user for the username. By default, it's S.?("email.address"), you can can change it to something else

The string that's generated when the user name is not found. By default: S.?("email.address.not.found")

Validates the inst Record by calling validators for each field

Override this method to validate the user signup (eg by adding captcha verification)

The menu item for validating a user (make this "Empty" to disable)

The LocParams for the menu item for validating a user. Overwrite in order to add custom LocParams. Attention: Not calling super will change the default behavior!

The calculated path to the user validation screen

The path suffix for the validate user screen