Sha256: 9022d06beec31d6089dd474c4cb890085583a8205137ec223470edd0779dd5dc
Contents?: true
Size: 1.87 KB
Versions: 5
Compression:
Stored size: 1.87 KB
Contents
# BundleNotification
## Example BundleNotification Object
```
{
"bundle_id": 1,
"id": 1,
"notify_on_registration": true,
"user_id": 1
}
```
* `bundle_id` (int64): Bundle ID to notify on
* `id` (int64): Bundle Notification ID
* `notify_on_registration` (boolean): Triggers bundle notification when a registration action occurs for it.
* `user_id` (int64): The id of the user to notify.
---
## List Bundle Notifications
```
Files::BundleNotification.list(
user_id: 1,
per_page: 1,
bundle_id: 1
)
```
### Parameters
* `user_id` (int64): User ID. Provide a value of `0` to operate the current session's user.
* `cursor` (string): Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
* `bundle_id` (int64): Bundle ID to notify on
---
## Show Bundle Notification
```
Files::BundleNotification.find(id)
```
### Parameters
* `id` (int64): Required - Bundle Notification ID.
---
## Create Bundle Notification
```
Files::BundleNotification.create(
user_id: 1,
notify_on_registration: true,
bundle_id: 1
)
```
### Parameters
* `user_id` (int64): Required - The id of the user to notify.
* `notify_on_registration` (boolean): Triggers bundle notification when a registration action occurs for it.
* `bundle_id` (int64): Required - Bundle ID to notify on
---
## Delete Bundle Notification
```
Files::BundleNotification.delete(id)
```
### Parameters
* `id` (int64): Required - Bundle Notification ID.
---
## Delete Bundle Notification
```
bundle_notification = Files::BundleNotification.list.first
bundle_notification.delete
```
### Parameters
* `id` (int64): Required - Bundle Notification ID.
Version data entries
5 entries across 5 versions & 1 rubygems