library hipchat-laravel

qwince/hipchat-laravel

HipChat PHP Client for Laravel 5

qwince/hipchat-laravel

This a HipChat PHP Client for Laravel 5, _(*1)

Installation

• Include "qwince/hipchat-laravel" inside the "require" section of composer.json file:, _(*2)

      ...
      "require": {
          ...,
          "qwince/hipchat-laravel": "dev-master"
      }
      ...
  
  

• Update composer dependencies by running:, _(*3)

  composer update
  

• Insert 'Qwince\HipchatLaravel\HipchatLaravelServiceProvider', in your 'providers' array, inside app/config/app.php:, _(*4)

  ...
  'providers' => [
      ...
      Qwince\HipchatLaravel\HipchatLaravelServiceProvider::class,
  ],
  

• Insert 'HipChat' => Qwince\HipchatLaravel\Facade\HipChat:class, in your 'aliases' array, inside app/config/app.php:, _(*5)

  ...
  'aliases' => [
      ...
      'HipChat'         => Qwince\HipchatLaravel\Facade\HipChat::class,
  ],
  

• To Publish the configuration files you will need, run:, _(*6)

  php artisan vendor:publish --provider="Qwince\HipchatLaravel\HipchatLaravelServiceProvider"
  

• Edit app/config/hipchat.php file updating it your credentials / configurations:, _(*7)

  'server' => 'insert_your_url',
  'api_token' => 'insert_your_api_token',
  'app_name' => 'Your App Name',
  'default_room' => 1234,
  
  

Usage

• Notify in a Room, _(*8)

  
  HipChat::setRoom('RoomID'); // or set default in config file 
  
  HipChat::sendMessage('My Message');
  
  // you have two optional parameters, `color` and `notify`
  // the 'red' will set the message color, and the third parameter when `true` notify all users on the room
  
  HipChat::sendMessage('My Message', 'red', true);