M10Directory class
Represents a client for interacting with the M10 directory service.
This class provides methods for various directory-related operations, including listing ledgers, creating aliases, checking alias existence, retrieving alias details, searching for aliases, and creating and retrieving object URLs.
M10Directory establishes a connection to the directory service using
the provided host, port, and optional tokenProvider and
disableTls.
Constructors
- M10Directory.new(String host, {TokenProvider? tokenProvider, bool disableTls = false, int port = 443})
- Creates an M10Directory instance for interacting with the directory service.
Properties
- hashCode → int
-
The hash code for this object.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
checkAlias(
String handle) → Future< bool> - Checks if an alias with the given handle exists.
-
createAlias(
{required String handle, required String displayName, required String accountSetId, required Alias_Type aliasType, required String operator}) → Future< void> - Creates a new alias in the directory service.
-
createImageUrl(
String mimeType) → Future< ObjectUrlResponse> - Creates a URL for uploading an image.
-
createObjectUrl(
) → Future< ObjectUrlResponse> - Creates a URL for uploading an object.
-
findAliasesOfUser(
[int pageSize = 20]) → Future< Iterable< AliasDoc> > - Searches for aliases associated with the current user.
-
getAlias(
String handle) → Future< AliasDoc?> - Retrieves an alias by its handle.
-
getObjectUrl(
String objectId) → Future< ObjectUrlResponse> - Retrieves a URL for downloading an object.
-
listLedgers(
) → Future< List< Ledger> > - Retrieves a list of available ledgers from the directory service.
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
searchAliases(
String handlePrefix, [int pageSize = 20]) → Future< Iterable< AliasDoc> > - Searches for aliases based on a handle prefix.
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited