The slack-client Reference Manual

This is the slack-client Reference Manual, version 0.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Aug 15 05:52:14 2022 GMT+0.

1 Introduction

Slack-Client - Slack Real Time Messaging API Client

Usage

You can use roswell script examle. You should set the shell env variable SLACK_API_TOKEN.

env SLACK_API_TOKEN='xoxb-...' ./client.ros

Installation

Author

Kazuo Koga (obiwanko@me.com)

Copyright

License

Licensed under the Apache-2.0 License.

2 Systems

The main system appears first, followed by any subsystem dependency.

slack-client

2.1 `slack-client`

Slack Real Time Messaging API Client

Author

Kazuo Koga

License

Apache-2.0

Long Description

# Slack-Client - Slack Real Time Messaging API Client

## Usage

You can use roswell script examle.
You should set the shell env variable “‘SLACK_API_TOKEN“‘.

“‘
env SLACK_API_TOKEN=’xoxb-...’ ./client.ros
“‘

## Installation

## Author

* Kazuo Koga (obiwanko@me.com)

## Copyright

## License

Licensed under the Apache-2.0 License.

Version

0.1

Dependencies

blackbird (system).
babel (system).
cl-async (system).
drakma-async (system).
event-glue (system).
jonathan (system).
safe-queue (system).
websocket-driver (system).

Source

slack-client.asd.

Child Component

src (module).

3 Modules

Modules are listed depth-first from the system components tree.

slack-client/src

3.1 `slack-client/src`

Source: slack-client.asd.
Parent Component: slack-client (system).
Child Component: slack-client.lisp (file).

4 Files

Files are sorted by type and then listed depth-first from the systems components trees.

Lisp

4.1.1 `slack-client/slack-client.asd`

Source: slack-client.asd.
Parent Component: slack-client (system).
ASDF Systems: slack-client.
Packages: slack-client-asd.

4.1.2 `slack-client/src/slack-client.lisp`

Source

slack-client.asd.

Parent Component

src (module).

Packages

slack-client.

Public Interface

afind (function).
bind (function).
channel-id-channel (function).
data (function).
im-id-im (function).
run-client (function).
send-text (function).
slack-client (class).
team-id-team (function).
user-id-user (function).
with-data-let (macro).

Internals

asv (function).
fail-ping-of (reader method).
(setf fail-ping-of) (writer method).
find-id-from-alists (function).
getenv (function).
last-ping-of (reader method).
(setf last-ping-of) (writer method).
mailbox-of (reader method).
on-message (function).
ping (function).
pong (function).
prop-of (function).
rtm-start (function).
send-id-of (reader method).
(setf send-id-of) (writer method).
send-notify (function).
sender-loop (function).
slack-api-token (function).
state-of (reader method).
(setf state-of) (writer method).
ws-connect (function).

5 Packages

Packages are listed by definition order.

slack-client-asd
slack-client

5.1 `slack-client-asd`

Source

slack-client.asd.

Use List

asdf/interface.
common-lisp.

5.2 `slack-client`

Source

slack-client.lisp.

Nicknames

slack
sc

Use List

common-lisp.

Public Interface

afind (function).
bind (function).
channel-id-channel (function).
data (function).
im-id-im (function).
run-client (function).
send-text (function).
slack-client (class).
team-id-team (function).
user-id-user (function).
with-data-let (macro).

Internals

asv (function).
fail-ping-of (generic reader).
(setf fail-ping-of) (generic writer).
find-id-from-alists (function).
getenv (function).
last-ping-of (generic reader).
(setf last-ping-of) (generic writer).
mailbox-of (generic reader).
on-message (function).
ping (function).
pong (function).
prop-of (function).
rtm-start (function).
send-id-of (generic reader).
(setf send-id-of) (generic writer).
send-notify (function).
sender-loop (function).
slack-api-token (function).
state-of (generic reader).
(setf state-of) (generic writer).
ws-connect (function).

6 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.

Public Interface
Internals

6.1 Public Interface

Macros
Ordinary functions
Classes

6.1.1 Macros

Macro: with-data-let (ev vars &body body) ¶

Package: slack-client.
Source: slack-client.lisp.

6.1.2 Ordinary functions

Function: afind (alist &rest keys) ¶

Package: slack-client.
Source: slack-client.lisp.

Function: bind (key client function) ¶

Package: slack-client.
Source: slack-client.lisp.

Function: channel-id-channel (client channel-id) ¶

Package: slack-client.
Source: slack-client.lisp.

Function: data (event &rest keys) ¶

Package: slack-client.
Source: slack-client.lisp.

Function: im-id-im (client im-id) ¶

Package: slack-client.
Source: slack-client.lisp.

Function: run-client (client) ¶

Package: slack-client.
Source: slack-client.lisp.

Function: send-text (client channel-id message) ¶

Package: slack-client.
Source: slack-client.lisp.

Function: team-id-team (client team-id) ¶

Package: slack-client.
Source: slack-client.lisp.

Function: user-id-user (client user-id) ¶

Package: slack-client.
Source: slack-client.lisp.

6.1.3 Classes

Class: slack-client ¶

Package

slack-client.

Source

slack-client.lisp.

Direct superclasses

dispatch.

Direct methods

(setf fail-ping-of).
fail-ping-of.
(setf last-ping-of).
last-ping-of.
mailbox-of.
(setf send-id-of).
send-id-of.
(setf state-of).
state-of.

Direct slots

Slot: state ¶

Readers: state-of.
Writers: (setf state-of).

Slot: send-id ¶

Initform: 0
Readers: send-id-of.
Writers: (setf send-id-of).

Slot: last-ping ¶

Readers: last-ping-of.
Writers: (setf last-ping-of).

Slot: fail-ping ¶

Initform: 0
Readers: fail-ping-of.
Writers: (setf fail-ping-of).

Slot: mailbox ¶

Initform: (safe-queue:make-mailbox)
Readers: mailbox-of.
Writers: This slot is read-only.

6.2 Internals

Ordinary functions
Generic functions

6.2.1 Ordinary functions

Function: asv (key alist) ¶

Package: slack-client.
Source: slack-client.lisp.

Function: find-id-from-alists (key id alists) ¶

Package: slack-client.
Source: slack-client.lisp.

Function: getenv (name) ¶

Package: slack-client.
Source: slack-client.lisp.

Function: on-message (client ws message) ¶

Package: slack-client.
Source: slack-client.lisp.

Function: ping (client ws) ¶

Package: slack-client.
Source: slack-client.lisp.

Function: pong (client ws reply-to time) ¶

Package: slack-client.
Source: slack-client.lisp.

Function: prop-of (client key) ¶

Package: slack-client.
Source: slack-client.lisp.

Function: rtm-start (token) ¶

Package: slack-client.
Source: slack-client.lisp.

Function: send-notify (client) ¶

Package: slack-client.
Source: slack-client.lisp.

Function: sender-loop (client ws iter) ¶

Package: slack-client.
Source: slack-client.lisp.

Function: slack-api-token () ¶

Package: slack-client.
Source: slack-client.lisp.

Function: ws-connect (client) ¶

Package: slack-client.
Source: slack-client.lisp.

6.2.2 Generic functions

Generic Reader: fail-ping-of (object) ¶

Package

slack-client.

Methods

Reader Method: fail-ping-of ((slack-client slack-client)) ¶

automatically generated reader method

Source: slack-client.lisp.
Target Slot: fail-ping.

Generic Writer: (setf fail-ping-of) (object) ¶

Package

slack-client.

Methods

Writer Method: (setf fail-ping-of) ((slack-client slack-client)) ¶

automatically generated writer method

Source: slack-client.lisp.
Target Slot: fail-ping.

Generic Reader: last-ping-of (object) ¶

Package

slack-client.

Methods

Reader Method: last-ping-of ((slack-client slack-client)) ¶

automatically generated reader method

Source: slack-client.lisp.
Target Slot: last-ping.

Generic Writer: (setf last-ping-of) (object) ¶

Package

slack-client.

Methods

Writer Method: (setf last-ping-of) ((slack-client slack-client)) ¶

automatically generated writer method

Source: slack-client.lisp.
Target Slot: last-ping.

Generic Reader: mailbox-of (object) ¶

Package

slack-client.

Methods

Reader Method: mailbox-of ((slack-client slack-client)) ¶

automatically generated reader method

Source: slack-client.lisp.
Target Slot: mailbox.

Generic Reader: send-id-of (object) ¶

Package

slack-client.

Methods

Reader Method: send-id-of ((slack-client slack-client)) ¶

automatically generated reader method

Source: slack-client.lisp.
Target Slot: send-id.

Generic Writer: (setf send-id-of) (object) ¶

Package

slack-client.

Methods

Writer Method: (setf send-id-of) ((slack-client slack-client)) ¶

automatically generated writer method

Source: slack-client.lisp.
Target Slot: send-id.

Generic Reader: state-of (object) ¶

Package

slack-client.

Methods

Reader Method: state-of ((slack-client slack-client)) ¶

automatically generated reader method

Source: slack-client.lisp.
Target Slot: state.

Generic Writer: (setf state-of) (object) ¶

Package

slack-client.

Methods

Writer Method: (setf state-of) ((slack-client slack-client)) ¶

automatically generated writer method

Source: slack-client.lisp.
Target Slot: state.

Appendix A Indexes

Concepts
Functions
Variables
Data types

A.1 Concepts

A.2 Functions

Jump to:	( A B C D F G I L M O P R S T U W

	Index Entry	Section

(
	`(setf fail-ping-of)`:	Private generic functions
	`(setf fail-ping-of)`:	Private generic functions
	`(setf last-ping-of)`:	Private generic functions
	`(setf last-ping-of)`:	Private generic functions
	`(setf send-id-of)`:	Private generic functions
	`(setf send-id-of)`:	Private generic functions
	`(setf state-of)`:	Private generic functions
	`(setf state-of)`:	Private generic functions

A
	`afind`:	Public ordinary functions
	`asv`:	Private ordinary functions

B
	`bind`:	Public ordinary functions

C
	`channel-id-channel`:	Public ordinary functions

D
	`data`:	Public ordinary functions

F
	`fail-ping-of`:	Private generic functions
	`fail-ping-of`:	Private generic functions
	`find-id-from-alists`:	Private ordinary functions
	`Function, afind`:	Public ordinary functions
	`Function, asv`:	Private ordinary functions
	`Function, bind`:	Public ordinary functions
	`Function, channel-id-channel`:	Public ordinary functions
	`Function, data`:	Public ordinary functions
	`Function, find-id-from-alists`:	Private ordinary functions
	`Function, getenv`:	Private ordinary functions
	`Function, im-id-im`:	Public ordinary functions
	`Function, on-message`:	Private ordinary functions
	`Function, ping`:	Private ordinary functions
	`Function, pong`:	Private ordinary functions
	`Function, prop-of`:	Private ordinary functions
	`Function, rtm-start`:	Private ordinary functions
	`Function, run-client`:	Public ordinary functions
	`Function, send-notify`:	Private ordinary functions
	`Function, send-text`:	Public ordinary functions
	`Function, sender-loop`:	Private ordinary functions
	`Function, slack-api-token`:	Private ordinary functions
	`Function, team-id-team`:	Public ordinary functions
	`Function, user-id-user`:	Public ordinary functions
	`Function, ws-connect`:	Private ordinary functions

G
	`Generic Function, (setf fail-ping-of)`:	Private generic functions
	`Generic Function, (setf last-ping-of)`:	Private generic functions
	`Generic Function, (setf send-id-of)`:	Private generic functions
	`Generic Function, (setf state-of)`:	Private generic functions
	`Generic Function, fail-ping-of`:	Private generic functions
	`Generic Function, last-ping-of`:	Private generic functions
	`Generic Function, mailbox-of`:	Private generic functions
	`Generic Function, send-id-of`:	Private generic functions
	`Generic Function, state-of`:	Private generic functions
	`getenv`:	Private ordinary functions

I
	`im-id-im`:	Public ordinary functions

L
	`last-ping-of`:	Private generic functions
	`last-ping-of`:	Private generic functions

M
	`Macro, with-data-let`:	Public macros
	`mailbox-of`:	Private generic functions
	`mailbox-of`:	Private generic functions
	`Method, (setf fail-ping-of)`:	Private generic functions
	`Method, (setf last-ping-of)`:	Private generic functions
	`Method, (setf send-id-of)`:	Private generic functions
	`Method, (setf state-of)`:	Private generic functions
	`Method, fail-ping-of`:	Private generic functions
	`Method, last-ping-of`:	Private generic functions
	`Method, mailbox-of`:	Private generic functions
	`Method, send-id-of`:	Private generic functions
	`Method, state-of`:	Private generic functions

O
	`on-message`:	Private ordinary functions

P
	`ping`:	Private ordinary functions
	`pong`:	Private ordinary functions
	`prop-of`:	Private ordinary functions

R
	`rtm-start`:	Private ordinary functions
	`run-client`:	Public ordinary functions

S
	`send-id-of`:	Private generic functions
	`send-id-of`:	Private generic functions
	`send-notify`:	Private ordinary functions
	`send-text`:	Public ordinary functions
	`sender-loop`:	Private ordinary functions
	`slack-api-token`:	Private ordinary functions
	`state-of`:	Private generic functions
	`state-of`:	Private generic functions

T
	`team-id-team`:	Public ordinary functions

U
	`user-id-user`:	Public ordinary functions

W
	`with-data-let`:	Public macros
	`ws-connect`:	Private ordinary functions

Jump to:	( A B C D F G I L M O P R S T U W

A.3 Variables

Jump to:	F L M S

	Index Entry	Section

F
	`fail-ping`:	Public classes

L
	`last-ping`:	Public classes

M
	`mailbox`:	Public classes

S
	`send-id`:	Public classes
	`Slot, fail-ping`:	Public classes
	`Slot, last-ping`:	Public classes
	`Slot, mailbox`:	Public classes
	`Slot, send-id`:	Public classes
	`Slot, state`:	Public classes
	`state`:	Public classes

Jump to:	F L M S

A.4 Data types

Jump to:	C F M P S

	Index Entry	Section

C
	`Class, slack-client`:	Public classes

F
	`File, slack-client.asd`:	The slack-client/slack-client․asd file
	`File, slack-client.lisp`:	The slack-client/src/slack-client․lisp file

M
	`Module, src`:	The slack-client/src module

P
	`Package, slack-client`:	The slack-client package
	`Package, slack-client-asd`:	The slack-client-asd package

S
	`slack-client`:	The slack-client system
	`slack-client`:	The slack-client package
	`slack-client`:	Public classes
	`slack-client-asd`:	The slack-client-asd package
	`slack-client.asd`:	The slack-client/slack-client․asd file
	`slack-client.lisp`:	The slack-client/src/slack-client․lisp file
	`src`:	The slack-client/src module
	`System, slack-client`:	The slack-client system

Jump to:	C F M P S

The slack-client Reference Manual

The slack-client Reference Manual

Table of Contents

1 Introduction

Slack-Client - Slack Real Time Messaging API Client

Usage

Installation

Author

Copyright

License

2 Systems

2.1 slack-client

3 Modules

3.1 slack-client/src

4 Files

4.1 Lisp

4.1.1 slack-client/slack-client.asd

4.1.2 slack-client/src/slack-client.lisp

5 Packages

5.1 slack-client-asd

5.2 slack-client

6 Definitions

6.1 Public Interface

6.1.1 Macros

6.1.2 Ordinary functions

6.1.3 Classes

6.2 Internals

6.2.1 Ordinary functions

6.2.2 Generic functions

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types

2.1 `slack-client`

3.1 `slack-client/src`

4.1.1 `slack-client/slack-client.asd`

4.1.2 `slack-client/src/slack-client.lisp`

5.1 `slack-client-asd`

5.2 `slack-client`