mattermost-api: Client API for Mattermost chat system

Client API for Mattermost chat system

Versions	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
Change log	CHANGELOG.md
Dependencies	aeson (>=1.0.0.0), base (>=4.4 && <5), binary (>=0.8.1), bytestring, connection, containers, gitrev, hashable, HTTP, mattermost-api, memory (<0.14.3), microlens, microlens-th, network-uri, pretty-show, process, stm, template-haskell, text, time, unordered-containers, websockets (>=0.11.0.0) [details]
License	BSD-3-Clause
Copyright	2016-2017 Jason Dagit, Getty Ritter, Jonathan Daugherty
Author	Jason Dagit
Maintainer	dagitj@gmail.com
Category	Web
Source repo	head: git clone https://github.com/matterhorn-chat/mattermost-api.git
Uploaded	by JonathanDaugherty at Fri Mar 2 18:31:34 UTC 2018
Distributions	NixOS:40900.1.0
Executables	mm-show-raw-events, mm-get-websocket-connection, mm-make-post, mm-get-posts, mm-get-channels, mm-get-teams
Downloads	1326 total (28 in the last 30 days)
Rating	(no votes yet) [estimated by rule of succession]
Your Rating	λ λ λ
Status	Docs available [build log] Last success reported on 2018-03-02 [all 1 reports] Hackage Matrix CI

Modules

[Index]

Network
- Network.Mattermost

Flags

Name	Description	Default	Type
build-examples	Build example applications	Disabled	Automatic

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

Downloads

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

Maintainer's Corner

For package maintainers and hackage trustees

edit package information

Readme for mattermost-api-40700.0.0

[back to package description]

mattermost-api

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

Testing

We use the MaterMost 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.