Divisions: R6 Class representing divisions endpoints.

In sevenbridges2: The 'Seven Bridges Platform' API Client

R6 Class representing divisions endpoints.

Description

R6 Class representing Divisions resource.

Super class

sevenbridges2::Resource -> Divisions

Public fields

URL

List of URL endpoints for this resource.

Methods

Public methods

• Divisions$new()

• Divisions$query()

• Divisions$get()

• Divisions$clone()

Inherited methods

• sevenbridges2::Resource$delete()

---

Method new()

Create new Divisions resource object.

Usage

Divisions$new(...)

Arguments

...

Other response arguments.

---

Method query()

This call retrieves a list of all divisions you are a member of. Each division's ID, name and URL on platform will be returned.

Usage

Divisions$query()

Returns

A Collection of Division objects.

Examples

\dontrun{
  # Retrieve a list of all divisions you are a member of
  a$Divisions$query()
}

---

Method get()

This call returns the details of a specified division.

Usage

Divisions$get(id, ...)

Arguments

id

The ID of the division you are querying. The function also accepts a Division object and extracts the ID.

...

Other arguments that can be passed to core api() function like 'fields', etc.

Returns

Division object.

Examples

\dontrun{
  # Retrieve details of a specified division
  a$Divisions$get(id = "division-id")
}

---

Method clone()

The objects of this class are cloneable with this method.

Usage

Divisions$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

Examples

## ------------------------------------------------
## Method `Divisions$query`
## ------------------------------------------------

## Not run: 
  # Retrieve a list of all divisions you are a member of
  a$Divisions$query()

## End(Not run)

## ------------------------------------------------
## Method `Divisions$get`
## ------------------------------------------------

## Not run: 
  # Retrieve details of a specified division
  a$Divisions$get(id = "division-id")

## End(Not run)

sevenbridges2 documentation built on April 11, 2025, 6 p.m.