The slack-client Reference Manual

Table of Contents

Next: , Previous: , Up: (dir)   [Contents][Index]

The slack-client Reference Manual

This is the slack-client Reference Manual, version 0.1, generated automatically by Declt version 2.3 "Robert April" on Tue Feb 20 09:21:37 2018 GMT+0.


Next: , Previous: , Up: Top   [Contents][Index]

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

Copyright

Copyright (c) 2016 Kazuo Koga (obiwanko@me.com)

License

Licensed under the Apache-2.0 License.


Next: , Previous: , Up: Top   [Contents][Index]

2 Systems

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


Previous: , Up: Systems   [Contents][Index]

2.1 slack-client

Author

Kazuo Koga

License

Apache-2.0

Description

Slack Real Time Messaging API Client

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

Copyright (c) 2016 Kazuo Koga (obiwanko@me.com)

## License

Licensed under the Apache-2.0 License.

Version

0.1

Dependencies
Source

slack-client.asd (file)

Component

src (module)


Next: , Previous: , Up: Top   [Contents][Index]

3 Modules

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


Previous: , Up: Modules   [Contents][Index]

3.1 slack-client/src

Parent

slack-client (system)

Location

src/

Component

slack-client.lisp (file)


Next: , Previous: , Up: Top   [Contents][Index]

4 Files

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


Previous: , Up: Files   [Contents][Index]

4.1 Lisp


Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.1 slack-client.asd

Location

slack-client.asd

Systems

slack-client (system)

Packages

slack-client-asd


Previous: , Up: Lisp files   [Contents][Index]

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

Parent

src (module)

Location

src/slack-client.lisp

Packages

slack-client

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Top   [Contents][Index]

5 Packages

Packages are listed by definition order.


Next: , Previous: , Up: Packages   [Contents][Index]

5.1 slack-client-asd

Source

slack-client.asd

Use List

Previous: , Up: Packages   [Contents][Index]

5.2 slack-client

Source

slack-client.lisp (file)

Nicknames
Use List

common-lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Top   [Contents][Index]

6 Definitions

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


Next: , Previous: , Up: Definitions   [Contents][Index]

6.1 Exported definitions


Next: , Previous: , Up: Exported definitions   [Contents][Index]

6.1.1 Macros

Macro: with-data-let EV VARS &body BODY
Package

slack-client

Source

slack-client.lisp (file)


Next: , Previous: , Up: Exported definitions   [Contents][Index]

6.1.2 Functions

Function: afind ALIST &rest KEYS
Package

slack-client

Source

slack-client.lisp (file)

Function: bind KEY CLIENT FUNCTION
Package

slack-client

Source

slack-client.lisp (file)

Function: channel-id-channel CLIENT CHANNEL-ID
Package

slack-client

Source

slack-client.lisp (file)

Function: data EVENT &rest KEYS
Package

slack-client

Source

slack-client.lisp (file)

Function: im-id-im CLIENT IM-ID
Package

slack-client

Source

slack-client.lisp (file)

Function: run-client CLIENT
Package

slack-client

Source

slack-client.lisp (file)

Function: send-text CLIENT CHANNEL-ID MESSAGE
Package

slack-client

Source

slack-client.lisp (file)

Function: team-id-team CLIENT TEAM-ID
Package

slack-client

Source

slack-client.lisp (file)

Function: user-id-user CLIENT USER-ID
Package

slack-client

Source

slack-client.lisp (file)


Previous: , Up: Exported definitions   [Contents][Index]

6.1.3 Classes

Class: slack-client ()
Package

slack-client

Source

slack-client.lisp (file)

Direct superclasses

dispatch (class)

Direct methods
Direct slots
Slot: state
Readers

state-of (generic function)

Writers

(setf state-of) (generic function)

Slot: send-id
Initform

0

Readers

send-id-of (generic function)

Writers

(setf send-id-of) (generic function)

Slot: last-ping
Readers

last-ping-of (generic function)

Writers

(setf last-ping-of) (generic function)

Slot: fail-ping
Initform

0

Readers

fail-ping-of (generic function)

Writers

(setf fail-ping-of) (generic function)

Slot: mailbox
Initform

(safe-queue:make-mailbox)

Readers

mailbox-of (generic function)


Previous: , Up: Definitions   [Contents][Index]

6.2 Internal definitions


Next: , Previous: , Up: Internal definitions   [Contents][Index]

6.2.1 Functions

Function: asv KEY ALIST
Package

slack-client

Source

slack-client.lisp (file)

Function: find-id-from-alists KEY ID ALISTS
Package

slack-client

Source

slack-client.lisp (file)

Function: getenv NAME
Package

slack-client

Source

slack-client.lisp (file)

Function: on-message CLIENT WS MESSAGE
Package

slack-client

Source

slack-client.lisp (file)

Function: ping CLIENT WS
Package

slack-client

Source

slack-client.lisp (file)

Function: pong CLIENT WS REPLY-TO TIME
Package

slack-client

Source

slack-client.lisp (file)

Function: prop-of CLIENT KEY
Package

slack-client

Source

slack-client.lisp (file)

Function: rtm-start TOKEN
Package

slack-client

Source

slack-client.lisp (file)

Function: send-notify CLIENT
Package

slack-client

Source

slack-client.lisp (file)

Function: sender-loop CLIENT WS ITER
Package

slack-client

Source

slack-client.lisp (file)

Function: slack-api-token ()
Package

slack-client

Source

slack-client.lisp (file)

Function: ws-connect CLIENT
Package

slack-client

Source

slack-client.lisp (file)


Previous: , Up: Internal definitions   [Contents][Index]

6.2.2 Generic functions

Generic Function: fail-ping-of OBJECT
Generic Function: (setf fail-ping-of) NEW-VALUE OBJECT
Package

slack-client

Methods
Method: fail-ping-of (SLACK-CLIENT slack-client)

automatically generated reader method

Source

slack-client.lisp (file)

Method: (setf fail-ping-of) NEW-VALUE (SLACK-CLIENT slack-client)

automatically generated writer method

Source

slack-client.lisp (file)

Generic Function: last-ping-of OBJECT
Generic Function: (setf last-ping-of) NEW-VALUE OBJECT
Package

slack-client

Methods
Method: last-ping-of (SLACK-CLIENT slack-client)

automatically generated reader method

Source

slack-client.lisp (file)

Method: (setf last-ping-of) NEW-VALUE (SLACK-CLIENT slack-client)

automatically generated writer method

Source

slack-client.lisp (file)

Generic Function: mailbox-of OBJECT
Package

slack-client

Methods
Method: mailbox-of (SLACK-CLIENT slack-client)

automatically generated reader method

Source

slack-client.lisp (file)

Generic Function: send-id-of OBJECT
Generic Function: (setf send-id-of) NEW-VALUE OBJECT
Package

slack-client

Methods
Method: send-id-of (SLACK-CLIENT slack-client)

automatically generated reader method

Source

slack-client.lisp (file)

Method: (setf send-id-of) NEW-VALUE (SLACK-CLIENT slack-client)

automatically generated writer method

Source

slack-client.lisp (file)

Generic Function: state-of OBJECT
Generic Function: (setf state-of) NEW-VALUE OBJECT
Package

slack-client

Methods
Method: state-of (SLACK-CLIENT slack-client)

automatically generated reader method

Source

slack-client.lisp (file)

Method: (setf state-of) NEW-VALUE (SLACK-CLIENT slack-client)

automatically generated writer method

Source

slack-client.lisp (file)


Previous: , Up: Top   [Contents][Index]

Appendix A Indexes


Next: , Previous: , Up: Indexes   [Contents][Index]

A.1 Concepts

Jump to:   F   L   M   S  
Index Entry  Section

F
File, Lisp, slack-client.asd: The slack-client<dot>asd file
File, Lisp, slack-client/src/slack-client.lisp: The slack-client/src/slack-client<dot>lisp file

L
Lisp File, slack-client.asd: The slack-client<dot>asd file
Lisp File, slack-client/src/slack-client.lisp: The slack-client/src/slack-client<dot>lisp file

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

S
slack-client.asd: The slack-client<dot>asd file
slack-client/src: The slack-client/src module
slack-client/src/slack-client.lisp: The slack-client/src/slack-client<dot>lisp file

Jump to:   F   L   M   S  

Next: , Previous: , Up: Indexes   [Contents][Index]

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): Internal generic functions
(setf fail-ping-of): Internal generic functions
(setf last-ping-of): Internal generic functions
(setf last-ping-of): Internal generic functions
(setf send-id-of): Internal generic functions
(setf send-id-of): Internal generic functions
(setf state-of): Internal generic functions
(setf state-of): Internal generic functions

A
afind: Exported functions
asv: Internal functions

B
bind: Exported functions

C
channel-id-channel: Exported functions

D
data: Exported functions

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

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

I
im-id-im: Exported functions

L
last-ping-of: Internal generic functions
last-ping-of: Internal generic functions

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

O
on-message: Internal functions

P
ping: Internal functions
pong: Internal functions
prop-of: Internal functions

R
rtm-start: Internal functions
run-client: Exported functions

S
send-id-of: Internal generic functions
send-id-of: Internal generic functions
send-notify: Internal functions
send-text: Exported functions
sender-loop: Internal functions
slack-api-token: Internal functions
state-of: Internal generic functions
state-of: Internal generic functions

T
team-id-team: Exported functions

U
user-id-user: Exported functions

W
with-data-let: Exported macros
ws-connect: Internal functions

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

Next: , Previous: , Up: Indexes   [Contents][Index]

A.3 Variables

Jump to:   F   L   M   S  
Index Entry  Section

F
fail-ping: Exported classes

L
last-ping: Exported classes

M
mailbox: Exported classes

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

Jump to:   F   L   M   S  

Previous: , Up: Indexes   [Contents][Index]

A.4 Data types

Jump to:   C   P   S  
Index Entry  Section

C
Class, slack-client: Exported classes

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: Exported classes
slack-client-asd: The slack-client-asd package
System, slack-client: The slack-client system

Jump to:   C   P   S