-
Include "hernandev/hipchat-laravel" inside the "require" section of composer.json file:, (*3)
...
"require": {
...,
"hernandev/hipchat-laravel": "~2.0"
}
...
-
Update composer dependencies by running:, (*4)
composer update
-
Insert 'Hernandev\HipchatLaravel\HipchatLaravelServiceProvider', in your 'providers' array, inside app/config/app.php:, (*5)
...
'providers' => [
...
Hernandev\HipchatLaravel\HipchatLaravelServiceProvider::class,
],
-
Insert 'HipChat' => Hernandev\HipchatLaravel\Facade\HipChat:class, in your 'aliases' array, inside app/config/app.php:, (*6)
...
'aliases' => [
...
'HipChat' => Hernandev\HipchatLaravel\Facade\HipChat::class,
],
-
To Publish the configuration files you will need, run:, (*7)
php artisan vendor:publish --tag=laravel
-
Edit app/config/hipchat.php file updating it your credentials / configurations:, (*8)
'api_token' => 'insert_your_api_token',
'app_name' => 'Your App Name',
'default_room' => null, // this is optional
-
Notify in a Room, (*10)
HipChat::setRoom('RoomName');
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);
-
Get a Room Details, (*11)
HipChat::setRoom('RoomName');
HipChat::getRoom(); // StdObject
-
Verify is a room exists, (*12)
HipChat::setRoom('RoomName');
HipChat::roomExists(); // boolean
-
Get Rooms List, (*13)
HipChat::getRooms(); // json
-
Retrieve Message History for a Room, (*14)
HipChat::setRoom('RoomName');
return HipChat::getRoomsHistory(); // json
-
Change Room Topic, (*15)
HipChat::setRoom('RoomName');
return HipChat::setRoomTopic('New Topic via API'); // boolean
-
Get a List of Users, (*16)
HipChat::getUsers(); // json
-
Get an User details, (*17)
HipChat::setUser('me@me.com'); // you can use id, email or @mention_name
HipChat::getUser(); // StdObject
-
Create an Room, (*18)
HipChat::setUser('me@me.com'); // you can use id, email or @mention_name
// see optional fields on code
HipChat::createRoom('New Room Name'); // boolean
-
Get a List of Users, (*19)
HipChat::getUsers(); // json
-
Delete a room, (*20)
HipChat::setRoom('RoomName');
HipChat::deleteRoom(); // boolean
-
Create User, (*21)
// email, first_name last_name, mention_name, title
HipChat::createUser('me2@me2.com', 'First Last', 'mention', 'title'); // boolean
-
Update User Info, (*22)
// you can use email, mention name or user_id
HipChat::setUser('me@me.com');
// same signature as create_user method, pass null the fields you dont want to update
HipChat::updateUser(null, 'NewFirst New Last'); // boolean
Wallogit.com
