Module net.bis5.mattermost4j.core

Package net.bis5.mattermost.client4.api

Interface BotsApi

All Known Implementing Classes:

MattermostClient

public interface BotsApi

Bots API.

Since:

Mattermost Server 5.12

Author:

Takayuki Maruyama

Method Summary

Modifier and Type	Method	Description
ApiResponse<Bot>	assignBotToUser(String botUserId, String ownerUserId)	Assign a bot to a user.
ApiResponse<Bot>	createBot(BotPatch bot)	Create a bot.
ApiResponse<Bot>	disableBot(String botUserId)	Disable a bot.
ApiResponse<Bot>	enableBot(String botUserId)	Enable a bot.
default ApiResponse<Bot>	getBot(String botUserId)	Get a bot exclude deleted.
ApiResponse<Bot>	getBot(String botUserId, boolean includeDeleted)	Get a bot.
default ApiResponse<Bots>	getBots()	Get bots.
default ApiResponse<Bots>	getBots(GetBotsOption option)	Get bots.
ApiResponse<Bots>	getBots(Pager pager, GetBotsOption option)	Get bots.
ApiResponse<Bot>	patchBot(String botUserId, BotPatch patch)	Patch a bot.

Method Detail

createBot

ApiResponse<Bot> createBot(BotPatch bot)

Create a bot.

patchBot

ApiResponse<Bot> patchBot(String botUserId,
                          BotPatch patch)

Patch a bot.

getBot

default ApiResponse<Bot> getBot(String botUserId)

Get a bot exclude deleted.

getBot

ApiResponse<Bot> getBot(String botUserId,
                        boolean includeDeleted)

Get a bot.

getBots

default ApiResponse<Bots> getBots()

Get bots.

See Also:

GetBotsOption

getBots

default ApiResponse<Bots> getBots(GetBotsOption option)

Get bots.

getBots

ApiResponse<Bots> getBots(Pager pager,
                          GetBotsOption option)

Get bots.

disableBot

ApiResponse<Bot> disableBot(String botUserId)

Disable a bot.

enableBot

ApiResponse<Bot> enableBot(String botUserId)

Enable a bot.

assignBotToUser

ApiResponse<Bot> assignBotToUser(String botUserId,
                                 String ownerUserId)

Assign a bot to a user.