CreateBulkInvitationsRequestInner class

Constructors

CreateBulkInvitationsRequestInner({required String emailAddress, Map<String, Object>? publicMetadata = const {}, String? redirectUrl, bool? notify = true, bool? ignoreExisting = false, int? expiresInDays, CreateBulkInvitationsRequestInnerTemplateSlugEnum templateSlug = const CreateBulkInvitationsRequestInnerTemplateSlugEnum._('invitation')})
Returns a new CreateBulkInvitationsRequestInner instance.

Properties

emailAddress ↔ String
The email address the invitation will be sent to
getter/setter pair
expiresInDays ↔ int?
The number of days the invitation will be valid for. By default, the invitation expires after 30 days.
getter/setter pair
hashCode → int
The hash code for this object.
no setteroverride
ignoreExisting ↔ bool?
Whether an invitation should be created if there is already an existing invitation for this email address, or it's claimed by another user.
getter/setter pair
notify ↔ bool?
Optional flag which denotes whether an email invitation should be sent to the given email address. Defaults to true.
getter/setter pair
publicMetadata ↔ Map<String, Object>?
Metadata that will be attached to the newly created invitation. The value of this property should be a well-formed JSON object. Once the user accepts the invitation and signs up, these metadata will end up in the user's public metadata.
getter/setter pair
redirectUrl ↔ String?
The URL where the user is redirected upon visiting the invitation link, where they can accept the invitation. Required if you have implemented a custom flow for handling application invitations.
getter/setter pair
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
templateSlug ↔ CreateBulkInvitationsRequestInnerTemplateSlugEnum
The slug of the email template to use for the invitation email.
getter/setter pair

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) → CreateBulkInvitationsRequestInner?
Returns a new CreateBulkInvitationsRequestInner instance and imports its values from value if it's a Map, null otherwise.
listFromJson(dynamic json, {bool growable = false}) → List<CreateBulkInvitationsRequestInner>
mapFromJson(dynamic json) → Map<String, CreateBulkInvitationsRequestInner>
mapListFromJson(dynamic json, {bool growable = false}) → Map<String, List<CreateBulkInvitationsRequestInner>>

Constants

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