Project class

Project

Implemented types

Constructors

Project({required String $id, required String $createdAt, required String $updatedAt, required String name, required String teamId, required String region, required bool smtpEnabled, required String smtpSenderName, required String smtpSenderEmail, required String smtpReplyToName, required String smtpReplyToEmail, required String smtpHost, required int smtpPort, required String smtpUsername, required String smtpPassword, required String smtpSecure, required bool ldapEnabled, required List<String> ldapHosts, required int ldapPort, required String ldapEncryption, required bool ldapVerification, required String ldapCertificate, required int ldapTimeout, required String ldapBaseDn, required String ldapBindDn, required String ldapBindPassword, required String ldapUserFilter, required String ldapRequiredGroupDn, required String ldapIdAttribute, required String ldapEmailAttribute, required String ldapNameAttribute, required String ldapPhoneAttribute, required int pingCount, required String pingedAt, required List<String> labels, Preferences? prefs, required String status, required Map<String, dynamic> onboarding, required List<ProjectAuthMethod> authMethods, required List<ProjectService> services, required List<ProjectProtocol> protocols, required List<Block> blocks, required String consoleAccessedAt, bool? wafEnabled, String? parentId, String? environmentId, BillingLimits? billingLimits, String? firstAccessedAt, String? mcpAccessedAt, bool? oAuth2ServerEnabled, String? oAuth2ServerAuthorizationUrl, List<String>? oAuth2ServerScopes, List<String>? oAuth2ServerDefaultScopes, List<String>? oAuth2ServerInstallationScopes, List<String>? oAuth2ServerAuthorizationDetailsTypes, int? oAuth2ServerAccessTokenDuration, int? oAuth2ServerRefreshTokenDuration, int? oAuth2ServerPublicAccessTokenDuration, int? oAuth2ServerPublicRefreshTokenDuration, int? oAuth2ServerInstallationAccessTokenDuration, bool? oAuth2ServerConfidentialPkce, String? oAuth2ServerVerificationUrl, int? oAuth2ServerUserCodeLength, String? oAuth2ServerUserCodeFormat, int? oAuth2ServerDeviceCodeDuration, String? oAuth2ServerDiscoveryUrl})
Project.fromMap(Map<String, dynamic> map)
factory

Properties

$createdAt → String
Project creation date in ISO 8601 format.
final
$id → String
Project ID.
final
$updatedAt → String
Project update date in ISO 8601 format.
final
authMethods → List<ProjectAuthMethod>
List of auth methods.
final
billingLimits → BillingLimits?
Billing limits reached
final
blocks → List<Block>
Project blocks information
final
consoleAccessedAt → String
Last time the project was accessed via console. Used with plan's projectInactivityDays to determine if project is paused.
final
environmentId → String?
ID of the environment, as passed in the X-Appwrite-Environment header, when the project is accessed as one. Null when the project is not an environment.
final
firstAccessedAt → String?
First time the project received a non-console API request. Empty until the project is used.
final
hashCode → int
The hash code for this object.
no setterinherited
labels → List<String>
Labels for the project.
final
ldapBaseDn → String
LDAP subtree the user search starts from.
final
ldapBindDn → String
LDAP service account used to search for users, empty for anonymous search.
final
ldapBindPassword → String
LDAP service account password. This property is write-only and always returned empty.
final
ldapCertificate → String
Certificate in PEM format of the authority that signed the LDAP directory certificate, or the directory certificate itself when it is self-signed. Empty for the system trust store.
final
ldapEmailAttribute → String
LDAP attribute holding the email address.
final
ldapEnabled → bool
Status for LDAP sign-in
final
ldapEncryption → String
LDAP transport encryption: none, ldaps or starttls.
final
ldapHosts → List<String>
LDAP directory hosts, tried in order.
final
ldapIdAttribute → String
LDAP attribute holding the identifier that stays the same when an entry is renamed or moved.
final
ldapNameAttribute → String
LDAP attribute holding the display name.
final
ldapPhoneAttribute → String
LDAP attribute holding the phone number, empty when unmapped.
final
ldapPort → int
LDAP directory port.
final
ldapRequiredGroupDn → String
LDAP group a user must belong to in order to sign in, empty to allow every user.
final
ldapTimeout → int
Seconds to wait for the LDAP directory to connect and answer.
final
ldapUserFilter → String
LDAP filter that finds the user signing in, with {username} where the username they enter goes.
final
ldapVerification → bool
Whether the LDAP directory certificate is verified.
final
mcpAccessedAt → String?
Last time the project was accessed through the MCP server. Empty if it was never accessed via MCP.
final
name → String
Project name.
final
oAuth2ServerAccessTokenDuration → int?
OAuth2 server access token duration in seconds for confidential clients
final
oAuth2ServerAuthorizationDetailsTypes → List<String>?
OAuth2 server accepted RFC 9396 authorization_details types
final
oAuth2ServerAuthorizationUrl → String?
OAuth2 server authorization URL
final
oAuth2ServerConfidentialPkce → bool?
When enabled, PKCE is required for confidential clients (server-side flows using client_secret). PKCE is always required for public clients regardless of this setting.
final
oAuth2ServerDefaultScopes → List<String>?
OAuth2 server scopes used when an authorization request omits the scope parameter
final
oAuth2ServerDeviceCodeDuration → int?
Lifetime in seconds of device flow device codes and user codes.
final
oAuth2ServerDiscoveryUrl → String?
OAuth2 server discovery URL
final
oAuth2ServerEnabled → bool?
OAuth2 server status
final
oAuth2ServerInstallationAccessTokenDuration → int?
OAuth2 server access token duration in seconds for app installation access tokens
final
oAuth2ServerInstallationScopes → List<String>?
Scopes an application may request when installed on a team
final
oAuth2ServerPublicAccessTokenDuration → int?
OAuth2 server access token duration in seconds for public clients (SPAs, mobile, native)
final
oAuth2ServerPublicRefreshTokenDuration → int?
OAuth2 server refresh token duration in seconds for public clients (SPAs, mobile, native)
final
oAuth2ServerRefreshTokenDuration → int?
OAuth2 server refresh token duration in seconds for confidential clients
final
oAuth2ServerScopes → List<String>?
OAuth2 server allowed scopes
final
oAuth2ServerUserCodeFormat → String?
Character set for device flow user codes: numeric, alphabetic, or alphanumeric.
final
oAuth2ServerUserCodeLength → int?
Number of characters in the device flow user code, excluding the formatting separator.
final
oAuth2ServerVerificationUrl → String?
URL to your application page where users enter the device flow user code. Empty when the Device Authorization Grant is not configured.
final
onboarding → Map<String, dynamic>
Stage progress (completed or skipped) with timestamps and actor types, keyed by stage id.
final
parentId → String?
ID of the project this environment belongs to. Null when the project is not an environment.
final
pingCount → int
Number of times the ping was received for this project.
final
pingedAt → String
Last ping datetime in ISO 8601 format.
final
prefs → Preferences?
Project preferences as a key-value object
final
protocols → List<ProjectProtocol>
List of protocols.
final
region → String
Project region
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
services → List<ProjectService>
List of services.
final
smtpEnabled → bool
Status for custom SMTP
final
smtpHost → String
SMTP server host name
final
smtpPassword → String
SMTP server password. This property is write-only and always returned empty.
final
smtpPort → int
SMTP server port
final
smtpReplyToEmail → String
SMTP reply to email
final
smtpReplyToName → String
SMTP reply to name
final
smtpSecure → String
SMTP server secure protocol
final
smtpSenderEmail → String
SMTP sender email
final
smtpSenderName → String
SMTP sender name
final
smtpUsername → String
SMTP server username
final
status → String
Project status
final
teamId → String
Project team ID.
final
wafEnabled → bool?
Whether WAF enforcement is enabled for the project.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toMap() → Map<String, dynamic>
override
toString() → String
A string representation of this object.
inherited

Operators

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