PHP download

Download the PHP package vanilla/hipchat-api without Composer

On this page you can find all versions of the php package vanilla/hipchat-api. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

Table of contents
Download vanilla/hipchat-api
More information about vanilla/hipchat-api
Files in vanilla/hipchat-api

Vendor vanilla
Package hipchat-api
Short Description Hipchat v2 API client
License MIT
Homepage https://github.com/vanilla/hipchat-api

Keywords api client library hipchat v2

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:

If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.

Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
To use Composer is sometimes complicated. Especially for beginners.
Composer needs much resources. Sometimes they are not available on a simple webspace.
If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.

Please rate this library. Is it a good library?

Example code of vanilla/hipchat-api

Informations about the package hipchat-api

HipChat API

MIT License

hipchat-api is a PHP library that provides an implementation of the HipChat v2 REST API.

Installation

hipchat-api requires PHP 5.4 or higher

hipchat-api is PSR-4 compliant and can be easily installed using composer.

Just add vanilla/hipchat-api to your composer.json.

Usage

HipChat uses OAuth2 tokens with specific scopes to control API access. You can request a token for yourself by visiting the HipChat Account/API page.

This example makes a call to the Users API to get all users.

You can make the client throw an exception instead of returning false on error by calling setThrowExceptions(true) on $client.

Custom API Endpoint

If you are using a private instance of HipChat, you can change the API base URL when you instantiate the client:

You can also change the base URL at any time by calling setBaseUrl() on an existing $client.

Current status

The following list shows methods available and missing:

Add ons

[ ] Get addon installable data
[ ] Create addon link
[ ] Invoke addon link
[ ] Delete addon link

Capabilities

[x] Get capabilities

Emoticons

[ ] Get emoticon
[ ] Get all emoticons

OAuth Sessions

[ ] Generate token
[ ] Get session
[ ] Delete session

Rooms

[x] Get all rooms
[x] Create room
[x] Get room
[x] Update room
[x] Delete room
[x] Get avatar
[X] Update avatar
[X] Delete avatar
[x] Get room message
[x] View room history
[x] View recent room history
[ ] Get glance
[ ] Create glance
[ ] Delete glance
[x] Invite user
[x] Add member
[x] Remove member
[x] Get all members
[x] Get all participants
[x] Send message
[x] Send room notification
[x] Reply to message
[ ] Share file with room
[ ] Share link with room
[x] Get room statistics
[x] Set topic
[x] Get webhook
[x] Delete webhook
[x] Get all webhooks
[x] Create webhook

Users

[x] Get all users
[x] Create user
[x] View user
[x] Update user
[x] Delete user
[x] View privatechat history
[x] View recent privatechat history
[x] Get private chat message
[x] Send message to user
[x] Get photo
[x] Upload photo
[x] Delete photo
[x] Get preference (auto-join)
[ ] Share file with user
[ ] Share link with user

All versions of hipchat-api with dependencies

PHP Build Version

Package Version

Version v2.0 Release 29. Apr 2016
create-project require 0 people choosed require and
0 people choosed create-project.

Download

Download latest version of hipchat-api from vendor vanilla

Requires php Version >=5.4
vanilla/garden-http Version ^1.1.2

Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package vanilla/hipchat-api contains the following files

Loading the files please wait ....