GoogleAccountBaseEndpoint class
abstract
Properties
hashCode → int
The hash code for this object.
no setter inherited
logSessions → bool
States if Sessions should be logged for this endpoint. Defaults to true,
override to change.
no setter inherited
moduleName → String ?
The name of the current module, or null for the main server.
no setter inherited
name → String
The name of this Endpoint. It will be automatically generated from the
name of the class (excluding any Endpoint suffix).
no setter inherited
pod → Serverpod
The ServerPod this Endpoint is running on.
no setter inherited
requiredScopes → Set <Scope >
List of Scopes that are required to access this Endpoint. Override
this getter to setup custom requirements.
no setter inherited
requireLogin → bool
States if the Endpoint only should accept users that are authenticated.
Default value is false, override to change.
no setter inherited
runtimeType → Type
A representation of the runtime type of the object.
no setter inherited
sendAsRaw → bool
If true, returned value from methods will be sent sent to the client
as raw data without any formatting. One use case is to return data through
a non-api call. Defaults to false, override to change. If used, the
endpoint method is responsible for correctly setting the contentType of
the http response (defaults to text/plain).
no setter inherited
server → Server
The Server this Endpoint is running on.
no setter inherited
Methods
authenticate (Session session , {required String idToken → Future <AuthSuccess
getUserObject (Session session → dynamic
Retrieves a custom object associated with this Endpoint and Session.
inherited
handleStreamMessage (StreamingSession session , SerializableModel message → Future <void >
Invoked when a message is sent to this endpoint from the client.
Override this method to create your own custom StreamingEndpoint.
inherited
initialize (Server server , String name , String ?moduleName → void
Initializes the endpoint with the current Server. Typically, this is
done from generated code.
inherited
noSuchMethod (Invocation invocation → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
sendStreamMessage (StreamingSession session , SerializableModel message → Future <void >
Sends an event to the client represented by the Session object.
inherited
setUserObject (Session session , dynamic userObject → void
Associate a custom object with this Endpoint and Session.
inherited
streamClosed (StreamingSession session → Future <void >
Called when a stream was closed.
inherited
streamOpened (StreamingSession session → Future <void >
Override this method to setup a new stream when a client connects to the
server.
inherited
toString ()
→ String
A string representation of this object.
inherited
