The gcm Reference Manual

Table of Contents

The gcm Reference Manual

This is the gcm Reference Manual, generated automatically by Declt version 2.4 "Will Decker" on Wed Jun 20 11:49:17 2018 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

• *config* (special variable)
• *registration-ids* (special variable)
• config (class)
• config-api-key (method)
• config-dry-run-p (method)
• config-send-endpoint (method)
• config-timeout (method)
• configure (function)
• gcm-error (condition)
• message (class)
• message-collapse-key (method)
• message-delay-while-idle-p (method)
• message-payload (method)
• message-time-to-live (method)
• raw-json (generic function)
• raw-json (method)
• raw-json (method)
• response (class)
• response-canonical-ids (method)
• response-failure (method)
• response-multicast-id (method)
• response-results (method)
• response-success (method)
• result (class)
• result-error-string (method)
• result-message-id (method)
• send (function)
• send-failure (condition)
• send-failure-code (method)
• send-failure-response (method)
• set-registration-ids (function)

Internal Definitions

• cat (function)
• json-bool (function)
• parse-response (function)
• parse-result (function)
• report-send-failure (function)
• require-config (function)
• send-body (function)

4 Packages

Packages are listed by definition order.

4.1 gcm

Source

gcm.lisp (file)

Use List

common-lisp

Exported Definitions

• *config* (special variable)
• *registration-ids* (special variable)
• config (class)
• config-api-key (generic function)
• config-api-key (method)
• config-dry-run-p (generic function)
• config-dry-run-p (method)
• config-send-endpoint (generic function)
• config-send-endpoint (method)
• config-timeout (generic function)
• config-timeout (method)
• configure (function)
• gcm-error (condition)
• message (class)
• message-collapse-key (generic function)
• message-collapse-key (method)
• message-delay-while-idle-p (generic function)
• message-delay-while-idle-p (method)
• message-payload (generic function)
• message-payload (method)
• message-time-to-live (generic function)
• message-time-to-live (method)
• raw-json (generic function)
• raw-json (method)
• raw-json (method)
• response (class)
• response-canonical-ids (generic function)
• response-canonical-ids (method)
• response-failure (generic function)
• response-failure (method)
• response-multicast-id (generic function)
• response-multicast-id (method)
• response-results (generic function)
• response-results (method)
• response-success (generic function)
• response-success (method)
• result (class)
• result-error-string (generic function)
• result-error-string (method)
• result-message-id (generic function)
• result-message-id (method)
• send (function)
• send-failure (condition)
• send-failure-code (generic function)
• send-failure-code (method)
• send-failure-response (generic function)
• send-failure-response (method)
• set-registration-ids (function)

Internal Definitions

• cat (function)
• json-bool (function)
• parse-response (function)
• parse-result (function)
• report-send-failure (function)
• require-config (function)
• send-body (function)

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

• send-failure-response (method)
• send-failure-code (method)

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

• config-timeout (method)
• config-send-endpoint (method)
• config-dry-run-p (method)
• config-api-key (method)

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

• to-json (method)
• initialize-instance (method)
• message-time-to-live (method)
• message-collapse-key (method)
• message-delay-while-idle-p (method)
• message-payload (method)

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

• raw-json (method)
• response-results (method)
• response-canonical-ids (method)
• response-failure (method)
• response-success (method)
• response-multicast-id (method)

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

• raw-json (method)
• result-error-string (method)
• result-message-id (method)

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

A.3 Variables

A.4 Data types