EndpointProjects class Endpoint

Endpoint for managing projects.

Inheritance
Implementers

Constructors

EndpointProjects(EndpointCaller caller)

Properties

caller → EndpointCaller
Holds a reference to the caller class.
finalinherited
client ↔ ServerpodClientShared
Reference to the client.
latefinalinherited
hashCode → int
The hash code for this object.
no setterinherited
name → String
The name of the endpoint this reference is connected to.
no setteroverride
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
stream → Stream<SerializableModel>
Stream of messages sent from an endpoint that supports streaming.
no setterinherited

Methods

attachUser({required String cloudProjectId, required String email, required List<String> assignRoleNames}) → Future<void>
Invites a user to a project by assigning the specified project roles.
createProject({required String cloudProjectId, String? underSubscriptionId}) → Future<Project>
Creates a new project with basic setup. The cloudProjectId must be globally unique. underSubscriptionId optionally specify a subscription to procure the project under, or the user's primary subscription will be used.
deleteProject({required String cloudProjectId}) → Future<Project>
Deletes a project permanently. The id / name of the project is not immediately available for reuse.
detachUser({required String cloudProjectId, required String email, List<String>? unassignRoleNames, bool? unassignAllRoles}) → Future<List<String>>
Revokes a user from a project by unassigning the specified project roles.
fetchProject({required String cloudProjectId}) → Future<Project>
Fetches the specified project. Its user roles are included in the response.
fetchProjectConfig({required String cloudProjectId}) → Future<ProjectConfig>
inviteUser({required String cloudProjectId, required String email, required List<String> assignRoleNames}) → Future<void>
Invites a user to a project by assigning the specified project roles. If the user does not exist, a user invitation email is sent.
listProjects() → Future<List<Project>>
Fetches the list of projects the current user has access to.
listProjectsInfo({bool? includeLatestDeployAttemptTime}) → Future<List<ProjectInfo>>
Fetches the list of projects the current user has access to. If requested, the result includes the latest deploy attempt time (or null if undeployed).
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
resetStream() → void
Resets web socket stream, so it's possible to re-listen to endpoint streams.
inherited
revokeUser({required String cloudProjectId, required String email, List<String>? unassignRoleNames, bool? unassignAllRoles}) → Future<List<String>>
Revokes a user from a project by unassigning the specified project roles. If any of the roles do not exist or are not previously assigned to the user, they are simply ignored. If unassignAllRoles is true, all roles on the project are unassigned from the user.
sendStreamMessage(SerializableModel message) → Future<void>
Sends a message to the endpoint's stream.
inherited
toString() → String
A string representation of this object.
inherited
validateProjectId(String projectId) → Future<bool>
Validates a project ID by checking format rules and database existence. Throws InvalidValueException for format violations. Throws DuplicateEntryException if the project ID already exists. Returns true if the project ID is valid and available.

Operators

operator ==(Object other) → bool
The equality operator.
inherited