Ready-to-use .NET Standard library for convenient development of Mattermost bots.
The library is available as a NuGet package. You can install it using the NuGet Package Manager or the dotnet CLI.
dotnet add package Mattermost.NETusing Mattermost.NET;
const string token = "37VlFKySIZn6gryA85cR1GKBQkjmfRZ6";
const string server = "https://mm.your-server.com"; // or https://community.mattermost.com by default
MattermostClient client = new(server);var botUser = await client.LoginAsync(token);
// Or you can use constructor if you have API key, ex. personal or bot token
// It will automatically authenticate the bot
MattermostClient client = new(server, apiKey);client.OnMessageReceived += ClientOnMessageReceived;
private static void ClientOnMessageReceived(object? sender, MessageEventArgs e)
{
if (string.IsNullOrWhiteSpace(e.Message.Post.Text))
{
return;
}
e.Client.SendMessageAsync(e.Message.Post.ChannelId, "Hello, World!");
}await client.StartReceivingAsync();Note: The bot will automatically reconnect if the connection is lost. It's not required to call
StartReceivingAsyncif you don't want to receive updates through the WebSocket connection.
await client.StopReceivingAsync();string channelId - The ID of the channel to send the message to.
string message - The message to send.
string replyToPostId - The ID of the post to reply to (optional).
MessagePriority priority - The priority of the message, default is MessagePriority.Empty.
IEnumerable<string> files - The files to upload, you have to upload files before sending the message.
IDictionary<string, object>? props - The properties of the post (optional).
Example:
await client.CreatePostAsync("channel_id", "Hello, World!");string postId - The ID of the post to get.
Example:
var post = await client.GetPostAsync("post_id");string channelId - The ID of the channel to get posts from.
int page - The page number to get (default is 0).
int perPage - The number of posts per page (default is 60).
string? beforePostId - The ID of the post to get posts before (optional).
string? afterPostId - The ID of the post to get posts after (optional).
bool includeDeleted - Whether to include deleted posts (default is false).
DateTime? since - The date to get posts since (optional).
Example:
var posts = await client.GetChannelPostsAsync("channel_id", 0, 60);
// or
var posts = await client.GetChannelPostsAsync("channel_id", since: DateTime.UtcNow);string postId - The ID of the post to update.
string message - The new message text.
IDictionary<string, object>? props - The properties of the post (optional).
Example:
await client.UpdatePostAsync("post_id", "I changed my mind");string postId - The ID of the post to delete.
Example:
await client.DeletePostAsync("post_id");string teamId - The ID of the team to create the channel in.
string name - The name of the channel to create.
string displayName - The display name of the channel to create.
ChannelType channelType - The type of the channel to create.
string purpose - The purpose of the channel to create (optional).
string header - The header of the channel to create (optional).
Example:
await client.CreateChannelAsync("team_id", "channel_name", "Channel display name", ChannelType.Public, "Channel purpose", "Channel header");string[] userIds - The IDs of the users to create the group channel with.
Example:
await client.CreateGroupChannelAsync([ "user_id_1", "user_id_2" ]);string channelId - The ID of the channel to add the user to.
string userId - The ID of the user to add to the channel.
Example:
await client.AddUserToChannelAsync("channel_id", "user_id");string channelId - The ID of the channel to remove the user from.
string userId - The ID of the user to remove from the channel.
Example:
await client.DeleteUserFromChannelAsync("channel_id", "user_id");string teamId - The ID of the team to search in.
string channelName - The name of the channel to search for.
Example:
Channel? channel = await client.FindChannelByNameAsync("team_id", "channel_name");string channelId - The ID of the channel to archive.
Example:
bool archived = await client.ArchiveChannelAsync("channel_id");string fileId - The ID of the file to get.
Example:
byte[] file = await client.GetFileAsync("file_id");string fileId - The ID of the file to get.
Example:
FileDetails fileDetails = await client.GetFileDetailsAsync("file_id");string channelId - The ID of the channel to upload the file to.
string filePath - The path to the file to upload.
Action<int>? progressChanged - The action to call with the upload progress.
Example:
var callback = new Action<int>(progress => Console.WriteLine($"Upload progress: {progress}%"));
await client.UploadFileAsync("channel_id", "file_path", callback);Example:
User me = await client.GetMeAsync();string userId - The ID of the user to get.
Example:
User user = await client.GetUserAsync("user_id");string username - The username of the user to get.
Example:
User user = await client.GetUserByUsernameAsync("username");SetChannelCallStateAsync - Set call state for specified channel ('Calls' plugin required).
If you are looking for another methods, please visit the Mattermost API documentation and create an issue in the GitHub repository with what exact methods you need - I will add them as soon as possible.
Distributed under the MIT License. See LICENSE.md for more information.
