matrix_api_lite library
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
- BasicRoomEvent
- Capabilities
- Categories
- ChangePasswordCapability
- ChildRoomsChunk
- CiphertextInfo
- ClaimKeysResponse
- ConnectionInfo
- 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
- GetEventByTimestampResponse
- GetEventsResponse
- GetKeysChangesResponse
- GetNotificationsResponse
- GetPresenceResponse
- GetPublicRoomsResponse
- A list of the rooms on the server.
- GetRelatingEventsResponse
- GetRelatingEventsWithRelTypeAndEventTypeResponse
- GetRelatingEventsWithRelTypeResponse
- GetRoomEventsResponse
- A list of messages with a new token to request more.
- GetRoomIdByAliasResponse
- GetRoomKeysVersionCurrentResponse
- GetRoomKeysVersionResponse
- GetSpaceHierarchyResponse
- GetThreadRootsResponse
- GetUrlPreviewResponse
- GetVersionsResponse
- Group
- Configuration for group.
- Groupings
- GroupValue
- The results for a particular group value.
- HomeserverInformation
- IdentityServerInformation
- ImagePackContent
- ImagePackImageContent
- ImagePackPackContent
- IncludeEventContext
- Invite3pid
- InvitedRoomUpdate
- JoinedRoomUpdate
- KeyBackupData
- The key data
- LeftRoomUpdate
- Location
- LogEvent
- LoginFlow
- LoginResponse
- Logs
- MatrixApi
- MatrixCrossSigningKey
- MatrixDeviceKeys
- MatrixEvent
- MatrixSignableKey
- MessageTypes
- Notification
- OlmPlaintextPayload
- OpenIdCredentials
- PassphraseInfo
- PeekEventsResponse
- Presence
- PresenceContent
- Profile
- ProfileInformation
- Protocol
- ProtocolInstance
- PublicRoomQueryFilter
- PublicRoomsChunk
- PushCondition
- Pusher
- PusherData
- PusherId
- PushRule
- PushRuleAction
- PushRuleSet
- QueryKeysResponse
- QueryPublicRoomsResponse
- A list of the 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
- RoomsUpdate
- RoomVersionsCapability
- SearchFilter
- SearchResults
- SearchResultsEventContext
- SearchUserDirectoryResponse
- SecretStorageDefaultKeyContent
- SecretStorageKeyContent
- ServerConfig
- SessionInfo
- SpaceRoomsChunk
- 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
Extensions
- AccountKindEnhancedEnum
- AccountKindFromStringExtension
- BackupAlgorithmEnhancedEnum
- BackupAlgorithmFromStringExtension
- CreateRoomPresetEnhancedEnum
- CreateRoomPresetFromStringExtension
- DirectionEnhancedEnum
- DirectionFromStringExtension
- EventFormatEnhancedEnum
- EventFormatFromStringExtension
- FilterMap
- ForwardedRoomKeyContentBasicEventExtension
- GroupKeyEnhancedEnum
- GroupKeyFromStringExtension
- IdServerUnbindResultEnhancedEnum
- IdServerUnbindResultFromStringExtension
- ImagePackContentBasicEventExtension
- IncludeEnhancedEnum
- IncludeFromStringExtension
- KeyKindEnhancedEnum
- KeyKindFromStringExtension
- LoginTypeEnhancedEnum
- LoginTypeFromStringExtension
- MapCopyExtension
- MembershipEnhancedEnum
- MembershipFromStringExtension
- MethodEnhancedEnum
- MethodFromStringExtension
- PresenceTypeEnhancedEnum
- PresenceTypeFromStringExtension
- PushRuleKindEnhancedEnum
- PushRuleKindFromStringExtension
- ReceiptTypeEnhancedEnum
- ReceiptTypeFromStringExtension
- RoomEncryptedContentBasicEventExtension
- RoomEncryptionContentBasicEventExtension
- RoomKeyContentBasicEventExtension
- RoomKeyRequestContentBasicEventExtension
- RoomVersionAvailableEnhancedEnum
- RoomVersionAvailableFromStringExtension
- SearchOrderEnhancedEnum
- SearchOrderFromStringExtension
- SecretStorageDefaultKeyContentBasicEventExtension
- SecretStorageKeyContentBasicEventExtension
- ThirdPartyIdentifierMediumEnhancedEnum
- ThirdPartyIdentifierMediumFromStringExtension
- TombstoneContentBasicEventExtension
- TryGetMapExtension
- VisibilityEnhancedEnum
- VisibilityFromStringExtension
Functions
-
imagePackUsageFromJson(
List< String> ? json) → List<ImagePackUsage> ? -
imagePackUsageToJson(
List< ImagePackUsage> ? usage, List<String> ? prevUsage) → List<String>
Enums
- AccountKind
- BackupAlgorithm
- CreateRoomPreset
- Direction
- EventFormat
- GroupKey
- IdServerUnbindResult
- ImagePackUsage
- Include
- KeyKind
- Level
- LoginType
- MatrixError
- Membership
- Method
- PresenceType
- PushRuleKind
- ReceiptType
- RequestType
- RoomVersionAvailable
- The stability of the room version.
- SearchOrder
- ThirdPartyIdentifierMedium
- Visibility
Exceptions / Errors
- MatrixConnectionException
- MatrixException
- Represents a special response from the Homeserver for errors.