Class MattermostClient

Hierarchy

MattermostClient

Constructors

constructor

new MattermostClient(personalAccessToken?: string): MattermostClient

- Defined in mattermost/src/client/index.ts:13
Parameters
- Optional personalAccessToken: string
Returns MattermostClient

Methods

addUserToChannel

addUserToChannel(__namedParameters: { channelId: string; userId: string }): Promise<unknown>

- Defined in mattermost/src/client/index.ts:109
Parameters
- __namedParameters: { channelId: string; userId: string }
  - channelId: string
  - userId: string
Returns Promise<unknown>

checkSystemHealth

checkSystemHealth(): Promise<SystemStatus>

- Defined in mattermost/src/client/index.ts:159
Returns Promise<SystemStatus>

createIncomingWebhooks

createIncomingWebhooks(params: { channelId: string; description: string; displayName: string; iconUrl: string; userId: string; userName: string }): Promise<IncomingWebhook>

- Defined in mattermost/src/client/index.ts:126
Parameters
- params: { channelId: string; description: string; displayName: string; iconUrl: string; userId: string; userName: string }
  - channelId: string
  - description: string
  - displayName: string
  - iconUrl: string
  - userId: string
  - userName: string
Returns Promise<IncomingWebhook>

createUser

createUser(user: CreateUserProfile): Promise<UserProfile>

- Defined in mattermost/src/client/index.ts:42
Parameters
- user: CreateUserProfile
Returns Promise<UserProfile>

fetchAllChannels

fetchAllChannels(queries: QueryParams): Promise<ChannelWithTeamData>

- Defined in mattermost/src/client/index.ts:95
Parameters
- queries: QueryParams
Returns Promise<ChannelWithTeamData>

fetchAllIncomingWebhooks

fetchAllIncomingWebhooks(queries: QueryParams): Promise<IncomingWebhook[]>

- Defined in mattermost/src/client/index.ts:141
Parameters
- queries: QueryParams
Returns Promise<IncomingWebhook[]>

fetchAllUsers

fetchAllUsers(queries: QueryParams): Promise<UserProfile[]>

- Defined in mattermost/src/client/index.ts:46
Parameters
- queries: QueryParams
Returns Promise<UserProfile[]>

fetchChannelMembers

fetchChannelMembers(channelId: string): Promise<ChannelMembership[]>

- Defined in mattermost/src/client/index.ts:102
Parameters
- channelId: string
Returns Promise<ChannelMembership[]>

fetchIncomingWebhook

fetchIncomingWebhook(hookId: string): Promise<IncomingWebhook>

- Defined in mattermost/src/client/index.ts:148
Parameters
- hookId: string
Returns Promise<IncomingWebhook>

fetchUser

fetchUser(userId: string): Promise<UserProfile>

- Defined in mattermost/src/client/index.ts:53
Parameters
- userId: string
Returns Promise<UserProfile>

login

login(__namedParameters: { email: string; password: string }): Promise<string>

- Defined in mattermost/src/client/index.ts:29
Parameters
- __namedParameters: { email: string; password: string }
  - email: string
  - password: string
Returns Promise<string>

logout

logout(): Promise<StatusResponse>

- Defined in mattermost/src/client/index.ts:38
Returns Promise<StatusResponse>

patchUser

patchUser(userId: string, user: Partial<UserProfile>): Promise<UserProfile>

- Defined in mattermost/src/client/index.ts:57
Parameters
- userId: string
- user: Partial<UserProfile>
Returns Promise<UserProfile>

postMessageToIncomingWebhook

postMessageToIncomingWebhook(webhookUrl: string, args: IncomingWebhookMessageParams): Promise<unknown>

- Defined in mattermost/src/client/index.ts:155
Parameters
- webhookUrl: string
- args: IncomingWebhookMessageParams
Returns Promise<unknown>

removeUserFromChannel

removeUserFromChannel(__namedParameters: { channelId: string; userId: string }): Promise<unknown>

- Defined in mattermost/src/client/index.ts:119
Parameters
- __namedParameters: { channelId: string; userId: string }
  - channelId: string
  - userId: string
Returns Promise<unknown>

sendPasswordResetEmail

sendPasswordResetEmail(email: string): Promise<StatusResponse>

- Defined in mattermost/src/client/index.ts:85
Parameters
- email: string
Returns Promise<StatusResponse>

setPersonalAccessToken

setPersonalAccessToken(personalAccessToken: string): void

- Defined in mattermost/src/client/index.ts:25
Parameters
- personalAccessToken: string
Returns void

updateUserActiveStatus

updateUserActiveStatus(userId: string, active: boolean): Promise<StatusResponse>

- Defined in mattermost/src/client/index.ts:75
Parameters
- userId: string
- active: boolean
Returns Promise<StatusResponse>

updateUserRole

updateUserRole(userId: string, roles: UserRole[]): Promise<StatusResponse>

- Defined in mattermost/src/client/index.ts:65
Parameters
- userId: string
- roles: UserRole[]
Returns Promise<StatusResponse>

Generated using TypeDoc