Api class
Main entry point to library.
Constructors
- Api(DynamicLibrary dynamicLibrary)
-
The symbols are looked up in
dynamicLibrary
. -
Api.fromLookup(Pointer<
T> lookup<T extends NativeType>(String symbolName) ) -
The symbols are looked up with
lookup
. - Api.load()
-
The library is loaded based on platform conventions.
factory
- Api.loadDynamic(String name)
-
The library is dynamically loaded.
factory
- Api.loadStatic()
-
The library is loaded from the executable.
factory
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
-
createFfiListActerPin(
) → FfiListActerPin -
createFfiListAttachment(
) → FfiListAttachment -
createFfiListCalendarEvent(
) → FfiListCalendarEvent -
createFfiListCategory(
) → FfiListCategory -
createFfiListComment(
) → FfiListComment -
createFfiListConvo(
) → FfiListConvo -
createFfiListDeviceRecord(
) → FfiListDeviceRecord -
createFfiListEventLocationInfo(
) → FfiListEventLocationInfo -
createFfiListExternalId(
) → FfiListExternalId -
createFfiListFfiString(
) → FfiListFfiString -
createFfiListInvitation(
) → FfiListInvitation -
createFfiListMember(
) → FfiListMember -
createFfiListNewsEntry(
) → FfiListNewsEntry -
createFfiListNewsSlide(
) → FfiListNewsSlide -
createFfiListNewsSlideDraft(
) → FfiListNewsSlideDraft -
createFfiListObjRef(
) → FfiListObjRef -
createFfiListPublicSearchResultItem(
) → FfiListPublicSearchResultItem -
createFfiListPusher(
) → FfiListPusher -
createFfiListReaction(
) → FfiListReaction -
createFfiListReactionRecord(
) → FfiListReactionRecord -
createFfiListReceiptRecord(
) → FfiListReceiptRecord -
createFfiListRoomMessage(
) → FfiListRoomMessage -
createFfiListRsvp(
) → FfiListRsvp -
createFfiListSpace(
) → FfiListSpace -
createFfiListSpaceHierarchyRoomInfo(
) → FfiListSpaceHierarchyRoomInfo -
createFfiListSpaceRelation(
) → FfiListSpaceRelation -
createFfiListSuperInviteToken(
) → FfiListSuperInviteToken -
createFfiListTask(
) → FfiListTask -
createFfiListTaskList(
) → FfiListTaskList -
createFfiListUserId(
) → FfiListUserId -
createFfiListUserProfile(
) → FfiListUserProfile -
createFfiListVerificationEmoji(
) → FfiListVerificationEmoji -
destroyLocalData(
String basePath, String? mediaCacheBasePath, String username, String defaultHomeserverName) → Future< bool> - destroy the local data of a session
-
durationFromSecs(
int secs) → EfkDuration -
guestClient(
String basePath, String mediaCacheBasePath, String defaultHomeserverName, String defaultHomeserverUrl, String? deviceName) → Future< Client> - Create an anonymous client connecting to the homeserver
-
initLogging(
String logDir, String filter) → void - Initialize logging
-
loginNewClient(
String basePath, String mediaCacheBasePath, String username, String password, String defaultHomeserverName, String defaultHomeserverUrl, String? deviceName) → Future< Client> - Create a new client for homeserver at url with storage at data_path
-
loginWithToken(
String basePath, String mediaCacheBasePath, String restoreToken) → Future< Client> - Create a new client from the restore token
-
newCalendarEventRefBuilder(
String targetId, String? roomId, String? action) → RefDetailsBuilder - create a calendar event ref builder target_id: event id of target action: link/embed/embed-rsvp
-
newColorizeBuilder(
int? color, int? background) → ColorizeBuilder - create a colorize builder
-
newConvoSettingsBuilder(
) → CreateConvoSettingsBuilder - make convo settings builder
-
newDisplayBuilder(
) → DisplayBuilder - create a display builder
-
newJoinRuleBuilder(
) → JoinRuleBuilder - Rotate the logging file
-
newLinkRefBuilder(
String title, String uri) → RefDetailsBuilder - create a link ref builder
-
newObjRefBuilder(
String? position, RefDetails reference) → ObjRefBuilder - create object reference position: top-left/top-middle/top-right/center-left/center-middle/center-right/bottom-left/bottom-middle/bottom-right
-
newSpaceSettingsBuilder(
) → CreateSpaceSettingsBuilder - make space settings builder
-
newTaskListRefBuilder(
String targetId, String? roomId, String? action) → RefDetailsBuilder - create a task list ref builder target_id: event id of target action: link/embed/embed-subscribe
-
newTaskRefBuilder(
String targetId, String? roomId, String taskList, String? action) → RefDetailsBuilder - create a task ref builder target_id: event id of target task_list: event id of task list action: link/embed/embed-subscribe/embed-accept-assignment/embed-mark-done
-
newThumbSize(
int width, int height) → ThumbnailSize - create size object to be used for thumbnail download
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
parseMarkdown(
String text) → String? -
registerWithToken(
String basePath, String mediaCacheBasePath, String username, String password, String registrationToken, String defaultHomeserverName, String defaultHomeserverUrl, String deviceName) → Future< Client> - Create a new client from the registration token
-
requestPasswordChangeTokenViaEmail(
String defaultHomeserverUrl, String email) → Future< PasswordChangeEmailTokenResponse> - Request the password change token via email
-
requestRegistrationTokenViaEmail(
String basePath, String mediaCacheBasePath, String username, String defaultHomeserverName, String defaultHomeserverUrl, String email) → Future< RegistrationTokenViaEmailResponse> - Request the registration token via email
-
resetPassword(
String defaultHomeserverUrl, String sid, String clientSecret, String newVal) → Future< bool> - Finish password reset without login
-
rotateLogFile(
) → String - Rotate the logging file
-
setProxy(
String? proxy) → void - Set the global proxy to the given string. Will only apply to client initialized after calling this.
-
toString(
) → String -
A string representation of this object.
inherited
-
wouldLog(
String target, String level) → bool -
writeLog(
String target, String level, String message, String? file, int? line, String? modulePath) → void - Log the entry to the rust logging
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited