ProtoUser

Value Members

1. def != (arg0: AnyRef) : Boolean

   attributes: final

   definition classes: AnyRef

2. def != (arg0: Any) : Boolean

   o != arg0 is the same as !(o == (arg0)).

   o != arg0 is the same as !(o == (arg0)).

   arg0

   the object to compare against this object for dis-equality.

   returns

   false if the receiver object is equivalent to the argument; true otherwise.

   attributes: final

   definition classes: Any

3. def ## () : Int

   attributes: final

   definition classes: AnyRef → Any

4. def $asInstanceOf [T0] () : T0

   attributes: final

   definition classes: AnyRef

5. def $isInstanceOf [T0] () : Boolean

   attributes: final

   definition classes: AnyRef

6. def == (arg0: AnyRef) : Boolean

   o == arg0 is the same as if (o eq null) arg0 eq null else o.equals(arg0).

   o == arg0 is the same as if (o eq null) arg0 eq null else o.equals(arg0).

   arg0

   the object to compare against this object for equality.

   returns

   true if the receiver object is equivalent to the argument; false otherwise.

   attributes: final

   definition classes: AnyRef

7. def == (arg0: Any) : Boolean

   o == arg0 is the same as o.equals(arg0).

   o == arg0 is the same as o.equals(arg0).

   arg0

   the object to compare against this object for equality.

   returns

   true if the receiver object is equivalent to the argument; false otherwise.

   attributes: final

   definition classes: Any

8. object AddUserMenusAfter extends LocParam[Any] with Product

   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

9. object AddUserMenusHere extends LocParam[Any] with Product

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

10. object AddUserMenusUnder extends LocParam[Any] with Product

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

11. lazy val ItemList : List[MenuItem]

12. def actionsAfterSignup (theUser: TheUserType, func: () ⇒ Nothing) : Nothing

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

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

    attributes: protected

13. def asInstanceOf [T0] : T0

    This method is used to cast the receiver object to be of type T0.

    This method is used to cast the receiver object to be of type T0.

    Note that the success of a cast at runtime is modulo Scala's erasure semantics. Therefore the expression1.asInstanceOf[String] will throw a ClassCastException at runtime, while the expressionList(1).asInstanceOf[List[String]] will not. In the latter example, because the type argument is erased as part of compilation it is not possible to check whether the contents of the list are of the requested typed.

    returns

    the receiver object.

    attributes: final

    definition classes: Any

14. var autologinFunc : Box[() ⇒ Unit]

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

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

15. val basePath : List[String]

16. def bccEmail : Box[String]

17. implicit def buildFieldBridge (from: FieldPointerType) : FieldPointerBridge

    Based on a FieldPointer, build a FieldPointerBridge

    Based on a FieldPointer, build a FieldPointerBridge

    attributes: protected implicit abstract

18. def capturePreLoginState () : () ⇒ Unit

    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.

    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.

    attributes: protected

19. def changePassword : NodeSeq

20. def changePasswordMenuLoc : Box[Menu]

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

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

21. def changePasswordMenuLocParams : List[LocParam[Unit]]

    The LocParams for the menu item for changing password.

    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!

    attributes: protected

22. lazy val changePasswordPath : List[String]

23. def changePasswordSuffix : String

24. def changePasswordXhtml : Elem

25. def clone () : AnyRef

    This method creates and returns a copy of the receiver object.

    This method creates and returns a copy of the receiver object.

    The default implementation of the clone method is platform dependent.

    returns

    a copy of the receiver object.

    attributes: protected

    definition classes: AnyRef

26. def computeFieldFromPointer (instance: TheUserType, pointer: FieldPointerType) : Box[BaseField]

    Given an instance of TheCrudType and FieldPointerType, convert that to an actual instance of a BaseField on the instance of TheCrudType

    Given an instance of TheCrudType and FieldPointerType, convert that to an actual instance of a BaseField on the instance of TheCrudType

    attributes: protected abstract

27. def createNewUserInstance () : TheUserType

    Create a new instance of the User

    Create a new instance of the User

    attributes: protected abstract

28. def createUserMenuLoc : Box[Menu]

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

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

29. def createUserMenuLocParams : List[LocParam[Unit]]

    The LocParams for the menu item for creating the user/sign up.

    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!

    attributes: protected

30. def currentUser : Box[TheUserType]

31. def currentUserId : Box[String]

32. def destroySessionOnLogin : Boolean

    By default, destroy the session on login.

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

    attributes: protected

33. def edit : NodeSeq

34. def editFields : List[FieldPointerType]

    The list of fields presented to the user for editing

    The list of fields presented to the user for editing

    attributes: abstract

35. object editFunc extends RequestVar[Box[() ⇒ NodeSeq]]

36. lazy val editPath : List[String]

37. def editSuffix : String

38. def editUserMenuLoc : Box[Menu]

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

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

39. def editUserMenuLocParams : List[LocParam[Unit]]

    The LocParams for the menu item for editing the user.

    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!

    attributes: protected

40. def editXhtml (user: TheUserType) : Elem

41. def emailFrom : String

42. def eq (arg0: AnyRef) : Boolean

    This method is used to test whether the argument (arg0) is a reference to the receiver object (this).

    This method is used to test whether the argument (arg0) is a reference to the receiver object (this).

    The eq method implements an [http://en.wikipedia.org/wiki/Equivalence_relation equivalence relation] on non-null instances of AnyRef: * It is reflexive: for any non-null instance x of type AnyRef, x.eq(x) returns true. * It is symmetric: for any non-null instances x and y of type AnyRef, x.eq(y) returns true if and only if y.eq(x) returns true. * It is transitive: for any non-null instances x, y, and z of type AnyRef if x.eq(y) returns true and y.eq(z) returns true, then x.eq(z) returns true.

    Additionally, the eq method has three other properties. * It is consistent: for any non-null instances x and y of type AnyRef, multiple invocations of x.eq(y) consistently returns true or consistently returns false. * For any non-null instance x of type AnyRef, x.eq(null) and null.eq(x) returns false. * null.eq(null) returns true.

    When overriding the equals or hashCode methods, it is important to ensure that their behavior is consistent with reference equality. Therefore, if two objects are references to each other (o1 eq o2), they should be equal to each other (o1 == o2) and they should hash to the same value (o1.hashCode == o2.hashCode).

    arg0

    the object to compare against this object for reference equality.

    returns

    true if the argument is a reference to the receiver object; false otherwise.

    attributes: final

    definition classes: AnyRef

43. def equals (arg0: Any) : Boolean

    This method is used to compare the receiver object (this) with the argument object (arg0) for equivalence.

    This method is used to compare the receiver object (this) with the argument object (arg0) for equivalence.

    The default implementations of this method is an [http://en.wikipedia.org/wiki/Equivalence_relation equivalence relation]: * It is reflexive: for any instance x of type Any, x.equals(x) should return true. * It is symmetric: for any instances x and y of type Any, x.equals(y) should return true if and only if y.equals(x) returns true. * It is transitive: for any instances x, y, and z of type AnyRef if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.

    If you override this method, you should verify that your implementation remains an equivalence relation. Additionally, when overriding this method it is often necessary to override hashCode to ensure that objects that are "equal" (o1.equals(o2) returns true) hash to the same scala.Int (o1.hashCode.equals(o2.hashCode)).

    arg0

    the object to compare against this object for equality.

    returns

    true if the receiver object is equivalent to the argument; false otherwise.

    definition classes: AnyRef → Any

44. def finalize () : Unit

    This method is called by the garbage collector on the receiver object when garbage collection determines that there are no more references to the object.

    This method is called by the garbage collector on the receiver object when garbage collection determines that there are no more references to the object.

    The details of when and if the finalize method are invoked, as well as the interaction between finalizeand non-local returns and exceptions, are all platform dependent.

    attributes: protected

    definition classes: AnyRef

45. def findUserByUniqueId (id: String) : Box[TheUserType]

    Given a unique id, find the user

    Given a unique id, find the user

    attributes: protected abstract

46. def findUserByUserName (username: String) : Box[TheUserType]

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

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

    attributes: protected abstract

47. def generateResetEmailBodies (user: TheUserType, resetLink: String) : List[MailBodyType]

    Generate the mail bodies to send with the password reset link.

    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.

    attributes: protected

48. def generateValidationEmailBodies (user: TheUserType, resetLink: String) : List[MailBodyType]

    Generate the mail bodies to send with the valdiation link.

    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.

    attributes: protected

49. def getClass () : java.lang.Class[_]

    Returns a representation that corresponds to the dynamic class of the receiver object.

    Returns a representation that corresponds to the dynamic class of the receiver object.

    The nature of the representation is platform dependent.

    returns

    a representation that corresponds to the dynamic class of the receiver object.

    attributes: final

    definition classes: AnyRef

50. def hashCode () : Int

    Returns a hash code value for the object.

    Returns a hash code value for the object.

    The default hashing algorithm is platform dependent.

    Note that it is allowed for two objects to have identical hash codes (o1.hashCode.equals(o2.hashCode)) yet not be equal (o1.equals(o2) returns false). A degenerate implementation could always return 0. However, it is required that if two objects are equal (o1.equals(o2) returns true) that they have identical hash codes (o1.hashCode.equals(o2.hashCode)). Therefore, when overriding this method, be sure to verify that the behavior is consistent with the equals method.

    returns

    the hash code value for the object.

    definition classes: AnyRef → Any

51. def homePage : String

52. def isInstanceOf [T0] : Boolean

    This method is used to test whether the dynamic type of the receiver object is T0.

    This method is used to test whether the dynamic type of the receiver object is T0.

    Note that the test result of the test is modulo Scala's erasure semantics. Therefore the expression1.isInstanceOf[String] will return false, while the expression List(1).isInstanceOf[List[String]] will return true. In the latter example, because the type argument is erased as part of compilation it is not possible to check whether the contents of the list are of the requested typed.

    returns

    true if the receiver object is an instance of erasure of type T0; false otherwise.

    attributes: final

    definition classes: Any

53. def localForm (user: TheUserType, ignorePassword: Boolean, fields: List[FieldPointerType]) : NodeSeq

    attributes: protected

54. def logUserIdIn (id: String) : Unit

55. def logUserIn (who: TheUserType) : Unit

56. def logUserIn (who: TheUserType, postLogin: () ⇒ Nothing) : Nothing

57. def logUserOut () : Unit

58. def loggedIn_? : Boolean

59. def login : NodeSeq

60. def loginFirst : If

61. def loginMenuLoc : Box[Menu]

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

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

62. def loginMenuLocParams : List[LocParam[Unit]]

    The LocParams for the menu item for login.

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

    attributes: protected

63. def loginPageURL : String

    Return the URL of the "login" page

    Return the URL of the "login" page

64. lazy val loginPath : List[String]

65. object loginRedirect extends SessionVar[Box[String]]

66. def loginSuffix : String

67. def loginXhtml : Elem

68. def logout : Nothing

69. def logoutCurrentUser : Unit

70. def logoutMenuLoc : Box[Menu]

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

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

71. def logoutMenuLocParams : List[LocParam[Unit]]

    The LocParams for the menu item for logout.

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

    attributes: protected

72. lazy val logoutPath : List[String]

73. def logoutSuffix : String

74. def lostPassword : NodeSeq

75. def lostPasswordMenuLoc : Box[Menu]

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

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

76. def lostPasswordMenuLocParams : List[LocParam[Unit]]

    The LocParams for the menu item for lost password.

    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!

    attributes: protected

77. lazy val lostPasswordPath : List[String]

78. def lostPasswordSuffix : String

79. def lostPasswordXhtml : Elem

80. def menus : List[Menu]

    An alias for the sitemap property

    An alias for the sitemap property

81. def mutateUserOnEdit (user: TheUserType) : TheUserType

    If there's any mutation to do to the user on retrieval for editting, override this method and mutate the user.

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

    user

    the user to mutate

    returns

    the mutated user

    attributes: protected

82. def mutateUserOnSignup (user: TheUserType) : TheUserType

    If there's any mutation to do to the user on creation for signup, override this method and mutate the user.

    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

    user

    the user to mutate

    returns

    the mutated user

    attributes: protected

83. def ne (arg0: AnyRef) : Boolean

    o.ne(arg0) is the same as !(o.eq(arg0)).

    o.ne(arg0) is the same as !(o.eq(arg0)).

    arg0

    the object to compare against this object for reference dis-equality.

    returns

    false if the argument is not a reference to the receiver object; true otherwise.

    attributes: final

    definition classes: AnyRef

84. def niceName (inst: TheUserType) : String

    Get a nice name for the user

    Get a nice name for the user

85. def niceNameWEmailLink (inst: TheUserType) : Elem

    Get an email link for the user

    Get an email link for the user

86. def notLoggedIn_? : Boolean

87. def notify () : Unit

    Wakes up a single thread that is waiting on the receiver object's monitor.

    Wakes up a single thread that is waiting on the receiver object's monitor.

    attributes: final

    definition classes: AnyRef

88. def notifyAll () : Unit

    Wakes up all threads that are waiting on the receiver object's monitor.

    Wakes up all threads that are waiting on the receiver object's monitor.

    attributes: final

    definition classes: AnyRef

89. var onLogIn : List[(TheUserType) ⇒ Unit]

90. var onLogOut : List[(Box[TheUserType]) ⇒ Unit]

91. def passwordReset (id: String) : NodeSeq

92. def passwordResetEmailSubject : String

93. def passwordResetMailBody (user: TheUserType, resetLink: String) : Elem

94. lazy val passwordResetPath : List[String]

95. def passwordResetSuffix : String

96. def passwordResetXhtml : Elem

97. def resetPasswordMenuLoc : Box[Menu]

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

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

98. def resetPasswordMenuLocParams : List[LocParam[Unit]]

    The LocParams for the menu item for resetting the password.

    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!

    attributes: protected

99. def screenWrap : Box[Node]

    What template are you going to wrap the various nodes in

    What template are you going to wrap the various nodes in

100. def sendPasswordReset (email: String) : Unit

     Send password reset email to the user.

     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.

101. def sendValidationEmail (user: TheUserType) : Unit

     Send validation email to the user.

     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.

102. def shortName (inst: TheUserType) : String

     Get a nice name for the user

     Get a nice name for the user

103. lazy val signUpPath : List[String]

104. def signUpSuffix : String

105. def signup : NodeSeq

106. def signupFields : List[FieldPointerType]

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

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

     attributes: abstract

107. object signupFunc extends RequestVar[Box[() ⇒ NodeSeq]]

     attributes: protected

108. def signupMailBody (user: TheUserType, validationLink: String) : Elem

109. def signupMailSubject : String

110. def signupXhtml (user: TheUserType) : Elem

111. lazy val sitemap : List[Menu]

112. def sitemapMutator : (SiteMap) ⇒ SiteMap

     The SiteMap mutator function

     The SiteMap mutator function

113. def skipEmailValidation : Boolean

114. def snarfLastItem : String

     attributes: protected

115. def superUser_? : Boolean

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

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

116. def synchronized [T0] (arg0: T0) : T0

     attributes: final

     definition classes: AnyRef

117. def testLoggedIn (page: String) : Boolean

118. lazy val testLogginIn : If

119. lazy val testSuperUser : If

120. def thePath (end: String) : List[String]

121. def toString () : String

     Returns a string representation of the object.

     Returns a string representation of the object.

     The default representation is platform dependent.

     returns

     a string representation of the object.

     definition classes: AnyRef → Any

122. implicit def typeToBridge (in: TheUserType) : UserBridge

     Convert an instance of TheUserType to the Bridge trait

     Convert an instance of TheUserType to the Bridge trait

     attributes: protected implicit abstract

123. def userFromStringId (id: String) : Box[TheUserType]

     Given a String representing the User ID, find the user

     Given a String representing the User ID, find the user

     attributes: protected abstract

124. def userMenu : List[Node]

125. def userNameFieldString : String

     How do we prompt the user for the username.

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

126. def userNameNotFoundString : String

     The string that's generated when the user name is not found.

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

127. def validateSignup (user: TheUserType) : List[FieldError]

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

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

128. def validateUser (id: String) : NodeSeq

129. def validateUserMenuLoc : Box[Menu]

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

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

130. def validateUserMenuLocParams : List[LocParam[Unit]]

     The LocParams for the menu item for validating a user.

     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!

     attributes: protected

131. lazy val validateUserPath : List[String]

132. def validateUserSuffix : String

133. def wait () : Unit

     attributes: final

     definition classes: AnyRef

134. def wait (arg0: Long, arg1: Int) : Unit

     attributes: final

     definition classes: AnyRef

135. def wait (arg0: Long) : Unit

     attributes: final

     definition classes: AnyRef

136. def wrapIt (in: NodeSeq) : NodeSeq

     attributes: protected