OrganizationPlugin class

Inheritance

• Object
• BasePlugin
• OrganizationPlugin

Constructors

OrganizationPlugin.new()

Properties

dio ↔ Dio

late, final, inherited

fromJsonUser ↔ dynamic Function(Map<String, dynamic> json)

late, final, inherited

getOptions ↔ Future<Options> Function({bool isTokenRequired})

late, final, inherited

hashCode → int

The hash code for this object.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

tokenStore ↔ TokenStore

late, final, inherited

Methods

acceptInvitation({required String invitationId}) → Future<AcceptInvitationResponse>

Accept an invitation

cancelInvitation({required String invitationId}) → Future<void>

Cancel an invitation

checkSlug({required String slug}) → Future<StatusResponse>

Check if a slug is available

create({required String name, required String slug, String? logo, Map<String, dynamic>? metadata, bool? keepCurrentActiveOrganization}) → Future<CreateOrganizationResponse>

Create an organization

delete({required String organizationId}) → Future<void>

Delete an organization

getActiveMember() → Future<MemberPartial>

Get the active member

getAllInvitations() → Future<List<Invitation>>

Get all invitations

getAllOrganizations() → Future<List<Organization>>

Get all organizations

getFullOrganization({String? organizationId, String? organizationSlug}) → Future<Organization>

Get full organization details

getInvitation({required String invitationId}) → Future<GetInvitationResponse>

Get an invitation

hasPermission({required List<Map<String, dynamic>> permissions}) → Future<SuccessResponse>

Check if user has a permission

initialize({required Dio dio, required Future<Options> getOptions({bool isTokenRequired}), required TokenStore tokenStore, required dynamic fromJsonUser(Map<String, dynamic> json)}) → void

inherited

inviteMember({required String email, required String role, String? organizationId, bool? resend, String? teamId}) → Future<Invitation>

Invite a member to an organization

leaveOrganization({required String organizationId}) → Future<void>

Leave an organization

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

rejectInvitation({required String invitationId}) → Future<RejectInvitationResponse>

Reject an invitation

removeMember({required String memberIdOrEmail, String? organizationId}) → Future<RemoveMemberResponse>

Remove a member from an organization

setActive({String? organizationId, String? organizationSlug}) → Future<void>

Set an organization as active

toString() → String

A string representation of this object.

inherited

update({required UpdateOrganizationRequest data, required String organizationId}) → Future<UpdateOrganizationResponse>

Update an organization

updateMemberRole({required String role, required String memberId, String? organizationId}) → Future<UpdateMemberRoleResponse>

Update a member's role

Operators

operator ==(Object other) → bool

The equality operator.

inherited