Packages

trait RoomsApiWrapper extends AnyRef

A trait that describes the Api wrapper for Rooms

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. RoomsApiWrapper
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def createRoom(roomName: String, playersNumber: Int)(implicit userToken: String): Future[String]

    Creates a room

    Creates a room

    roomName

    the room name

    playersNumber

    the players number

    userToken

    the token to be authenticated against api

    returns

    the future containing the identifier of the created room, or fails if roomName is empty or playersNumber not correct

  2. abstract def enterPublicRoom(playersNumber: Int, userAddress: Address, notificationAddress: Address)(implicit userToken: String): Future[Unit]

    Enters a public room

    Enters a public room

    playersNumber

    the number of players that the public room has to have

    userAddress

    the address of the paler that wants to enter

    notificationAddress

    the address where player wants to receive notification of room filling

    userToken

    the token to be authenticated against api

    returns

    the future that completes when user ha entered, or fails if players number is not correct, or user already inside a room

  3. abstract def enterRoom(roomID: String, userAddress: Address, notificationAddress: Address)(implicit userToken: String): Future[Unit]

    Enters a room

    Enters a room

    roomID

    the identifier of the room

    userAddress

    the address of the paler that wants to enter

    notificationAddress

    the address where player wants to receive notification of room filling

    userToken

    the token to be authenticated against api

    returns

    the future that completes when the user has entered, or fails if roomID not provided, not present or user already inside a room, or room full

  4. abstract def exitPublicRoom(playersNumber: Int)(implicit userToken: String): Future[Unit]

    Exits a public room

    Exits a public room

    playersNumber

    the number of players that the public room has to have

    userToken

    the token to be authenticated against api

    returns

    the future that completes when the user has exited, or fails if players number is not correct, or user not inside that room

  5. abstract def exitRoom(roomID: String)(implicit userToken: String): Future[Unit]

    Exits a room

    Exits a room

    roomID

    the identifier of the room to exit

    userToken

    the token to be authenticated against api

    returns

    the future that completes when user has exited, or fails if roomId is not provided or not present or user is not inside that room

  6. abstract def listPublicRooms()(implicit userToken: String): Future[Seq[Room]]

    retrieves a list of available public rooms

    retrieves a list of available public rooms

    userToken

    the token to be authenticated against api

    returns

    a future that completes when such list is available

  7. abstract def publicRoomInfo(playersNumber: Int)(implicit userToken: String): Future[Room]

    Retrieves information about a public room with specific number of players

    Retrieves information about a public room with specific number of players

    playersNumber

    the number of players that the public room has to have

    userToken

    the token to be authenticated against api

    returns

    the future that completes when the information is available, or fails if players number not correct

  8. abstract def roomInfo(roomID: String)(implicit userToken: String): Future[Room]

    Retrieves room information

    Retrieves room information

    roomID

    the identifier of the room

    userToken

    the token to be authenticated against api

    returns

    the future that completes when the room information is available, or fails if room id not provided or not present

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  8. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  9. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  10. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  11. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  12. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  14. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  15. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  16. def toString(): String
    Definition Classes
    AnyRef → Any
  17. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  18. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  19. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped