Classes
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. |
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. |
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. |
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. |
The parts of the permalink.