Options
All
  • Public
  • Public/Protected
  • All
Menu

matrix-appservice-bridge

Index

Namespaces

Enumerations

Classes

Interfaces

Type aliases

Variables

Functions

Type aliases

EphemeralEvent

EphemeralEvent: TypingEvent | ReadReceiptEvent | PresenceEvent

IntentBackingStore

IntentBackingStore: { getMemberProfile: any; getMembership: any; getPowerLevelContent: any; setMembership: any; setPowerLevelContent: any }

Type declaration

Methods

Methods: "all" | "get" | "post" | "put" | "delete" | "patch" | "options" | "head" | "checkout" | "connect" | "copy" | "lock" | "merge" | "mkactivity" | "mkcol" | "move" | "m-search" | "notify" | "propfind" | "proppatch" | "purge" | "report" | "search" | "subscribe" | "trace" | "unlock" | "unsubscribe"

PowerLevelContent

PowerLevelContent: { events?: {}; events_default?: unknown; state_default?: unknown; users?: {}; users_default?: unknown }

Type declaration

  • Optional events?: {}
    • [eventType: string]: unknown
  • Optional events_default?: unknown
  • Optional state_default?: unknown
  • Optional users?: {}
    • [userId: string]: unknown
  • Optional users_default?: unknown

UserMembership

UserMembership: "join" | "invite" | "leave" | "ban" | null

Caches membership of virtual users to rooms in memory and also stores the state of whether users are registered.

UserProfile

UserProfile: { avatar_url?: string; displayname?: string }

Type declaration

  • Optional avatar_url?: string
  • Optional displayname?: string

WidgetOpts

WidgetOpts: { data?: Record<string, unknown>; extra?: Record<string, unknown>; name: string; type?: string; url: string; waitForIframeLoad: boolean }

Type declaration

  • Optional data?: Record<string, unknown>
  • Optional extra?: Record<string, unknown>
  • name: string
  • Optional type?: string
  • url: string
  • waitForIframeLoad: boolean

Variables

APPSERVICE_LOGIN_TYPE

APPSERVICE_LOGIN_TYPE: "m.login.application_service" = "m.login.application_service"

BRIDGE_PING_EVENT_TYPE

BRIDGE_PING_EVENT_TYPE: "org.matrix.bridge.ping" = "org.matrix.bridge.ping"

BRIDGE_PING_TIMEOUT_MS

BRIDGE_PING_TIMEOUT_MS: 60000 = 60000

ContentRepo

ContentRepo: { getHttpUriForMxc: (baseUrl: string, mxc: string, width?: number, height?: number, resizeMethod?: "crop" | "scale", allowDirectLinks?: boolean) => string } = ...

Type declaration

  • getHttpUriForMxc: (baseUrl: string, mxc: string, width?: number, height?: number, resizeMethod?: "crop" | "scale", allowDirectLinks?: boolean) => string
      • (baseUrl: string, mxc: string, width?: number, height?: number, resizeMethod?: "crop" | "scale", allowDirectLinks?: boolean): string

      • Get the HTTP URL for an MXC URI.

        Parameters

        • baseUrl: string

          The base homeserver url which has a content repo.

        • mxc: string

          The mxc:// URI.

        • Optional width: number

          The desired width of the thumbnail.

        • Optional height: number

          The desired height of the thumbnail.

        • Optional resizeMethod: "crop" | "scale"

          The thumbnail resize method to use, either "crop" or "scale".

        • Optional allowDirectLinks: boolean

          If true, return any non-mxc URLs directly. Fetching such URLs will leak information about the user to anyone they share a room with. If false, will return the emptry string for such URLs.

        Returns string

        The complete URL to the content. May be empty string if mxc is not a string.

DEFAULT_OPTS

DEFAULT_OPTS: MembershipQueueOptsWithDefaults = ...

Default values used by the queue if not specified.

DefaultCacheForMs

DefaultCacheForMs: number = ...

DefaultDisallowedIpRanges

DefaultDisallowedIpRanges: string[] = ...

MaxCacheForMs

MaxCacheForMs: number = ...

MinCacheForMs

MinCacheForMs: number = ...

Functions

getBridgeVersion

  • getBridgeVersion(packageJsonPath?: string): string

  • Get the current version of the bridge from the package.json file.

    Parameters

    • packageJsonPath: string = "./package.json"

      The path to the package.json of the bridge.

    Returns string

    Either the version number, or unknown.

setBridgeVersion

  • setBridgeVersion(version: string): void

  • Forcibly set the version of the bridge, for use by other components. This will override getBridgeVersions default behaviour of fetching the version from package.json.

    Parameters

    • version: string

      A version string e.g. v1.0.0

    Returns void

Generated using TypeDoc