Preparing search index...
The search index is not available
matrix-js-sdk
matrix-js-sdk
UIAFlow
Interface UIAFlow
interface
UIAFlow
{
stages
:
string
[]
;
}
Index
Properties
stages
Properties
stages
stages
:
string
[]
Settings
Member Visibility
Protected
Private
Inherited
Theme
OS
Light
Dark
On This Page
stages
matrix-js-sdk
CryptoApi
DeviceVerificationStatus
ISSOFlow
OidcDiscoveryError
<internal>
CallDirection
CallErrorCode
CallParty
CallState
CallType
CrossSigningKeyType
CrossSigningLevel
ExtensionState
Feature
GroupCallErrorCode
GroupKey
MatrixRTCSessionEvent
MatrixRTCSessionManagerEvents
MediaType
MigrationState
Mode
OobStatus
PolicyScope
RoomKeyRequestState
SDPStreamMetadataPurpose
ServerSupport
SlidingSyncState
TrackingStatus
TreePermissions
Ended
Incoming
Incoming
Megolm
OPUS
Olm
Outgoing
Participants
BackupManager
CallError
CallEventHandler
CallFeed
CallMembership
CallStatsReportGatherer
ConnectionStats
CrossSigningInfo
Crypto
DanglingReceipt
DanglingReceipts
DecryptionAlgorithm
DehydrationManager
DeviceInfo
DeviceList
DeviceListUpdateSerialiser
DeviceTrustLevel
EncryptionAlgorithm
EventContext
ExtensibleEvent
FetchHttpApi
FilterComponent
GroupCallError
GroupCallEventHandler
GroupCallStats
IgnoredInvites
InRoomChannel
InRoomRequests
IncomingRoomKeyRequest
IncomingRoomKeyRequestCancellation
MSC3089Branch
MSC3089TreeSpace
MapWithDefault
MatrixRTCSession
MatrixRTCSessionManager
MediaHandler
MediaSsrcHandler
MediaTrackHandler
MediaTrackStats
MediaTrackStatsHandler
MessageEvent
NamespacedValue
OlmDevice
OutgoingRoomKeyRequestManager
PollAnswerSubevent
PollStartEvent
PushProcessor
QRCodeData
ReEmitter
ReadReceipt
ReceiptAccumulator
ReceiptInfo
ReceiptsByUser
RelationsContainer
RoomList
RoomReceipts
SecretSharing
SecretStorage
ServerControlledNamespacedValue
SlidingList
SlidingSync
SlidingSyncSdk
StatsReportEmitter
SummaryStatsReportGatherer
SyncApi
ThreadedReceipts
ToDeviceChannel
ToDeviceMessageQueue
ToDeviceRequests
TypedReEmitter
UnstableValue
UserReceipts
VerificationBase
VerificationRequest
AccumulatedReceipt
AssertedIdentity
AudioConcealment
AudioSettings
AutoDiscoveryState
BackupAlgorithm
BackupDecryptor
BaseLogger
BaseOperation
Bitrate
ByteSentStatsReport
CallCapabilities
CallFeedReport
CallFeedStats
CallMembershipData
CallOpts
CallStatsReportSummary
CallStatsReportSummaryCounter
CheckOwnCrossSigningTrustOpts
CodecMap
CodecParamsMod
ConnectionStatsBandwidth
ConnectionStatsBitrate
ConnectionStatsReport
CryptoBackend
CryptoStore
Decryptors
DeleteOperation
DesktopCapturerConstraints
Extensible
Extension
Focus
FramerateMap
GroupCallStatsReport
IAccountData
IActionsObject
ICacheCallbacks
ICallFeedOpts
ICallHandlers
ICheckOwnCrossSigningTrustOpts
ICrossSigningInfo
IDecryptedGroupMessage
IDeferred
IDehydratedDevice
IDehydratedDeviceKeyInfo
IDevice
IDeviceData
IDeviceVerificationUpgrade
IEncryptedEventInfo
IEncryptedPayload
IErrorJson
IExportedDevice
IExportedDevice
IFilterComponent
IGroupCallDataChannelOptions
IGroupCallRoomMemberDevice
IGroupCallRoomMemberFeed
IInboundGroupSessionKey
IInboundSession
IIndexedDBBackend
IInfo
IInitOpts
IInitOpts
IJoinedMembersResponse
IJoinedRoomsResponse
IKeyBackup
IKeyBackupCheck
IKeyBackupPath
IKeyBackupPrepareOpts
IKeyBackupRestoreOpts
IKeyBackupRestoreResult
IKeyRequestRecipient
IMediaConfig
IMegolmEncryptedContent
IMessage
IMessagesResponse
IOlmDevice
IOlmEncryptedContent
IOlmSessionResult
IOpts
IOpts
IOpts
IOpts
IOpts
IOpts
IOutboundGroupSessionKey
IParams
IPreparedKeyBackupVersion
IPresence
IProblem
IPublicRoomsResponse
IQrData
IQueueEntry
IRequestsMap
IResultCategories
IRoom
IRoomEncryption
IRoomFilter
IRoomHierarchy
IRoomInitialSyncResponse
IRoomKey
IRoomKeyRequestBody
IRoomKeyRequestRecipient
IRoomKeysResponse
IRoomSummary
IRoomsKeysResponse
ISavedSync
IScreensharingOpts
ISecretRequest
ISecretRequestInternal
ISession
ISessionInfo
ISignableObject
ISignatures
ISigned
IState
IStateEventRequest
IStateFilter
IStore
ISynapseAdminDeactivateResponse
ISynapseAdminWhoisResponse
ISyncOptions
ISyncParams
ITagMetadata
ITargetDevice
IThirdPartyLocation
IThirdPartyUser
IThreadOpts
IToDevice
ITransition
IUnpickledSessionInfo
IUserDirectoryResponse
IUserOlmSession
IVerificationChannel
IWhoamiResponse
IWithheld
InboundGroupSessionData
IndexedToDeviceBatch
InsertOperation
InvalidateOperation
ListResponse
Logger
MCallAnswer
MCallBase
MCallHangupReject
MSC3575Filter
MSC3575List
MSC3575RoomData
MSC3575RoomSubscription
MSC3575SlidingSyncRequest
MSC3575SlidingSyncResponse
MapperOpts
OidcRegistrationRequestBody
OnSyncCompletedData
PacketLoss
PacketLoss
ParkedSharedHistory
ParticipantState
RequestMessageBase
RequestMessageCancellation
RequestMessageRequest
Resolution
ResolutionMap
RoomDeferred
SDPStreamMetadata
SDPStreamMetadataObject
SecretStorePrivateKeys
SessionExtended
SummaryStatsReport
SyncApiOptions
SyncCryptoCallbacks
SyncOperation
ThreepidCreds
ToDeviceBatch
ToDeviceBatchWithTxnId
ToDeviceMessage
TrackStats
TrackSummary
TransceiverStats
TransportStats
TurnServer
TypedResponse
UnreadNotificationCounts
VoipEvent
WellKnownConfig
AnyListener
ByteSend
CallEventHandlerEventHandlerMap
CallEventHandlerMap
CallScope
CallsByUserAndDevice
CryptoEventHandlerMap
CryptoEvents
DecryptionClassParams
DegradableFn
DeviceInfoMap
DeviceParameters
EmailIdentityDict
EmittedEvents
EmittedEvents
EmittedEvents
EventEmitterErrorListener
EventEmitterEventListener
EventHandlerMap
EventHandlerMap
EventHandlerMap
EventHandlerMap
EventHandlerMap
EventMapper
GetKey
GroupCallEventHandlerEventHandlerMap
GroupCallEventHandlerMap
GroupCallStatsReportEventHandlerMap
IEncryptedContent
KeyVerifier
KeysDuringVerification
MapType
MatrixEventEvents
MatrixRTCSessionEventHandlerMap
MediaHandlerEventHandlerMap
Mode
OneTimeKeys
Operation
OptionalTimestampEvent
PasswordDict
PhoneLoginIdentifier
ProcessFunction
QueryDict
RecaptchaDict
Request
RequestMessage
ResponseType
RoomEvents
RoomMemberEvents
RoomStateEvents
SigInfo
SlidingSyncEventHandlerMap
SpecUserIdentifier
StatsReportHandlerMap
ThirdPartyLoginIdentifier
ToDevicePayload
TrackID
TrackStatsType
TrustInfo
UserCreator
UserEvents
UserLoginIdentifier
UserTuple
ValidSignInResponse
WrappedRoom
ContentHelpers
BeaconInfoState
BeaconLocationState
MakeBeaconContent
MakeBeaconInfoContent
MakeTopicContent
TopicState
getTextForLocationEvent
makeBeaconContent
makeBeaconInfoContent
makeEmoteMessage
makeHtmlEmote
makeHtmlMessage
makeHtmlNotice
makeLocationContent
makeNotice
makeTextMessage
makeTopicContent
parseBeaconContent
parseBeaconInfoContent
parseLocationEvent
parseTopicContent
Crypto
CryptoCallbacks
CrossSigningKey
EventShieldColour
EventShieldReason
VerificationPhase
VerificationRequestEvent
VerifierEvent
DeviceVerificationStatus
UserVerificationStatus
Aes256AuthData
BackupTrustInfo
BootstrapCrossSigningOpts
CreateSecretStorageOpts
CrossSigningKeyInfo
CrossSigningStatus
CryptoApi
Curve25519AuthData
Curve25519SessionData
EventEncryptionInfo
GeneratedSas
GeneratedSecretStorageKey
ImportRoomKeyProgressData
ImportRoomKeysOpts
KeyBackupCheck
KeyBackupInfo
KeyBackupRoomSessions
KeyBackupSession
OwnDeviceKeys
ShowQrCodeCallbacks
ShowSasCallbacks
VerificationRequest
Verifier
EmojiMapping
VerificationRequestEventHandlerMap
VerifierEventHandlerMap
canAcceptVerificationRequest
SecretStorage
ServerSideSecretStorageImpl
AccountDataClient
AddSecretStorageKeyOpts
PassphraseInfo
SecretStorageCallbacks
SecretStorageKeyDescriptionAesV1
SecretStorageKeyDescriptionCommon
ServerSideSecretStorage
SecretStorageKeyDescription
SecretStorageKeyObject
SecretStorageKeyTuple
SECRET_STORAGE_ALGORITHM_V1_AES
trimTrailingEquals
AuthType
AutoDiscoveryAction
AutoDiscoveryError
BeaconEvent
CallEvent
CallFeedEvent
Category
ClientEvent
ClientPrefix
ConditionKind
ConditionOperator
CryptoEvent
DeviceVerification
Direction
DuplicateStrategy
EventEmitterEvents
EventStatus
EventType
FeatureSupport
GroupCallEvent
GroupCallIntent
GroupCallState
GroupCallStatsReportEvent
GroupCallType
GuestAccess
HistoryVisibility
HttpApiEvent
IdentityPrefix
IdentityProviderBrand
InvalidCryptoStoreState
InvalidStoreState
JoinRule
LocalStorageErrors
LocationAssetType
MatrixEventEvent
MediaHandlerEvent
MediaPrefix
Method
MsgType
NotificationCountType
OidcError
PendingEventOrdering
PollEvent
Preset
PushRuleActionName
PushRuleKind
ReceiptType
RelationType
RelationsEvent
RestrictedAllowType
RoomEvent
RoomMemberEvent
RoomNameType
RoomStateEvent
RoomType
RoomVersionStability
RuleId
SERVICE_TYPES
SSOAction
SearchOrderBy
SetPresence
SlidingSyncEvent
StatsReport
SyncState
ThreadEvent
ThreadFilterType
ThreepidMedium
TweakName
UserEvent
Visibility
AutoDiscovery
Beacon
ClientStoppedError
ConnectionError
Device
EventTimeline
EventTimelineSet
Filter
GroupCall
HTTPError
IndexedDBCryptoStore
IndexedDBStore
InteractiveAuth
InvalidCryptoStoreError
InvalidStoreError
KeySignatureUploadError
LocalStorageCryptoStore
MatrixCall
MatrixClient
MatrixError
MatrixEvent
MatrixHttpApi
MatrixScheduler
MemoryCryptoStore
MemoryStore
NoAuthFlowFoundError
OidcTokenRefresher
Poll
Relations
Room
RoomMember
RoomState
RoomSummary
RoomWidgetClient
SearchResult
SyncAccumulator
Thread
TimelineIndex
TimelineWindow
TypedEventEmitter
User
ActualRoomNameState
CachedReceipt
Capabilities
ClientConfig
DeviceKeys
EmptyRoomNameState
GeneratedRoomNameState
HierarchyRelation
HierarchyRoom
IAddEventOptions
IAddEventToTimelineOptions
IAddLiveEventOptions
IAddThreePidOnlyBody
IAggregatedRelation
IAnnotatedPushRule
IAuthData
IBindThreePidBody
ICallStartedCondition
ICallStartedPrefixCondition
ICapabilities
ICapability
IChangePasswordCapability
IClaimKeysRequest
IClaimOTKsResult
IClearEvent
IClientWellKnown
IContainsDisplayNameCondition
IContent
IContentUri
IContextResponse
ICreateClientOpts
ICreateFilterOpts
ICreateRoomOpts
ICreateRoomStateEvent
ICryptoCallbacks
IDecryptOptions
IDeviceKeys
IDeviceLists
IDownloadKeyResult
IEncryptedFile
IEphemeral
IEvent
IEventDecryptionResult
IEventMatchCondition
IEventPropertyContainsCondition
IEventPropertyIsCondition
IEventRelation
IEventSearchOpts
IEventWithRoomId
IEventsResponse
IFieldType
IFilterDefinition
IFilterResponse
IGetLoginTokenCapability
IGuestAccessOpts
IHttpOpts
IIdentityProvider
IIdentityServerProvider
IImageInfo
IInitialiseStateOptions
IInputs
IInstance
IInvite3PID
IInviteState
IInvitedRoom
IJoinRoomOpts
IJoinRuleEventContent
IJoinedRoom
IKeysUploadResponse
IKnockState
IKnockedRoom
ILeftRoom
ILoginFlow
ILoginFlowsResponse
IMarkedUnreadEvent
IMarkerFoundOptions
IMatrixClientCreateOpts
IMatrixProfile
IMegolmSessionData
IMentions
IMessageRendering
IMessageVisibilityHidden
IMessageVisibilityVisible
IMinimalEvent
IMyDevice
INotification
INotificationsResponse
IOneTimeKey
IOpenIDToken
IOpts
IPaginateOpts
IPartialEvent
IPasswordFlow
IPowerLevelsContent
IPresenceOpts
IPreviewUrlResponse
IProtocol
IPublicRoomsChunkRoom
IPushRule
IPushRuleCondition
IPushRules
IPusher
IPusherRequest
IQueryKeysRequest
IRecommendedVersion
IRedactOpts
IRefreshTokenResponse
IRelationsRequestOpts
IRelationsResponse
IRequestMsisdnTokenResponse
IRequestOpts
IRequestTokenResponse
IResultContext
IResultRoomEvents
IRoomDirectoryOptions
IRoomEvent
IRoomEventFilter
IRoomMemberCountCondition
IRoomSummary
IRoomTimelineData
IRoomVersionsCapability
IRooms
ISearchOpts
ISearchRequestBody
ISearchResponse
ISearchResult
ISearchResults
ISendEventResponse
ISenderNotificationPermissionCondition
IServerVersions
ISignedKey
IStageStatus
IStartClientOpts
IStateEvent
IStateEventWithRoomId
IStatusResponse
IStoredClientOpts
IStrippedState
ISyncData
ISyncResponse
ITagsResponse
IThreadBundledRelationship
IThreadsCapability
IThreepid
ITimeline
IToDeviceEvent
ITurnServer
ITurnServerResponse
IUnsigned
IUploadKeySignaturesResponse
IUploadKeysRequest
IUsageLimit
IVisibilityChange
IWellKnownConfig
Keys
KnockRoomOpts
LocalNotificationSettings
LoginRequest
LoginResponse
LoginTokenPostResponse
OidcClientConfig
OutgoingRoomKeyRequest
PushDetails
Receipt
ReceiptContent
RegisterRequest
RegisterResponse
SSOFlow
SigningKeys
SyncStateData
TimestampToEventResponse
UIAFlow
Upload
UploadOpts
UploadProgress
UploadResponse
WrappedReceipt
AccessTokens
AnyMemberCountCondition
AnyRelation
AuthDict
AuthorizationParams
BeaconEventHandlerMap
BeaconIdentifier
BearerTokenResponse
Body
CachedReceiptStructure
ClientEventHandlerMap
CrossSigningKeys
DefaultNever
DeviceMap
EmittedEvents
EventHandlerMap
EventTimelineSetHandlerMap
ExtensibleAnyMessageEventContent
ExtensibleEventType
ExtensibleMessageEventContent
FileType
HtmlEventContent
HttpApiEventHandlerMap
IAuthDict
ICrossSigningKey
ILocationContent
ILoginParams
IRegisterRequestParams
IdServerUnbindResult
KeySignatures
KnownPollKind
LegacyLocationEventContent
Listener
ListenerMap
LocationEventWireContent
LoginFlow
MAssetContent
MAssetEvent
MBeaconEventContent
MBeaconInfoContent
MBeaconInfoEventContent
MLocationContent
MLocationEvent
MLocationEventContent
MRoomTopicEventContent
MTextEvent
MTimestampEvent
MTopicContent
MTopicEvent
MatrixEventEmittedEvents
MatrixEventHandlerMap
MemberCountCondition
MessageVisibility
NonEmptyArray
NotificationCount
OidcRegistrationClientMetadata
OlmGroupSessionExtraData
PollAnswer
PollEndEvent
PollEndEventContent
PollEventHandlerMap
PollKind
PollResponseEvent
PollResponseEventContent
PollResponseSubtype
PollStartEvent
PollStartEventContent
PollStartSubtype
PushRuleAction
PushRuleCondition
PushRuleSet
ReceiptCache
Receipts
RelatesToRelationship
ResetTimelineCallback
ResizeMethod
RoomEmittedEvents
RoomEventHandlerMap
RoomMemberEventHandlerMap
RoomNameState
RoomStateEventHandlerMap
SearchKey
SendToDeviceContentMap
Store
TSNamespace
TSNamespaceValue
TextEventContent
ThreadEmittedEvents
ThreadEventHandlerMap
TokenRefreshFunction
Tweak
TweakHighlight
TweakSound
Tweaks
UIARequest
UIAResponse
UIAuthCallback
UserEventHandlerMap
UserIdentifier
UserState
ValidatedIssuerConfig
ValidatedIssuerMetadata
CRYPTO_ENABLED
DELEGATED_OIDC_COMPATIBILITY
DMMemberCountCondition
EVENT_VISIBILITY_CHANGE_TYPE
FILTER_RELATED_BY_REL_TYPES
FILTER_RELATED_BY_SENDERS
GET_LOGIN_TOKEN_CAPABILITY
KNOWN_SAFE_ROOM_VERSION
LOCAL_NOTIFICATION_SETTINGS_PREFIX
MAIN_ROOM_TIMELINE
MSC3912_RELATION_BASED_REDACTIONS_PROP
M_ASSET
M_BEACON
M_BEACON_INFO
M_HTML
M_LOCATION
M_MESSAGE
M_POLL_END
M_POLL_KIND_DISCLOSED
M_POLL_KIND_UNDISCLOSED
M_POLL_RESPONSE
M_POLL_START
M_TEXT
M_TIMESTAMP
M_TOPIC
PUSHER_DEVICE_ID
PUSHER_ENABLED
REFERENCE_RELATION
RoomCreateTypeField
THREAD_RELATION_TYPE
ToDeviceMessageId
UNSIGNED_THREAD_ID_FIELD
UNSTABLE_ELEMENT_FUNCTIONAL_USERS
UNSTABLE_MSC2666_MUTUAL_ROOMS
UNSTABLE_MSC2666_QUERY_MUTUAL_ROOMS
UNSTABLE_MSC2666_SHARED_ROOMS
UNSTABLE_MSC2716_MARKER
UNSTABLE_MSC3088_ENABLED
UNSTABLE_MSC3088_PURPOSE
UNSTABLE_MSC3089_BRANCH
UNSTABLE_MSC3089_LEAF
UNSTABLE_MSC3089_TREE_SUBTYPE
UNSTABLE_MSC3852_LAST_SEEN_UA
anySignal
calculateRetryBackoff
completeAuthorizationCodeGrant
createClient
createNewMatrixCall
createRoomWidgetClient
decodeBase64
determineFeatureSupport
discoverAndValidateOIDCIssuerWellKnown
encodeBase64
encodeUnpaddedBase64
encodeUnpaddedBase64Url
fixNotificationCountOnDecryption
generateAuthorizationParams
generateAuthorizationUrl
generateOidcAuthorizationUrl
generateScope
getBeaconInfoIdentifier
getHttpUriForMxc
inMainTimelineForReceipt
isDmMemberCountCondition
isEventTypeSame
isPollEvent
isTimestampInDuration
isValidatedIssuerMetadata
parseErrorResponse
registerOidcClient
retryNetworkOperation
setCryptoStoreFactory
threadFilterTypeToFilter
threadIdForReceipt
timeoutSignal
validateBearerTokenResponse
validateIdToken
validateOIDCIssuerWellKnown
validateStoredUserState
Generated using
TypeDoc