api/locality_social_cloud library
Classes
- AccessToken
- A class representing the current access token. It extends ChangeNotifier to allow listening for changes in the token value.
- AuthDataWatcher
- A singleton class responsible for watching and refreshing the access token when it expires. This class periodically checks if the token has expired and attempts to fetch a new one if necessary.
- Cache
- A class representing a cache that queues and processes messages before storing them in the MessageRepository. This cache ensures that messages are processed in batches rather than immediately, reducing the number of operations and increasing efficiency.
- DiscoverUsers
-
ExecuteSendMessage<
T> - GeoChannel
- Locality
- LocalityAuth
- LocalityEvent
- LocalitySocialCloud
- LocalityUser
- LoggedInUser
- Represents a user who is currently logged into the system.
- LoggedInUserOrError
- A class representing either a successfully logged-in user or an authentication error.
- MessageRepository
- PubSubSupervisor
- StandardSendMessage
- SupervisedTopic
- ThrottledChangeNotifier
- A ChangeNotifier that throttles the rate at which it notifies listeners based on the specified frames per second (FPS).
- Timeline
- WaitingMessage
- A class that manages messages waiting to be processed in a publish/subscribe system. It handles message state tracking, payload encryption, and lifecycle management. It is not a Locality Event, because Locality Events are only created upon acknowledgment by the server
Enums
- AuthError
- An enum representing different types of authentication errors that can occur.
- FetchStrategy
- PubSubType
- UserType
Mixins
- PubSub
- This is the main class for you.
Typedefs
- EventSink = dynamic Function(PubSub pubSub, LocalityEvent localityEvent)
- ExecuteWhenSynchronized = dynamic Function()
- WithNewAccessToken = dynamic Function(String newToken, DateTime expiresAt)
-
A function type alias that represents a callback to handle the event when a
new access token is received. The function takes the
newTokenand itsexpiresAttime.