NotificationsApi: Agave Notifications API operations

Description Usage Format Details Arguments Methods See Also

Description

NotificationsApi Class

Usage

1
notifications <- NotificationsApi$new( apiClient = ApiClient$new(), cache = AgaveCache$new() )

Format

An object of class R6ClassGenerator of length 24.

Details

Under the covers, the Agave API is an event-driven distributed system implemented on top of a reliable, cloud-based messaging system. This means that every action either observed or taken by Agave is tied to an event. The changing of a job from one status to another is an event. The granting of permissions on a file is an event. Editing a piece of metadata is an event, and to be sure, the moment you created an account with Agave was an event. You get the idea.

Having such a fine-grain event system is helpful for the same reason that having a fine-grain permission model is helpful. It affords you the highest degree of flexibility and control possible to achieve the behavior you desire. With Agave’s event system, you have the ability to alert your users (or yourself) the instant something occurs. You can be proactive rather than reactive, and you can begin orchestrating your complex tasks in a loosely coupled, asynchronous way.

Read more about the Notifications API in the Agave Developer's Guide

Arguments

apiClient a rAgave::ApiClient instance preconfigured to speak to the Agave Platform.

cache an rAgave::AgaveCache instance pointing to the persistent auth cache file on disk.

responseType the default object type methods of this class should return. Valid values are:

Methods

$addNotification() Add new notification.

Usage

1
notifications$addNotification$listNotifications(body, naked, )

$deleteNotification() Remove notification from the system.

Usage

1
notifications$deleteNotification$listNotifications(uuid, naked, )

$getNotification() Retrieve notification.

Usage

1
notifications$getNotification$listNotifications(uuid, naked, )

$listNotifications() Retrieve notification for a specific resource.

Usage

1
2
notifications$listNotifications$listNotifications(associatedUuid, naked, limit, offset, search, )
notifications$listNotifications$listNotifications(search=list("foo"="bar"))

$updateNotification() Update existing notification.

Usage

1
notifications$updateNotification$listNotifications(uuid, body, naked, )

See Also

rAgave::ApiClient rAgave::Agave rAgave::Notification


agaveplatform/r-sdk documentation built on Sept. 22, 2018, 2:14 p.m.