space_member_add: Invite Users

View source: R/members.R

space_member_addR Documentation

Invite Users

Description

Invites users to a space.

Usage

space_member_add(space, users, ...)

## S3 method for class 'character'
space_member_add(
  space,
  users,
  email_invite = TRUE,
  email_message = NULL,
  space_role = "contributor",
  ...
)

## S3 method for class 'data.frame'
space_member_add(space, users, ...)

Arguments

space

A space object created using rscloud_space().

users

Email address of the user to add or a data frame of user information.

...

Additional arguments.

email_invite

Indicates whether an email should be sent to the user with the invite, TRUE by default

email_message

Message to be sent to the user should the email_invite flag be set to TRUE

space_role

Desired role for the user in the space

Details

The users input should be a data frame consisting of the columns "user_email", "email_invite", "email_message", and "space_role". Each row of the users data frame denotes one user to be added. If any of these properties are specified in ..., they will take precendence and a message printed.


rstudio/rscloud documentation built on Oct. 8, 2022, 4:24 p.m.