Giter Club home page Giter Club logo

uaship's Introduction

UAShip

Build Status

Urban Airship library for Laravel 5. UAShip

Usage

Requirements
  • Composer
  • PHP >= 5.6
Install
composer require mapalagama/uaship
Import

use Mapalagama\UAShip\UAShip

Initilization

Initialize UAShip class with your App Key and App Master Secret

$uaShip = new UAShip("**app_key_here**", "**app_master_secret**");

Alert

Add alert using addAlert method in UAShip class

$uaShip->addAlert("This is alert");

Channels

Add channels using addChannel method. parameters,

  1. Channel Type
    • UAShip::IOS for IOS Channels
    • UAShip::ANDROID for Android channels
  2. Channel id
$uaShip->addChannel(UAShip::IOS, "**Channel_id_here**");
$uaShip->addChannel(UAShip::ANDROID, "**Channel_id_here**");

Extra

Add extra data using addExtra method. parameters,

  1. Extra - Generic class or stdClass required. This parameter will encode to a json before sending
$extra = new stdClass();
$extra->question = "what is your name ?";

$uaShip->addExtra($e);

Send Message

Send notification using send method.

$result = $uaShip->send();

SUCCESS MESSAGE $result

{
  "ok": true,
  "operation_id": "**operation_id**",
  "push_ids": [
    "**push_id**"
  ],
  "message_ids": [],
  "content_urls": []
}

ERROR MESSAGE $result

error field contains the reason

{
  "ok": false,
  "error": "Unauthorized", 
  "error_code": 40101
}

Full code

   //initialization
    $uaShip = new UAShip("**APP_KEY**", "**APP_MASTER_SECRET**");
    
    //add alert message
    $uaShip->addAlert("This is alert");

    //add channels
    $uaShip->addChannel(UAShip::IOS, "**CHANNEL_ID**");
    $uaShip->addChannel(UAShip::ANDROID, "**CHANNEL_ID**");

    //add extra
    $extra = new stdClass();
    $extra->question = "what is your name ?";
    $uaShip->addExtra($extra);

    //send
    echo $uaShip->send();
    

Whats's in Next Version

  • push using device token
  • push using tags and device types
  • scheduling
  • more...

License

UAShip is released under the MIT License.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.