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

getCloudWorkspaceReader getEnvironmentReader getLivechatReader getMessageReader getNotifier getOAuthAppsReader getPersistenceReader getRoleReader getRoomReader getThreadReader getUploadReader getUserReader getVideoConferenceReader

Methods

getCloudWorkspaceReader

getCloudWorkspaceReader(): ICloudWorkspaceRead
Returns ICloudWorkspaceRead
- Defined in src/definition/accessors/IRead.ts:45

getEnvironmentReader

getEnvironmentReader(): IEnvironmentRead
Gets the IEnvironmentRead instance, contains settings and environmental variables.

Returns IEnvironmentRead
- Defined in src/definition/accessors/IRead.ts:22

getLivechatReader

getLivechatReader(): ILivechatRead
Returns ILivechatRead
- Defined in src/definition/accessors/IRead.ts:43

getMessageReader

getMessageReader(): IMessageRead
Gets the IMessageRead instance.

Returns IMessageRead
- Defined in src/definition/accessors/IRead.ts:29

getNotifier

getNotifier(): INotifier
Gets the INotifier for notifying users/rooms.

Returns INotifier
- Defined in src/definition/accessors/IRead.ts:41

getOAuthAppsReader

getOAuthAppsReader(): IOAuthAppsReader
Returns IOAuthAppsReader
- Defined in src/definition/accessors/IRead.ts:49

getPersistenceReader

getPersistenceReader(): IPersistenceRead
Gets the IPersistenceRead instance.

Returns IPersistenceRead
- Defined in src/definition/accessors/IRead.ts:32

getRoleReader

getRoleReader(): IRoleRead
Returns IRoleRead
- Defined in src/definition/accessors/IRead.ts:51

getRoomReader

getRoomReader(): IRoomRead
Gets the IRoomRead instance.

Returns IRoomRead
- Defined in src/definition/accessors/IRead.ts:35

getThreadReader

getThreadReader(): IThreadRead
Gets the IThreadRead instance

Returns IThreadRead
- Defined in src/definition/accessors/IRead.ts:26

getUploadReader

getUploadReader(): IUploadRead
Returns IUploadRead
- Defined in src/definition/accessors/IRead.ts:44

getUserReader

getUserReader(): IUserRead
Gets the IUserRead instance.

Returns IUserRead
- Defined in src/definition/accessors/IRead.ts:38

getVideoConferenceReader

getVideoConferenceReader(): IVideoConferenceRead
Returns IVideoConferenceRead
- Defined in src/definition/accessors/IRead.ts:47

Generated using TypeDoc