Interface IRedactOpts

interface IRedactOpts {
    reason?: string;
    with_rel_types?: ("*" | RelationType)[];
}

Properties

reason? with_rel_types?

Properties

Optionalreason

reason?: string

Optionalwith_rel_types

with_rel_types?: ("*" | RelationType)[]

If specified, then any events which relate to the event being redacted with any of the relationship types listed will also be redacted. Provide a "*" list item to tell the server to redact relations of any type.

Raises an Error if the server does not support it. Check for server-side support before using this param with client.canSupport.get(Feature.RelationBasedRedactions). https://github.com/matrix-org/matrix-spec-proposals/pull/3912

Settings

Member Visibility

On This Page

Properties