conversation

Documentation

Overview

Package conversation synchronises email addresses with a Slack conversation.

Requirements

In order to synchronise with Slack, you'll need to create a Slack app with the following OAuth Bot Token permissions:

• users:read
• users:read.email
• channels:manage
• channels:read
• groups:read
• groups:write
• im:write
• mpim:write

Examples

See New and Init.

Index

• Constants
• func Init(_ context.Context, config map[gosync.ConfigKey]string) (gosync.Adapter, error)
• type Conversation
  • func New(client *slack.Client, conversationName string, ...) *Conversation
  • func (c *Conversation) Add(_ context.Context, emails []string) error
  • func (c *Conversation) Get(_ context.Context) ([]string, error)
  • func (c *Conversation) Remove(_ context.Context, emails []string) error

Examples

• Init
• New

Constants

const MuteRestrictedErrOnKickFromPublic gosync.ConfigKey = "mute_restricted_err_kick_from_public"

MuteRestrictedErrOnKickFromPublic mutes an error that occurs when Slack is configured to prevent kicking users from public conversations. Set this to true to mute this error and continue syncing.

const Name gosync.ConfigKey = "name"

Name is the Slack conversation name.

const SlackAPIKey gosync.ConfigKey = "slack_api_key" //nolint:gosec

SlackAPIKey is an API key for authenticating with Slack.

Functions

func Init

func Init(_ context.Context, config map[gosync.ConfigKey]string) (gosync.Adapter, error)

Init a new Slack Conversation gosync.Adapter.

Required config:

• conversation.SlackAPIKey
• conversation.Name

Example

package main

import (
	"context"
	"log"

	"github.com/ovotech/go-sync/packages/gosync"
	"github.com/ovotech/go-sync/packages/slack/conversation"
)

func main() {
	ctx := context.Background()

	adapter, err := conversation.Init(ctx, map[gosync.ConfigKey]string{
		conversation.SlackAPIKey: "my-slack-token",
		conversation.Name:        "C0123ABC456",
	})
	if err != nil {
		log.Fatal(err)
	}

	gosync.New(adapter)
}

Types

type Conversation

type Conversation struct {
	MuteRestrictedErrOnKickFromPublic bool // See [conversation.MuteRestrictedErrOnKickFromPublic]

	Logger *log.Logger
	// contains filtered or unexported fields
}

func New

func New(client *slack.Client, conversationName string, optsFn ...func(conversation *Conversation)) *Conversation

New Slack Conversation gosync.Adapter.

Example

package main

import (
	"github.com/slack-go/slack"

	"github.com/ovotech/go-sync/packages/gosync"
	"github.com/ovotech/go-sync/packages/slack/conversation"
)

func main() {
	client := slack.New("my-slack-token")

	adapter := conversation.New(client, "C0123ABC456")

	gosync.New(adapter)
}

func (*Conversation) Add

func (c *Conversation) Add(_ context.Context, emails []string) error

Add email addresses to a Slack Conversation.

func (*Conversation) Get

func (c *Conversation) Get(_ context.Context) ([]string, error)

Get email addresses in a Slack Conversation.

func (*Conversation) Remove

func (c *Conversation) Remove(_ context.Context, emails []string) error

Remove email addresses from a Slack Conversation.