get_rocket_groups: Retrieve a list of all groups which the user is invited in a...

In paeselhz/rocketeer:

Description

get_rocket_groups Gets a dataframe with all the groups which the user is allowed in a Rocket.chat server.

Usage

get_rocket_groups(url, user_id, auth_token)

Arguments

url	The url of the rocket.chat server (has to be complete, with http or https).
user_id	The users ID retrieved from 'get_rocket_credentials'.
auth_token	The users authentication Token retrieved from 'get_rocket_credentials'.

Details

This function connects to the Rocket.chat server and returns a dataframe containing the name of the group, the group's ID, number of users and number of messages exchanged there.

The function may be similar (some might say is equal) to 'get_rocket_channels', but Rocket.chat has a few differences in the API regarding public/open channels and private groups, this is the reason there are two functions.

Value

The return of this function is a dataframe.

Examples

## Not run: 
get_rocket_groups(url        = 'http://localhost:8000/',
                  user_id    = '<ROCKET_USER_ID>',
                  auth_token = '<ROCKET_USER_AUTH_TOKEN>')

## End(Not run)

paeselhz/rocketeer documentation built on Nov. 11, 2019, 1:23 a.m.