hipchat_rooms: Get the list of all hipchat rooms.

In robertzk/hipchat: An R package for communicating with the hipchat API

Description

Get the list of all hipchat rooms.

Usage

hipchat_rooms(max_results = 1000, include_archived = FALSE, full = FALSE,
  api_token = hipchat_api_token())

Arguments

max_results	integer. Maximum number of rooms to return. Must be between 0 and 1000 – the default is 1000.
include_archived	logical. Whether or not to include archived rooms in the results. The default is FALSE.
full	logical. Whether or not to return raw output from the Hipchat API. If FALSE (the default), only a named character vector of room IDs will be returned.
api_token	character. By default, hipchat_api_token().

Value

an integer vector, with names being room names and values being room IDs if full = TRUE. Otherwise, return the full raw output from the Hipchat API.

References

https://www.hipchat.com/docs/apiv2/method/get_all_rooms

robertzk/hipchat documentation built on May 27, 2019, 10:34 a.m.