location-service 5.7.0 API
API
Generated with
location-service 5.7.0 API/io.github.positionpal.location/io.github.positionpal.location.domain/Session

Session

io.github.positionpal.location.domain.Session
See theSession companion trait
object Session

Attributes

Companion
trait
Graph
Supertypes
class Object
trait Matchable
class Any
Self type
Session.type

Members list

Type members

Classlikes

final case class Snapshot(scope: Scope, userState: UserState, lastSampledLocation: Option[SampledLocation])

A snapshot of the user's state and tracking information.

A snapshot of the user's state and tracking information.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all

Value members

Concrete methods

def from(groupId: GroupId, userId: UserId, state: UserState, lastSample: Option[SampledLocation], tracking: Option[Tracking]): Session

Creates a new Session from the given groupId, userId, state, lastSample and tracking information.

Creates a new Session from the given groupId, userId, state, lastSample and tracking information.

Attributes

def from(scope: Scope, state: UserState, lastSample: Option[SampledLocation], tracking: Option[Tracking]): Session

Creates a new Session from the given scope, state, lastSample and tracking information.

Creates a new Session from the given scope, state, lastSample and tracking information.

Attributes

def of(groupId: GroupId, userId: UserId): Session

Creates a new Session for the given groupId - userId initially in the Inactive state with no tracking information.

Creates a new Session for the given groupId - userId initially in the Inactive state with no tracking information.

Value parameters

groupId

The unique identifier of the group.

userId

The unique identifier of the user.

Attributes

def of(scope: Scope): Session

Creates a new Session for the given Scope initially in the Inactive state with no tracking information.

Creates a new Session for the given Scope initially in the Inactive state with no tracking information.

Attributes

def unapply(s: Session): Option[(Scope, UserState, Option[SampledLocation], Option[Tracking])]

Extractor method for a Session, allowing pattern matching to deconstruct it into its components.

Extractor method for a Session, allowing pattern matching to deconstruct it into its components.

Value parameters

s

The Session instance to deconstruct.

Attributes

Returns

an Optional tuple with the Scope, UserState, SampledLocation and Tracking information.

Extensions

Extensions

extension (s: Session)
def toSnapshot: Snapshot

Attributes

Returns

a Snapshot from the current Session.

Generated with