class UserStateItemHandler[S <: SocialStateItem] extends SocialStateItemHandler
Handles user defined state.
- S
The type of the user state.
- Alphabetic
- By Inheritance
- UserStateItemHandler
- SocialStateItemHandler
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new UserStateItemHandler(item: S)(implicit format: Format[S], classTag: ClassTag[S])
- item
The user state item.
- format
The JSON format to the transform the user state into JSON and vice versa.
- classTag
The class tag for the user state item.
Type Members
- type Item = S
The item the handler can handle.
The item the handler can handle.
- Definition Classes
- UserStateItemHandler → SocialStateItemHandler
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def canHandle[B](itemStructure: ItemStructure)(implicit request: ExtractableRequest[B]): Boolean
Indicates if a handler can handle the given unserialized state item.
Indicates if a handler can handle the given unserialized state item.
This method should check if the unserialize method of this handler can unserialize the given serialized state item.
- B
The type of the request body.
- itemStructure
The item to check for.
- request
The request instance to get additional data to validate against.
- returns
True if the handler can handle the given state item, false otherwise.
- Definition Classes
- UserStateItemHandler → SocialStateItemHandler
- def canHandle(socialStateItem: SocialStateItem): Option[Item]
Indicates if a handler can handle the given
SocialStateItem.Indicates if a handler can handle the given
SocialStateItem.This method should check if the serialize method of this handler can serialize the given unserialized state item.
- socialStateItem
The item to check for.
- returns
Some[Item]casted state item if the handler can handle the given state item,Noneotherwise.
- Definition Classes
- UserStateItemHandler → SocialStateItemHandler
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @IntrinsicCandidate() @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @IntrinsicCandidate() @native()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def item(implicit ec: ExecutionContext): Future[Item]
Gets the state item the handler can handle.
Gets the state item the handler can handle.
- ec
The execution context to handle the asynchronous operations.
- returns
The state params the handler can handle.
- Definition Classes
- UserStateItemHandler → SocialStateItemHandler
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @IntrinsicCandidate() @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @IntrinsicCandidate() @native()
- def serialize(itemStructure: Item): ItemStructure
Returns a serialized value of the state item.
Returns a serialized value of the state item.
- itemStructure
The state item to serialize.
- returns
The serialized state item.
- Definition Classes
- UserStateItemHandler → SocialStateItemHandler
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- def unserialize[B](itemStructure: ItemStructure)(implicit request: ExtractableRequest[B], ec: ExecutionContext): Future[Item]
Unserializes the state item.
Unserializes the state item.
- B
The type of the request body.
- itemStructure
The state item to unserialize.
- request
The request instance to get additional data to validate against.
- ec
The execution context to handle the asynchronous operations.
- returns
The unserialized state item.
- Definition Classes
- UserStateItemHandler → SocialStateItemHandler
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
Deprecated Value Members
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated
- Deprecated
(Since version 9)