Class

Permalinks

Permalinks()

Functions for handling permalinks
Constructor

View Source helpers/Permalinks.ts, line 6

Classes

Permalinks

Methods

# static forEvent(roomIdOrAlias, eventId, viaServers) → {string}

Creates an event permalink.
Parameters:
Name Type Description
roomIdOrAlias string The room ID or alias to create a permalink in.
eventId string The event ID to reference in the permalink.
viaServers Array.<string> The servers to route the permalink through.

View Source helpers/Permalinks.ts, line 124

An event permalink.
string

# static forRoom(roomIdOrAlias, viaServers) → {string}

Creates a room permalink.
Parameters:
Name Type Description
roomIdOrAlias string The room ID or alias to create a permalink for.
viaServers Array.<string> The servers to route the permalink through.

View Source helpers/Permalinks.ts, line 106

A room permalink.
string

# static forUser(userId) → {string}

Creates a user permalink.
Parameters:
Name Type Description
userId string The user ID to create a permalink for.

View Source helpers/Permalinks.ts, line 114

A user permalink.
string

# static parseUrl(matrixTo) → {PermalinkParts}

Parses a permalink URL into usable parts.
Parameters:
Name Type Description
matrixTo string The matrix.to URL to parse.

View Source helpers/Permalinks.ts, line 132

The parts of the permalink.