matrix-js-sdk

    Module matrix

    Modules

    <internal>

    Namespaces

    ContentHelpers
    SecretStorage

    Enumerations

    AuthType
    AutoDiscoveryAction
    AutoDiscoveryError
    BeaconEvent
    CallEvent
    CallFeedEvent
    Category
    ClientEvent
    ClientPrefix
    ConditionKind
    ConditionOperator
    DeviceVerification
    Direction
    DuplicateStrategy
    EventEmitterEvents
    EventStatus
    EventType
    FeatureSupport
    GroupCallEvent
    GroupCallIntent
    GroupCallState
    GroupCallStatsReportEvent
    GroupCallType
    GuestAccess
    HistoryVisibility
    HttpApiEvent
    IdentityPrefix
    IdentityProviderBrand
    InvalidCryptoStoreState
    JoinRule
    KnownMembership
    LocalStorageErrors
    LocationAssetType
    MatrixEventEvent
    MediaHandlerEvent
    MediaPrefix
    Method
    MsgType
    NotificationCountType
    OidcError
    PendingEventOrdering
    PollEvent
    Preset
    PushRuleActionName
    PushRuleKind
    ReceiptType
    RelationsEvent
    RelationType
    RestrictedAllowType
    RoomEvent
    RoomMemberEvent
    RoomNameType
    RoomStateEvent
    RoomType
    RoomVersionStability
    RoomWidgetClientEvent
    RuleId
    SearchOrderBy
    SERVICE_TYPES
    SetPresence
    SlidingSyncEvent
    SSOAction
    StatsReport
    SyncState
    ThreadEvent
    ThreadFilterType
    ThreepidMedium
    TweakName
    UpdateDelayedEventAction
    UserEvent
    Visibility

    Classes

    AutoDiscovery
    Beacon
    ClientStoppedError
    ConnectionError
    Device
    EventTimeline
    EventTimelineSet
    Filter
    GroupCall
    HTTPError
    IndexedDBCryptoStore
    IndexedDBStore
    InteractiveAuth
    InvalidCryptoStoreError
    KeySignatureUploadError
    LocalStorageCryptoStore
    MatrixCall
    MatrixClient
    MatrixError
    MatrixEvent
    MatrixHttpApi
    MatrixScheduler
    MemoryCryptoStore
    MemoryStore
    NoAuthFlowFoundError
    OidcTokenRefresher
    Poll
    RelatedRelations
    Relations
    Room
    RoomMember
    RoomState
    RoomWidgetClient
    SearchResult
    ServerCapabilities
    SyncAccumulator
    Thread
    TimelineIndex
    TimelineWindow
    TokenRefreshError
    TokenRefreshLogoutError
    TypedEventEmitter
    UnsupportedDelayedEventsEndpointError
    User

    Interfaces

    AccountDataEvents
    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
    IDecryptOptions
    IDeviceKeys
    IDeviceLists
    IDownloadKeyResult
    IEphemeral
    IEvent
    IEventDecryptionResult
    IEventMatchCondition
    IEventPropertyContainsCondition
    IEventPropertyIsCondition
    IEventRelation
    IEventSearchOpts
    IEventsResponse
    IEventWithRoomId
    IFieldType
    IFilterDefinition
    IFilterResponse
    IGetLoginTokenCapability
    IGuestAccessOpts
    IHttpOpts
    IIdentityProvider
    IIdentityServerProvider
    IInitialiseStateOptions
    IInputs
    IInstance
    IInvite3PID
    IInvitedRoom
    IInviteState
    IJoinedRoom
    IJoinRoomOpts
    IKeysUploadResponse
    IKnockedRoom
    IKnockState
    ILeftRoom
    ILoginFlow
    ILoginFlowsResponse
    IMarkedUnreadEvent
    IMarkerFoundOptions
    IMatrixClientCreateOpts
    IMatrixProfile
    IMegolmSessionData
    IMentions
    IMessageRendering
    IMessageVisibilityHidden
    IMessageVisibilityVisible
    IMinimalEvent
    IMyDevice
    INotification
    INotificationsResponse
    InternationalisedPolicy
    IOneTimeKey
    IOpenIDToken
    IOpts
    IPaginateOpts
    IPartialEvent
    IPasswordFlow
    IPowerLevelsContent
    IPresenceOpts
    IPreviewUrlResponse
    IProfileFieldsCapability
    IProtocol
    IPublicRoomsChunkRoom
    IPusher
    IPusherRequest
    IPushRule
    IPushRuleCondition
    IPushRules
    IQueryKeysRequest
    IRecommendedVersion
    IRedactOpts
    IRefreshTokenResponse
    IRelationsRequestOpts
    IRelationsResponse
    IRequestMsisdnTokenResponse
    IRequestOpts
    IRequestTokenResponse
    IResultContext
    IResultRoomEvents
    IRoomDirectoryOptions
    IRoomEvent
    IRoomEventFilter
    IRoomMemberCountCondition
    IRooms
    IRoomSummary
    IRoomTimelineData
    IRoomVersionsCapability
    ISearchOpts
    ISearchRequestBody
    ISearchResponse
    ISearchResult
    ISearchResults
    ISenderNotificationPermissionCondition
    ISendEventResponse
    IServerVersions
    ISetAvatarUrlCapability
    ISetDisplayNameCapability
    ISignedKey
    ISSOFlow
    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
    OlmDevice
    OutgoingRoomKeyRequest
    Policy
    PushDetails
    Receipt
    ReceiptContent
    RegisterRequest
    RegisterResponse
    RoomSummary
    SecretStorageAccountDataEvents
    SigningKeys
    StateEvents
    SyncStateData
    Terms
    TimelineEvents
    TimestampToEventResponse
    UIAFlow
    Upload
    UploadOpts
    UploadProgress
    UploadResponse
    WrappedReceipt

    Type Aliases

    AccessTokens
    AnyMemberCountCondition
    AnyRelation
    AuthDict
    AuthorizationParams
    BeaconEventHandlerMap
    BeaconIdentifier
    BearerTokenResponse
    Body
    CachedReceiptStructure
    ClientEventHandlerMap
    CrossSigningKeys
    DefaultNever
    DelayedEventInfo
    DeviceMap
    EmittedEvents
    EmptyObject
    EventHandlerMap
    EventTimelineSetHandlerMap
    ExtensibleAnyMessageEventContent
    ExtensibleEventType
    ExtensibleMessageEventContent
    FileType
    Hero
    HtmlEventContent
    HttpApiEventHandlerMap
    IdServerUnbindResult
    ILocationContent
    ILoginParams
    IRegisterRequestParams
    KeySignatures
    KnownPollKind
    LegacyLocationEventContent
    Listener
    ListenerMap
    LocationEventWireContent
    LoginFlow
    MAssetContent
    MAssetEvent
    MatrixEventEmittedEvents
    MatrixEventHandlerMap
    MBeaconEventContent
    MBeaconInfoContent
    MBeaconInfoEventContent
    MemberCountCondition
    Membership
    MessageVisibility
    MLocationContent
    MLocationEvent
    MLocationEventContent
    MRoomTopicEventContent
    MTextEvent
    MTimestampEvent
    MTopicContent
    MTopicEvent
    NonEmptyArray
    NotificationCount
    OidcRegistrationClientMetadata
    ParentDelayId
    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
    SendActionDelayedEventRequestOpts
    SendDelayedEventRequestOpts
    SendDelayedEventResponse
    SendTimeoutDelayedEventRequestOpts
    SendToDeviceContentMap
    Store
    TextEventContent
    ThreadEmittedEvents
    ThreadEventHandlerMap
    TimeoutDelay
    TokenRefreshFunction
    TSNamespace
    TSNamespaceValue
    Tweak
    TweakHighlight
    Tweaks
    TweakSound
    UIARequest
    UIAResponse
    UIAuthCallback
    UpdateDelayedEventRequestOpts
    UserEventHandlerMap
    UserIdentifier
    UserState
    ValidatedAuthMetadata
    Without
    Writeable
    XOR

    Variables

    DELEGATED_OIDC_COMPATIBILITY
    DEVICE_CODE_SCOPE
    DMMemberCountCondition
    EVENT_VISIBILITY_CHANGE_TYPE
    GET_LOGIN_TOKEN_CAPABILITY
    KNOWN_SAFE_ROOM_VERSION
    LOCAL_NOTIFICATION_SETTINGS_PREFIX
    localStorageErrorsEventsEmitter
    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
    MAIN_ROOM_TIMELINE
    MAXIMUM_MATRIX_VERSION
    MINIMUM_MATRIX_VERSION
    MSC3912_RELATION_BASED_REDACTIONS_PROP
    ProfileKeyMSC4175Timezone
    PUSHER_DEVICE_ID
    PUSHER_ENABLED
    REFERENCE_RELATION
    RoomCreateTypeField
    SUPPORTED_MATRIX_VERSIONS
    THREAD_RELATION_TYPE
    ToDeviceMessageId
    UNSIGNED_MEMBERSHIP_FIELD
    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
    UNSTABLE_MSC4133_EXTENDED_PROFILES
    UNSTABLE_MSC4140_DELAYED_EVENTS

    Functions

    anySignal
    calculateRetryBackoff
    completeAuthorizationCodeGrant
    createClient
    createNewMatrixCall
    createRoomWidgetClient
    decodeBase64
    decodeIdToken
    determineFeatureSupport
    discoverAndValidateOIDCIssuerWellKnown
    encodeBase64
    encodeUnpaddedBase64
    encodeUnpaddedBase64Url
    fixNotificationCountOnDecryption
    generateAuthorizationParams
    generateAuthorizationUrl
    generateOidcAuthorizationUrl
    generateScope
    getBeaconInfoIdentifier
    getHttpUriForMxc
    inMainTimelineForReceipt
    isDmMemberCountCondition
    isEventTypeSame
    isPollEvent
    isTimestampInDuration
    parseErrorResponse
    registerOidcClient
    retryNetworkOperation
    safeGetRetryAfterMs
    setCryptoStoreFactory
    threadFilterTypeToFilter
    threadIdForReceipt
    timeoutSignal
    validateAuthMetadata
    validateAuthMetadataAndKeys
    validateBearerTokenResponse
    validateIdToken
    validateStoredUserState

    References

    SSOFlow â†’ ISSOFlow
    MMNEPVFCICPMFPCPTTAAATR