Protocols

Check if the given user has the permission to execute the command.

let checker = MyChecker()
guard checker.check(user, canUse: command, on: event) else { throw CommandError.InvalidPermissions }

Marks a type as CommandArgumentConvertible.

These types can be created from one or more arguments passed into a command.

Marks a type as both CommandArgumentConvertible and Consuming.

ConsumingCommandArgumentConvertible types will not take a single arguments, but rather [x...], consuming the entire list of arguments. Examples of arguments that support consuming are Array and String.Consuming

A representation of an unresolved argument

Any type capable of consuming.

See also ConsumingCommandArgumentConvertible

Commands used in Plugins

Base ExecutableCommand

Base ExecutableCommand

A Hook within SwiftHooks is a backend implementation emitting events. For example Discord, Slack or GitHub

Base hook type. Non-generic to be stored in arrays. See Hook for generic version.

EventListeners used in Plugins.

Base plugin type. Used for array storage.

A Plugin contains Commands and Listeners, usually grouped by purpose and can be registered to the main SwiftHooks class.

class MyPlugin: Plugin {
    var commands: some Commands {
        Command("ping")
            .execute { (hooks, event) in
                event.message.reply("Pong!")
        }
    }

    var listeners: some EventListeners {
        Listener(Global.messageCreate) { event, message in
            print("Message: \(message.content)")
        }
    }
}

A generic channel used in GlobalEvents.

A generic message used in GlobalEvents.

A generic user used in GlobalEvents.