matrix_api_lite library
Lightweight wrapper around the raw matrix API.
Classes
- AlgorithmTypes
- AuthenticationData
- AuthenticationFlow
- For each endpoint, a server offers one or more 'flows' that the client can use to authenticate itself. Each flow comprises a series of stages
- AuthenticationIdentifier
- AuthenticationIdentifierTypes
- AuthenticationPassword
- AuthenticationPhoneIdentifier
- AuthenticationRecaptcha
- AuthenticationThirdPartyIdentifier
- AuthenticationThreePidCreds
- For email based identity: https://matrix.org/docs/spec/client_server/r0.6.1#email-based-identity-homeserver Or phone number based identity: https://matrix.org/docs/spec/client_server/r0.6.1#phone-number-msisdn-based-identity-homeserver
- AuthenticationToken
- AuthenticationTypes
- AuthenticationUserIdentifier
- BasicEvent
- BasicEventWithSender
- BooleanCapability
- Capabilities
- Categories
- CiphertextInfo
- ClaimKeysResponse
- ConnectionInfo
- Contact
- A way to contact the server administrator.
- CreateContentResponse
- Device
- A client device
- DeviceInfo
- DeviceListsUpdate
- DiscoveryInformation
- Used by clients to determine the homeserver, identity server, and other optional components they should be interacting with.
- EventContext
- The events and state surrounding the requested event.
- EventFilter
- EventTypes
- FieldType
- Definition of valid values for a field.
- Filter
- ForwardedRoomKeyContent
- GenerateLoginTokenResponse
- GetAuthMetadataResponse
- GetEventByTimestampResponse
- GetEventsResponse
- GetKeysChangesResponse
- GetNotificationsResponse
- GetPresenceResponse
- GetProtocolMetadataResponse$1
- GetProtocolMetadataResponse$2
- GetProtocolsResponse$1
- GetProtocolsResponse$2
- GetPublicRoomsResponse
- A list of the published rooms on the server.
- GetPushRulesGlobalResponse
- GetRelatingEventsResponse
- GetRelatingEventsWithRelTypeAndEventTypeResponse
- GetRelatingEventsWithRelTypeResponse
- GetRoomEventsResponse
- A list of messages with a new token to request more.
- GetRoomIdByAliasResponse
- GetRoomKeysVersionCurrentResponse
- GetRoomKeysVersionResponse
- GetRoomSummaryResponse$1
- GetRoomSummaryResponse$2
- GetRoomSummaryResponse$3
- A summary of the room.
- GetSpaceHierarchyResponse
- GetThreadRootsResponse
- GetVersionsResponse
- GetWellknownSupportResponse
- Group
- Configuration for group.
- Groupings
- GroupValue
- The results for a particular group value.
- HomeserverInformation
- IdentityServerInformation
- ImagePackContent
- ImagePackImageContent
- ImagePackPackContent
- IncludeEventContext
- Instances$1
- Instances$2
- Invite3pid
- InvitedRoomUpdate
- JoinedRoomUpdate
- KeyBackupData
- The key data
- KnockRoomUpdate
- LeftRoomUpdate
- Location
- LogEvent
- LoginFlow
- LoginResponse
- Logs
- MatrixApi
- MatrixCrossSigningKey
- MatrixDeviceKeys
- MatrixEvent
- MatrixSignableKey
- MediaConfig
- MessageTypes
- Notification
- OlmPlaintextPayload
- OpenIdCredentials
- PassphraseInfo
- PeekEventsResponse
- Presence
- PresenceContent
- PreviewForUrl
- Profile
- ProfileFieldsCapability
- ProfileInformation
- Protocol
- ProtocolInstance
- PublicRoomQueryFilter
- PublishedRoomsChunk
- PushCondition
- Pusher
- PusherData
- PusherId
- PushRule
- PushRuleAction
- PushRuleSet
- QueryKeysResponse
- QueryPublicRoomsResponse
- A list of the published rooms on the server.
- RefreshResponse
- RegisterResponse
- RequestedKeyInfo
- RequestTokenResponse
- Result
- The result object.
- ResultCategories
- ResultRoomEvents
- RoomCreationTypes
- RoomEncryptedContent
- RoomEncryptionContent
- RoomEventFilter
- RoomEventsCriteria
- RoomFilter
- RoomKeyBackup
- The backed up keys for a room.
- RoomKeyContent
- RoomKeyRequestContent
- RoomKeys
- RoomKeysUpdateResponse
- RoomMember
- RoomSummary
- RoomSummary$1
- RoomSummary$2
- RoomsUpdate
- RoomVersionsCapability
- SearchFilter
- SearchResults
- SearchResultsEventContext
- SearchUserDirectoryResponse
- SecretStorageDefaultKeyContent
- SecretStorageKeyContent
- SessionInfo
- SpaceHierarchyRoomsChunk
- SpaceRoomsChunk$1
- SpaceRoomsChunk$2
- StateEvent
- StateFilter
- StrippedStateEvent
- SyncRoomUpdate
- SyncUpdate
- Tag
- TagType
- ThirdPartyIdentifier
- ThirdPartySigned
-
A signature of an
m.third_party_invitetoken to prove that this user owns a third-party identity which has been invited to the room. - ThirdPartyUser
- ThreePidCredentials
- ThreepidCreds
- TimelineUpdate
- TokenOwnerInfo
- TombstoneContent
- TryGet
- TurnServerCredentials
- UnreadNotificationCounts
- UserProfile
- WhoIsInfo
Enums
- AccountKind
- BackupAlgorithm
- CreateRoomPreset
- Direction
- EventFormat
- Format
- GroupKey
- IdServerUnbindResult
- ImagePackUsage
- Include
- KeyKind
- Level
- MatrixError
- Membership
- Method
- PresenceType
- PushRuleKind
- ReceiptType
- RequestType
- Role
- RoomVersionAvailable
- The stability of the room version.
- SearchOrder
- ThirdPartyIdentifierMedium
- Visibility
Extensions
- AccountKindEnhancedEnum on AccountKind
-
AccountKindFromStringExtension
on Iterable<
AccountKind> - BackupAlgorithmEnhancedEnum on BackupAlgorithm
-
BackupAlgorithmFromStringExtension
on Iterable<
BackupAlgorithm> - CreateRoomPresetEnhancedEnum on CreateRoomPreset
-
CreateRoomPresetFromStringExtension
on Iterable<
CreateRoomPreset> - DirectionEnhancedEnum on Direction
-
DirectionFromStringExtension
on Iterable<
Direction> - EventFormatEnhancedEnum on EventFormat
-
EventFormatFromStringExtension
on Iterable<
EventFormat> -
FilterMap
on Map<
K, V> - ForwardedRoomKeyContentBasicEventExtension on BasicEvent
- GroupKeyEnhancedEnum on GroupKey
-
GroupKeyFromStringExtension
on Iterable<
GroupKey> - IdServerUnbindResultEnhancedEnum on IdServerUnbindResult
-
IdServerUnbindResultFromStringExtension
on Iterable<
IdServerUnbindResult> - ImagePackContentBasicEventExtension on BasicEvent
- IncludeEnhancedEnum on Include
-
IncludeFromStringExtension
on Iterable<
Include> - KeyKindEnhancedEnum on KeyKind
-
KeyKindFromStringExtension
on Iterable<
KeyKind> -
MapCopyExtension
on Map<
String, Object?> - MembershipEnhancedEnum on Membership
-
MembershipFromStringExtension
on Iterable<
Membership> - MethodEnhancedEnum on Method
-
MethodFromStringExtension
on Iterable<
Method> - PresenceTypeEnhancedEnum on PresenceType
-
PresenceTypeFromStringExtension
on Iterable<
PresenceType> - PushRuleKindEnhancedEnum on PushRuleKind
-
PushRuleKindFromStringExtension
on Iterable<
PushRuleKind> - ReceiptTypeEnhancedEnum on ReceiptType
-
ReceiptTypeFromStringExtension
on Iterable<
ReceiptType> - RoleEnhancedEnum on Role
-
RoleFromStringExtension
on Iterable<
Role> - RoomEncryptedContentBasicEventExtension on BasicEvent
- RoomEncryptionContentBasicEventExtension on BasicEvent
- RoomKeyContentBasicEventExtension on BasicEvent
- RoomKeyRequestContentBasicEventExtension on BasicEvent
- RoomVersionAvailableEnhancedEnum on RoomVersionAvailable
-
RoomVersionAvailableFromStringExtension
on Iterable<
RoomVersionAvailable> - SearchOrderEnhancedEnum on SearchOrder
-
SearchOrderFromStringExtension
on Iterable<
SearchOrder> - SecretStorageDefaultKeyContentBasicEventExtension on BasicEvent
- SecretStorageKeyContentBasicEventExtension on BasicEvent
- ThirdPartyIdentifierMediumEnhancedEnum on ThirdPartyIdentifierMedium
-
ThirdPartyIdentifierMediumFromStringExtension
on Iterable<
ThirdPartyIdentifierMedium> - TombstoneContentBasicEventExtension on BasicEvent
-
TryGetMapExtension
on Map<
String, Object?> - VisibilityEnhancedEnum on Visibility
-
VisibilityFromStringExtension
on Iterable<
Visibility>
Functions
-
imagePackUsageFromJson(
List< String> ? json) → List<ImagePackUsage> ? -
imagePackUsageToJson(
List< ImagePackUsage> ? usage, List<String> ? prevUsage) → List<String>
Exceptions / Errors
- EventTooLarge
- MatrixException
- Represents a special response from the Homeserver for errors.