Class MatrixUtils

Hierarchy

MatrixUtils

Index

Constructors

Methods

createRoomGuestAccessEventDTO createRoomHistoryVisibilityEventDTO createRoomJoinRulesEventDTO createRoomMemberEventDTO getRoomAlias getRoomId getRoomPresetFromVisibility getRoomStateEventsFromPreset getUserId

Constructors

constructor

new MatrixUtils(): MatrixUtils
Returns MatrixUtils

Methods

`Static` createRoomGuestAccessEventDTO

createRoomGuestAccessEventDTO(access: MatrixGuestAccess): RoomGuestAccessStateEventDTO
Parameters
- access: MatrixGuestAccess
Returns RoomGuestAccessStateEventDTO
- Defined in fi/hg/matrix/MatrixUtils.ts:94

`Static` createRoomHistoryVisibilityEventDTO

createRoomHistoryVisibilityEventDTO(visibility: MatrixHistoryVisibility): RoomHistoryVisibilityStateEventDTO
Parameters
- visibility: MatrixHistoryVisibility
Returns RoomHistoryVisibilityStateEventDTO
- Defined in fi/hg/matrix/MatrixUtils.ts:84

`Static` createRoomJoinRulesEventDTO

createRoomJoinRulesEventDTO(roomId: string, joinRule: MatrixJoinRule): RoomJoinRulesStateEventDTO
Parameters
- roomId: string
- joinRule: MatrixJoinRule
Returns RoomJoinRulesStateEventDTO
- Defined in fi/hg/matrix/MatrixUtils.ts:67

`Static` createRoomMemberEventDTO

createRoomMemberEventDTO(userId: string, membership: RoomMembershipState, reason?: string, avatar_url?: string, displayname?: string, is_direct?: boolean, join_authorised_via_users_server?: string, third_party_invite?: RoomMemberContent3rdPartyInviteDTO): RoomMemberStateEventDTO
Parameters
- userId: string
- membership: RoomMembershipState
- Optional reason: string
- Optional avatar_url: string
- Optional displayname: string
- Optional is_direct: boolean
- Optional join_authorised_via_users_server: string
- Optional third_party_invite: RoomMemberContent3rdPartyInviteDTO
Returns RoomMemberStateEventDTO
- Defined in fi/hg/matrix/MatrixUtils.ts:102

`Static` getRoomAlias

getRoomAlias(alias: string, hostname: string): string
Parameters
- alias: string
- hostname: string
Returns string
- Defined in fi/hg/matrix/MatrixUtils.ts:37

`Static` getRoomId

getRoomId(id: string, hostname: string): string
Parameters
- id: string
- hostname: string
Returns string
- Defined in fi/hg/matrix/MatrixUtils.ts:44

`Static` getRoomPresetFromVisibility

getRoomPresetFromVisibility(visibility: MatrixVisibility): MatrixCreateRoomPreset
Get default preset from visibility setting

See
https://spec.matrix.org/v1.2/client-server-api/#post_matrixclientv3createroom
Parameters
- visibility: MatrixVisibility
Returns MatrixCreateRoomPreset
- Defined in fi/hg/matrix/MatrixUtils.ts:57

`Static` getRoomStateEventsFromPreset

getRoomStateEventsFromPreset(roomId: string, preset: MatrixCreateRoomPreset): readonly MatrixStateEvent[]
Get initial room state events for specific preset

See
https://spec.matrix.org/v1.2/client-server-api/#post_matrixclientv3createroom
Parameters
- roomId: string
- preset: MatrixCreateRoomPreset
Returns readonly MatrixStateEvent[]
- Defined in fi/hg/matrix/MatrixUtils.ts:133

`Static` getUserId

getUserId(username: string, hostname: string): string
Parameters
- username: string
- hostname: string
Returns string
- Defined in fi/hg/matrix/MatrixUtils.ts:30

Class MatrixUtils

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Returns MatrixUtils

Methods

Static createRoomGuestAccessEventDTO

Parameters

access: MatrixGuestAccess

Returns RoomGuestAccessStateEventDTO

Static createRoomHistoryVisibilityEventDTO

Parameters

visibility: MatrixHistoryVisibility

Returns RoomHistoryVisibilityStateEventDTO

Static createRoomJoinRulesEventDTO

Parameters

roomId: string

joinRule: MatrixJoinRule

Returns RoomJoinRulesStateEventDTO

Static createRoomMemberEventDTO

Parameters

userId: string

membership: RoomMembershipState

Optional reason: string

Optional avatar_url: string

Optional displayname: string

Optional is_direct: boolean

Optional join_authorised_via_users_server: string

Optional third_party_invite: RoomMemberContent3rdPartyInviteDTO

Returns RoomMemberStateEventDTO

Static getRoomAlias

Parameters

alias: string

hostname: string

Returns string

Static getRoomId

Parameters

id: string

hostname: string

Returns string

Static getRoomPresetFromVisibility

See

Parameters

visibility: MatrixVisibility

Returns MatrixCreateRoomPreset

Static getRoomStateEventsFromPreset

See

Parameters

roomId: string

preset: MatrixCreateRoomPreset

Returns readonly MatrixStateEvent[]

Static getUserId

Parameters

username: string

hostname: string

Returns string

Settings

Member Visibility

Theme

`Static` createRoomGuestAccessEventDTO

`Static` createRoomHistoryVisibilityEventDTO

`Static` createRoomJoinRulesEventDTO

`Static` createRoomMemberEventDTO

`Optional` reason: string

`Optional` avatar_url: string

`Optional` displayname: string

`Optional` is_direct: boolean

`Optional` join_authorised_via_users_server: string

`Optional` third_party_invite: RoomMemberContent3rdPartyInviteDTO

`Static` getRoomAlias

`Static` getRoomId

`Static` getRoomPresetFromVisibility

`Static` getRoomStateEventsFromPreset

`Static` getUserId