summaryrefslogtreecommitdiff
path: root/teleirc/matterbridge/vendor/github.com/slack-go/slack/README.md
diff options
context:
space:
mode:
authorMistivia <i@mistivia.com>2025-11-02 15:27:18 +0800
committerMistivia <i@mistivia.com>2025-11-02 15:27:18 +0800
commite9c24f4af7ed56760f6db7941827d09f6db9020b (patch)
tree62128c43b883ce5e3148113350978755779bb5de /teleirc/matterbridge/vendor/github.com/slack-go/slack/README.md
parent58d5e7cfda4781d8a57ec52aefd02983835c301a (diff)
add matterbridge
Diffstat (limited to 'teleirc/matterbridge/vendor/github.com/slack-go/slack/README.md')
-rw-r--r--teleirc/matterbridge/vendor/github.com/slack-go/slack/README.md111
1 files changed, 111 insertions, 0 deletions
diff --git a/teleirc/matterbridge/vendor/github.com/slack-go/slack/README.md b/teleirc/matterbridge/vendor/github.com/slack-go/slack/README.md
new file mode 100644
index 0000000..9618aeb
--- /dev/null
+++ b/teleirc/matterbridge/vendor/github.com/slack-go/slack/README.md
@@ -0,0 +1,111 @@
+Slack API in Go [![Go Reference](https://pkg.go.dev/badge/github.com/slack-go/slack.svg)](https://pkg.go.dev/github.com/slack-go/slack)
+===============
+
+This is the original Slack library for Go created by Norberto Lopes, transferred to a GitHub organization.
+
+You can also chat with us on the #slack-go, #slack-go-ja Slack channel on the Gophers Slack.
+
+![logo](logo.png "icon")
+
+This library supports most if not all of the `api.slack.com` REST
+calls, as well as the Real-Time Messaging protocol over websocket, in
+a fully managed way.
+
+## Project Status
+There is currently no major version released.
+Therefore, minor version releases may include backward incompatible changes.
+
+See [CHANGELOG.md](https://github.com/slack-go/slack/blob/master/CHANGELOG.md) or [Releases](https://github.com/slack-go/slack/releases) for more information about the changes.
+
+## Installing
+
+### *go get*
+
+ $ go get -u github.com/slack-go/slack
+
+## Example
+
+### Getting all groups
+
+```golang
+import (
+ "fmt"
+
+ "github.com/slack-go/slack"
+)
+
+func main() {
+ api := slack.New("YOUR_TOKEN_HERE")
+ // If you set debugging, it will log all requests to the console
+ // Useful when encountering issues
+ // slack.New("YOUR_TOKEN_HERE", slack.OptionDebug(true))
+ groups, err := api.GetUserGroups(slack.GetUserGroupsOptionIncludeUsers(false))
+ if err != nil {
+ fmt.Printf("%s\n", err)
+ return
+ }
+ for _, group := range groups {
+ fmt.Printf("ID: %s, Name: %s\n", group.ID, group.Name)
+ }
+}
+```
+
+### Getting User Information
+
+```golang
+import (
+ "fmt"
+
+ "github.com/slack-go/slack"
+)
+
+func main() {
+ api := slack.New("YOUR_TOKEN_HERE")
+ user, err := api.GetUserInfo("U023BECGF")
+ if err != nil {
+ fmt.Printf("%s\n", err)
+ return
+ }
+ fmt.Printf("ID: %s, Fullname: %s, Email: %s\n", user.ID, user.Profile.RealName, user.Profile.Email)
+}
+```
+
+## Minimal Socket Mode usage:
+
+See https://github.com/slack-go/slack/blob/master/examples/socketmode/socketmode.go
+
+
+## Minimal RTM usage:
+
+As mentioned in https://api.slack.com/rtm - for most applications, Socket Mode is a better way to communicate with Slack.
+
+See https://github.com/slack-go/slack/blob/master/examples/websocket/websocket.go
+
+
+## Minimal EventsAPI usage:
+
+See https://github.com/slack-go/slack/blob/master/examples/eventsapi/events.go
+
+## Socketmode Event Handler (Experimental)
+
+When using socket mode, dealing with an event can be pretty lengthy as it requires you to route the event to the right place.
+
+Instead, you can use `SocketmodeHandler` much like you use an HTTP handler to register which event you would like to listen to and what callback function will process that event when it occurs.
+
+See [./examples/socketmode_handler/socketmode_handler.go](./examples/socketmode_handler/socketmode_handler.go)
+## Contributing
+
+You are more than welcome to contribute to this project. Fork and
+make a Pull Request, or create an Issue if you see any problem.
+
+Before making any Pull Request please run the following:
+
+```
+make pr-prep
+```
+
+This will check/update code formatting, linting and then run all tests
+
+## License
+
+BSD 2 Clause license