CreateOrganizationInvitationRequest class

Constructors

CreateOrganizationInvitationRequest.new({required String emailAddress, String? inviterUserId, required String role, Map<String, Object>? publicMetadata = const {}, Map<String, Object>? privateMetadata = const {}, String? redirectUrl, int? expiresInDays})
Returns a new CreateOrganizationInvitationRequest instance.

Properties

emailAddress String
The email address of the new member that is going to be invited to the organization
getter/setter pair
expiresInDays int?
The number of days the invitation will be valid for. By default, the invitation has a 30 days expire.
getter/setter pair
hashCode int
The hash code for this object.
no setteroverride
inviterUserId String?
The ID of the user that invites the new member to the organization. Must be an administrator in the organization.
getter/setter pair
privateMetadata Map<String, Object>?
Metadata saved on the organization invitation, fully accessible (read/write) from the Backend API but not visible from the Frontend API. When the organization invitation is accepted, the metadata will be transferred to the newly created organization membership.
getter/setter pair
publicMetadata Map<String, Object>?
Metadata saved on the organization invitation, read-only from the Frontend API and fully accessible (read/write) from the Backend API. When the organization invitation is accepted, the metadata will be transferred to the newly created organization membership.
getter/setter pair
redirectUrl String?
Optional URL that the invitee will be redirected to once they accept the invitation by clicking the join link in the invitation email.
getter/setter pair
role String
The role of the new member in the organization
getter/setter pair
runtimeType Type
A representation of the runtime type of the object.
no setterinherited

Methods

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

Operators

operator ==(Object other) bool
The equality operator.
override

Static Methods

fromJson(dynamic value) CreateOrganizationInvitationRequest?
Returns a new CreateOrganizationInvitationRequest instance and imports its values from value if it's a Map, null otherwise.
listFromJson(dynamic json, {bool growable = false}) List<CreateOrganizationInvitationRequest>
mapFromJson(dynamic json) Map<String, CreateOrganizationInvitationRequest>
mapListFromJson(dynamic json, {bool growable = false}) Map<String, List<CreateOrganizationInvitationRequest>>

Constants

requiredKeys → const Set<String>
The list of required keys that must be present in a JSON.