hipchat_history: Show the history for a given Hipchat room.

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

Description

Show the history for a given Hipchat room.

Usage

hipchat_history(room_name_or_id, date = "recent", timezone = "UTC",
  start_index = 0, max_results = 100, reverse = TRUE, full = FALSE,
  api_token = hipchat_api_token())

Arguments

room_name_or_id	character or integer.
date	character or Date. Either the latest date to fetch history, or 'recent' to fetch the latest 75 messages. The default is 'recent'.
timezone	character. See note. By default, 'UTC'.
start_index	integer. The offset for messages to return. If date = 'recent', this parameter has no effect. The default is 0.
max_results	integer. Miaxmum number of messages to return. If date = 'recent', this parameter has no effect. By default, 100, but can be any value between 0 and 1000.
reverse	logical. Reverse the output so that the olest message is first. The default is TRUE, but set this to FALSE for consistent paging.
full	logical. Whether or not to display full history. By default, FALSE, which will return a data.frame with columns c('id', 'from', 'message', 'date'). If full = TRUE, the raw output from the Hipchat API is provided as a list.
api_token	character. By default, hipchat_api_token().

Value

If full = FALSE (the default), a data.frame with columns c('id', 'from', 'message', 'time', 'color'). Otherwise, a full list of the JSON response from the Hipchat API. (see References section)

Note

for available timezones, see the tz database at: http://en.wikipedia.org/wiki/List_of_tz_database_time_zones

References

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

Examples

## Not run: 
  hipchat_history('some room')
  hipchat_history('some room', start_index = 100, max_results = 200, date = Sys.time())
  # A data.frame of the 200 most recent messages with an offset of 100
  hipchat_history('some room', full = TRUE)
  # Full Hipchat API output for the latest 75 messages.

## End(Not run)

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