net.bis5.mattermost.client4.api

Interface WebhookApi

All Known Implementing Classes:

MattermostClient

public interface WebhookApi

Webhook API.

Author:

Takayuki Maruyama

Method Summary

Modifier and Type	Method and Description
ApiResponse<IncomingWebhook>	createIncomingWebhook(IncomingWebhook hook) creates an incoming webhook for a channel.
ApiResponse<OutgoingWebhook>	createOutgoingWebhook(OutgoingWebhook hook) creates an outgoing webhook for a team or channel.
ApiResponse<Boolean>	deleteIncomingWebhook(String hookId) deletes an Incoming Webhook given the hook id.
ApiResponse<Boolean>	deleteOutgoingWebhook(String hookId) delete the outgoing webhook on the system requested by hook id.
default ApiResponse<IncomingWebhook>	getIncomingWebhook(String hookId) returns an Incoming webhook given the hook id.
ApiResponse<IncomingWebhook>	getIncomingWebhook(String hookId, String etag) returns an Incoming webhook given the hook id.
default ApiResponse<IncomingWebhookList>	getIncomingWebhooks() returns a page of incoming webhooks on the system.
default ApiResponse<IncomingWebhookList>	getIncomingWebhooks(Pager pager) returns a page of incoming webhooks on the system.
ApiResponse<IncomingWebhookList>	getIncomingWebhooks(Pager pager, String etag) returns a page of incoming webhooks on the system.
default ApiResponse<IncomingWebhookList>	getIncomingWebhooksForTeam(String teamId) returns a page of incoming webhooks for a team.
default ApiResponse<IncomingWebhookList>	getIncomingWebhooksForTeam(String teamId, Pager pager) returns a page of incoming webhooks for a team.
ApiResponse<IncomingWebhookList>	getIncomingWebhooksForTeam(String teamId, Pager pager, String etag) returns a page of incoming webhooks for a team.
ApiResponse<OutgoingWebhook>	getOutgoingWebhook(String hookId) outgoing webhooks on the system requested by hook id.
default ApiResponse<OutgoingWebhookList>	getOutgoingWebhooks() returns a page of outgoing webhooks ont eh system.
default ApiResponse<OutgoingWebhookList>	getOutgoingWebhooks(Pager pager) returns a page of outgoing webhooks ont eh system.
ApiResponse<OutgoingWebhookList>	getOutgoingWebhooks(Pager pager, String etag) returns a page of outgoing webhooks ont eh system.
default ApiResponse<OutgoingWebhookList>	getOutgoingWebhooksForChannel(String channelId) returns a page of outgoing webhooks for a channel.
default ApiResponse<OutgoingWebhookList>	getOutgoingWebhooksForChannel(String channelId, Pager pager) returns a page of outgoing webhooks for a channel.
ApiResponse<OutgoingWebhookList>	getOutgoingWebhooksForChannel(String channelId, Pager pager, String etag) returns a page of outgoing webhooks for a channel.
default ApiResponse<OutgoingWebhookList>	getOutgoingWebhooksForTeam(String teamId) returns a page of outgoing webhooks for a team.
default ApiResponse<OutgoingWebhookList>	getOutgoingWebhooksForTeam(String teamId, Pager pager) returns a page of outgoing webhooks for a team.
ApiResponse<OutgoingWebhookList>	getOutgoingWebhooksForTeam(String teamId, Pager pager, String etag) returns a page of outgoing webhooks for a team.
ApiResponse<OutgoingWebhook>	regenOutgoingHookToken(String hookId) regenerate the outgoing webhook token.
ApiResponse<IncomingWebhook>	updateIncomingWebhook(IncomingWebhook hook) updates an incoming webhook for a channel.
ApiResponse<OutgoingWebhook>	updateOutgoingWebhook(OutgoingWebhook hook) updates an outgoing webhook.

Method Detail

createIncomingWebhook

ApiResponse<IncomingWebhook> createIncomingWebhook(IncomingWebhook hook)

creates an incoming webhook for a channel.

updateIncomingWebhook

ApiResponse<IncomingWebhook> updateIncomingWebhook(IncomingWebhook hook)

updates an incoming webhook for a channel.

getIncomingWebhooks

default ApiResponse<IncomingWebhookList> getIncomingWebhooks()

returns a page of incoming webhooks on the system. Page counting starts at 0.

getIncomingWebhooks

default ApiResponse<IncomingWebhookList> getIncomingWebhooks(Pager pager)

returns a page of incoming webhooks on the system. Page counting starts at 0.

getIncomingWebhooks

ApiResponse<IncomingWebhookList> getIncomingWebhooks(Pager pager,
                                                     String etag)

returns a page of incoming webhooks on the system. Page counting starts at 0.

getIncomingWebhooksForTeam

default ApiResponse<IncomingWebhookList> getIncomingWebhooksForTeam(String teamId)

returns a page of incoming webhooks for a team. Page counting starts at 0.

getIncomingWebhooksForTeam

default ApiResponse<IncomingWebhookList> getIncomingWebhooksForTeam(String teamId,
                                                                    Pager pager)

returns a page of incoming webhooks for a team. Page counting starts at 0.

getIncomingWebhooksForTeam

ApiResponse<IncomingWebhookList> getIncomingWebhooksForTeam(String teamId,
                                                            Pager pager,
                                                            String etag)

returns a page of incoming webhooks for a team. Page counting starts at 0.

getIncomingWebhook

default ApiResponse<IncomingWebhook> getIncomingWebhook(String hookId)

returns an Incoming webhook given the hook id.

getIncomingWebhook

ApiResponse<IncomingWebhook> getIncomingWebhook(String hookId,
                                                String etag)

returns an Incoming webhook given the hook id.

deleteIncomingWebhook

ApiResponse<Boolean> deleteIncomingWebhook(String hookId)

deletes an Incoming Webhook given the hook id.

createOutgoingWebhook

ApiResponse<OutgoingWebhook> createOutgoingWebhook(OutgoingWebhook hook)

creates an outgoing webhook for a team or channel.

updateOutgoingWebhook

ApiResponse<OutgoingWebhook> updateOutgoingWebhook(OutgoingWebhook hook)

updates an outgoing webhook.

getOutgoingWebhooks

default ApiResponse<OutgoingWebhookList> getOutgoingWebhooks()

returns a page of outgoing webhooks ont eh system. Page counting starts at 0.

getOutgoingWebhooks

default ApiResponse<OutgoingWebhookList> getOutgoingWebhooks(Pager pager)

returns a page of outgoing webhooks ont eh system. Page counting starts at 0.

getOutgoingWebhooks

ApiResponse<OutgoingWebhookList> getOutgoingWebhooks(Pager pager,
                                                     String etag)

returns a page of outgoing webhooks ont eh system. Page counting starts at 0.

getOutgoingWebhook

ApiResponse<OutgoingWebhook> getOutgoingWebhook(String hookId)

outgoing webhooks on the system requested by hook id.

getOutgoingWebhooksForChannel

default ApiResponse<OutgoingWebhookList> getOutgoingWebhooksForChannel(String channelId)

returns a page of outgoing webhooks for a channel. Page counting starts at 0.

getOutgoingWebhooksForChannel

default ApiResponse<OutgoingWebhookList> getOutgoingWebhooksForChannel(String channelId,
                                                                       Pager pager)

returns a page of outgoing webhooks for a channel. Page counting starts at 0.

getOutgoingWebhooksForChannel

ApiResponse<OutgoingWebhookList> getOutgoingWebhooksForChannel(String channelId,
                                                               Pager pager,
                                                               String etag)

returns a page of outgoing webhooks for a channel. Page counting starts at 0.

getOutgoingWebhooksForTeam

default ApiResponse<OutgoingWebhookList> getOutgoingWebhooksForTeam(String teamId)

returns a page of outgoing webhooks for a team. Page counting starts at 0.

getOutgoingWebhooksForTeam

default ApiResponse<OutgoingWebhookList> getOutgoingWebhooksForTeam(String teamId,
                                                                    Pager pager)

returns a page of outgoing webhooks for a team. Page counting starts at 0.

getOutgoingWebhooksForTeam

ApiResponse<OutgoingWebhookList> getOutgoingWebhooksForTeam(String teamId,
                                                            Pager pager,
                                                            String etag)

returns a page of outgoing webhooks for a team. Page counting starts at 0.

regenOutgoingHookToken

ApiResponse<OutgoingWebhook> regenOutgoingHookToken(String hookId)

regenerate the outgoing webhook token.

deleteOutgoingWebhook

ApiResponse<Boolean> deleteOutgoingWebhook(String hookId)

delete the outgoing webhook on the system requested by hook id.