group {hypothesis}R Documentation

Operate with group

Description

Operate with group

Usage

group(
  group_id,
  action = c("fetch", "update", "fetch_members"),
  ...,
  api_path = get_hs_host(),
  api_key = NULL
)

Arguments

group_id

Group ID

action

Action to process, Default: 'fetch'

...

Parameters for update group information, more details can be found in hypothesis documentation.

api_path

The hypothesis API path, can be specify by 'hypothesis.api.api_path' option or 'HYPOTHESIS_API_PATH' environment variable. Default: 'https://hypothes.is/api/'.

api_key

User api key, generated on the platform.

Source

https://h.readthedocs.io/en/latest/api-reference/v1/

Examples

## Not run: 
group("group_id")
group("group_id", action = "update", name = "updated text", description = "desc")
group("group_id", action = "fetch_members")

## End(Not run)

[Package hypothesis version 1.1.0 Index]