The gcm Reference Manual
Table of Contents
The gcm Reference Manual
This is the gcm Reference Manual,
generated automatically by Declt version 3.0 "Montgomery Scott"
on Tue Dec 22 13:32:25 2020 GMT+0.
1 Introduction
GCM
A Google Cloud Messaging library for Common Lisp.
Example
CL-USER> (gcm:configure "<your api key>")
; No value
CL-USER> (gcm:send (make-instance 'gcm:message
:payload (list "title" "Hello"
"text" "Hey there"))
:registration-ids (list "<a registration id>"))
#<GCM:RESPONSE {100A3022A3}>
License
MIT
2 Systems
The main system appears first, followed by any subsystem dependency.
2.1 gcm
- Author
death <github.com/death>
- License
MIT
- Description
Google Cloud Messaging (GCM) library for Common Lisp
- Dependencies
- drakma
- com.gigamonkeys.json
- babel
- Source
gcm.asd (file)
- Component
gcm.lisp (file)
3 Files
Files are sorted by type and then listed depth-first from the systems
components trees.
3.1 Lisp
3.1.1 gcm.asd
- Location
gcm.asd
- Systems
gcm (system)
3.1.2 gcm/gcm.lisp
- Parent
gcm (system)
- Location
gcm.lisp
- Packages
gcm
- Exported Definitions
-
- Internal Definitions
-
4 Packages
Packages are listed by definition order.
4.1 gcm
- Source
gcm.lisp (file)
- Use List
common-lisp
- Exported Definitions
-
- Internal Definitions
-
5 Definitions
Definitions are sorted by export status, category, package, and then by
lexicographic order.
5.1 Exported definitions
5.1.1 Special variables
- Special Variable: *config*
-
- Package
gcm
- Source
gcm.lisp (file)
- Special Variable: *registration-ids*
-
- Package
gcm
- Source
gcm.lisp (file)
5.1.2 Functions
- Function: configure API-KEY &rest OPTIONS
-
- Package
gcm
- Source
gcm.lisp (file)
- Function: send MESSAGE &key CONFIG REGISTRATION-IDS
-
- Package
gcm
- Source
gcm.lisp (file)
- Function: set-registration-ids REGISTRATION-IDS
-
- Package
gcm
- Source
gcm.lisp (file)
5.1.3 Generic functions
- Generic Function: config-api-key OBJECT
-
- Package
gcm
- Methods
- Method: config-api-key (CONFIG config)
-
automatically generated reader method
- Source
gcm.lisp (file)
- Generic Function: config-dry-run-p OBJECT
-
- Package
gcm
- Methods
- Method: config-dry-run-p (CONFIG config)
-
automatically generated reader method
- Source
gcm.lisp (file)
- Generic Function: config-send-endpoint OBJECT
-
- Package
gcm
- Methods
- Method: config-send-endpoint (CONFIG config)
-
automatically generated reader method
- Source
gcm.lisp (file)
- Generic Function: config-timeout OBJECT
-
- Package
gcm
- Methods
- Method: config-timeout (CONFIG config)
-
automatically generated reader method
- Source
gcm.lisp (file)
- Generic Function: message-collapse-key OBJECT
-
- Package
gcm
- Methods
- Method: message-collapse-key (MESSAGE message)
-
automatically generated reader method
- Source
gcm.lisp (file)
- Generic Function: message-delay-while-idle-p OBJECT
-
- Package
gcm
- Methods
- Method: message-delay-while-idle-p (MESSAGE message)
-
automatically generated reader method
- Source
gcm.lisp (file)
- Generic Function: message-payload OBJECT
-
- Package
gcm
- Methods
- Method: message-payload (MESSAGE message)
-
automatically generated reader method
- Source
gcm.lisp (file)
- Generic Function: message-time-to-live OBJECT
-
- Package
gcm
- Methods
- Method: message-time-to-live (MESSAGE message)
-
automatically generated reader method
- Source
gcm.lisp (file)
- Generic Function: raw-json OBJECT
-
- Package
gcm
- Source
gcm.lisp (file)
- Methods
- Method: raw-json (RESULT result)
-
automatically generated reader method
- Method: raw-json (RESPONSE response)
-
automatically generated reader method
- Generic Function: response-canonical-ids OBJECT
-
- Package
gcm
- Methods
- Method: response-canonical-ids (RESPONSE response)
-
automatically generated reader method
- Source
gcm.lisp (file)
- Generic Function: response-failure OBJECT
-
- Package
gcm
- Methods
- Method: response-failure (RESPONSE response)
-
automatically generated reader method
- Source
gcm.lisp (file)
- Generic Function: response-multicast-id OBJECT
-
- Package
gcm
- Methods
- Method: response-multicast-id (RESPONSE response)
-
automatically generated reader method
- Source
gcm.lisp (file)
- Generic Function: response-results OBJECT
-
- Package
gcm
- Methods
- Method: response-results (RESPONSE response)
-
automatically generated reader method
- Source
gcm.lisp (file)
- Generic Function: response-success OBJECT
-
- Package
gcm
- Methods
- Method: response-success (RESPONSE response)
-
automatically generated reader method
- Source
gcm.lisp (file)
- Generic Function: result-error-string OBJECT
-
- Package
gcm
- Methods
- Method: result-error-string (RESULT result)
-
automatically generated reader method
- Source
gcm.lisp (file)
- Generic Function: result-message-id OBJECT
-
- Package
gcm
- Methods
- Method: result-message-id (RESULT result)
-
automatically generated reader method
- Source
gcm.lisp (file)
- Generic Function: send-failure-code CONDITION
-
- Package
gcm
- Methods
- Method: send-failure-code (CONDITION send-failure)
-
- Source
gcm.lisp (file)
- Generic Function: send-failure-response CONDITION
-
- Package
gcm
- Methods
- Method: send-failure-response (CONDITION send-failure)
-
- Source
gcm.lisp (file)
5.1.4 Conditions
- Condition: gcm-error ()
-
- Package
gcm
- Source
gcm.lisp (file)
- Direct superclasses
error (condition)
- Direct subclasses
send-failure (condition)
- Condition: send-failure ()
-
- Package
gcm
- Source
gcm.lisp (file)
- Direct superclasses
gcm-error (condition)
- Direct methods
-
- Direct slots
- Slot: code
-
- Initargs
:code
- Readers
send-failure-code (generic function)
- Slot: response
-
- Initargs
:response
- Readers
send-failure-response (generic function)
5.1.5 Classes
- Class: config ()
-
- Package
gcm
- Source
gcm.lisp (file)
- Direct superclasses
standard-object (class)
- Direct methods
-
- Direct slots
- Slot: api-key
-
- Initargs
:api-key
- Readers
config-api-key (generic function)
- Slot: dry-run
-
- Initargs
:dry-run
- Readers
config-dry-run-p (generic function)
- Slot: send-endpoint
-
- Initargs
:send-endpoint
- Readers
config-send-endpoint (generic function)
- Slot: timeout
-
- Initargs
:timeout
- Readers
config-timeout (generic function)
- Direct Default Initargs
Initarg | Value |
:dry-run | nil |
:send-endpoint | "https://android.googleapis.com/gcm/send" |
:timeout | 20 |
:api-key | nil |
- Class: message ()
-
- Package
gcm
- Source
gcm.lisp (file)
- Direct superclasses
standard-object (class)
- Direct methods
-
- Direct slots
- Slot: payload
-
- Initargs
:payload
- Readers
message-payload (generic function)
- Slot: delay-while-idle
-
- Initargs
:delay-while-idle
- Readers
message-delay-while-idle-p (generic function)
- Slot: collapse-key
-
- Initargs
:collapse-key
- Readers
message-collapse-key (generic function)
- Slot: time-to-live
-
- Initargs
:time-to-live
- Readers
message-time-to-live (generic function)
- Class: response ()
-
- Package
gcm
- Source
gcm.lisp (file)
- Direct superclasses
standard-object (class)
- Direct methods
-
- Direct slots
- Slot: multicast-id
-
- Readers
response-multicast-id (generic function)
- Slot: success
-
- Initform
0
- Readers
response-success (generic function)
- Slot: failure
-
- Initform
0
- Readers
response-failure (generic function)
- Slot: canonical-ids
-
- Initform
0
- Readers
response-canonical-ids (generic function)
- Slot: results
-
- Initform
#()
- Readers
response-results (generic function)
- Slot: raw-json
-
- Initargs
:raw-json
- Readers
raw-json (generic function)
- Class: result ()
-
- Package
gcm
- Source
gcm.lisp (file)
- Direct superclasses
standard-object (class)
- Direct methods
-
- Direct slots
- Slot: message-id
-
- Readers
result-message-id (generic function)
- Slot: error-string
-
- Readers
result-error-string (generic function)
- Slot: raw-json
-
- Initargs
:raw-json
- Readers
raw-json (generic function)
5.2 Internal definitions
5.2.1 Functions
- Function: cat &rest STRINGS
-
- Package
gcm
- Source
gcm.lisp (file)
- Function: json-bool X
-
- Package
gcm
- Source
gcm.lisp (file)
- Function: parse-response JSON
-
- Package
gcm
- Source
gcm.lisp (file)
- Function: parse-result JSON
-
- Package
gcm
- Source
gcm.lisp (file)
- Function: report-send-failure CONDITION STREAM
-
- Package
gcm
- Source
gcm.lisp (file)
- Function: require-config CONFIG
-
- Package
gcm
- Source
gcm.lisp (file)
- Function: send-body MESSAGE REGISTRATION-IDS CONFIG
-
- Package
gcm
- Source
gcm.lisp (file)
Appendix A Indexes
A.1 Concepts
A.2 Functions
| Index Entry | | Section |
|
C | | |
| cat : | | Internal functions |
| config-api-key : | | Exported generic functions |
| config-api-key : | | Exported generic functions |
| config-dry-run-p : | | Exported generic functions |
| config-dry-run-p : | | Exported generic functions |
| config-send-endpoint : | | Exported generic functions |
| config-send-endpoint : | | Exported generic functions |
| config-timeout : | | Exported generic functions |
| config-timeout : | | Exported generic functions |
| configure : | | Exported functions |
|
F | | |
| Function, cat : | | Internal functions |
| Function, configure : | | Exported functions |
| Function, json-bool : | | Internal functions |
| Function, parse-response : | | Internal functions |
| Function, parse-result : | | Internal functions |
| Function, report-send-failure : | | Internal functions |
| Function, require-config : | | Internal functions |
| Function, send : | | Exported functions |
| Function, send-body : | | Internal functions |
| Function, set-registration-ids : | | Exported functions |
|
G | | |
| Generic Function, config-api-key : | | Exported generic functions |
| Generic Function, config-dry-run-p : | | Exported generic functions |
| Generic Function, config-send-endpoint : | | Exported generic functions |
| Generic Function, config-timeout : | | Exported generic functions |
| Generic Function, message-collapse-key : | | Exported generic functions |
| Generic Function, message-delay-while-idle-p : | | Exported generic functions |
| Generic Function, message-payload : | | Exported generic functions |
| Generic Function, message-time-to-live : | | Exported generic functions |
| Generic Function, raw-json : | | Exported generic functions |
| Generic Function, response-canonical-ids : | | Exported generic functions |
| Generic Function, response-failure : | | Exported generic functions |
| Generic Function, response-multicast-id : | | Exported generic functions |
| Generic Function, response-results : | | Exported generic functions |
| Generic Function, response-success : | | Exported generic functions |
| Generic Function, result-error-string : | | Exported generic functions |
| Generic Function, result-message-id : | | Exported generic functions |
| Generic Function, send-failure-code : | | Exported generic functions |
| Generic Function, send-failure-response : | | Exported generic functions |
|
J | | |
| json-bool : | | Internal functions |
|
M | | |
| message-collapse-key : | | Exported generic functions |
| message-collapse-key : | | Exported generic functions |
| message-delay-while-idle-p : | | Exported generic functions |
| message-delay-while-idle-p : | | Exported generic functions |
| message-payload : | | Exported generic functions |
| message-payload : | | Exported generic functions |
| message-time-to-live : | | Exported generic functions |
| message-time-to-live : | | Exported generic functions |
| Method, config-api-key : | | Exported generic functions |
| Method, config-dry-run-p : | | Exported generic functions |
| Method, config-send-endpoint : | | Exported generic functions |
| Method, config-timeout : | | Exported generic functions |
| Method, message-collapse-key : | | Exported generic functions |
| Method, message-delay-while-idle-p : | | Exported generic functions |
| Method, message-payload : | | Exported generic functions |
| Method, message-time-to-live : | | Exported generic functions |
| Method, raw-json : | | Exported generic functions |
| Method, raw-json : | | Exported generic functions |
| Method, response-canonical-ids : | | Exported generic functions |
| Method, response-failure : | | Exported generic functions |
| Method, response-multicast-id : | | Exported generic functions |
| Method, response-results : | | Exported generic functions |
| Method, response-success : | | Exported generic functions |
| Method, result-error-string : | | Exported generic functions |
| Method, result-message-id : | | Exported generic functions |
| Method, send-failure-code : | | Exported generic functions |
| Method, send-failure-response : | | Exported generic functions |
|
P | | |
| parse-response : | | Internal functions |
| parse-result : | | Internal functions |
|
R | | |
| raw-json : | | Exported generic functions |
| raw-json : | | Exported generic functions |
| raw-json : | | Exported generic functions |
| report-send-failure : | | Internal functions |
| require-config : | | Internal functions |
| response-canonical-ids : | | Exported generic functions |
| response-canonical-ids : | | Exported generic functions |
| response-failure : | | Exported generic functions |
| response-failure : | | Exported generic functions |
| response-multicast-id : | | Exported generic functions |
| response-multicast-id : | | Exported generic functions |
| response-results : | | Exported generic functions |
| response-results : | | Exported generic functions |
| response-success : | | Exported generic functions |
| response-success : | | Exported generic functions |
| result-error-string : | | Exported generic functions |
| result-error-string : | | Exported generic functions |
| result-message-id : | | Exported generic functions |
| result-message-id : | | Exported generic functions |
|
S | | |
| send : | | Exported functions |
| send-body : | | Internal functions |
| send-failure-code : | | Exported generic functions |
| send-failure-code : | | Exported generic functions |
| send-failure-response : | | Exported generic functions |
| send-failure-response : | | Exported generic functions |
| set-registration-ids : | | Exported functions |
|
A.3 Variables
| Index Entry | | Section |
|
* | | |
| *config* : | | Exported special variables |
| *registration-ids* : | | Exported special variables |
|
A | | |
| api-key : | | Exported classes |
|
C | | |
| canonical-ids : | | Exported classes |
| code : | | Exported conditions |
| collapse-key : | | Exported classes |
|
D | | |
| delay-while-idle : | | Exported classes |
| dry-run : | | Exported classes |
|
E | | |
| error-string : | | Exported classes |
|
F | | |
| failure : | | Exported classes |
|
M | | |
| message-id : | | Exported classes |
| multicast-id : | | Exported classes |
|
P | | |
| payload : | | Exported classes |
|
R | | |
| raw-json : | | Exported classes |
| raw-json : | | Exported classes |
| response : | | Exported conditions |
| results : | | Exported classes |
|
S | | |
| send-endpoint : | | Exported classes |
| Slot, api-key : | | Exported classes |
| Slot, canonical-ids : | | Exported classes |
| Slot, code : | | Exported conditions |
| Slot, collapse-key : | | Exported classes |
| Slot, delay-while-idle : | | Exported classes |
| Slot, dry-run : | | Exported classes |
| Slot, error-string : | | Exported classes |
| Slot, failure : | | Exported classes |
| Slot, message-id : | | Exported classes |
| Slot, multicast-id : | | Exported classes |
| Slot, payload : | | Exported classes |
| Slot, raw-json : | | Exported classes |
| Slot, raw-json : | | Exported classes |
| Slot, response : | | Exported conditions |
| Slot, results : | | Exported classes |
| Slot, send-endpoint : | | Exported classes |
| Slot, success : | | Exported classes |
| Slot, time-to-live : | | Exported classes |
| Slot, timeout : | | Exported classes |
| Special Variable, *config* : | | Exported special variables |
| Special Variable, *registration-ids* : | | Exported special variables |
| success : | | Exported classes |
|
T | | |
| time-to-live : | | Exported classes |
| timeout : | | Exported classes |
|
A.4 Data types