MethodCallSession class
When a call is made to the Server a MethodCallSession object is created. It contains all data associated with the current connection and provides easy access to the database.
Constructors
- MethodCallSession({required Server server, required Uri uri, required String body, required String endpointName, required HttpRequest httpRequest, String? authenticationKey, bool enableLogging = true})
- Creates a new Session for a method call to an endpoint.
Properties
- auth ↔ UserAuthetication
-
Methods related to user authentication.
latefinalinherited
- authenticationKey → String?
-
The authentication key passed from the client.
no setterinherited
- body → String
-
The body of the server call.
final
- caches → Caches
-
Provides access to all caches used by the server.
no setterinherited
- db ↔ Database
-
Access to the database.
latefinalinherited
- duration → Duration
-
Returns the duration this session has been open.
no setterinherited
- enableLogging → bool
-
True if logging is enabled for this session. Normally, logging should be
enabled but it will be disabled for internal sessions used by Serverpod.
finalinherited
- endpointName → String
-
The name of the called Endpoint.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- httpRequest → HttpRequest
-
The HttpRequest associated with the call.
final
-
isUserSignedIn
→ Future<
bool> -
Returns true if the user is signed in.
no setterinherited
- maxLifeTime → Duration
-
Max lifetime of the session, after it will be forcefully terminated.
finalinherited
- messages ↔ MessageCentralAccess
-
Access to the MessageCentral for passing real time messages between
web socket streams and other listeners.
getter/setter pairinherited
- methodName ↔ String
-
The name of the method that is being called.
latefinal
-
passwords
→ Map<
String, String> -
Map of passwords loaded from config/passwords.yaml
no setterinherited
-
queryParameters
↔ Map<
String, dynamic> -
Query parameters of the server call.
latefinal
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
scopes
→ Future<
Set< Scope> ?> -
Returns the scopes associated with an authenticated user.
no setterinherited
- server → Server
-
The Server that created the session.
finalinherited
- serverpod → Serverpod
-
The Serverpod this session is running on.
no setterinherited
- sessionLogs ↔ SessionLogEntryCache
-
Log messages saved during the session.
latefinalinherited
- startTime → DateTime
-
The time the session object was created.
no setterinherited
- storage ↔ StorageAccess
-
Provides access to the cloud storages used by this Serverpod.
latefinalinherited
- uri → Uri
-
The uri that was used to call the server.
final
- userObject ↔ dynamic
-
An custom object associated with this Session. This is especially
useful for keeping track of the state in a
StreamingEndpoint
.getter/setter pairinherited
Methods
-
close(
{dynamic error, StackTrace? stackTrace}) → Future< int?> -
Closes the session. This method should only be called if you have
manually created a the Session e.g. by calling
createSession
on Serverpod. Closing the session finalizes and writes logs to the database. After a session has been closed, you should not call any more methods on it. Optionally pass in anerror
/exception andstackTrace
if the session ended with an error and it should be written to the logs. Returns the session id, if the session has been logged to the database.inherited -
log(
String message, {LogLevel? level, dynamic exception, StackTrace? stackTrace}) → void -
Logs a message. Default LogLevel is LogLevel.info. The log is written
to the database when the session is closed.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited