Context for a command
Provides a way to address the channel(s) related to this action:
usually, an event or command invocation.
In an event handler, these are usually the channel(s) linked to a repo.
In a command handler, the behavior will be the same as that of
In some cases, such as repo creation or a push to a repo where there is no linked channel,
addressChannels will go to dev/null without error.
Context of the Atomist EventHandler invocation. Use to run GraphQL queries, use the messageClient directly and find the team and correlation id
Credentials for use with source control hosts such as GitHub
The repos this command relates to, if available.
Parameters, if any were supplied
Store and retrieve preferences for this SDM or team
Prompt for additional parameters needed during execution of the command listener.
Callers should wait for the returned Promise to resolve. It will resolve with the requested parameters if those have already been collected. If not, a parameter prompt request to the backend will be sent and the Promise will reject. Once the new parameters are collected, a new command invocation will be sent and the command listener will restart.
This requires that any state that gets created before calling promptFor can be re-created when re-entering the listener function. Also any action taken before calling promptFor needs to be implemented using idempotency patterns.
Generated using TypeDoc