Skip to content
← Docs Hub
Digital World Messaging SDK
Search
Ctrl
K
Cancel
Select theme
Dark
Light
Auto
Reference
client
Namespaces
ContentHelpers
functions
getTextForLocationEvent
makeEmoteMessage
makeHtmlEmote
makeHtmlMessage
makeHtmlNotice
makeLocationContent
makeNotice
makeTextMessage
parseBeaconContent
parseBeaconInfoContent
parseLocationEvent
parseTopicContent
type-aliases
BeaconInfoState
BeaconLocationState
MakeBeaconContent
MakeBeaconInfoContent
MakeTopicContent
TopicState
variables
makeBeaconContent
makeBeaconInfoContent
makeTopicContent
SecretStorage
classes
ServerSideSecretStorageImpl
functions
calculateKeyCheck
interfaces
AccountDataClient
AddSecretStorageKeyOpts
PassphraseInfo
SecretInfo
SecretStorageCallbacks
SecretStorageKeyDescriptionAesV1
SecretStorageKeyDescriptionCommon
ServerSideSecretStorage
type-aliases
SecretStorageKey
SecretStorageKeyDescription
SecretStorageKeyObject
SecretStorageKeyTuple
variables
SECRET_STORAGE_ALGORITHM_V1_AES
Enumerations
AuthType
AutoDiscoveryAction
AutoDiscoveryError
BeaconEvent
CallEvent
CallFeedEvent
Category
ClientEvent
ClientPrefix
ConditionKind
ConditionOperator
DeviceVerification
DigitalWorldEventEvent
Direction
DuplicateStrategy
EventEmitterEvents
EventStatus
EventType
FeatureSupport
GroupCallEvent
GroupCallIntent
GroupCallState
GroupCallStatsReportEvent
GroupCallType
GuestAccess
HistoryVisibility
HttpApiEvent
IdentityPrefix
IdentityProviderBrand
InvalidCryptoStoreState
JoinRule
KnownMembership
LocalStorageErrors
LocationAssetType
MediaHandlerEvent
MediaPrefix
Method
MsgType
NotificationCountType
OAuth2Error
OAuthGrantType
PendingEventOrdering
PollEvent
Preset
PushRuleActionName
PushRuleKind
ReceiptType
RelationsEvent
RelationType
RestrictedAllowType
RoomEvent
RoomMemberEvent
RoomNameType
RoomStateEvent
RoomStickyEventsEvent
RoomType
RoomVersionStability
RoomWidgetClientEvent
RuleId
SearchOrderBy
SERVICE_TYPES
SetPresence
SlidingSyncEvent
SSOAction
StatsReport
SyncState
ThreadEvent
ThreadFilterType
ThreepidMedium
TweakName
UpdateDelayedEventAction
UserEvent
Visibility
Classes
AutoDiscovery
Beacon
ClientStoppedError
ConnectionError
DebugLogger
Device
DigitalWorldClient
DigitalWorldError
DigitalWorldEvent
DigitalWorldHttpApi
DigitalWorldSafetyError
DigitalWorldScheduler
EventTimeline
EventTimelineSet
Filter
GroupCall
HTTPError
IndexedDBCryptoStore
IndexedDBStore
InteractiveAuth
InvalidCryptoStoreError
KeySignatureUploadError
LocalStorageCryptoStore
MemoryCryptoStore
MemoryStore
NoAuthFlowFoundError
OAuth2
Poll
RelatedRelations
Relations
Room
RoomMember
RoomState
RoomWidgetClient
SearchResult
ServerCapabilities
SyncAccumulator
Thread
TimelineWindow
TokenRefresher
TokenRefreshError
TokenRefreshLogoutError
TypedEventEmitter
UnsupportedDelayedEventsEndpointError
UnsupportedStickyEventsEndpointError
User
Interfaces
AccountDataEvents
ActualRoomNameState
BaseRequestOpts
CachedReceipt
Capabilities
ClientConfig
DeviceAccessTokenError
DeviceAccessTokenResponse
DeviceAuthorizationResponse
DeviceKeys
DigitalWorldCall
EmptyRoomNameState
GeneratedRoomNameState
HierarchyRelation
HierarchyRoom
IAddEventOptions
IAddEventToTimelineOptions
IAddLiveEventOptions
IAddThreePidOnlyBody
IAggregatedRelation
IAnnotatedPushRule
IAuthData
IBindThreePidBody
ICallStartedCondition
ICallStartedPrefixCondition
ICapabilities
ICapability
IChangePasswordCapability
IClaimKeysRequest
IClaimOTKsResult
IClearEvent
IClientWellKnown
IContainsDisplayNameCondition
IContent
IContextResponse
ICreateClientOpts
ICreateFilterOpts
ICreateRoomOpts
ICreateRoomStateEvent
IDecryptOptions
IDeviceKeys
IDeviceLists
IDigitalWorldClientCreateOpts
IDigitalWorldProfile
IDownloadKeyResult
IEphemeral
IEvent
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
IMegolmSessionData
IMentions
IMessageRendering
IMessageVisibilityHidden
IMessageVisibilityVisible
IMinimalEvent
IMyDevice
INotification
INotificationsResponse
InternationalisedPolicy
InviteOpts
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
ISticky
IStoredClientOpts
IStrippedState
ISyncData
ISyncResponse
ITagsResponse
IThreadBundledRelationship
IThreadsCapability
IThreepid
ITimeline
IToDeviceEvent
ITurnServer
ITurnServerResponse
IUnsigned
IUploadKeySignaturesResponse
IUploadKeysRequest
IUsageLimit
IVisibilityChange
IWellKnownConfig
Keys
KnockRoomOpts
LocalNotificationSettings
LoginRequest
LoginResponse
LoginTokenPostResponse
OutgoingRoomKeyRequest
Policy
PushDetails
Receipt
ReceiptContent
ReceivedToDeviceMessage
RegisterRequest
RegisterResponse
RoomAccountDataEvents
RoomRetentionContent
RoomSummary
SecretStorageAccountDataEvents
SigningKeys
StateEvents
SyncStateData
Terms
TimelineEvents
TimestampToEventResponse
UIAFlow
Upload
UploadOpts
UploadProgress
UploadResponse
UsersUpdate
ValidatedAuthMetadata
WrappedReceipt
Type Aliases
AccessTokens
AnyMemberCountCondition
AnyRelation
AuthDict
BeaconEventHandlerMap
BeaconIdentifier
BearerTokenResponse
Body
CachedReceiptStructure
ClientEventHandlerMap
DefaultNever
DelayedEventInfo
DelayedEventInfoItem
DeviceMap
DigitalWorldEventEmittedEvents
DigitalWorldEventHandlerMap
EmittedEvents
EmptyObject
EventHandlerMap
EventTimelineSetHandlerMap
ExtensibleAnyMessageEventContent
ExtensibleEventType
ExtensibleMessageEventContent
FileType
Hero
HtmlEventContent
HttpApiEventHandlerMap
IdServerUnbindResult
IEventDecryptionResult
ILocationContent
ILoginParams
IRegisterRequestParams
IStickyEvent
IStickyStateEvent
KeySignatures
KnownPollKind
LegacyLocationEventContent
Listener
ListenerMap
LocationEventWireContent
LoginFlow
MalformedMTopicEvent
MAssetContent
MAssetEvent
MBeaconEventContent
MBeaconInfoContent
MBeaconInfoEventContent
MemberCountCondition
Membership
MessageVisibility
MLocationContent
MLocationEvent
MLocationEventContent
MRoomTopicEventContent
MTextEvent
MTimestampEvent
MTopicContent
MTopicEvent
NonEmptyArray
NotificationCount
OAuthRegistrationRequest
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
SendDelayedEventRequestOpts
SendDelayedEventResponse
SendToDeviceContentMap
StickyDigitalWorldEvent
Store
SyncUserProfile
TextEventContent
ThreadEmittedEvents
ThreadEventHandlerMap
TokenRefreshFunction
TSNamespace
TSNamespaceValue
Tweak
TweakHighlight
Tweaks
TweakSound
UIARequest
UIAuthCallback
UpdateDelayedEventRequestOpts
UserEventHandlerMap
UserIdentifier
Without
WritableAccountDataEvents
Writeable
XOR
Variables
DIGITAL_WORLD_ID_PATTERN
DigitalWorldSafetyErrorCode
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
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
MAX_STICKY_DURATION_MS
MAXIMUM_PROTOCOL_VERSION
MINIMUM_PROTOCOL_VERSION
MSC3912_RELATION_BASED_REDACTIONS_PROP
OAUTH_AWARE_PREFERRED_FLOW_FIELD
ProfileKeyMSC4175Timezone
ProfileKeyTimezone
PUSHER_DEVICE_ID
PUSHER_ENABLED
REFERENCE_RELATION
ROOM_RETENTION_TYPE
RoomCreateTypeField
STABLE_MSC4133_EXTENDED_PROFILES
SUPPORTED_PROTOCOL_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
UNSTABLE_MSC4354_STICKY_EVENTS
Functions
anySignal
calculateRetryBackoff
createClient
createNewDigitalWorldCall
createRoomWidgetClient
decodeBase64
determineFeatureSupport
encodeBase64
encodeUnpaddedBase64
encodeUnpaddedBase64Url
fixNotificationCountOnDecryption
generateScope
getBeaconInfoIdentifier
getHttpUriForMxc
inMainTimelineForReceipt
isDmMemberCountCondition
isEventTypeSame
isPollEvent
isSendDelayedEventRequestOpts
isTimestampInDuration
isValidAuthMetadata
isValidDeviceAccessTokenResponse
normalizeBearerTokenResponseTokenType
parseErrorResponse
retryNetworkOperation
safeGetRetryAfterMs
setCryptoStoreFactory
startDeviceAuthorization
threadFilterTypeToFilter
threadIdForReceipt
timeoutSignal
urlHasCommonBase
validateBearerTokenResponse
validateDeviceAuthorizationResponse
validateRegistrationResponse
waitForDeviceAuthorization
References
CrossSigningKeys
SSOFlow
crypto-api
Enumerations
CrossSigningKey
CryptoEvent
DecryptionFailureCode
DeviceIsolationModeKind
EventShieldColour
EventShieldReason
ImportRoomKeyStage
VerificationPhase
VerificationRequestEvent
VerifierEvent
Classes
AllDevicesIsolationMode
DecryptionKeyDoesNotMatchError
DeviceVerificationStatus
OnlySignedDevicesIsolationMode
UserVerificationStatus
Interfaces
Aes256AuthData
BackupTrustInfo
BootstrapCrossSigningOpts
CreateSecretStorageOpts
CrossSigningKeyInfo
CrossSigningStatus
CryptoApi
CryptoCallbacks
Curve25519AuthData
Curve25519SessionData
EventEncryptionInfo
GeneratedSas
GeneratedSecretStorageKey
ImportRoomKeysOpts
KeyBackupCheck
KeyBackupInfo
KeyBackupRestoreOpts
KeyBackupRestoreResult
KeyBackupRoomSessions
KeyBackupSession
OlmEncryptionInfo
OwnDeviceKeys
SecretStorageStatus
ShowQrCodeCallbacks
ShowSasCallbacks
StartDehydrationOpts
VerificationRequest
Verifier
Type Aliases
CrossSigningKeys
CryptoEventHandlerMap
DeviceIsolationMode
EmojiMapping
ImportRoomKeyFetchProgress
ImportRoomKeyLoadProgress
ImportRoomKeyProgressData
VerifierEventHandlerMap
Functions
canAcceptVerificationRequest
decodeRecoveryKey
deriveRecoveryKeyFromPassphrase
encodeRecoveryKey
testing
Functions
decryptExistingEvent
makeDelegatedAuthMetadata
mkDecryptionFailureDigitalWorldEvent
mkDigitalWorldEvent
mkEncryptedDigitalWorldEvent
types
Enumerations
VerificationMethod
Interfaces
AESEncryptedSecretStoragePayload
AudioContent
AudioInfo
EncryptedFile
FileContent
FileInfo
ImageContent
ImageInfo
PolicyRuleEventContent
ReactionEventContent
RelationEvent
ReplacementEvent
RoomAvatarEventContent
RoomCanonicalAliasEventContent
RoomCreateEventContent
RoomEncryptionEventContent
RoomGuestAccessEventContent
RoomHistoryVisibilityEventContent
RoomJoinRulesEventContent
RoomMemberEventContent
RoomMessageLocationEventContent
RoomMessageTextEventContent
RoomNameEventContent
RoomPinnedEventsEventContent
RoomPolicyContent
RoomPowerLevelsEventContent
RoomServerAclEventContent
RoomThirdPartyInviteEventContent
RoomTombstoneEventContent
RoomTopicEventContent
SpaceChildEventContent
SpaceParentEventContent
StickerEventContent
VideoContent
VideoInfo
Type Aliases
MediaEventContent
MediaEventInfo
RoomMessageEventContent
References
AccountDataEvents
EVENT_VISIBILITY_CHANGE_TYPE
EventType
KnownMembership
LOCAL_NOTIFICATION_SETTINGS_PREFIX
Membership
MSC3912_RELATION_BASED_REDACTIONS_PROP
MsgType
PUSHER_DEVICE_ID
PUSHER_ENABLED
RelationType
RoomAccountDataEvents
RoomCreateTypeField
RoomType
SecretStorageAccountDataEvents
StateEvents
TimelineEvents
ToDeviceMessageId
UNSIGNED_MEMBERSHIP_FIELD
UNSIGNED_THREAD_ID_FIELD
UNSTABLE_ELEMENT_FUNCTIONAL_USERS
UNSTABLE_MSC2716_MARKER
UNSTABLE_MSC3088_ENABLED
UNSTABLE_MSC3088_PURPOSE
UNSTABLE_MSC3089_BRANCH
UNSTABLE_MSC3089_LEAF
UNSTABLE_MSC3089_TREE_SUBTYPE
WritableAccountDataEvents
Select theme
Dark
Light
Auto
IRegisterRequestParams
IRegisterRequestParams
=
RegisterRequest
Defined in:
src/client.ts:749