BotCommands/io.github.freya022.botcommands.api.components.builder/timeout

timeout

@JvmName(name = "timeoutSuspend")

fun <T : IPersistentTimeoutableComponent<T>, E : ITimeoutData> T.~~timeout~~(duration: Duration, func: suspend (E) -> Unit): T(source)

fun <T : IPersistentTimeoutableComponent<T>, E : ITimeoutData> T.~~timeout~~(duration: Duration, func: (E) -> Unit): T(source)

Deprecated

Replaced with timeoutWith

Replace with

timeoutWith(duration, func)

Sets the timeout on this component, invalidating the component on expiration, and running the timeout handler with the given name and its arguments.

Note: Components inside groups cannot have timeouts.

Timeout cancellation

The timeout will be canceled once a component has been deleted, including if the component was set to a single use.

Component deletion

If the component is a group, then all of its owned components will also be deleted.
If the component is inside a group, then all the group's components will also be deleted.

Timeout data

The data passed is transformed with toString, except snowflakes which get their IDs stored.

The data can only be reconstructed if a TimeoutParameterResolver exists for the handler's parameter type.

Remember the parameters need to be annotated with @TimeoutData.

@JvmName(name = "timeoutSuspend")

fun <T : IPersistentTimeoutableComponent<T>, E : ITimeoutData, T1> T.~~timeout~~(duration: Duration, func: suspend (E, T1) -> Unit, arg1: T1): T(source)

fun <T : IPersistentTimeoutableComponent<T>, E : ITimeoutData, T1> T.~~timeout~~(duration: Duration, func: (E, T1) -> Unit, arg1: T1): T(source)

Deprecated

Replaced with timeoutWith

Replace with

timeoutWith(duration, func, arg1)

Sets the timeout on this component, invalidating the component on expiration, and running the timeout handler with the given name and its arguments.

Note: Components inside groups cannot have timeouts.

Timeout cancellation

The timeout will be canceled once a component has been deleted, including if the component was set to a single use.

Component deletion

If the component is a group, then all of its owned components will also be deleted.
If the component is inside a group, then all the group's components will also be deleted.

Timeout data

The data passed is transformed with toString, except snowflakes which get their IDs stored.

The data can only be reconstructed if a TimeoutParameterResolver exists for the handler's parameter type.

Remember the parameters need to be annotated with @TimeoutData.

@JvmName(name = "timeoutSuspend")

fun <T : IPersistentTimeoutableComponent<T>, E : ITimeoutData, T1, T2> T.~~timeout~~(duration: Duration, func: suspend (E, T1, T2) -> Unit, arg1: T1, arg2: T2): T(source)

fun <T : IPersistentTimeoutableComponent<T>, E : ITimeoutData, T1, T2> T.~~timeout~~(duration: Duration, func: (E, T1, T2) -> Unit, arg1: T1, arg2: T2): T(source)

Deprecated

Replaced with timeoutWith

Replace with

timeoutWith(duration, func, arg1, arg2)

Sets the timeout on this component, invalidating the component on expiration, and running the timeout handler with the given name and its arguments.

Note: Components inside groups cannot have timeouts.

Timeout cancellation

The timeout will be canceled once a component has been deleted, including if the component was set to a single use.

Component deletion

If the component is a group, then all of its owned components will also be deleted.
If the component is inside a group, then all the group's components will also be deleted.

Timeout data

The data passed is transformed with toString, except snowflakes which get their IDs stored.

The data can only be reconstructed if a TimeoutParameterResolver exists for the handler's parameter type.

Remember the parameters need to be annotated with @TimeoutData.

@JvmName(name = "timeoutSuspend")

fun <T : IPersistentTimeoutableComponent<T>, E : ITimeoutData, T1, T2, T3> T.~~timeout~~(duration: Duration, func: suspend (E, T1, T2, T3) -> Unit, arg1: T1, arg2: T2, arg3: T3): T(source)

fun <T : IPersistentTimeoutableComponent<T>, E : ITimeoutData, T1, T2, T3> T.~~timeout~~(duration: Duration, func: (E, T1, T2, T3) -> Unit, arg1: T1, arg2: T2, arg3: T3): T(source)

Deprecated

Replaced with timeoutWith

Replace with

timeoutWith(duration, func, arg1, arg2, arg3)

Sets the timeout on this component, invalidating the component on expiration, and running the timeout handler with the given name and its arguments.

Note: Components inside groups cannot have timeouts.

Timeout cancellation

The timeout will be canceled once a component has been deleted, including if the component was set to a single use.

Component deletion

If the component is a group, then all of its owned components will also be deleted.
If the component is inside a group, then all the group's components will also be deleted.

Timeout data

The data passed is transformed with toString, except snowflakes which get their IDs stored.

The data can only be reconstructed if a TimeoutParameterResolver exists for the handler's parameter type.

Remember the parameters need to be annotated with @TimeoutData.

@JvmName(name = "timeoutSuspend")

fun <T : IPersistentTimeoutableComponent<T>, E : ITimeoutData, T1, T2, T3, T4> T.~~timeout~~(duration: Duration, func: suspend (E, T1, T2, T3, T4) -> Unit, arg1: T1, arg2: T2, arg3: T3, arg4: T4): T(source)

fun <T : IPersistentTimeoutableComponent<T>, E : ITimeoutData, T1, T2, T3, T4> T.~~timeout~~(duration: Duration, func: (E, T1, T2, T3, T4) -> Unit, arg1: T1, arg2: T2, arg3: T3, arg4: T4): T(source)

Deprecated

Replaced with timeoutWith

Replace with

timeoutWith(duration, func, arg1, arg2, arg3, arg4)

Sets the timeout on this component, invalidating the component on expiration, and running the timeout handler with the given name and its arguments.

Note: Components inside groups cannot have timeouts.

Timeout cancellation

The timeout will be canceled once a component has been deleted, including if the component was set to a single use.

Component deletion

If the component is a group, then all of its owned components will also be deleted.
If the component is inside a group, then all the group's components will also be deleted.

Timeout data

The data passed is transformed with toString, except snowflakes which get their IDs stored.

The data can only be reconstructed if a TimeoutParameterResolver exists for the handler's parameter type.

Remember the parameters need to be annotated with @TimeoutData.

@JvmName(name = "timeoutSuspend")

fun <T : IPersistentTimeoutableComponent<T>, E : ITimeoutData, T1, T2, T3, T4, T5> T.~~timeout~~(duration: Duration, func: suspend (E, T1, T2, T3, T4, T5) -> Unit, arg1: T1, arg2: T2, arg3: T3, arg4: T4, arg5: T5): T(source)

fun <T : IPersistentTimeoutableComponent<T>, E : ITimeoutData, T1, T2, T3, T4, T5> T.~~timeout~~(duration: Duration, func: (E, T1, T2, T3, T4, T5) -> Unit, arg1: T1, arg2: T2, arg3: T3, arg4: T4, arg5: T5): T(source)

Deprecated

Replaced with timeoutWith

Replace with

timeoutWith(duration, func, arg1, arg2, arg3, arg4, arg5)

Sets the timeout on this component, invalidating the component on expiration, and running the timeout handler with the given name and its arguments.

Note: Components inside groups cannot have timeouts.

Timeout cancellation

The timeout will be canceled once a component has been deleted, including if the component was set to a single use.

Component deletion

If the component is a group, then all of its owned components will also be deleted.
If the component is inside a group, then all the group's components will also be deleted.

Timeout data

The data passed is transformed with toString, except snowflakes which get their IDs stored.

The data can only be reconstructed if a TimeoutParameterResolver exists for the handler's parameter type.

Remember the parameters need to be annotated with @TimeoutData.

@JvmName(name = "timeoutSuspend")

fun <T : IPersistentTimeoutableComponent<T>, E : ITimeoutData, T1, T2, T3, T4, T5, T6> T.~~timeout~~(duration: Duration, func: suspend (E, T1, T2, T3, T4, T5, T6) -> Unit, arg1: T1, arg2: T2, arg3: T3, arg4: T4, arg5: T5, arg6: T6): T(source)

fun <T : IPersistentTimeoutableComponent<T>, E : ITimeoutData, T1, T2, T3, T4, T5, T6> T.~~timeout~~(duration: Duration, func: (E, T1, T2, T3, T4, T5, T6) -> Unit, arg1: T1, arg2: T2, arg3: T3, arg4: T4, arg5: T5, arg6: T6): T(source)

Deprecated

Replaced with timeoutWith

Replace with

timeoutWith(duration, func, arg1, arg2, arg3, arg4, arg5, arg6)

Sets the timeout on this component, invalidating the component on expiration, and running the timeout handler with the given name and its arguments.

Note: Components inside groups cannot have timeouts.

Timeout cancellation

The timeout will be canceled once a component has been deleted, including if the component was set to a single use.

Component deletion

If the component is a group, then all of its owned components will also be deleted.
If the component is inside a group, then all the group's components will also be deleted.

Timeout data

The data passed is transformed with toString, except snowflakes which get their IDs stored.

The data can only be reconstructed if a TimeoutParameterResolver exists for the handler's parameter type.

Remember the parameters need to be annotated with @TimeoutData.

@JvmName(name = "timeoutSuspend")

fun <T : IPersistentTimeoutableComponent<T>, E : ITimeoutData, T1, T2, T3, T4, T5, T6, T7> T.~~timeout~~(duration: Duration, func: suspend (E, T1, T2, T3, T4, T5, T6, T7) -> Unit, arg1: T1, arg2: T2, arg3: T3, arg4: T4, arg5: T5, arg6: T6, arg7: T7): T(source)

fun <T : IPersistentTimeoutableComponent<T>, E : ITimeoutData, T1, T2, T3, T4, T5, T6, T7> T.~~timeout~~(duration: Duration, func: (E, T1, T2, T3, T4, T5, T6, T7) -> Unit, arg1: T1, arg2: T2, arg3: T3, arg4: T4, arg5: T5, arg6: T6, arg7: T7): T(source)

Deprecated

Replaced with timeoutWith

Replace with

timeoutWith(duration, func, arg1, arg2, arg3, arg4, arg5, arg6, arg7)

Sets the timeout on this component, invalidating the component on expiration, and running the timeout handler with the given name and its arguments.

Note: Components inside groups cannot have timeouts.

Timeout cancellation

The timeout will be canceled once a component has been deleted, including if the component was set to a single use.

Component deletion

If the component is a group, then all of its owned components will also be deleted.
If the component is inside a group, then all the group's components will also be deleted.

Timeout data

The data passed is transformed with toString, except snowflakes which get their IDs stored.

The data can only be reconstructed if a TimeoutParameterResolver exists for the handler's parameter type.

Remember the parameters need to be annotated with @TimeoutData.

@JvmName(name = "timeoutSuspend")

fun <T : IPersistentTimeoutableComponent<T>, E : ITimeoutData, T1, T2, T3, T4, T5, T6, T7, T8> T.~~timeout~~(duration: Duration, func: suspend (E, T1, T2, T3, T4, T5, T6, T7, T8) -> Unit, arg1: T1, arg2: T2, arg3: T3, arg4: T4, arg5: T5, arg6: T6, arg7: T7, arg8: T8): T(source)

fun <T : IPersistentTimeoutableComponent<T>, E : ITimeoutData, T1, T2, T3, T4, T5, T6, T7, T8> T.~~timeout~~(duration: Duration, func: (E, T1, T2, T3, T4, T5, T6, T7, T8) -> Unit, arg1: T1, arg2: T2, arg3: T3, arg4: T4, arg5: T5, arg6: T6, arg7: T7, arg8: T8): T(source)

Deprecated

Replaced with timeoutWith

Replace with

timeoutWith(duration, func, arg1, arg2, arg3, arg4, arg5, arg6, arg7, arg8)

Sets the timeout on this component, invalidating the component on expiration, and running the timeout handler with the given name and its arguments.

Note: Components inside groups cannot have timeouts.

Timeout cancellation

The timeout will be canceled once a component has been deleted, including if the component was set to a single use.

Component deletion

If the component is a group, then all of its owned components will also be deleted.
If the component is inside a group, then all the group's components will also be deleted.

Timeout data

The data passed is transformed with toString, except snowflakes which get their IDs stored.

The data can only be reconstructed if a TimeoutParameterResolver exists for the handler's parameter type.

Remember the parameters need to be annotated with @TimeoutData.

@JvmName(name = "timeoutSuspend")

fun <T : IPersistentTimeoutableComponent<T>, E : ITimeoutData, T1, T2, T3, T4, T5, T6, T7, T8, T9> T.~~timeout~~(duration: Duration, func: suspend (E, T1, T2, T3, T4, T5, T6, T7, T8, T9) -> Unit, arg1: T1, arg2: T2, arg3: T3, arg4: T4, arg5: T5, arg6: T6, arg7: T7, arg8: T8, arg9: T9): T(source)

fun <T : IPersistentTimeoutableComponent<T>, E : ITimeoutData, T1, T2, T3, T4, T5, T6, T7, T8, T9> T.~~timeout~~(duration: Duration, func: (E, T1, T2, T3, T4, T5, T6, T7, T8, T9) -> Unit, arg1: T1, arg2: T2, arg3: T3, arg4: T4, arg5: T5, arg6: T6, arg7: T7, arg8: T8, arg9: T9): T(source)

Deprecated

Replaced with timeoutWith

Replace with

timeoutWith(duration, func, arg1, arg2, arg3, arg4, arg5, arg6, arg7, arg8, arg9)

Sets the timeout on this component, invalidating the component on expiration, and running the timeout handler with the given name and its arguments.

Note: Components inside groups cannot have timeouts.

Timeout cancellation

The timeout will be canceled once a component has been deleted, including if the component was set to a single use.

Component deletion

If the component is a group, then all of its owned components will also be deleted.
If the component is inside a group, then all the group's components will also be deleted.

Timeout data

The data passed is transformed with toString, except snowflakes which get their IDs stored.

The data can only be reconstructed if a TimeoutParameterResolver exists for the handler's parameter type.

Remember the parameters need to be annotated with @TimeoutData.

@JvmName(name = "timeoutSuspend")

fun <T : IPersistentTimeoutableComponent<T>, E : ITimeoutData, T1, T2, T3, T4, T5, T6, T7, T8, T9, T10> T.~~timeout~~(duration: Duration, func: suspend (E, T1, T2, T3, T4, T5, T6, T7, T8, T9, T10) -> Unit, arg1: T1, arg2: T2, arg3: T3, arg4: T4, arg5: T5, arg6: T6, arg7: T7, arg8: T8, arg9: T9, arg10: T10): T(source)

fun <T : IPersistentTimeoutableComponent<T>, E : ITimeoutData, T1, T2, T3, T4, T5, T6, T7, T8, T9, T10> T.~~timeout~~(duration: Duration, func: (E, T1, T2, T3, T4, T5, T6, T7, T8, T9, T10) -> Unit, arg1: T1, arg2: T2, arg3: T3, arg4: T4, arg5: T5, arg6: T6, arg7: T7, arg8: T8, arg9: T9, arg10: T10): T(source)

Deprecated

Replaced with timeoutWith

Replace with

timeoutWith(duration, func, arg1, arg2, arg3, arg4, arg5, arg6, arg7, arg8, arg9, arg10)

Sets the timeout on this component, invalidating the component on expiration, and running the timeout handler with the given name and its arguments.

Note: Components inside groups cannot have timeouts.

Timeout cancellation

The timeout will be canceled once a component has been deleted, including if the component was set to a single use.

Component deletion

If the component is a group, then all of its owned components will also be deleted.
If the component is inside a group, then all the group's components will also be deleted.

Timeout data

The data passed is transformed with toString, except snowflakes which get their IDs stored.

The data can only be reconstructed if a TimeoutParameterResolver exists for the handler's parameter type.

Remember the parameters need to be annotated with @TimeoutData.