ground_control_client library

Classes

AcceptedTerms
AcceptedTermsDTO
AccountAuthorization: This model and table is deprecated. Use UserInvitation instead.
Address: Represents a physical address of a person or company.
AuthenticationKeyManager: Manages keys for authentication with the server.
BadRequestMessage: A message sent when a bad request is received.
BillingInfo
Bit: Represents a binary vector, where each element is either true or false.
Capsule: Represents an infrastructure capsule instance (a deployment target).
CapsuleResource
Client
CloseMethodStreamCommand: A message sent over a websocket connection to close a websocket stream of data to an endpoint method.
ConnectivityMonitor: Keeps track of internet connectivity and notifies its listeners when the internet connection is either lost or regained. For most use cases, use the concrete FlutterConnectivityMonitor class in the serverpod_flutter package.
CustomDomainName
CustomDomainNameList
CustomDomainNameWithDefaultDomains
DatabaseConnection
DatabaseResource
DeployAttempt: Represents the status information of a deployment attempt.
DeployAttemptStage: Represents the status information of a stage in a deployment attempt.
EndpointAdminProjects Endpoint: Endpoint for global administrator projects access.
EndpointAdminUsers Endpoint: Endpoint for global administrator users access.
EndpointAuth Endpoint: Endpoint for authentication.
EndpointAuthWithAuth Endpoint: Endpoint for authentication.
EndpointBilling Endpoint
EndpointCaller: Super class for all classes that can call a server endpoint.
EndpointCustomDomainName Endpoint
EndpointDatabase Endpoint: Endpoint for database management.
EndpointDeploy Endpoint
EndpointEnvironmentVariables Endpoint: Endpoint for managing environment variables.
EndpointInfraResources Endpoint: Endpoint for infrastructure resource provisioning.
EndpointLogs Endpoint: Endpoint for accessing cloud logs.
EndpointProjects Endpoint: Endpoint for managing projects.
EndpointRef: This class connects endpoints on the server with the client, it also hooks up streams with the endpoint. Overridden by generated code.
EndpointRoles Endpoint: Endpoint for managing access roles.
EndpointSecrets Endpoint
EndpointStatus Endpoint: Endpoint for accessing capsule deployment status.
EndpointUsers Endpoint: Endpoint for managing users.
EnvironmentVariable
FileUploader: The file uploader uploads files to Serverpod's cloud storage. On the server you can setup a custom storage service, such as S3 or Google Cloud. To directly upload a file, you first need to retrieve an upload description from your server. After the file is uploaded, make sure to notify the server by calling the verifyDirectFileUpload on the current Session object.
FileUploaderClient: The file uploader uploads files to some storage.
GoogleCloudStorageUploader: The file uploader uploads files to Serverpod's cloud storage. On the server you can setup a custom storage service, such as S3 or Google Cloud. To directly upload a file, you first need to retrieve an upload description from your server. After the file is uploaded, make sure to notify the server by calling the verifyDirectFileUpload on the current Session object.
HalfVector: Represents a vector of half-precision float values.
LogRecord: Represents a log record (entry).
MethodCallContext: Context for a method call.
MethodStreamMessage: A message sent to a method stream.
MethodStreamSerializableException: A serializable exception sent over a method stream.
MockFileUploader
ModuleEndpointCaller: This class is used to connect modules with the client. Overridden by generated code.
Modules
NewCustomDomainNamesEvent
OpenMethodStreamCommand: A message sent over a websocket connection to open a websocket stream of data to an endpoint method.
OpenMethodStreamResponse: A message sent over a websocket connection to respond to an OpenMethodStreamCommand.
Owner
PingCommand: A message sent over a websocket connection to check if the connection is still alive. The other end should respond with a PongCommand.
PongCommand: A response to a PingCommand.
Project: Represents a project of a tenant. Typically a serverpod project.
ProjectConfig
ProjectDeleteCallEvent
Protocol
ProtocolSerialization: The ProtocolSerialization defines a toJsonForProtocol method which makes it possible to limit what fields are serialized
PubsubEntry: Represents the receiving of a Pubsub message.
RequiredTerms
Role: Represents an access role for a specific project. Roles are assigned to users via membership, giving them the role's access scopes.
SecretResource
SerializableEntity: DEPRECATED: This class is deprecated and will be removed in version 2.1. Please implement the SerializableModel interface instead for creating serializable models.
SerializableModel: The SerializableModel is the base interface for all serializable objects in Serverpod, except primitives.
SerializationManager: The SerializationManager is responsible for creating objects from a serialization, but also for serializing objects. This class is typically extended by generated code.
ServerpodClientRequestDelegate: Defines the interface of the delegate that performs the actual request to the server and returns the response data. The delegate is used by ServerpodClientShared to perform the actual request. It's overridden in different versions depending on if the dart:io library is available.
ServerpodClientShared: Superclass with shared methods for handling communication with the server. Is typically overridden by generated code to provide implementations of methods for calling the server.
SparseVector: Represents a sparse vector that stores only non-zero elements.
StreamingConnectionHandler: The StreamingConnection handler manages the web socket connection and its state. It will automatically reconnect to the server if the connection is lost. The listener will be notified whenever the connection state changes and once every second when counting down to reconnect. The time between reconnection attempts is specified with retryEverySeconds, default is 5 seconds.
StreamingConnectionHandlerState: Represents the state of the connection handler.
Subscription
User: Represents a Serverpod cloud customer user, invited or registered.
UserRoleMembership: Represents a membership of a user in a role.
Uuid: uuid for Dart Author: Yulian Kuncheff Released under MIT License.
UuidValue
Vector: Represents a vector of double values.
WebSocketMessage: Base class for messages sent over a WebSocket connection.
WebSocketMessageInfo: Interface of WebSocketMessage subclasses that have endpoint, method and connection id info.

Enums

CloseReason: The reason a stream was closed.
DatabaseProvider
DeployProgressStatus
DeployStageType
DnsRecordType
DomainNameStatus
DomainNameTarget
Namespace: RFC4122 & RFC9562 provided namespaces for v3, v5, and v8 namespace based UUIDs
OpenMethodStreamResponseType: The response to an OpenMethodStreamCommand.
SecretType
ServerpodRegion
StreamingConnectionStatus: Status of the streaming connection.
Terms
UserAccountStatus
ValidationMode: The options for UUID Validation strictness

Extensions

Base64Dec on String: Extension for decoding ByteData in protocol.
Base64Enc on ByteData: Extension for encoding ByteData in the protocol.
BigIntJsonExtension on BigInt: Expose toJson on BigInt Expose static fromJson builder
BitJsonExtension on Bit: Expose toJson on Bit
ByteDataJsonExtension on ByteData: Expose toJson on ByteData Expose static fromJson builder
CloneBit on Bit: Adds clone method that create a deep copy of a Bit vector.
CloneByteData on ByteData: Adds clone method that create a deep copy of a ByteData.
CloneHalfVector on HalfVector: Adds clone method that create a deep copy of a HalfVector.
CloneSparseVector on SparseVector: Adds clone method that create a deep copy of a SparseVector.
CloneVector on Vector: Adds clone method that create a deep copy of a ByteData.
DateTimeJsonExtension on DateTime: Expose toJson on DateTime Expose static fromJson builder
DurationJsonExtension on Duration: Expose toJson on Duration Expose static fromJson builder
HalfVectorJsonExtension on HalfVector: Expose toJson on HalfVector
ListJsonExtension on List<T>: Expose toJson on List
MapJsonExtension on Map<K, V>: Expose toJson on Map
SetJsonExtension on Set<T>: Expose toJson on Set
SparseVectorJsonExtension on SparseVector: Expose toJson on SparseVector
UriJsonExtension on Uri: Expose toJson on Uri Expose static fromJson builder
UuidValueJsonExtension on UuidValue: Expose toJson on UuidValue Expose static fromJson builder
VectorJsonExtension on Vector: Expose toJson on Vector

Constants

autoSerializedTypes → const List<String>: All datatypes that are serialized by default. Used internally in Serverpod code generation.
basicAuthSchemeName → const String: The name of the default Serverpod scheme for HTTP "authorization" headers. Note, the scheme name is case-insensitive and should be compared in a case-insensitive manner.
extensionSerializedTypes → const List<String>: All datatypes that has extensions to support serialization. Used internally in Serverpod code generation.
hasCloneExtensionTypes → const List<String>: List of types that has a clone method extension and therefore can be copied by calling clone().
useResult → const UseResult: Used to annotate a method, field, or getter within a class, mixin, or extension, or a or top-level getter, variable or function to indicate that the value obtained by invoking it should be used. A value is considered used if it is assigned to a variable, passed to a function, or used as the target of an invocation, or invoked (if the result is itself a function).

Properties

nonMutableTypeNames → List<String>: List of types that are not mutable and therefore do not need to be copied or handled in a copyWith method.
final

Functions

getType<T>() → Type: Get the type provided as an generic. Useful for getting a nullable type.
isValidAuthHeaderValue(String value) → bool: Returns true if the provided value is a valid HTTP "authorization" header value (which includes starting with an authentication scheme name).
isWrappedBasicAuthHeaderValue(String value) → bool: Returns true if the provided value is a Serverpod-wrapped auth key.
unwrapAuthHeaderValue(String? authValue) → String?: Returns the auth key from an auth value that has potentially been wrapped. This operation is the inverse of wrapAsBasicAuthHeaderValue. If null is provided, null is returned.
wrapAsBasicAuthHeaderValue(String key) → String: Returns a value that is compliant with the HTTP auth header format by encoding and wrapping the provided auth key as a Basic auth value.

Typedefs

ConnectivityMonitorListener = void Function(bool connected): Callback for when internet connectivity changes.
VoidCallback = void Function(): A callback with no parameters or return value.

Exceptions / Errors

AuthHeaderEncodingException: An exception thrown upon erroneous encoding of an auth header.
ConnectionAttemptTimedOutException: Thrown if connection attempt timed out.
ConnectionClosedException: Thrown if the connection is closed with an error.
DeserializationTypeNotFoundException: Exception thrown when no deserialization type was found during protocol deserialization
DNSVerificationFailedException
DuplicateEntryException
ForbiddenException
InvalidValueException
MethodStreamException: Exceptions thrown by the ClientMethodStreamManager.
NotFoundException
OpenMethodStreamException: Thrown if opening a method stream fails.
SerializableException: This is SerializableException that can be used to pass Domain exceptions from the Server to the Client
ServerpodClientBadRequest: Thrown if the client created a malformed or invalid request to the server.
ServerpodClientException: Exception thrown when errors in communication with the server occurs.
ServerpodClientForbidden: Thrown if the client is forbidden to perform the request. This is typically due to missing permissions.
ServerpodClientInternalServerError: Thrown if the server encountered an internal error. This is typically a bug in the server code.
ServerpodClientNotFound: Thrown if the requested resource was not found on the server.
ServerpodClientUnauthorized: Thrown if the client fails to authenticate and is therefore not authorized to perform the request.
UnauthenticatedException
UnauthorizedException
UnknownMessageException: Exception thrown when an unknown message is received.
UserAccountRegistrationDeniedException: Indicates that the user account registration request was denied, due to incomplete information or missing approval.
WebSocketClosedException: Thrown if the WebSocket connection is closed.
WebSocketConnectException: Thrown if the WebSocket connection fails.
WebSocketListenException: Thrown if an error occurs when listening to the WebSocket connection.

ground_control_client library

Classes

Enums

Extensions

Constants

Properties

Functions

Typedefs

Exceptions / Errors

ground_control_client package

ground_control_client library