https://github.com/songmu/p5-apns-agent

https://github.com/songmu/p5-apns-agent

Last synced: 2 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/songmu/p5-apns-agent
• Owner: Songmu
• License: other
• Created: 2014-01-01T18:02:54.000Z (almost 11 years ago)
• Default Branch: master
• Last Pushed: 2014-03-17T08:40:48.000Z (over 10 years ago)
• Last Synced: 2024-10-11T21:09:53.984Z (27 days ago)
• Language: Perl
• Size: 305 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: Changes
  • License: LICENSE

Awesome Lists containing this project

README

        
# NAME

APNS::Agent - agent server for APNS

# SYNOPSIS

    use APNS::Agent;

    my $agent = APNS::Agent->new(

        certificate => '/path/to/certificate',

        private_key => '/path/to/private_key',

    );

    $agent->run;

# DESCRIPTION

APNS::Agent is agent server for APNS. It is also backend class of [apns-agent](http://search.cpan.org/perldoc?apns-agent).

This module provides consistent connection to APNS and cares reconnection. It utilizes

[AnyEvent::APNS](http://search.cpan.org/perldoc?AnyEvent::APNS) internally.

__THE SOFTWARE IS ALPHA QUALITY. API MAY CHANGE WITHOUT NOTICE.__

# API PARAMETERS

APNS::Agent launches HTTP Server process which accepts only POST method and

`application/x-www-form-urlencoded` format parameters.

Acceptable parameters as follows:

- `token`

    device token by HEX format. (Required)

- `payload`

    JSON string for push notification. If you only want to send message, alternatively can use

    `alert` parameter.

    One of `payload` and `alert` must be supplied. Both of `payload` and `alert` are specified,

    the `payload` parameter has priority.

- `alert`

    push notification message.

# SEE ALSO

[AnyEvent::APNS](http://search.cpan.org/perldoc?AnyEvent::APNS)

# THANKS

Thank __@shin1rosei__ that many code of this module is taken from

[https://github.com/shin1rosei/AnyEvent-APNS-Server](https://github.com/shin1rosei/AnyEvent-APNS-Server).

# LICENSE

Copyright (C) Songmu.

This library is free software; you can redistribute it and/or modify

it under the same terms as Perl itself.

# AUTHOR

Songmu