Member {sevenbridges2}R Documentation

R6 Class representing a project member

Description

R6 Class representing a resource for managing project members.

Super class

sevenbridges2::Item -> Member

Public fields

id

Member's id.

username

Member's username.

email

Member's email.

type

Member's type.

permissions

Member's permissions.

Methods

Public methods

Method new()

Create a new Member object.

Usage
Member$new(res = NA, ...)
Arguments
res

Response containing Member object information.

...

Other response arguments.

Method print()

Print method for Member class.

Usage
Member$print()
Examples
\dontrun{
 # x is API response when member is requested
 member_object <- Member$new(
                    res = x,
                    href = x$href,
                    auth = auth,
                    response = attr(x, "response")
                   )

 # Print member object
 member_object$print()
}

Method reload()

Reload Member object information.

Usage
Member$reload()
Examples
\dontrun{
 # x is API response when member is requested
 member_object <- Member$new(
                    res = x,
                    href = x$href,
                    auth = auth,
                    response = attr(x, "response")
                   )

 # Reload member object
 member_object$reload()
}

Method clone()

The objects of this class are cloneable with this method.

Usage
Member$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

Examples


## ------------------------------------------------
## Method `Member$print`
## ------------------------------------------------

## Not run: 
 # x is API response when member is requested
 member_object <- Member$new(
                    res = x,
                    href = x$href,
                    auth = auth,
                    response = attr(x, "response")
                   )

 # Print member object
 member_object$print()

## End(Not run)


## ------------------------------------------------
## Method `Member$reload`
## ------------------------------------------------

## Not run: 
 # x is API response when member is requested
 member_object <- Member$new(
                    res = x,
                    href = x$href,
                    auth = auth,
                    response = attr(x, "response")
                   )

 # Reload member object
 member_object$reload()

## End(Not run)
[Package sevenbridges2 version 0.1.0 Index]