@tagea/capacitor-matrix 0.0.2

package/dist/docs.json

@@ -0,0 +1,1943 @@
+{
+  "api": {
+    "name": "MatrixPlugin",
+    "slug": "matrixplugin",
+    "docs": "",
+    "tags": [],
+    "methods": [
+      {
+        "name": "login",
+        "signature": "(options: LoginOptions) => Promise<SessionInfo>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "LoginOptions"
+          }
+        ],
+        "returns": "Promise<SessionInfo>",
+        "tags": [],
+        "docs": "",
+        "complexTypes": [
+          "SessionInfo",
+          "LoginOptions"
+        ],
+        "slug": "login"
+      },
+      {
+        "name": "loginWithToken",
+        "signature": "(options: LoginWithTokenOptions) => Promise<SessionInfo>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "LoginWithTokenOptions"
+          }
+        ],
+        "returns": "Promise<SessionInfo>",
+        "tags": [],
+        "docs": "",
+        "complexTypes": [
+          "SessionInfo",
+          "LoginWithTokenOptions"
+        ],
+        "slug": "loginwithtoken"
+      },
+      {
+        "name": "logout",
+        "signature": "() => Promise<void>",
+        "parameters": [],
+        "returns": "Promise<void>",
+        "tags": [],
+        "docs": "",
+        "complexTypes": [],
+        "slug": "logout"
+      },
+      {
+        "name": "getSession",
+        "signature": "() => Promise<SessionInfo | null>",
+        "parameters": [],
+        "returns": "Promise<SessionInfo | null>",
+        "tags": [],
+        "docs": "",
+        "complexTypes": [
+          "SessionInfo"
+        ],
+        "slug": "getsession"
+      },
+      {
+        "name": "startSync",
+        "signature": "() => Promise<void>",
+        "parameters": [],
+        "returns": "Promise<void>",
+        "tags": [],
+        "docs": "",
+        "complexTypes": [],
+        "slug": "startsync"
+      },
+      {
+        "name": "stopSync",
+        "signature": "() => Promise<void>",
+        "parameters": [],
+        "returns": "Promise<void>",
+        "tags": [],
+        "docs": "",
+        "complexTypes": [],
+        "slug": "stopsync"
+      },
+      {
+        "name": "getSyncState",
+        "signature": "() => Promise<{ state: SyncState; }>",
+        "parameters": [],
+        "returns": "Promise<{ state: SyncState; }>",
+        "tags": [],
+        "docs": "",
+        "complexTypes": [
+          "SyncState"
+        ],
+        "slug": "getsyncstate"
+      },
+      {
+        "name": "createRoom",
+        "signature": "(options: { name?: string; topic?: string; isEncrypted?: boolean; isDirect?: boolean; invite?: string[]; preset?: 'private_chat' | 'trusted_private_chat' | 'public_chat'; historyVisibility?: 'invited' | 'joined' | 'shared' | 'world_readable'; }) => Promise<{ roomId: string; }>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "{ name?: string | undefined; topic?: string | undefined; isEncrypted?: boolean | undefined; isDirect?: boolean | undefined; invite?: string[] | undefined; preset?: 'private_chat' | 'trusted_private_chat' | 'public_chat' | undefined; historyVisibility?: 'invited' | 'joined' | 'shared' | 'world_readable' | undefined; }"
+          }
+        ],
+        "returns": "Promise<{ roomId: string; }>",
+        "tags": [],
+        "docs": "",
+        "complexTypes": [],
+        "slug": "createroom"
+      },
+      {
+        "name": "getRooms",
+        "signature": "() => Promise<{ rooms: RoomSummary[]; }>",
+        "parameters": [],
+        "returns": "Promise<{ rooms: RoomSummary[]; }>",
+        "tags": [],
+        "docs": "",
+        "complexTypes": [
+          "RoomSummary"
+        ],
+        "slug": "getrooms"
+      },
+      {
+        "name": "getRoomMembers",
+        "signature": "(options: { roomId: string; }) => Promise<{ members: RoomMember[]; }>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "{ roomId: string; }"
+          }
+        ],
+        "returns": "Promise<{ members: RoomMember[]; }>",
+        "tags": [],
+        "docs": "",
+        "complexTypes": [
+          "RoomMember"
+        ],
+        "slug": "getroommembers"
+      },
+      {
+        "name": "joinRoom",
+        "signature": "(options: { roomIdOrAlias: string; }) => Promise<{ roomId: string; }>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "{ roomIdOrAlias: string; }"
+          }
+        ],
+        "returns": "Promise<{ roomId: string; }>",
+        "tags": [],
+        "docs": "",
+        "complexTypes": [],
+        "slug": "joinroom"
+      },
+      {
+        "name": "leaveRoom",
+        "signature": "(options: { roomId: string; }) => Promise<void>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "{ roomId: string; }"
+          }
+        ],
+        "returns": "Promise<void>",
+        "tags": [],
+        "docs": "",
+        "complexTypes": [],
+        "slug": "leaveroom"
+      },
+      {
+        "name": "forgetRoom",
+        "signature": "(options: { roomId: string; }) => Promise<void>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "{ roomId: string; }"
+          }
+        ],
+        "returns": "Promise<void>",
+        "tags": [],
+        "docs": "",
+        "complexTypes": [],
+        "slug": "forgetroom"
+      },
+      {
+        "name": "sendMessage",
+        "signature": "(options: SendMessageOptions) => Promise<{ eventId: string; }>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "SendMessageOptions"
+          }
+        ],
+        "returns": "Promise<{ eventId: string; }>",
+        "tags": [],
+        "docs": "",
+        "complexTypes": [
+          "SendMessageOptions"
+        ],
+        "slug": "sendmessage"
+      },
+      {
+        "name": "editMessage",
+        "signature": "(options: EditMessageOptions) => Promise<{ eventId: string; }>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "EditMessageOptions"
+          }
+        ],
+        "returns": "Promise<{ eventId: string; }>",
+        "tags": [],
+        "docs": "",
+        "complexTypes": [
+          "EditMessageOptions"
+        ],
+        "slug": "editmessage"
+      },
+      {
+        "name": "sendReply",
+        "signature": "(options: SendReplyOptions) => Promise<{ eventId: string; }>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "SendReplyOptions"
+          }
+        ],
+        "returns": "Promise<{ eventId: string; }>",
+        "tags": [],
+        "docs": "",
+        "complexTypes": [
+          "SendReplyOptions"
+        ],
+        "slug": "sendreply"
+      },
+      {
+        "name": "getRoomMessages",
+        "signature": "(options: { roomId: string; limit?: number; from?: string; }) => Promise<{ events: MatrixEvent[]; nextBatch?: string; }>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "{ roomId: string; limit?: number | undefined; from?: string | undefined; }"
+          }
+        ],
+        "returns": "Promise<{ events: MatrixEvent[]; nextBatch?: string | undefined; }>",
+        "tags": [],
+        "docs": "",
+        "complexTypes": [
+          "MatrixEvent"
+        ],
+        "slug": "getroommessages"
+      },
+      {
+        "name": "markRoomAsRead",
+        "signature": "(options: { roomId: string; eventId: string; }) => Promise<void>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "{ roomId: string; eventId: string; }"
+          }
+        ],
+        "returns": "Promise<void>",
+        "tags": [],
+        "docs": "",
+        "complexTypes": [],
+        "slug": "markroomasread"
+      },
+      {
+        "name": "refreshEventStatuses",
+        "signature": "(options: { roomId: string; eventIds: string[]; }) => Promise<{ events: MatrixEvent[]; }>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "{ roomId: string; eventIds: string[]; }"
+          }
+        ],
+        "returns": "Promise<{ events: MatrixEvent[]; }>",
+        "tags": [],
+        "docs": "",
+        "complexTypes": [
+          "MatrixEvent"
+        ],
+        "slug": "refresheventstatuses"
+      },
+      {
+        "name": "redactEvent",
+        "signature": "(options: { roomId: string; eventId: string; reason?: string; }) => Promise<void>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "{ roomId: string; eventId: string; reason?: string | undefined; }"
+          }
+        ],
+        "returns": "Promise<void>",
+        "tags": [],
+        "docs": "",
+        "complexTypes": [],
+        "slug": "redactevent"
+      },
+      {
+        "name": "sendReaction",
+        "signature": "(options: { roomId: string; eventId: string; key: string; }) => Promise<{ eventId: string; }>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "{ roomId: string; eventId: string; key: string; }"
+          }
+        ],
+        "returns": "Promise<{ eventId: string; }>",
+        "tags": [],
+        "docs": "",
+        "complexTypes": [],
+        "slug": "sendreaction"
+      },
+      {
+        "name": "setRoomName",
+        "signature": "(options: { roomId: string; name: string; }) => Promise<void>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "{ roomId: string; name: string; }"
+          }
+        ],
+        "returns": "Promise<void>",
+        "tags": [],
+        "docs": "",
+        "complexTypes": [],
+        "slug": "setroomname"
+      },
+      {
+        "name": "setRoomTopic",
+        "signature": "(options: { roomId: string; topic: string; }) => Promise<void>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "{ roomId: string; topic: string; }"
+          }
+        ],
+        "returns": "Promise<void>",
+        "tags": [],
+        "docs": "",
+        "complexTypes": [],
+        "slug": "setroomtopic"
+      },
+      {
+        "name": "setRoomAvatar",
+        "signature": "(options: { roomId: string; mxcUrl: string; }) => Promise<void>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "{ roomId: string; mxcUrl: string; }"
+          }
+        ],
+        "returns": "Promise<void>",
+        "tags": [],
+        "docs": "",
+        "complexTypes": [],
+        "slug": "setroomavatar"
+      },
+      {
+        "name": "inviteUser",
+        "signature": "(options: { roomId: string; userId: string; }) => Promise<void>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "{ roomId: string; userId: string; }"
+          }
+        ],
+        "returns": "Promise<void>",
+        "tags": [],
+        "docs": "",
+        "complexTypes": [],
+        "slug": "inviteuser"
+      },
+      {
+        "name": "kickUser",
+        "signature": "(options: { roomId: string; userId: string; reason?: string; }) => Promise<void>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "{ roomId: string; userId: string; reason?: string | undefined; }"
+          }
+        ],
+        "returns": "Promise<void>",
+        "tags": [],
+        "docs": "",
+        "complexTypes": [],
+        "slug": "kickuser"
+      },
+      {
+        "name": "banUser",
+        "signature": "(options: { roomId: string; userId: string; reason?: string; }) => Promise<void>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "{ roomId: string; userId: string; reason?: string | undefined; }"
+          }
+        ],
+        "returns": "Promise<void>",
+        "tags": [],
+        "docs": "",
+        "complexTypes": [],
+        "slug": "banuser"
+      },
+      {
+        "name": "unbanUser",
+        "signature": "(options: { roomId: string; userId: string; }) => Promise<void>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "{ roomId: string; userId: string; }"
+          }
+        ],
+        "returns": "Promise<void>",
+        "tags": [],
+        "docs": "",
+        "complexTypes": [],
+        "slug": "unbanuser"
+      },
+      {
+        "name": "sendTyping",
+        "signature": "(options: { roomId: string; isTyping: boolean; timeout?: number; }) => Promise<void>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "{ roomId: string; isTyping: boolean; timeout?: number | undefined; }"
+          }
+        ],
+        "returns": "Promise<void>",
+        "tags": [],
+        "docs": "",
+        "complexTypes": [],
+        "slug": "sendtyping"
+      },
+      {
+        "name": "getMediaUrl",
+        "signature": "(options: { mxcUrl: string; }) => Promise<{ httpUrl: string; }>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "{ mxcUrl: string; }"
+          }
+        ],
+        "returns": "Promise<{ httpUrl: string; }>",
+        "tags": [],
+        "docs": "",
+        "complexTypes": [],
+        "slug": "getmediaurl"
+      },
+      {
+        "name": "getThumbnailUrl",
+        "signature": "(options: ThumbnailUrlOptions) => Promise<{ httpUrl: string; }>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "ThumbnailUrlOptions"
+          }
+        ],
+        "returns": "Promise<{ httpUrl: string; }>",
+        "tags": [],
+        "docs": "",
+        "complexTypes": [
+          "ThumbnailUrlOptions"
+        ],
+        "slug": "getthumbnailurl"
+      },
+      {
+        "name": "uploadContent",
+        "signature": "(options: UploadContentOptions) => Promise<UploadContentResult>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "UploadContentOptions"
+          }
+        ],
+        "returns": "Promise<UploadContentResult>",
+        "tags": [],
+        "docs": "",
+        "complexTypes": [
+          "UploadContentResult",
+          "UploadContentOptions"
+        ],
+        "slug": "uploadcontent"
+      },
+      {
+        "name": "searchUsers",
+        "signature": "(options: { searchTerm: string; limit?: number; }) => Promise<{ results: UserProfile[]; limited: boolean; }>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "{ searchTerm: string; limit?: number | undefined; }"
+          }
+        ],
+        "returns": "Promise<{ results: UserProfile[]; limited: boolean; }>",
+        "tags": [],
+        "docs": "",
+        "complexTypes": [
+          "UserProfile"
+        ],
+        "slug": "searchusers"
+      },
+      {
+        "name": "setPresence",
+        "signature": "(options: { presence: 'online' | 'offline' | 'unavailable'; statusMsg?: string; }) => Promise<void>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "{ presence: 'online' | 'offline' | 'unavailable'; statusMsg?: string | undefined; }"
+          }
+        ],
+        "returns": "Promise<void>",
+        "tags": [],
+        "docs": "",
+        "complexTypes": [],
+        "slug": "setpresence"
+      },
+      {
+        "name": "getPresence",
+        "signature": "(options: { userId: string; }) => Promise<PresenceInfo>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "{ userId: string; }"
+          }
+        ],
+        "returns": "Promise<PresenceInfo>",
+        "tags": [],
+        "docs": "",
+        "complexTypes": [
+          "PresenceInfo"
+        ],
+        "slug": "getpresence"
+      },
+      {
+        "name": "getDevices",
+        "signature": "() => Promise<{ devices: DeviceInfo[]; }>",
+        "parameters": [],
+        "returns": "Promise<{ devices: DeviceInfo[]; }>",
+        "tags": [],
+        "docs": "",
+        "complexTypes": [
+          "DeviceInfo"
+        ],
+        "slug": "getdevices"
+      },
+      {
+        "name": "deleteDevice",
+        "signature": "(options: { deviceId: string; auth?: Record<string, unknown>; }) => Promise<void>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "{ deviceId: string; auth?: Record<string, unknown> | undefined; }"
+          }
+        ],
+        "returns": "Promise<void>",
+        "tags": [],
+        "docs": "",
+        "complexTypes": [
+          "Record"
+        ],
+        "slug": "deletedevice"
+      },
+      {
+        "name": "setPusher",
+        "signature": "(options: PusherOptions) => Promise<void>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "PusherOptions"
+          }
+        ],
+        "returns": "Promise<void>",
+        "tags": [],
+        "docs": "",
+        "complexTypes": [
+          "PusherOptions"
+        ],
+        "slug": "setpusher"
+      },
+      {
+        "name": "initializeCrypto",
+        "signature": "() => Promise<void>",
+        "parameters": [],
+        "returns": "Promise<void>",
+        "tags": [],
+        "docs": "",
+        "complexTypes": [],
+        "slug": "initializecrypto"
+      },
+      {
+        "name": "getEncryptionStatus",
+        "signature": "() => Promise<EncryptionStatus>",
+        "parameters": [],
+        "returns": "Promise<EncryptionStatus>",
+        "tags": [],
+        "docs": "",
+        "complexTypes": [
+          "EncryptionStatus"
+        ],
+        "slug": "getencryptionstatus"
+      },
+      {
+        "name": "bootstrapCrossSigning",
+        "signature": "() => Promise<void>",
+        "parameters": [],
+        "returns": "Promise<void>",
+        "tags": [],
+        "docs": "",
+        "complexTypes": [],
+        "slug": "bootstrapcrosssigning"
+      },
+      {
+        "name": "setupKeyBackup",
+        "signature": "() => Promise<KeyBackupStatus>",
+        "parameters": [],
+        "returns": "Promise<KeyBackupStatus>",
+        "tags": [],
+        "docs": "",
+        "complexTypes": [
+          "KeyBackupStatus"
+        ],
+        "slug": "setupkeybackup"
+      },
+      {
+        "name": "getKeyBackupStatus",
+        "signature": "() => Promise<KeyBackupStatus>",
+        "parameters": [],
+        "returns": "Promise<KeyBackupStatus>",
+        "tags": [],
+        "docs": "",
+        "complexTypes": [
+          "KeyBackupStatus"
+        ],
+        "slug": "getkeybackupstatus"
+      },
+      {
+        "name": "restoreKeyBackup",
+        "signature": "(options?: { recoveryKey?: string | undefined; } | undefined) => Promise<{ importedKeys: number; }>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "{ recoveryKey?: string | undefined; } | undefined"
+          }
+        ],
+        "returns": "Promise<{ importedKeys: number; }>",
+        "tags": [],
+        "docs": "",
+        "complexTypes": [],
+        "slug": "restorekeybackup"
+      },
+      {
+        "name": "setupRecovery",
+        "signature": "(options?: { passphrase?: string | undefined; } | undefined) => Promise<RecoveryKeyInfo>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "{ passphrase?: string | undefined; } | undefined"
+          }
+        ],
+        "returns": "Promise<RecoveryKeyInfo>",
+        "tags": [],
+        "docs": "",
+        "complexTypes": [
+          "RecoveryKeyInfo"
+        ],
+        "slug": "setuprecovery"
+      },
+      {
+        "name": "isRecoveryEnabled",
+        "signature": "() => Promise<{ enabled: boolean; }>",
+        "parameters": [],
+        "returns": "Promise<{ enabled: boolean; }>",
+        "tags": [],
+        "docs": "",
+        "complexTypes": [],
+        "slug": "isrecoveryenabled"
+      },
+      {
+        "name": "recoverAndSetup",
+        "signature": "(options: { recoveryKey?: string; passphrase?: string; }) => Promise<void>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "{ recoveryKey?: string | undefined; passphrase?: string | undefined; }"
+          }
+        ],
+        "returns": "Promise<void>",
+        "tags": [],
+        "docs": "",
+        "complexTypes": [],
+        "slug": "recoverandsetup"
+      },
+      {
+        "name": "resetRecoveryKey",
+        "signature": "(options?: { passphrase?: string | undefined; } | undefined) => Promise<RecoveryKeyInfo>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "{ passphrase?: string | undefined; } | undefined"
+          }
+        ],
+        "returns": "Promise<RecoveryKeyInfo>",
+        "tags": [],
+        "docs": "",
+        "complexTypes": [
+          "RecoveryKeyInfo"
+        ],
+        "slug": "resetrecoverykey"
+      },
+      {
+        "name": "exportRoomKeys",
+        "signature": "(options: { passphrase: string; }) => Promise<{ data: string; }>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "{ passphrase: string; }"
+          }
+        ],
+        "returns": "Promise<{ data: string; }>",
+        "tags": [],
+        "docs": "",
+        "complexTypes": [],
+        "slug": "exportroomkeys"
+      },
+      {
+        "name": "importRoomKeys",
+        "signature": "(options: { data: string; passphrase: string; }) => Promise<{ importedKeys: number; }>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "{ data: string; passphrase: string; }"
+          }
+        ],
+        "returns": "Promise<{ importedKeys: number; }>",
+        "tags": [],
+        "docs": "",
+        "complexTypes": [],
+        "slug": "importroomkeys"
+      },
+      {
+        "name": "addListener",
+        "signature": "(event: 'syncStateChange', listenerFunc: (data: SyncStateChangeEvent) => void) => Promise<PluginListenerHandle>",
+        "parameters": [
+          {
+            "name": "event",
+            "docs": "",
+            "type": "'syncStateChange'"
+          },
+          {
+            "name": "listenerFunc",
+            "docs": "",
+            "type": "(data: SyncStateChangeEvent) => void"
+          }
+        ],
+        "returns": "Promise<PluginListenerHandle>",
+        "tags": [],
+        "docs": "",
+        "complexTypes": [
+          "PluginListenerHandle",
+          "SyncStateChangeEvent"
+        ],
+        "slug": "addlistenersyncstatechange-"
+      },
+      {
+        "name": "addListener",
+        "signature": "(event: 'messageReceived', listenerFunc: (data: MessageReceivedEvent) => void) => Promise<PluginListenerHandle>",
+        "parameters": [
+          {
+            "name": "event",
+            "docs": "",
+            "type": "'messageReceived'"
+          },
+          {
+            "name": "listenerFunc",
+            "docs": "",
+            "type": "(data: MessageReceivedEvent) => void"
+          }
+        ],
+        "returns": "Promise<PluginListenerHandle>",
+        "tags": [],
+        "docs": "",
+        "complexTypes": [
+          "PluginListenerHandle",
+          "MessageReceivedEvent"
+        ],
+        "slug": "addlistenermessagereceived-"
+      },
+      {
+        "name": "addListener",
+        "signature": "(event: 'roomUpdated', listenerFunc: (data: RoomUpdatedEvent) => void) => Promise<PluginListenerHandle>",
+        "parameters": [
+          {
+            "name": "event",
+            "docs": "",
+            "type": "'roomUpdated'"
+          },
+          {
+            "name": "listenerFunc",
+            "docs": "",
+            "type": "(data: RoomUpdatedEvent) => void"
+          }
+        ],
+        "returns": "Promise<PluginListenerHandle>",
+        "tags": [],
+        "docs": "",
+        "complexTypes": [
+          "PluginListenerHandle",
+          "RoomUpdatedEvent"
+        ],
+        "slug": "addlistenerroomupdated-"
+      },
+      {
+        "name": "addListener",
+        "signature": "(event: 'typingChanged', listenerFunc: (data: TypingEvent) => void) => Promise<PluginListenerHandle>",
+        "parameters": [
+          {
+            "name": "event",
+            "docs": "",
+            "type": "'typingChanged'"
+          },
+          {
+            "name": "listenerFunc",
+            "docs": "",
+            "type": "(data: TypingEvent) => void"
+          }
+        ],
+        "returns": "Promise<PluginListenerHandle>",
+        "tags": [],
+        "docs": "",
+        "complexTypes": [
+          "PluginListenerHandle",
+          "TypingEvent"
+        ],
+        "slug": "addlistenertypingchanged-"
+      },
+      {
+        "name": "addListener",
+        "signature": "(event: 'receiptReceived', listenerFunc: (data: ReceiptReceivedEvent) => void) => Promise<PluginListenerHandle>",
+        "parameters": [
+          {
+            "name": "event",
+            "docs": "",
+            "type": "'receiptReceived'"
+          },
+          {
+            "name": "listenerFunc",
+            "docs": "",
+            "type": "(data: ReceiptReceivedEvent) => void"
+          }
+        ],
+        "returns": "Promise<PluginListenerHandle>",
+        "tags": [],
+        "docs": "",
+        "complexTypes": [
+          "PluginListenerHandle",
+          "ReceiptReceivedEvent"
+        ],
+        "slug": "addlistenerreceiptreceived-"
+      },
+      {
+        "name": "addListener",
+        "signature": "(event: 'presenceChanged', listenerFunc: (data: PresenceChangedEvent) => void) => Promise<PluginListenerHandle>",
+        "parameters": [
+          {
+            "name": "event",
+            "docs": "",
+            "type": "'presenceChanged'"
+          },
+          {
+            "name": "listenerFunc",
+            "docs": "",
+            "type": "(data: PresenceChangedEvent) => void"
+          }
+        ],
+        "returns": "Promise<PluginListenerHandle>",
+        "tags": [],
+        "docs": "",
+        "complexTypes": [
+          "PluginListenerHandle",
+          "PresenceChangedEvent"
+        ],
+        "slug": "addlistenerpresencechanged-"
+      },
+      {
+        "name": "removeAllListeners",
+        "signature": "() => Promise<void>",
+        "parameters": [],
+        "returns": "Promise<void>",
+        "tags": [],
+        "docs": "",
+        "complexTypes": [],
+        "slug": "removealllisteners"
+      }
+    ],
+    "properties": []
+  },
+  "interfaces": [
+    {
+      "name": "SessionInfo",
+      "slug": "sessioninfo",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "accessToken",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "userId",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "deviceId",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "homeserverUrl",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "string"
+        }
+      ]
+    },
+    {
+      "name": "LoginOptions",
+      "slug": "loginoptions",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "homeserverUrl",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "userId",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "password",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "string"
+        }
+      ]
+    },
+    {
+      "name": "LoginWithTokenOptions",
+      "slug": "loginwithtokenoptions",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "homeserverUrl",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "accessToken",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "userId",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "deviceId",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "string"
+        }
+      ]
+    },
+    {
+      "name": "RoomSummary",
+      "slug": "roomsummary",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "roomId",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "name",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "topic",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "memberCount",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "number"
+        },
+        {
+          "name": "isEncrypted",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "boolean"
+        },
+        {
+          "name": "unreadCount",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "number"
+        },
+        {
+          "name": "lastEventTs",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "number | undefined"
+        },
+        {
+          "name": "membership",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "'join' | 'invite' | 'leave' | 'ban' | undefined"
+        },
+        {
+          "name": "avatarUrl",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "isDirect",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "boolean | undefined"
+        }
+      ]
+    },
+    {
+      "name": "RoomMember",
+      "slug": "roommember",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "userId",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "displayName",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "membership",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "'join' | 'invite' | 'leave' | 'ban'"
+        },
+        {
+          "name": "avatarUrl",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "string | undefined"
+        }
+      ]
+    },
+    {
+      "name": "SendMessageOptions",
+      "slug": "sendmessageoptions",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "roomId",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "body",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "msgtype",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "'m.text' | 'm.notice' | 'm.emote' | 'm.image' | 'm.audio' | 'm.video' | 'm.file' | undefined"
+        },
+        {
+          "name": "fileUri",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "fileName",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "mimeType",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "fileSize",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "number | undefined"
+        }
+      ]
+    },
+    {
+      "name": "EditMessageOptions",
+      "slug": "editmessageoptions",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "roomId",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "eventId",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "newBody",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "string"
+        }
+      ]
+    },
+    {
+      "name": "SendReplyOptions",
+      "slug": "sendreplyoptions",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "roomId",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "body",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "replyToEventId",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "msgtype",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "'m.text' | 'm.notice' | 'm.emote' | 'm.image' | 'm.audio' | 'm.video' | 'm.file' | undefined"
+        },
+        {
+          "name": "fileUri",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "fileName",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "mimeType",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "fileSize",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "number | undefined"
+        }
+      ]
+    },
+    {
+      "name": "MatrixEvent",
+      "slug": "matrixevent",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "eventId",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "roomId",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "senderId",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "type",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "content",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [
+            "Record"
+          ],
+          "type": "Record<string, unknown>"
+        },
+        {
+          "name": "originServerTs",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "number"
+        },
+        {
+          "name": "status",
+          "tags": [],
+          "docs": "Delivery/read status for own messages: 'sending' | 'sent' | 'delivered' | 'read'",
+          "complexTypes": [],
+          "type": "'sending' | 'sent' | 'delivered' | 'read' | undefined"
+        },
+        {
+          "name": "readBy",
+          "tags": [],
+          "docs": "User IDs that have read this event",
+          "complexTypes": [],
+          "type": "string[] | undefined"
+        },
+        {
+          "name": "unsigned",
+          "tags": [],
+          "docs": "Unsigned data (e.g. m.relations for edits, transaction_id for local echo)",
+          "complexTypes": [
+            "Record"
+          ],
+          "type": "Record<string, unknown>"
+        }
+      ]
+    },
+    {
+      "name": "ThumbnailUrlOptions",
+      "slug": "thumbnailurloptions",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "mxcUrl",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "width",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "number"
+        },
+        {
+          "name": "height",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "number"
+        },
+        {
+          "name": "method",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "'scale' | 'crop' | undefined"
+        }
+      ]
+    },
+    {
+      "name": "UploadContentResult",
+      "slug": "uploadcontentresult",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "contentUri",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "string"
+        }
+      ]
+    },
+    {
+      "name": "UploadContentOptions",
+      "slug": "uploadcontentoptions",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "fileUri",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "fileName",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "mimeType",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "string"
+        }
+      ]
+    },
+    {
+      "name": "UserProfile",
+      "slug": "userprofile",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "userId",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "displayName",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "avatarUrl",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "string | undefined"
+        }
+      ]
+    },
+    {
+      "name": "PresenceInfo",
+      "slug": "presenceinfo",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "presence",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "'online' | 'offline' | 'unavailable'"
+        },
+        {
+          "name": "statusMsg",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "lastActiveAgo",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "number | undefined"
+        }
+      ]
+    },
+    {
+      "name": "DeviceInfo",
+      "slug": "deviceinfo",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "deviceId",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "displayName",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "lastSeenTs",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "number | undefined"
+        },
+        {
+          "name": "lastSeenIp",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "string | undefined"
+        }
+      ]
+    },
+    {
+      "name": "PusherOptions",
+      "slug": "pusheroptions",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "pushkey",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "kind",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "string | null"
+        },
+        {
+          "name": "appId",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "appDisplayName",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "deviceDisplayName",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "lang",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "data",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "{ url: string; format?: string | undefined; }"
+        }
+      ]
+    },
+    {
+      "name": "EncryptionStatus",
+      "slug": "encryptionstatus",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "isCrossSigningReady",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "boolean"
+        },
+        {
+          "name": "crossSigningStatus",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [
+            "CrossSigningStatus"
+          ],
+          "type": "CrossSigningStatus"
+        },
+        {
+          "name": "isKeyBackupEnabled",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "boolean"
+        },
+        {
+          "name": "keyBackupVersion",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "isSecretStorageReady",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "boolean"
+        }
+      ]
+    },
+    {
+      "name": "CrossSigningStatus",
+      "slug": "crosssigningstatus",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "hasMaster",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "boolean"
+        },
+        {
+          "name": "hasSelfSigning",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "boolean"
+        },
+        {
+          "name": "hasUserSigning",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "boolean"
+        },
+        {
+          "name": "isReady",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "boolean"
+        }
+      ]
+    },
+    {
+      "name": "KeyBackupStatus",
+      "slug": "keybackupstatus",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "exists",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "boolean"
+        },
+        {
+          "name": "version",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "enabled",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "boolean"
+        }
+      ]
+    },
+    {
+      "name": "RecoveryKeyInfo",
+      "slug": "recoverykeyinfo",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "recoveryKey",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "string"
+        }
+      ]
+    },
+    {
+      "name": "PluginListenerHandle",
+      "slug": "pluginlistenerhandle",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "remove",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "() => Promise<void>"
+        }
+      ]
+    },
+    {
+      "name": "SyncStateChangeEvent",
+      "slug": "syncstatechangeevent",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "state",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [
+            "SyncState"
+          ],
+          "type": "SyncState"
+        },
+        {
+          "name": "error",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "string | undefined"
+        }
+      ]
+    },
+    {
+      "name": "MessageReceivedEvent",
+      "slug": "messagereceivedevent",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "event",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [
+            "MatrixEvent"
+          ],
+          "type": "MatrixEvent"
+        }
+      ]
+    },
+    {
+      "name": "RoomUpdatedEvent",
+      "slug": "roomupdatedevent",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "roomId",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "summary",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [
+            "RoomSummary"
+          ],
+          "type": "RoomSummary"
+        }
+      ]
+    },
+    {
+      "name": "TypingEvent",
+      "slug": "typingevent",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "roomId",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "userIds",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "string[]"
+        }
+      ]
+    },
+    {
+      "name": "ReceiptReceivedEvent",
+      "slug": "receiptreceivedevent",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "roomId",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "string"
+        }
+      ]
+    },
+    {
+      "name": "PresenceChangedEvent",
+      "slug": "presencechangedevent",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "userId",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "presence",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [
+            "PresenceInfo"
+          ],
+          "type": "PresenceInfo"
+        }
+      ]
+    }
+  ],
+  "enums": [],
+  "typeAliases": [
+    {
+      "name": "SyncState",
+      "slug": "syncstate",
+      "docs": "",
+      "types": [
+        {
+          "text": "'INITIAL'",
+          "complexTypes": []
+        },
+        {
+          "text": "'SYNCING'",
+          "complexTypes": []
+        },
+        {
+          "text": "'ERROR'",
+          "complexTypes": []
+        },
+        {
+          "text": "'STOPPED'",
+          "complexTypes": []
+        }
+      ]
+    },
+    {
+      "name": "Record",
+      "slug": "record",
+      "docs": "Construct a type with a set of properties K of type T",
+      "types": [
+        {
+          "text": "{\r\n    [P in K]: T;\r\n}",
+          "complexTypes": [
+            "K",
+            "T"
+          ]
+        }
+      ]
+    }
+  ],
+  "pluginConfigs": []
+}