slack

func NewAdapter ¶

func NewAdapter(config *Config, options ...AdapterOption) (*Adapter, error)

NewAdapter creates new Adapter with given *Config and zero or more AdapterOption.

func WithEventsPayloadHandler ¶

func WithEventsPayloadHandler(fnc func(context.Context, *Config, *eventsapi.EventWrapper, func(sarah.Input) error)) AdapterOption

WithEventsPayloadHandler creates an AdapterOption with the given function to handle incoming Events API payloads. The simplest example to receive message payload is to use a default payload handler as below:

slackAdapter, _ := slack.NewAdapter(slackConfig, slack.WithEventsPayloadHandler(DefaultEventsPayloadHandler))

See WithRTMPayloadHandler for detailed usage. WithEventsPayloadHandler is just another form of payload handler to work with Events API.

func WithRTMPayloadHandler ¶

func WithRTMPayloadHandler(fnc func(context.Context, *Config, rtmapi.DecodedPayload, func(sarah.Input) error)) AdapterOption

WithRTMPayloadHandler creates an AdapterOption with the given function to handle incoming RTM payloads. The simplest example to receive message payload is to use a default payload handler as below:

slackAdapter, _ := slack.NewAdapter(slackConfig, slack.WithRTMPayloadHandler(DefaultRTMPayloadHandler))

However, Slack's RTM API defines relatively large amount of payload types. To have better user experience, developers may provide customized callback function to handle different types of received payload. In that case, one may implement an original payload handler and replace DefaultRTMPayloadHandler. Inside the customized payload handler, a developer may wish to have direct access to SlackClient to post some sort of message to Slack via Web API. To support such scenario, wrap this function like below so the SlackClient can be accessed within its scope.

// Setup golack instance, which implements SlackClient interface.
golackConfig := golack.NewConfig()
golackConfig.Token = "XXXXXXX"
slackClient := golack.New(golackConfig)

slackConfig := slack.NewConfig()
rtmPayloadHandler := func(connCtx context.Context, config *Config, paylad rtmapi.DecodedPayload, enqueueInput func(sarah.Input) error) {
  switch p := payload.(type) {
  case *event.PinAdded:
    // Do something with pre-defined SlackClient
    // slackClient.PostMessage(connCtx, ...)
  default:
    input, err := EventToInput(p)
    if err == ErrNonSupportedEvent {
      log.Debugf("Event given, but no corresponding action is defined. %#v", payload)
      return
    }

    if err != nil {
      log.Errorf("Failed to convert %T event: %s", p, err.Error())
      return
    }

    trimmed := strings.TrimSpace(input.Message())
    if config.HelpCommand != "" && trimmed == config.HelpCommand {
      // Help command
      help := sarah.NewHelpInput(input)
      _ = enqueueInput(help)
    } else if config.AbortCommand != "" && trimmed == config.AbortCommand {
      // Abort command
      abort := sarah.NewAbortInput(input)
      _ = enqueueInput(abort)
    } else {
      // Regular input
      _ = enqueueInput(input)
    }
  }
}

slackAdapter, _ := slack.NewAdapter(slackConfig, slack.WithSlackClient(slackClient), slack.WithRTMPayloadHandler(rtmPayloadHandler))
slackBot, _ := sarah.NewBot(slackAdapter)

func WithSlackClient ¶

func WithSlackClient(client SlackClient) AdapterOption

WithSlackClient creates AdapterOption with given SlackClient implementation. If this option is not given, NewAdapter() tries to create golack instance with given Config.

func NewConfig ¶

func NewConfig() *Config

NewConfig returns initialized Config struct with default settings. Token is empty at this point. Token can be set by feeding this instance to json.Unmarshal/yaml.Unmarshal, or direct assignment.

func RespAsThreadReply ¶

func RespAsThreadReply(asReply bool) RespOption

RespAsThreadReply indicates that this response is sent as a thread reply.

func RespReplyBroadcast ¶

func RespReplyBroadcast(broadcast bool) RespOption

RespReplyBroadcast decides if the thread reply should be broadcasted. To activate this option, RespAsThreadReply() must be set to true.

func RespWithAttachments ¶

func RespWithAttachments(attachments []*webapi.MessageAttachment) RespOption

RespWithAttachments adds given attachments to the response.

func RespWithLinkNames ¶

func RespWithLinkNames(linkNames int) RespOption

RespWithLinkNames sets given linkNames to the response. Set 1 to linkify channel names and usernames in the response. The default value in this apiSpecificAdapter is 1.

func RespWithNext ¶

func RespWithNext(fnc sarah.ContextualFunc) RespOption

RespWithNext sets given fnc as part of the response's *sarah.UserContext. The next input from the same user will be passed to this fnc. See sarah.UserContextStorage must be present or otherwise, fnc will be ignored.

func RespWithNextSerializable ¶

func RespWithNextSerializable(arg *sarah.SerializableArgument) RespOption

RespWithNextSerializable sets given arg as part of the response's *sarah.UserContext. The next input from the same user will be passed to the function defined in the arg. See sarah.UserContextStorage must be present or otherwise, arg will be ignored.

func RespWithParse ¶

func RespWithParse(mode webapi.ParseMode) RespOption

RespWithParse sets given mode to the response. The default value in this apiSpecificAdapter is webapi.ParseModeFull.

func RespWithUnfurlLinks ¶

func RespWithUnfurlLinks(unfurl bool) RespOption

RespWithUnfurlLinks sets given unfurl value to the response. The default value is this apiSpecificAdapter is true.

func RespWithUnfurlMedia ¶

func RespWithUnfurlMedia(unfurl bool) RespOption

RespWithUnfurlMedia sets given unfurl value ot the response. The default value is this apiSpecificAdapter is true.