Options
All
  • Public
  • Public/Protected
  • All
Menu

Invokes when an event occurs relating to execution of a goal within this SDM.

Hierarchy

Index

Properties

addressChannels

addressChannels: AddressChannels

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 MessageClient.respond. 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.

configuration

configuration: Configuration

context

context: HandlerContext

Context of the Atomist EventHandler invocation. Use to run GraphQL queries, use the messageClient directly and find the team and correlation id

credentials

credentials: ProjectOperationCredentials

Credentials for use with source control hosts such as GitHub

Optional error

error: Error

Error that was raised during goal execution if not handled inside the goalExecutor

goal

goal: Goal

The goal that is current executing

goalEvent

goalEvent: SdmGoalEvent

The goal event that changed state

id

id: RemoteRepoRef

The repo this relates to

preferences

preferences: PreferenceStore

Store and retrieve preferences for this SDM or team

Optional result

result: ExecuteGoalResult | undefined

Result of goal execution; only available if goalExecutor returned an result

Generated using TypeDoc