Interface IRead

The IRead accessor provides methods for accessing the Rocket.Chat's environment in a read-only-fashion. It is safe to be injected in multiple places, idempotent and extensible

Hierarchy

IRead

Index

Methods

Methods

getEnvironmentReader

getEnvironmentReader(): IEnvironmentRead

- Defined in accessors/IRead.ts:15
Gets the IEnvironmentRead instance, contains settings and environmental variables.

Returns IEnvironmentRead

getMessageReader

getMessageReader(): IMessageRead

- Defined in accessors/IRead.ts:18
Gets the IMessageRead instance.

Returns IMessageRead

getNotifier

getNotifier(): INotifier

- Defined in accessors/IRead.ts:30
Gets the INotifier for notifying users/rooms.

Returns INotifier

getPersistenceReader

getPersistenceReader(): IPersistenceRead

- Defined in accessors/IRead.ts:21
Gets the IPersistenceRead instance.

Returns IPersistenceRead

getRoomReader

getRoomReader(): IRoomRead

- Defined in accessors/IRead.ts:24
Gets the IRoomRead instance.

Returns IRoomRead

getUserReader

getUserReader(): IUserRead

- Defined in accessors/IRead.ts:27
Gets the IUserRead instance.

Returns IUserRead

Generated using TypeDoc