{"id":16296708,"url":"https://github.com/hernandev/hipchat-laravel","last_synced_at":"2025-03-20T04:31:36.066Z","repository":{"id":18994396,"uuid":"22216286","full_name":"hernandev/hipchat-laravel","owner":"hernandev","description":"Hipchat Notifer Wrapper for Laravel 4 and 5","archived":false,"fork":false,"pushed_at":"2016-03-21T19:03:07.000Z","size":16,"stargazers_count":27,"open_issues_count":1,"forks_count":8,"subscribers_count":2,"default_branch":"master","last_synced_at":"2024-10-11T20:23:56.507Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/hernandev.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2014-07-24T14:34:50.000Z","updated_at":"2019-04-16T20:41:25.000Z","dependencies_parsed_at":"2022-09-25T03:40:38.072Z","dependency_job_id":null,"html_url":"https://github.com/hernandev/hipchat-laravel","commit_stats":null,"previous_names":[],"tags_count":7,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hernandev%2Fhipchat-laravel","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hernandev%2Fhipchat-laravel/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hernandev%2Fhipchat-laravel/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hernandev%2Fhipchat-laravel/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/hernandev","download_url":"https://codeload.github.com/hernandev/hipchat-laravel/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":221734420,"owners_count":16872094,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-10-10T20:23:43.708Z","updated_at":"2024-10-27T21:18:17.129Z","avatar_url":"https://github.com/hernandev.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"## hernandev/hipchat-laravel\n\n[![Latest Stable Version](https://poser.pugx.org/hernandev/hipchat-laravel/version.svg)](https://packagist.org/packages/hernandev/hipchat-laravel)\n[![Total Downloads](https://poser.pugx.org/hernandev/hipchat-laravel/downloads.svg)](https://packagist.org/packages/hernandev/hipchat-laravel)\n[![License](https://poser.pugx.org/hernandev/hipchat-laravel/license.svg)](https://packagist.org/packages/hernandev/hipchat-laravel)\n\n\n\nThis a [HipChat PHP Client](https://github.com/hipchat/hipchat-php) wrapper for Laravel 4 and 5\n\n\n### Installation\n\n- Include `\"hernandev/hipchat-laravel\"` inside the `\"require\"` section of `composer.json` file:\n\n    ```php\n        ...\n        \"require\": {\n            ...,\n            \"hernandev/hipchat-laravel\": \"~2.0\"\n        }\n        ...\n    \n    ```\n\n- Update composer dependencies by running:\n\n    \n    ```\n    composer update\n    ```\n\n- Insert `'Hernandev\\HipchatLaravel\\HipchatLaravelServiceProvider',` in your `'providers'` array, inside `app/config/app.php`:\n\n    ```php\n    ...\n    'providers' =\u003e [\n        ...\n        Hernandev\\HipchatLaravel\\HipchatLaravelServiceProvider::class,\n    ],\n    ```\n    \n    \n- Insert `'HipChat' =\u003e Hernandev\\HipchatLaravel\\Facade\\HipChat:class,` in your `'aliases'` array, inside `app/config/app.php`:\n\n    ```php\n    ...\n    'aliases' =\u003e [\n        ...\n        'HipChat'         =\u003e Hernandev\\HipchatLaravel\\Facade\\HipChat::class,\n    ],\n    ```\n    \n    \n- To Publish the configuration files you will need, run:\n\n    ```\n    php artisan vendor:publish --tag=laravel\n    ```\n\n- Edit `app/config/hipchat.php` file updating it your credentials / configurations:\n\n    ```php\n    'api_token' =\u003e 'insert_your_api_token',\n    'app_name' =\u003e 'Your App Name',\n    'default_room' =\u003e null, // this is optional\n    \n    ```\n    \n    \n\n\n### Usage\n\n**Note**: when 'default_room' is set on config file, there is not need to call ::setRoom('room_name'), use it only if want to work with a room that is not the default one.\n\n- Notify in a Room\n\n    ```php\n    HipChat::setRoom('RoomName');\n    HipChat::sendMessage('My Message');\n    \n    // you have two optional parameters, `color` and `notify`\n    // the 'red' will set the message color, and the third parameter when `true` notify all users on the room\n    \n    HipChat::sendMessage('My Message', 'red', true);\n    \n    \n    \n    ```\n    \n- Get a Room Details\n\n    ```php\n    HipChat::setRoom('RoomName');\n    HipChat::getRoom(); // StdObject\n    ```\n    \n- Verify is a room exists\n\n    ```php\n    HipChat::setRoom('RoomName');\n    HipChat::roomExists(); // boolean\n    ```\n    \n    \n- Get Rooms List\n\n    ```php\n    HipChat::getRooms(); // json\n    ```\n    \n    \n- Retrieve Message History for a Room\n\n    ```php\n    HipChat::setRoom('RoomName');\n    return HipChat::getRoomsHistory(); // json\n    ```\n    \n    \n- Change Room Topic\n\n    ```php\n    HipChat::setRoom('RoomName');\n    return HipChat::setRoomTopic('New Topic via API'); // boolean\n    ```\n    \n    \n- Get a List of Users\n\n    ```php\n    HipChat::getUsers(); // json\n    ```\n    \n- Get an User details\n\n    ```php\n    HipChat::setUser('me@me.com'); // you can use id, email or @mention_name\n    HipChat::getUser(); // StdObject\n    ```\n    \n- Create an Room\n\n    ```php\n    HipChat::setUser('me@me.com'); // you can use id, email or @mention_name\n    // see optional fields on code\n    HipChat::createRoom('New Room Name'); // boolean\n    ```\n    \n- Get a List of Users\n\n    ```php\n    HipChat::getUsers(); // json\n    ```\n    \n\n- Delete a room\n\n    ```php\n    HipChat::setRoom('RoomName');\n    HipChat::deleteRoom(); // boolean\n    ```\n\n- Create User\n\n    ```php\n    // email, first_name last_name, mention_name, title\n    HipChat::createUser('me2@me2.com', 'First Last', 'mention', 'title'); // boolean\n    ```\n    \n- Update User Info\n\n    ```php \n     // you can use email, mention name or user_id\n    HipChat::setUser('me@me.com');\n    \n    // same signature as create_user method, pass null the fields you dont want to update\n    HipChat::updateUser(null, 'NewFirst New Last'); // boolean\n    \n    ```\n\n\n    ","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhernandev%2Fhipchat-laravel","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhernandev%2Fhipchat-laravel","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhernandev%2Fhipchat-laravel/lists"}