This is the gcm Reference Manual,
generated automatically by Declt version 4.0 beta 2 "William Riker"
on Sun Dec 08 18:07:10 2024 GMT+0.
5 Definitions
Definitions are sorted by export status, category, package, and then by
lexicographic order.
5.1 Public Interface
5.1.1 Special variables
- Special Variable: *config* ¶
-
- Package
gcm
.
- Source
gcm.lisp
.
- Special Variable: *registration-ids* ¶
-
- Package
gcm
.
- Source
gcm.lisp
.
5.1.2 Ordinary functions
- Function: configure (api-key &rest options) ¶
-
- Package
gcm
.
- Source
gcm.lisp
.
- Function: send (message &key config registration-ids) ¶
-
- Package
gcm
.
- Source
gcm.lisp
.
- Function: set-registration-ids (registration-ids) ¶
-
- Package
gcm
.
- Source
gcm.lisp
.
5.1.3 Generic functions
- Generic Reader: config-api-key (object) ¶
-
- Package
gcm
.
- Methods
- Reader Method: config-api-key ((config
config
)) ¶
-
automatically generated reader method
- Source
gcm.lisp
.
- Target Slot
api-key
.
- Generic Reader: config-dry-run-p (object) ¶
-
- Package
gcm
.
- Methods
- Reader Method: config-dry-run-p ((config
config
)) ¶
-
automatically generated reader method
- Source
gcm.lisp
.
- Target Slot
dry-run
.
- Generic Reader: config-send-endpoint (object) ¶
-
- Package
gcm
.
- Methods
- Reader Method: config-send-endpoint ((config
config
)) ¶
-
automatically generated reader method
- Source
gcm.lisp
.
- Target Slot
send-endpoint
.
- Generic Reader: config-timeout (object) ¶
-
- Package
gcm
.
- Methods
- Reader Method: config-timeout ((config
config
)) ¶
-
automatically generated reader method
- Source
gcm.lisp
.
- Target Slot
timeout
.
- Generic Reader: message-collapse-key (object) ¶
-
- Package
gcm
.
- Methods
- Reader Method: message-collapse-key ((message
message
)) ¶
-
automatically generated reader method
- Source
gcm.lisp
.
- Target Slot
collapse-key
.
- Generic Reader: message-delay-while-idle-p (object) ¶
-
- Package
gcm
.
- Methods
- Reader Method: message-delay-while-idle-p ((message
message
)) ¶
-
automatically generated reader method
- Source
gcm.lisp
.
- Target Slot
delay-while-idle
.
- Generic Reader: message-payload (object) ¶
-
- Package
gcm
.
- Methods
- Reader Method: message-payload ((message
message
)) ¶
-
automatically generated reader method
- Source
gcm.lisp
.
- Target Slot
payload
.
- Generic Reader: message-time-to-live (object) ¶
-
- Package
gcm
.
- Methods
- Reader Method: message-time-to-live ((message
message
)) ¶
-
automatically generated reader method
- Source
gcm.lisp
.
- Target Slot
time-to-live
.
- Generic Reader: raw-json (object) ¶
-
- Package
gcm
.
- Source
gcm.lisp
.
- Methods
- Reader Method: raw-json ((result
result
)) ¶
-
automatically generated reader method
- Target Slot
raw-json
.
- Reader Method: raw-json ((response
response
)) ¶
-
automatically generated reader method
- Target Slot
raw-json
.
- Generic Reader: response-canonical-ids (object) ¶
-
- Package
gcm
.
- Methods
- Reader Method: response-canonical-ids ((response
response
)) ¶
-
automatically generated reader method
- Source
gcm.lisp
.
- Target Slot
canonical-ids
.
- Generic Reader: response-failure (object) ¶
-
- Package
gcm
.
- Methods
- Reader Method: response-failure ((response
response
)) ¶
-
automatically generated reader method
- Source
gcm.lisp
.
- Target Slot
failure
.
- Generic Reader: response-multicast-id (object) ¶
-
- Package
gcm
.
- Methods
- Reader Method: response-multicast-id ((response
response
)) ¶
-
automatically generated reader method
- Source
gcm.lisp
.
- Target Slot
multicast-id
.
- Generic Reader: response-results (object) ¶
-
- Package
gcm
.
- Methods
- Reader Method: response-results ((response
response
)) ¶
-
automatically generated reader method
- Source
gcm.lisp
.
- Target Slot
results
.
- Generic Reader: response-success (object) ¶
-
- Package
gcm
.
- Methods
- Reader Method: response-success ((response
response
)) ¶
-
automatically generated reader method
- Source
gcm.lisp
.
- Target Slot
success
.
- Generic Reader: result-error-string (object) ¶
-
- Package
gcm
.
- Methods
- Reader Method: result-error-string ((result
result
)) ¶
-
automatically generated reader method
- Source
gcm.lisp
.
- Target Slot
error-string
.
- Generic Reader: result-message-id (object) ¶
-
- Package
gcm
.
- Methods
- Reader Method: result-message-id ((result
result
)) ¶
-
automatically generated reader method
- Source
gcm.lisp
.
- Target Slot
message-id
.
- Generic Reader: send-failure-code (condition) ¶
-
- Package
gcm
.
- Methods
- Reader Method: send-failure-code ((condition
send-failure
)) ¶
-
- Source
gcm.lisp
.
- Target Slot
code
.
- Generic Reader: send-failure-response (condition) ¶
-
- Package
gcm
.
- Methods
- Reader Method: send-failure-response ((condition
send-failure
)) ¶
-
- Source
gcm.lisp
.
- Target Slot
response
.
5.1.4 Standalone methods
- Method: initialize-instance :after ((message
message
) &key) ¶
-
- Source
gcm.lisp
.
- Method: to-json ((message
message
)) ¶
-
- Package
com.gigamonkeys.json
.
- Source
gcm.lisp
.
5.1.5 Conditions
- Condition: gcm-error ¶
-
- Package
gcm
.
- Source
gcm.lisp
.
- Direct superclasses
error
.
- Direct subclasses
send-failure
.
- Condition: send-failure ¶
-
- Package
gcm
.
- Source
gcm.lisp
.
- Direct superclasses
gcm-error
.
- Direct methods
-
- Direct slots
- Slot: code ¶
-
- Initargs
:code
- Readers
send-failure-code
.
- Writers
This slot is read-only.
- Slot: response ¶
-
- Initargs
:response
- Readers
send-failure-response
.
- Writers
This slot is read-only.
5.1.6 Classes
- Class: config ¶
-
- Package
gcm
.
- Source
gcm.lisp
.
- Direct methods
-
- Direct Default Initargs
Initarg | Value |
:dry-run | nil |
:send-endpoint | https://android.googleapis.com/gcm/send |
:timeout | 20 |
:api-key | nil |
- Direct slots
- Slot: api-key ¶
-
- Initargs
:api-key
- Readers
config-api-key
.
- Writers
This slot is read-only.
- Slot: dry-run ¶
-
- Initargs
:dry-run
- Readers
config-dry-run-p
.
- Writers
This slot is read-only.
- Slot: send-endpoint ¶
-
- Initargs
:send-endpoint
- Readers
config-send-endpoint
.
- Writers
This slot is read-only.
- Slot: timeout ¶
-
- Initargs
:timeout
- Readers
config-timeout
.
- Writers
This slot is read-only.
- Class: message ¶
-
- Package
gcm
.
- Source
gcm.lisp
.
- Direct methods
-
- Direct slots
- Slot: payload ¶
-
- Initargs
:payload
- Readers
message-payload
.
- Writers
This slot is read-only.
- Slot: delay-while-idle ¶
-
- Initargs
:delay-while-idle
- Readers
message-delay-while-idle-p
.
- Writers
This slot is read-only.
- Slot: collapse-key ¶
-
- Initargs
:collapse-key
- Readers
message-collapse-key
.
- Writers
This slot is read-only.
- Slot: time-to-live ¶
-
- Initargs
:time-to-live
- Readers
message-time-to-live
.
- Writers
This slot is read-only.
- Class: response ¶
-
- Package
gcm
.
- Source
gcm.lisp
.
- Direct methods
-
- Direct slots
- Slot: multicast-id ¶
-
- Readers
response-multicast-id
.
- Writers
This slot is read-only.
- Slot: success ¶
-
- Initform
0
- Readers
response-success
.
- Writers
This slot is read-only.
- Slot: failure ¶
-
- Initform
0
- Readers
response-failure
.
- Writers
This slot is read-only.
- Slot: canonical-ids ¶
-
- Initform
0
- Readers
response-canonical-ids
.
- Writers
This slot is read-only.
- Slot: results ¶
-
- Initform
#()
- Readers
response-results
.
- Writers
This slot is read-only.
- Slot: raw-json ¶
-
- Initargs
:raw-json
- Readers
raw-json
.
- Writers
This slot is read-only.
- Class: result ¶
-
- Package
gcm
.
- Source
gcm.lisp
.
- Direct methods
-
- Direct slots
- Slot: message-id ¶
-
- Readers
result-message-id
.
- Writers
This slot is read-only.
- Slot: error-string ¶
-
- Readers
result-error-string
.
- Writers
This slot is read-only.
- Slot: raw-json ¶
-
- Initargs
:raw-json
- Readers
raw-json
.
- Writers
This slot is read-only.
5.2 Internals
5.2.1 Ordinary functions
- Function: cat (&rest strings) ¶
-
- Package
gcm
.
- Source
gcm.lisp
.
- Function: json-bool (x) ¶
-
- Package
gcm
.
- Source
gcm.lisp
.
- Function: parse-response (json) ¶
-
- Package
gcm
.
- Source
gcm.lisp
.
- Function: parse-result (json) ¶
-
- Package
gcm
.
- Source
gcm.lisp
.
- Function: report-send-failure (condition stream) ¶
-
- Package
gcm
.
- Source
gcm.lisp
.
- Function: require-config (config) ¶
-
- Package
gcm
.
- Source
gcm.lisp
.
- Function: send-body (message registration-ids config) ¶
-
- Package
gcm
.
- Source
gcm.lisp
.