OrgProvider class abstract interface

Implementers

Properties

hashCode int
The hash code for this object.
no setterinherited
providerEventStream Stream<ProviderEvent>
Streams events emitted by the provider to the consumers of the provider
no setterinherited
runtimeType Type
A representation of the runtime type of the object.
no setterinherited

Methods

addOrgUser({required String orgId, required String userId, bool isAdmin = false}) Future<OrgUser>
Add a user to the org with the given org id. The user will be added as a member of the org.
createOrg({required String orgName, required Key orgKey, List<ContactInput>? contacts, List<AddressInput>? addresses, String? businessRef}) Future<OrgIi>
Create a new organization with the given information. Current logged in user will be added as the owner and admin of the organization.
deleteOrg(String orgId) Future<void>
Deletes the the org with the given org id
deleteOrgUser({required String orgId, required String userId}) Future<OrgUser>
Remove a user from the org with the given org id.
dispose() Future<void>
Disposes the repository provider. This method should close and release any resources used by the backend services.
inherited
getOrgData(String orgId) Future<Org>
Retrieves the org details for the given org id
getOrgs() Future<List<OrgUser>>
Retrieves all the orgs the current user is a part of.
initialize() Future<void>
Initializes the repository provider. This method should setup persistent connections to the backend services and initialize any resources used by the backend services.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() String
A string representation of this object.
inherited
updateOrg({required String orgId, Key? orgKey, List<ContactInput>? contacts, List<AddressInput>? addresses, String? config}) Future<Org>
Update the org with the given org id. The org name and business reference cannot be updated as they are immutable once an org has been created and verified.

Operators

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