getGroups: Returns a list of the communities to which a user belongs

Description Usage Arguments Examples

View source: R/groups.R

Description

Returns a list of the communities to which a user belongs

Usage

1
2
3
4
5
6
7
8
9
getGroups(
  user_id = "",
  extended = "",
  filter = "",
  fields = "",
  offset = "",
  count = "",
  v = getAPIVersion()
)

Arguments

user_id

User ID

extended

1 - to return complete information about a user's communities; 0 - to return a list of community IDs without any additional fields (default)

filter

Types of communities to return: admin, editor, moder, groups, publics, events

fields

List of additional fields to be returned

offset

Offset needed to return a specific subset of communities

count

Number of communities to return (maximum value 1000)

v

Version of API

Examples

1
2
3
4
## Not run: 
groups <- getGroups(me(), extended = 1, fields = 'city')

## End(Not run)

Dementiy/vkR documentation built on Oct. 1, 2020, 9:48 a.m.