Package com.symphony.bdk.core.activity.command

Class SlashCommand

java.lang.Object

com.symphony.bdk.core.activity.AbstractActivity<V4MessageSent,C>

com.symphony.bdk.core.activity.command.CommandActivity<CommandContext>

com.symphony.bdk.core.activity.command.SlashCommand

Direct Known Subclasses:

HelpCommand

@API(status=EXPERIMENTAL)
public class SlashCommand
extends CommandActivity<CommandContext>

A "slash" command if the most basic action that can be performed by an end-user through the chat.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	SlashCommand(String slashCommandPattern, boolean requiresBotMention, boolean isAsync, Consumer<CommandContext> callback, String description)	Default protected constructor, new instances from static methods only.

Method Summary

Modifier and Type	Method	Description
protected CommandContext	createContextInstance(V4Initiator initiator, V4MessageSent event)
boolean	equals(Object o)
int	hashCode()
protected ActivityInfo	info()	Build activity info.
boolean	isAsynchronous()
ActivityMatcher<CommandContext>	matcher()	Any kind of activity must provide an ActivityMatcher in order to detect if it can be applied to a certain user input.
void	onActivity(CommandContext context)	Contain the activity business logic.
static SlashCommand	slash(String slashCommandPattern, boolean requiresBotMention, boolean isAsync, Consumer<CommandContext> callback, String description)	Returns a new SlashCommand instance.
static SlashCommand	slash(String slashCommandPattern, boolean requiresBotMention, Consumer<CommandContext> callback)	Returns a new SlashCommand instance.
static SlashCommand	slash(String slashCommandPattern, boolean requiresBotMention, Consumer<CommandContext> callback, String description)	Returns a new SlashCommand instance.
static SlashCommand	slash(String slashCommandPattern, Consumer<CommandContext> callback)	Returns a new SlashCommand instance.
static SlashCommand	slash(String slashCommandPattern, Consumer<CommandContext> callback, String description)	Returns a new SlashCommand instance.

Methods inherited from class com.symphony.bdk.core.activity.command.CommandActivity

beforeMatcher, bindToRealTimeEventsSource

Methods inherited from class com.symphony.bdk.core.activity.AbstractActivity

getInfo, processEvent

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Details

SlashCommand

protected SlashCommand(@Nonnull
 String slashCommandPattern,
 boolean requiresBotMention,
 boolean isAsync,
 @Nonnull
 Consumer<CommandContext> callback,
 String description)

Default protected constructor, new instances from static methods only.

Method Details

slash

public static SlashCommand slash(@Nonnull
 String slashCommandPattern,
 @Nonnull
 Consumer<CommandContext> callback)

Returns a new SlashCommand instance.

Parameters:

slashCommandPattern - Pattern of the command (ex: '/gif' or 'gif {option} {@mention}').

callback - Callback to be processed when command is detected.

slash

public static SlashCommand slash(@Nonnull
 String slashCommandPattern,
 boolean requiresBotMention,
 @Nonnull
 Consumer<CommandContext> callback)

Returns a new SlashCommand instance.

Parameters:

slashCommandPattern - Pattern of the command (ex: '/gif' or 'gif {option} {@mention}').

requiresBotMention - Indicates whether the bot has to be mentioned in order to trigger the command.

callback - Callback to be processed when command is detected.

Throws:

IllegalArgumentException - if command name if empty.

slash

public static SlashCommand slash(@Nonnull
 String slashCommandPattern,
 @Nonnull
 Consumer<CommandContext> callback,
 String description)

Returns a new SlashCommand instance.

Parameters:

slashCommandPattern - Pattern of the command (ex: '/gif' or 'gif {option} {@mention}').

callback - Callback to be processed when command is detected.

description - The summary of the command.

Returns:

a SlashCommand instance.

slash

public static SlashCommand slash(@Nonnull
 String slashCommandPattern,
 boolean requiresBotMention,
 @Nonnull
 Consumer<CommandContext> callback,
 String description)

Returns a new SlashCommand instance.

Parameters:

slashCommandPattern - Pattern of the command (ex: '/gif' or 'gif {option} {@mention}').

requiresBotMention - Indicates whether the bot has to be mentioned in order to trigger the command.

callback - Callback to be processed when command is detected.

description - The summary of the command.

Returns:

a SlashCommand instance.

slash

public static SlashCommand slash(@Nonnull
 String slashCommandPattern,
 boolean requiresBotMention,
 boolean isAsync,
 @Nonnull
 Consumer<CommandContext> callback,
 String description)

Returns a new SlashCommand instance.

Parameters:

slashCommandPattern - Pattern of the command (ex: '/gif' or 'gif {option} {@mention}').

requiresBotMention - Indicates whether the bot has to be mentioned in order to trigger the command.

isAsync - Indicated whether the command is asynchronous or not.

callback - Callback to be processed when command is detected.

description - The summary of the command.

Returns:

a SlashCommand instance.

matcher

public ActivityMatcher<CommandContext> matcher()

Description copied from class: AbstractActivity

Any kind of activity must provide an ActivityMatcher in order to detect if it can be applied to a certain user input.

Specified by:

matcher in class AbstractActivity<V4MessageSent,CommandContext>

Returns:

an ActivityMatcher implementation.

onActivity

public void onActivity(CommandContext context)

Description copied from class: AbstractActivity

Contain the activity business logic. Executed only if the ActivityMatcher.matches(ActivityContext) returned a true value.

Specified by:

onActivity in class AbstractActivity<V4MessageSent,CommandContext>

Parameters:

context - The activity context object.

isAsynchronous

public boolean isAsynchronous()

Overrides:

isAsynchronous in class AbstractActivity<V4MessageSent,CommandContext>

info

protected ActivityInfo info()

Description copied from class: AbstractActivity

Build activity info.

Specified by:

info in class AbstractActivity<V4MessageSent,CommandContext>

createContextInstance

protected CommandContext createContextInstance(V4Initiator initiator,
 V4MessageSent event)

Overrides:

createContextInstance in class AbstractActivity<V4MessageSent,CommandContext>

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object