Interface SpyMessageContext

All Superinterfaces:

MessageContext, StringMessageContext

public interface SpyMessageContext
extends StringMessageContext

A change to a moderator's spy mode, or a message it caught. Builds on StringMessageContext.

Nested Class Summary

Nested classes/interfaces inherited from interface MessageContext

MessageContext.CacheKey

Method Summary

Modifier and Type	Method	Description
@NonNull String	action()	What was spied on.
static net.flectone.pulse.module.command.spy.model.SpyMessageContextImpl.SpyMessageContextImplBuilder	builder()	Starts building this context.
boolean	turned()	Whether spy mode was switched on, rather than off.
SpyMessageContext	withAction(@NonNull String action)	Returns a copy carrying a different value.
SpyMessageContext	withTurned(boolean turned)	Returns a copy carrying a different value.

Methods inherited from interface MessageContext

addFlag, addFlags, addTagResolver, addTagResolvers, base, createCacheKey, flags, isFlag, message, receiver, sender, tagResolver, toBuilder, uuid, withBase, withFlags, withMessage, withReceiver, withSender, withTagResolver, withUuid

Methods inherited from interface StringMessageContext

string, withString

Method Details

builder

static net.flectone.pulse.module.command.spy.model.SpyMessageContextImpl.SpyMessageContextImplBuilder builder()

Starts building this context.

Returns:

a new builder

turned

boolean turned()

Whether spy mode was switched on, rather than off.

Returns:

whether spy mode was switched on, rather than off

action

@NonNull String action()

What was spied on.

Returns:

what was spied on

withTurned

SpyMessageContext withTurned(boolean turned)

Returns a copy carrying a different value.

Parameters:

turned - whether spy mode was switched on, rather than off

Returns:

the copy

withAction

SpyMessageContext withAction(@NonNull String action)

Returns a copy carrying a different value.

Parameters:

action - what was spied on

Returns:

the copy