stable
v30.3
Preparing search index...
The search index is not available
matrix-js-sdk
matrix-js-sdk
<internal>
ISession
Interface ISession
Data on a Megolm session
Hierarchy
ISession
Index
Properties
sender
Key
session
Data?
session
Id
Properties
sender
Key
sender
Key
:
string
Optional
session
Data
session
Data
?:
InboundGroupSessionData
session
Id
session
Id
:
string
Settings
Member Visibility
Protected
Private
Inherited
Theme
OS
Light
Dark
On This Page
sender
Key
session
Data
session
Id
matrix-
js-
sdk
Crypto
Api
Device
Verification
Status
ISSOFlow
Oidc
Discovery
Error
<internal>
Call
Direction
Call
Error
Code
Call
Party
Call
State
Call
Type
Cross
Signing
Key
Type
Cross
Signing
Level
Extension
State
Feature
Group
Call
Error
Code
Group
Key
MatrixRTCSession
Event
MatrixRTCSession
Manager
Events
Media
Type
Migration
State
Mode
Oob
Status
Policy
Scope
Room
Key
Request
State
SDPStream
Metadata
Purpose
Server
Support
Sliding
Sync
State
Tracking
Status
Tree
Permissions
Ended
Incoming
Incoming
Megolm
OPUS
Olm
Outgoing
Participants
Backup
Manager
Call
Error
Call
Event
Handler
Call
Feed
Call
Membership
Call
Stats
Report
Gatherer
Connection
Stats
Cross
Signing
Info
Crypto
Dangling
Receipt
Dangling
Receipts
Decryption
Algorithm
Dehydration
Manager
Device
Info
Device
List
Device
List
Update
Serialiser
Device
Trust
Level
Encryption
Algorithm
Event
Context
Extensible
Event
Fetch
Http
Api
Filter
Component
Group
Call
Error
Group
Call
Event
Handler
Group
Call
Stats
Ignored
Invites
In
Room
Channel
In
Room
Requests
Incoming
Room
Key
Request
Incoming
Room
Key
Request
Cancellation
MSC3089
Branch
MSC3089
Tree
Space
Map
With
Default
MatrixRTCSession
MatrixRTCSession
Manager
Media
Handler
Media
Ssrc
Handler
Media
Track
Handler
Media
Track
Stats
Media
Track
Stats
Handler
Message
Event
Namespaced
Value
Olm
Device
Outgoing
Room
Key
Request
Manager
Poll
Answer
Subevent
Poll
Start
Event
Push
Processor
QRCode
Data
Re
Emitter
Read
Receipt
Receipt
Accumulator
Receipt
Info
Receipts
By
User
Relations
Container
Room
List
Room
Receipts
Secret
Sharing
Secret
Storage
Server
Controlled
Namespaced
Value
Sliding
List
Sliding
Sync
Sliding
Sync
Sdk
Stats
Report
Emitter
Summary
Stats
Report
Gatherer
Sync
Api
Threaded
Receipts
To
Device
Channel
To
Device
Message
Queue
To
Device
Requests
Typed
Re
Emitter
Unstable
Value
User
Receipts
Verification
Base
Verification
Request
Accumulated
Receipt
Asserted
Identity
Audio
Concealment
Audio
Settings
Auto
Discovery
State
Backup
Algorithm
Backup
Decryptor
Base
Logger
Base
Operation
Bitrate
Byte
Sent
Stats
Report
Call
Capabilities
Call
Feed
Report
Call
Feed
Stats
Call
Membership
Data
Call
Opts
Call
Stats
Report
Summary
Call
Stats
Report
Summary
Counter
Check
Own
Cross
Signing
Trust
Opts
Codec
Map
Codec
Params
Mod
Connection
Stats
Bandwidth
Connection
Stats
Bitrate
Connection
Stats
Report
Crypto
Backend
Crypto
Store
Decryptors
Delegated
Auth
Config
Delete
Operation
Desktop
Capturer
Constraints
Extensible
Extension
Focus
Framerate
Map
Group
Call
Stats
Report
IAccount
Data
IActions
Object
ICache
Callbacks
ICall
Feed
Opts
ICall
Handlers
ICheck
Own
Cross
Signing
Trust
Opts
ICross
Signing
Info
IDecrypted
Group
Message
IDeferred
IDehydrated
Device
IDehydrated
Device
Key
Info
IDevice
IDevice
Data
IDevice
Verification
Upgrade
IEncrypted
Event
Info
IEncrypted
Payload
IError
Json
IExported
Device
IExported
Device
IFilter
Component
IGroup
Call
Data
Channel
Options
IGroup
Call
Room
Member
Device
IGroup
Call
Room
Member
Feed
IInbound
Group
Session
Key
IInbound
Session
IIndexedDBBackend
IInfo
IInit
Opts
IInit
Opts
IJoined
Members
Response
IJoined
Rooms
Response
IKey
Backup
IKey
Backup
Check
IKey
Backup
Path
IKey
Backup
Prepare
Opts
IKey
Backup
Restore
Opts
IKey
Backup
Restore
Result
IKey
Request
Recipient
IMedia
Config
IMegolm
Encrypted
Content
IMessage
IMessages
Response
IOlm
Device
IOlm
Encrypted
Content
IOlm
Session
Result
IOpts
IOpts
IOpts
IOpts
IOpts
IOpts
IOutbound
Group
Session
Key
IParams
IPrepared
Key
Backup
Version
IPresence
IProblem
IPublic
Rooms
Response
IQr
Data
IQueue
Entry
IRequests
Map
IResult
Categories
IRoom
IRoom
Encryption
IRoom
Filter
IRoom
Hierarchy
IRoom
Initial
Sync
Response
IRoom
Key
IRoom
Key
Request
Body
IRoom
Key
Request
Recipient
IRoom
Summary
ISaved
Sync
IScreensharing
Opts
ISecret
Request
ISecret
Request
Internal
ISession
ISession
Info
ISignable
Object
ISignatures
IState
IState
Event
Request
IState
Filter
IStore
ISynapse
Admin
Deactivate
Response
ISynapse
Admin
Whois
Response
ISync
Options
ISync
Params
ITag
Metadata
ITarget
Device
IThird
Party
Location
IThird
Party
User
IThread
Opts
ITo
Device
ITransition
IUnpickled
Session
Info
IUser
Directory
Response
IUser
Olm
Session
IVerification
Channel
IWhoami
Response
IWithheld
Inbound
Group
Session
Data
Indexed
To
Device
Batch
Insert
Operation
Invalidate
Operation
List
Response
Logger
MCall
Answer
MCall
Base
MCall
Hangup
Reject
MSC3575
Filter
MSC3575
List
MSC3575
Room
Data
MSC3575
Room
Subscription
MSC3575
Sliding
Sync
Request
MSC3575
Sliding
Sync
Response
Mapper
Opts
On
Sync
Completed
Data
Packet
Loss
Packet
Loss
Parked
Shared
History
Participant
State
Request
Message
Base
Request
Message
Cancellation
Request
Message
Request
Resolution
Resolution
Map
Room
Deferred
SDPStream
Metadata
SDPStream
Metadata
Object
Secret
Store
Private
Keys
Summary
Stats
Report
Sync
Api
Options
Sync
Crypto
Callbacks
Sync
Operation
Threepid
Creds
To
Device
Batch
To
Device
Batch
With
Txn
Id
To
Device
Message
Track
Stats
Track
Summary
Transceiver
Stats
Transport
Stats
Turn
Server
Typed
Response
Unread
Notification
Counts
Voip
Event
Well
Known
Config
Any
Listener
Byte
Send
Call
Event
Handler
Event
Handler
Map
Call
Event
Handler
Map
Call
Scope
Calls
By
User
And
Device
Crypto
Event
Handler
Map
Crypto
Events
Decryption
Class
Params
Degradable
Fn
Device
Info
Map
Device
Parameters
Email
Identity
Dict
Emitted
Events
Emitted
Events
Emitted
Events
Event
Emitter
Error
Listener
Event
Emitter
Event
Listener
Event
Handler
Map
Event
Handler
Map
Event
Handler
Map
Event
Handler
Map
Event
Handler
Map
Event
Mapper
Get
Key
Group
Call
Event
Handler
Event
Handler
Map
Group
Call
Event
Handler
Map
Group
Call
Stats
Report
Event
Handler
Map
IEncrypted
Content
Key
Verifier
Keys
During
Verification
Map
Type
Matrix
Event
Events
MatrixRTCSession
Event
Handler
Map
Media
Handler
Event
Handler
Map
Mode
One
Time
Keys
Operation
Optional
Timestamp
Event
Password
Dict
Phone
Login
Identifier
Process
Function
Query
Dict
Recaptcha
Dict
Request
Request
Message
Response
Type
Room
Events
Room
Member
Events
Room
State
Events
Sig
Info
Sliding
Sync
Event
Handler
Map
Spec
User
Identifier
Stats
Report
Handler
Map
Third
Party
Login
Identifier
To
Device
Payload
TrackID
Track
Stats
Type
Trust
Info
User
Creator
User
Events
User
Login
Identifier
User
Tuple
Valid
Sign
In
Response
Wrapped
Room
Content
Helpers
Crypto
Secret
Storage
Auth
Type
Auto
Discovery
Action
Auto
Discovery
Error
Beacon
Event
Call
Event
Call
Feed
Event
Category
Client
Event
Client
Prefix
Condition
Kind
Condition
Operator
Crypto
Event
Device
Verification
Direction
Duplicate
Strategy
Event
Emitter
Events
Event
Status
Event
Type
Feature
Support
Group
Call
Event
Group
Call
Intent
Group
Call
State
Group
Call
Stats
Report
Event
Group
Call
Type
Guest
Access
History
Visibility
Http
Api
Event
Identity
Prefix
Identity
Provider
Brand
Invalid
Crypto
Store
State
Invalid
Store
State
Join
Rule
Local
Storage
Errors
Location
Asset
Type
Matrix
Event
Event
Media
Handler
Event
Media
Prefix
Method
Msg
Type
Notification
Count
Type
Oidc
Error
Pending
Event
Ordering
Poll
Event
Preset
Push
Rule
Action
Name
Push
Rule
Kind
Receipt
Type
Relation
Type
Relations
Event
Restricted
Allow
Type
Room
Event
Room
Member
Event
Room
Name
Type
Room
State
Event
Room
Type
Room
Version
Stability
Rule
Id
SERVICE_
TYPES
SSOAction
Search
Order
By
Set
Presence
Sliding
Sync
Event
Stats
Report
Sync
State
Thread
Event
Thread
Filter
Type
Threepid
Medium
Tweak
Name
User
Event
Visibility
Auto
Discovery
Beacon
Client
Stopped
Error
Connection
Error
Device
Event
Timeline
Event
Timeline
Set
Filter
Group
Call
HTTPError
IndexedDBCrypto
Store
IndexedDBStore
Interactive
Auth
Invalid
Crypto
Store
Error
Invalid
Store
Error
Key
Signature
Upload
Error
Local
Storage
Crypto
Store
Matrix
Call
Matrix
Client
Matrix
Error
Matrix
Event
Matrix
Http
Api
Matrix
Scheduler
Memory
Crypto
Store
Memory
Store
No
Auth
Flow
Found
Error
Oidc
Token
Refresher
Poll
Relations
Room
Room
Member
Room
State
Room
Summary
Room
Widget
Client
Search
Result
Sync
Accumulator
Thread
Timeline
Index
Timeline
Window
Typed
Event
Emitter
User
Actual
Room
Name
State
Cached
Receipt
Capabilities
Client
Config
Device
Keys
Empty
Room
Name
State
Generated
Room
Name
State
Hierarchy
Relation
Hierarchy
Room
IAdd
Event
Options
IAdd
Event
To
Timeline
Options
IAdd
Live
Event
Options
IAdd
Three
Pid
Only
Body
IAggregated
Relation
IAnnotated
Push
Rule
IAuth
Data
IBind
Three
Pid
Body
ICall
Started
Condition
ICall
Started
Prefix
Condition
ICapabilities
ICapability
IChange
Password
Capability
IClaim
Keys
Request
IClaimOTKs
Result
IClear
Event
IClient
Well
Known
IContains
Display
Name
Condition
IContent
IContent
Uri
IContext
Response
ICreate
Client
Opts
ICreate
Filter
Opts
ICreate
Room
Opts
ICreate
Room
State
Event
ICrypto
Callbacks
IDecrypt
Options
IDelegated
Auth
Config
IDevice
Keys
IDevice
Lists
IDownload
Key
Result
IEncrypted
File
IEphemeral
IEvent
IEvent
Decryption
Result
IEvent
Match
Condition
IEvent
Property
Contains
Condition
IEvent
Property
Is
Condition
IEvent
Relation
IEvent
Search
Opts
IEvent
With
Room
Id
IEvents
Response
IField
Type
IFilter
Definition
IFilter
Response
IGet
Login
Token
Capability
IGuest
Access
Opts
IHttp
Opts
IIdentity
Provider
IIdentity
Server
Provider
IImage
Info
IInitialise
State
Options
IInputs
IInstance
IInvite3PID
IInvite
State
IInvited
Room
IJoin
Room
Opts
IJoin
Rule
Event
Content
IJoined
Room
IKeys
Upload
Response
IKnock
State
IKnocked
Room
ILeft
Room
ILogin
Flow
ILogin
Flows
Response
IMarker
Found
Options
IMatrix
Client
Create
Opts
IMatrix
Profile
IMegolm
Session
Data
IMentions
IMessage
Rendering
IMessage
Visibility
Hidden
IMessage
Visibility
Visible
IMinimal
Event
IMy
Device
INotification
INotifications
Response
IOne
Time
Key
IOpenIDToken
IOpts
IPaginate
Opts
IPartial
Event
IPassword
Flow
IPower
Levels
Content
IPresence
Opts
IPreview
Url
Response
IProtocol
IPublic
Rooms
Chunk
Room
IPush
Rule
IPush
Rule
Condition
IPush
Rules
IPusher
IPusher
Request
IQuery
Keys
Request
IRecommended
Version
IRedact
Opts
IRefresh
Token
Response
IRelations
Request
Opts
IRelations
Response
IRequest
Msisdn
Token
Response
IRequest
Opts
IRequest
Token
Response
IResult
Context
IResult
Room
Events
IRoom
Directory
Options
IRoom
Event
IRoom
Event
Filter
IRoom
Member
Count
Condition
IRoom
Summary
IRoom
Timeline
Data
IRoom
Versions
Capability
IRooms
ISearch
Opts
ISearch
Request
Body
ISearch
Response
ISearch
Result
ISearch
Results
ISend
Event
Response
ISender
Notification
Permission
Condition
IServer
Versions
ISigned
Key
IStage
Status
IStart
Client
Opts
IState
Event
IState
Event
With
Room
Id
IStatus
Response
IStored
Client
Opts
IStripped
State
ISync
Data
ISync
Response
ITags
Response
IThread
Bundled
Relationship
IThreads
Capability
IThreepid
ITimeline
ITo
Device
Event
ITurn
Server
ITurn
Server
Response
IUnsigned
IUpload
Key
Signatures
Response
IUpload
Keys
Request
IUsage
Limit
IVisibility
Change
IWell
Known
Config
Keys
Knock
Room
Opts
Local
Notification
Settings
Login
Request
Login
Response
Login
Token
Post
Response
Oidc
Client
Config
Outgoing
Room
Key
Request
Push
Details
Receipt
Receipt
Content
Register
Request
Register
Response
SSOFlow
Signing
Keys
Sync
State
Data
Timestamp
To
Event
Response
UIAFlow
Upload
Upload
Opts
Upload
Progress
Upload
Response
Wrapped
Receipt
Access
Tokens
Any
Member
Count
Condition
Any
Relation
Auth
Dict
Authorization
Params
Beacon
Event
Handler
Map
Beacon
Identifier
Bearer
Token
Response
Body
Cached
Receipt
Structure
Client
Event
Handler
Map
Cross
Signing
Keys
Default
Never
Device
Map
Emitted
Events
Event
Handler
Map
Event
Timeline
Set
Handler
Map
Extensible
Any
Message
Event
Content
Extensible
Event
Type
Extensible
Message
Event
Content
File
Type
Html
Event
Content
Http
Api
Event
Handler
Map
IAuth
Dict
ICross
Signing
Key
ILocation
Content
ILogin
Params
IRegister
Request
Params
Id
Server
Unbind
Result
Key
Signatures
Known
Poll
Kind
Legacy
Location
Event
Content
Listener
Listener
Map
Location
Event
Wire
Content
Login
Flow
MAsset
Content
MAsset
Event
MBeacon
Event
Content
MBeacon
Info
Content
MBeacon
Info
Event
Content
MLocation
Content
MLocation
Event
MLocation
Event
Content
MRoom
Topic
Event
Content
MText
Event
MTimestamp
Event
MTopic
Content
MTopic
Event
Matrix
Event
Emitted
Events
Matrix
Event
Handler
Map
Member
Count
Condition
Message
Visibility
Notification
Count
Oidc
Registration
Client
Metadata
Olm
Group
Session
Extra
Data
Poll
Answer
Poll
End
Event
Poll
End
Event
Content
Poll
Event
Handler
Map
Poll
Kind
Poll
Response
Event
Poll
Response
Event
Content
Poll
Response
Subtype
Poll
Start
Event
Poll
Start
Event
Content
Poll
Start
Subtype
Push
Rule
Action
Push
Rule
Condition
Push
Rule
Set
Receipt
Cache
Receipts
Relates
To
Relationship
Reset
Timeline
Callback
Resize
Method
Room
Emitted
Events
Room
Event
Handler
Map
Room
Member
Event
Handler
Map
Room
Name
State
Room
State
Event
Handler
Map
Search
Key
Send
To
Device
Content
Map
Store
TSNamespace
TSNamespace
Value
Text
Event
Content
Thread
Emitted
Events
Thread
Event
Handler
Map
Token
Refresh
Function
Tweak
Tweak
Highlight
Tweak
Sound
Tweaks
UIARequest
UIAResponse
UIAuth
Callback
User
Event
Handler
Map
User
Identifier
User
State
Validated
Issuer
Config
Validated
Issuer
Metadata
CRYPTO_
ENABLED
DELEGATED_
OIDC_
COMPATIBILITY
DMMember
Count
Condition
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_
AUTHENTICATION
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
Room
Create
Type
Field
THREAD_
RELATION_
TYPE
To
Device
Message
Id
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
any
Signal
complete
Authorization
Code
Grant
create
Client
create
New
Matrix
Call
create
Room
Widget
Client
decode
Base64
determine
Feature
Support
discover
And
Validate
Authentication
Config
encode
Base64
encode
Unpadded
Base64
encode
Unpadded
Base64
Url
fix
Notification
Count
On
Decryption
generate
Authorization
Params
generate
Authorization
Url
generate
Oidc
Authorization
Url
generate
Scope
get
Beacon
Info
Identifier
get
Http
Uri
For
Mxc
in
Main
Timeline
For
Receipt
is
Dm
Member
Count
Condition
is
Event
Type
Same
is
Poll
Event
is
Timestamp
In
Duration
is
Validated
Issuer
Metadata
parse
Error
Response
register
Oidc
Client
retry
Network
Operation
set
Crypto
Store
Factory
thread
Filter
Type
To
Filter
thread
Id
For
Receipt
timeout
Signal
validate
Bearer
Token
Response
validate
Id
Token
validateOIDCIssuer
Well
Known
validate
Stored
User
State
validate
Well
Known
Authentication
Generated using
TypeDoc
Data on a Megolm session