Preparing search index...
The search index is not available
matrix-js-sdk
matrix-js-sdk
createRoomWidgetClient
Function createRoomWidgetClient
create
Room
Widget
Client
(
widgetApi
:
WidgetApi
, capabilities
:
ICapabilities
, roomId
:
string
, opts
:
ICreateClientOpts
)
:
MatrixClient
Parameters
widgetApi:
WidgetApi
capabilities:
ICapabilities
roomId:
string
opts:
ICreateClientOpts
Returns
MatrixClient
Settings
Member Visibility
Protected
Private
Inherited
Theme
OS
Light
Dark
Modules
matrix-
js-
sdk
<internal>
Content
Helpers
default
Auth
Type
Auto
Discovery
Action
Beacon
Event
Category
Client
Event
Client
Prefix
Condition
Kind
Condition
Operator
Direction
Duplicate
Strategy
Event
Status
Event
Type
Group
Call
Event
Group
Call
Intent
Group
Call
State
Group
Call
Type
Guest
Access
History
Visibility
Http
Api
Event
Identity
Prefix
Invalid
Crypto
Store
State
Invalid
Store
State
Join
Rule
Matrix
Event
Event
Media
Prefix
Method
Msg
Type
Notification
Count
Type
Pending
Event
Ordering
Poll
Event
Preset
Push
Rule
Action
Name
Push
Rule
Kind
Relation
Type
Restricted
Allow
Type
Room
Event
Room
Member
Event
Room
Name
Type
Room
State
Event
Room
Type
Room
Version
Stability
Rule
Id
SERVICE_
TYPES
Search
Order
By
Tweak
Name
User
Event
Visibility
Auto
Discovery
Beacon
Connection
Error
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
Matrix
Call
Matrix
Client
Matrix
Error
Matrix
Event
Matrix
Http
Api
Matrix
Scheduler
Memory
Crypto
Store
Memory
Store
Poll
Room
Room
Member
Room
State
Room
Summary
Room
Widget
Client
Sync
Accumulator
Timeline
Index
Timeline
Window
User
Actual
Room
Name
State
Client
Config
Crypto
Api
Device
Keys
Empty
Room
Name
State
Generated
Room
Name
State
IAdd
Event
Options
IAdd
Event
To
Timeline
Options
IAdd
Live
Event
Options
IAdd
Three
Pid
Only
Body
IAggregated
Relation
IAnnotated
Push
Rule
IAuth
Data
IAuth
Dict
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
ICross
Signing
Key
ICrypto
Callbacks
IDecrypt
Options
IDelegated
Auth
Config
IDownload
Key
Result
IEncrypted
File
IEphemeral
IEvent
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
IGuest
Access
Opts
IHttp
Opts
IImage
Info
IInitialise
State
Options
IInputs
IInstance
IInvite3PID
IInvite
State
IInvited
Room
IJoin
Room
Opts
IJoin
Rule
Event
Content
IJoined
Room
IKeys
Upload
Response
ILeft
Room
IMarker
Found
Options
IMatrix
Client
Create
Opts
IMatrix
Profile
IMentions
IMessage
Visibility
Hidden
IMessage
Visibility
Visible
IMinimal
Event
IMy
Device
INotification
INotifications
Response
IOpenIDToken
IOpts
IPaginate
Opts
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
IRegister
Request
Params
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
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
Signing
Keys
Timestamp
To
Event
Response
UIAFlow
Upload
Upload
Opts
Upload
Progress
Upload
Response
Any
Member
Count
Condition
Beacon
Event
Handler
Map
Beacon
Identifier
Client
Event
Handler
Map
Cross
Signing
Keys
Emitted
Events
Event
Timeline
Set
Handler
Map
File
Type
Http
Api
Event
Handler
Map
Id
Server
Unbind
Result
Key
Signatures
Matrix
Event
Emitted
Events
Matrix
Event
Handler
Map
Member
Count
Condition
Message
Visibility
Notification
Count
Poll
Event
Handler
Map
Push
Rule
Action
Push
Rule
Condition
Push
Rule
Set
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
Tweak
Tweak
Highlight
Tweak
Sound
Tweaks
User
Event
Handler
Map
CRYPTO_
ENABLED
DMMember
Count
Condition
EVENT_
VISIBILITY_
CHANGE_
TYPE
KNOWN_
SAFE_
ROOM_
VERSION
LOCAL_
NOTIFICATION_
SETTINGS_
PREFIX
MSC3912_
RELATION_
BASED_
REDACTIONS_
PROP
M_
AUTHENTICATION
PUSHER_
DEVICE_
ID
PUSHER_
ENABLED
Room
Create
Type
Field
To
Device
Message
Id
UNSTABLE_
ELEMENT_
FUNCTIONAL_
USERS
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
create
Client
create
New
Matrix
Call
create
Room
Widget
Client
fix
Notification
Count
On
Decryption
get
Beacon
Info
Identifier
get
Http
Uri
For
Mxc
is
Dm
Member
Count
Condition
is
Timestamp
In
Duration
parse
Error
Response
retry
Network
Operation
set
Crypto
Store
Factory
timeout
Signal
Generated using
TypeDoc