Class MatrixServerService

Provides services to implement Matrix HomeServer features.

Methods in this service should only provide means to implement features, e.g. not have control itself. Actual control of things must reside in the user side of this service.

See

HsBackendController

Hierarchy

MatrixServerService

Constructors

constructor

new MatrixServerService(url: string, hostname: string, deviceService: DeviceRepositoryService, userService: UserRepositoryService, roomService: RoomRepositoryService, eventService: EventRepositoryService, jwtEngine: JwtEngine, accessTokenExpirationTime?: number, defaultRoomVersion?: MatrixRoomVersion): MatrixServerService
Parameters
- url: string
- hostname: string
- deviceService: DeviceRepositoryService
- userService: UserRepositoryService
- roomService: RoomRepositoryService
- eventService: EventRepositoryService
- jwtEngine: JwtEngine
- accessTokenExpirationTime: number = DEFAULT_ACCESS_TOKEN_EXPIRATION_TIME
  
  Expiration time in minutes for access tokens
- defaultRoomVersion: MatrixRoomVersion = MatrixRoomVersion.V8
  
  Defaults to room version 8
Returns MatrixServerService
- Defined in fi/hg/matrix/server/MatrixServerService.ts:79

Properties

`Private` `Readonly` _accessTokenExpirationTime

_accessTokenExpirationTime: number

`Private` `Readonly` _defaultRoomVersion

_defaultRoomVersion: MatrixRoomVersion

`Private` `Readonly` _deviceService

_deviceService: DeviceRepositoryService

`Private` `Readonly` _eventService

_eventService: EventRepositoryService

`Private` `Readonly` _hostname

_hostname: string

`Private` `Readonly` _jwtEngine

_jwtEngine: JwtEngine

`Private` `Readonly` _roomService

_roomService: RoomRepositoryService

`Private` `Readonly` _url

_url: string

`Private` `Readonly` _userService

_userService: UserRepositoryService

Methods

createAdminRegisterNonce

createAdminRegisterNonce(): Promise<string>
Get a nonce for registration

See
https://github.com/heusalagroup/hghs/issues/1

TODO

Returns Promise<string>
- Defined in fi/hg/matrix/server/MatrixServerService.ts:159

createRoom

createRoom(userId: string, deviceId: string, roomVersion: MatrixRoomVersion, visibility: MatrixVisibility): Promise<CreateRoomResponse>
Create a room
Parameters
- userId: string
- deviceId: string
- roomVersion: MatrixRoomVersion
- visibility: MatrixVisibility
Returns Promise<CreateRoomResponse>
- Defined in fi/hg/matrix/server/MatrixServerService.ts:278

createRoomCreateEvent

createRoomCreateEvent(senderId: string, roomId: string, roomVersion?: MatrixRoomVersion, creatorId?: string, extraContent?: Partial<MatrixRoomCreateEventDTO>, originServerTs?: number): Promise<EventRepositoryItem>
Creates m.room.create event.

See
https://github.com/heusalagroup/hghs/issues/23
Parameters
- senderId: string
- roomId: string
- roomVersion: MatrixRoomVersion = MatrixRoomVersion.V1
- creatorId: string = senderId
- extraContent: Partial<MatrixRoomCreateEventDTO> = undefined
- originServerTs: number = ...
Returns Promise<EventRepositoryItem>
- Defined in fi/hg/matrix/server/MatrixServerService.ts:340

createRoomMemberEvent

createRoomMemberEvent(senderId: string, roomId: string, membership: RoomMembershipState, reason?: string, userId?: string, avatar_url?: string, displayname?: string, is_direct?: boolean, join_authorised_via_users_server?: string, third_party_invite?: RoomMemberContent3rdPartyInviteDTO, originServerTs?: number): Promise<EventRepositoryItem>
Creates m.room.member event

See
https://github.com/heusalagroup/hghs/issues/24
Parameters
- senderId: string
- roomId: string
- membership: RoomMembershipState
- Optional reason: string
- userId: string = senderId
- Optional avatar_url: string
- Optional displayname: string
- Optional is_direct: boolean
- Optional join_authorised_via_users_server: string
- Optional third_party_invite: RoomMemberContent3rdPartyInviteDTO
- originServerTs: number = ...
Returns Promise<EventRepositoryItem>
- Defined in fi/hg/matrix/server/MatrixServerService.ts:368

createRoomStateEvent

createRoomStateEvent(senderId: string, roomId: string, content: ReadonlyJsonObject, type: string, stateKey: string, originServerTs?: number): Promise<EventRepositoryItem>
Create room state event
Parameters
- senderId: string
- roomId: string
- content: ReadonlyJsonObject
- type: string
- stateKey: string
- originServerTs: number = ...
Returns Promise<EventRepositoryItem>
- Defined in fi/hg/matrix/server/MatrixServerService.ts:311

createUser

createUser(username: string, password: string, email?: string): Promise<User>
Parameters
- username: string
- password: string
- Optional email: string
Returns Promise<User>
- Defined in fi/hg/matrix/server/MatrixServerService.ts:126

findDeviceById

findDeviceById(deviceId: string): Promise<DeviceRepositoryItem>
Returns the device record by internal ID
Parameters
- deviceId: string
Returns Promise<DeviceRepositoryItem>
- Defined in fi/hg/matrix/server/MatrixServerService.ts:255

findUserById

findUserById(userId: string): Promise<UserRepositoryItem>
Returns the user record by internal ID
Parameters
- userId: string
Returns Promise<UserRepositoryItem>
- Defined in fi/hg/matrix/server/MatrixServerService.ts:266

getCurrentTimestamp

getCurrentTimestamp(): number
Returns number
- Defined in fi/hg/matrix/server/MatrixServerService.ts:400

getDefaultRoomVersion

getDefaultRoomVersion(): MatrixRoomVersion
Returns MatrixRoomVersion
- Defined in fi/hg/matrix/server/MatrixServerService.ts:105

getHostName

getHostName(): string
Returns string
- Defined in fi/hg/matrix/server/MatrixServerService.ts:101

getURL

getURL(): string
Returns string
- Defined in fi/hg/matrix/server/MatrixServerService.ts:109

initialize

initialize(): Promise<void>
Called once after every member has been initialized

Returns Promise<void>
- Defined in fi/hg/matrix/server/MatrixServerService.ts:116

loginWithPassword

loginWithPassword(username: string, password: string, deviceId?: string): Promise<string>
See
https://github.com/heusalagroup/hghs/issues/28
Parameters
- username: string
- password: string
- Optional deviceId: string
  
  This is the optional device ID provided by the client
Returns Promise<string>
- Defined in fi/hg/matrix/server/MatrixServerService.ts:170

verifyAccessToken

verifyAccessToken(accessToken: string): Promise<string>
Verifies access token and returns the device it belongs to.

Returns
string The device id if access token is valid
Parameters
- accessToken: string
Returns Promise<string>
- Defined in fi/hg/matrix/server/MatrixServerService.ts:240

`Static` setLogLevel

setLogLevel(level: LogLevel): void
Parameters
- level: LogLevel
Returns void
- Defined in fi/hg/matrix/server/MatrixServerService.ts:53

Class MatrixServerService

See

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

url: string

hostname: string

deviceService: DeviceRepositoryService

userService: UserRepositoryService

roomService: RoomRepositoryService

eventService: EventRepositoryService

jwtEngine: JwtEngine

accessTokenExpirationTime: number = DEFAULT_ACCESS_TOKEN_EXPIRATION_TIME

defaultRoomVersion: MatrixRoomVersion = MatrixRoomVersion.V8

Returns MatrixServerService

Properties

Private Readonly _accessTokenExpirationTime

Private Readonly _defaultRoomVersion

Private Readonly _deviceService

Private Readonly _eventService

Private Readonly _hostname

Private Readonly _jwtEngine

Private Readonly _roomService

Private Readonly _url

Private Readonly _userService

Methods

createAdminRegisterNonce

See

TODO

Returns Promise<string>

createRoom

Parameters

userId: string

deviceId: string

roomVersion: MatrixRoomVersion

visibility: MatrixVisibility

Returns Promise<CreateRoomResponse>

createRoomCreateEvent

See

Parameters

senderId: string

roomId: string

roomVersion: MatrixRoomVersion = MatrixRoomVersion.V1

creatorId: string = senderId

extraContent: Partial<MatrixRoomCreateEventDTO> = undefined

originServerTs: number = ...

Returns Promise<EventRepositoryItem>

createRoomMemberEvent

See

Parameters

senderId: string

roomId: string

membership: RoomMembershipState

Optional reason: string

userId: string = senderId

Optional avatar_url: string

Optional displayname: string

Optional is_direct: boolean

Optional join_authorised_via_users_server: string

Optional third_party_invite: RoomMemberContent3rdPartyInviteDTO

originServerTs: number = ...

Returns Promise<EventRepositoryItem>

createRoomStateEvent

Parameters

senderId: string

roomId: string

content: ReadonlyJsonObject

type: string

stateKey: string

originServerTs: number = ...

Returns Promise<EventRepositoryItem>

createUser

Parameters

username: string

password: string

`Private` `Readonly` _accessTokenExpirationTime

`Private` `Readonly` _defaultRoomVersion

`Private` `Readonly` _deviceService

`Private` `Readonly` _eventService

`Private` `Readonly` _hostname

`Private` `Readonly` _jwtEngine

`Private` `Readonly` _roomService

`Private` `Readonly` _url

`Private` `Readonly` _userService

`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

`Optional` email: string

`Optional` deviceId: string

`Static` setLogLevel