mattermost-api: Client API for Mattermost chat system

[ bsd3, library, web ] [ Propose Tags ] [ Report a vulnerability ]

Client API for Mattermost chat system. Mattermost is a flexible, open source messaging platform that meets even the most demanding privacy and security standards. This library provides network API interaction with the Mattermost server.

[Skip to Readme]

Modules

[Index] [Quick Jump]

Network
- Network.Mattermost

Flags

Automatic Flags

Name	Description	Default
build-examples	Build example applications	Disabled

Use -f <flag> to enable a flag, or -f -<flag> to disable that flag. More info

Downloads

mattermost-api-90000.0.0.tar.gz [browse] (Cabal source package)
Package description (as included in the package)

Maintainer's Corner

Package maintainers

JonathanDaugherty, KevinQuick

For package maintainers and hackage trustees

edit package information

Candidates

40400.0.0, 50200.0.1

Versions [RSS]	30802.1.0, 31000.0.0, 40000.0.0, 40000.0.1, 40000.1.0, 40400.0.0, 40600.0.0, 40600.1.0, 40700.0.0, 40800.0.0, 40800.0.1, 40800.0.2, 40900.0.0, 40900.1.0, 50200.0.0, 50200.0.1, 50200.1.0, 50200.1.2, 50200.1.3, 50200.1.4, 50200.2.0, 50200.3.0, 50200.4.0, 50200.5.0, 50200.6.0, 50200.7.0, 50200.8.0, 50200.9.0, 50200.10.0, 50200.11.0, 50200.12.0, 50200.13.0, 50200.14.0, 50200.15.0, 90000.0.0
Change log	CHANGELOG.md
Dependencies	aeson (>=2.0.1.0 && <2.2.0.0), base (>=4.4 && <5), binary (>=0.8.1), bytestring, connection, containers, crypton-connection, gitrev, hashable, HTTP (>=4000.3.15), http-media, mattermost-api, memory, microlens, microlens-th, modern-uri, network-uri, pretty-show, process, resource-pool (>=0.2.3), split, stm, template-haskell, text, time, unordered-containers, websockets (>=0.11.0.0) [details]
Tested with	ghc ==7.10.3, ghc ==8.0.1
License	BSD-3-Clause
Copyright	2016-2020 Jason Dagit, Getty Ritter, Jonathan Daugherty
Author
Maintainer	matterhorn@galois.com
Category	Web
Source repo	head: git clone https://github.com/matterhorn-chat/mattermost-api.git
Uploaded	by JonathanDaugherty at 2024-02-03T00:21:16Z
Distributions	NixOS:90000.0.0
Reverse Dependencies	2 direct, 1 indirect [details]
Executables	mm-show-raw-events, mm-get-websocket-connection, mm-make-post, mm-get-posts, mm-get-channels, mm-get-teams
Downloads	17774 total (37 in the last 30 days)
Rating	(no votes yet) [estimated by Bayesian average]
Your Rating	λ λ λ
Status	Docs available [build log] Last success reported on 2024-02-03 [all 1 reports]

Readme for mattermost-api-90000.0.0

[back to package description]

mattermost-api

Client-side API for communicating with a Mattermost server, written in Haskell.

Testing

We use the MatterMost docker image for detecting changes in the API. See .travis.yml or the Mattermost docs for the details.

If you are testing your changes locally during development, you will want to run the script ./test/local_test_mm.sh.

Note: The local_test_mm.sh script will stop and remove a docker container named mattermost-preview.

Note: The tests can only be run once against a given Mattermost instance. This is because the scripts currently assume they can create an initial admin user.

Note: The scripts assume the instance is reachable on localhost:8065 over plain HTTP.

For use in production we use TLS, but for testing purposes we avoid the certificate setup.

Our Versioning Scheme

This library uses the same versioning scheme as matterhorn, see Our Versioning Scheme. The short version is that in ABBCC.X.Y, the ABBCC corresponds to Mattermost server version A.BB.CC and the X.Y portion of the version string corresponds to the version of mattermost-api package releases.