Class MatrixLink

Link to a room, a user or an event: a matrix.to link, a matrix: URI or a bare identifier.

Inheritance

object

MatrixLink

Implements

IEquatable<MatrixLink>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Namespace: Uniform.Matrix.Protocol.Core

Assembly: Uniform.Matrix.Protocol.Core.dll

Syntax

public sealed record MatrixLink : IEquatable<MatrixLink>

Properties

EventId

Event in the room, or null.

Declaration

public string? EventId { get; init; }

Property Value

Type	Description
string

IsUser

Whether the link is to a user.

Declaration

public bool IsUser { get; }

Property Value

Type	Description
bool

Target

Room ID (!), room alias (#) or user ID (@).

Declaration

public string Target { get; init; }

Property Value

Type	Description
string

Via

Servers to join the room through, from via parameters.

Declaration

public IReadOnlyList<string> Via { get; init; }

Property Value

Type	Description
IReadOnlyList<string>

Methods

Equals(MatrixLink?)

Compare by target, event and servers.

Declaration

public bool Equals(MatrixLink? other)

Parameters

Type	Name	Description
MatrixLink	other

Returns

Type	Description
bool

FindAll(string?)

Return the matrix.to links and matrix: URIs in text, e.g. a message body or its HTML, once each, in order.

Declaration

public static IReadOnlyList<MatrixLink> FindAll(string? text)

Parameters

Type	Name	Description
string	text

Returns

Type	Description
IReadOnlyList<MatrixLink>

GetHashCode()

Hash of the target and event.

Declaration

public override int GetHashCode()

Returns

Type	Description
int

Overrides

object.GetHashCode()

ToString()

Format as a matrix.to link.

Declaration

public override string ToString()

Returns

Type	Description
string

Overrides

object.ToString()

TryParse(string?, out MatrixLink?)

Parse value; false when it is not a link or identifier of a room, user or event.

Declaration

public static bool TryParse(string? value, out MatrixLink? link)

Parameters

Type	Name	Description
string	value	E.g. https://matrix.to/#/#room:example.org, matrix:roomid/abc:example.org?via=example.org or !abc:example.org.
MatrixLink	link	The link.

Returns

Type	Description
bool

Implements

IEquatable<T>