com.files.models

Class Notification

java.lang.Object

com.files.models.Notification

All Implemented Interfaces:

ModelInterface

public class Notification
extends Object
implements ModelInterface

Field Summary

Fields

Modifier and Type	Field and Description
Long	groupId ID of Group to receive notifications
String	groupName Group name, if a Group ID is set
Long	id Notification ID
String	message Custom message to include in notification emails
Boolean	notifyOnCopy Trigger on files copied to this path?
Boolean	notifyOnDelete Trigger on files deleted in this path?
Boolean	notifyOnDownload Trigger on files downloaded in this path?
Boolean	notifyOnMove Trigger on files moved to this path?
Boolean	notifyOnUpload Trigger on files created/uploaded/updated/changed in this path?
Boolean	notifyUserActions If true, will send notifications about a user's own activity to that user.
String	path Folder path to notify on.
Boolean	recursive Apply notification recursively?
String	sendInterval The time interval that notifications are aggregated to
Boolean	suppressedEmail If true, it means that the recipient at this user's email address has manually unsubscribed from all emails, or had their email "hard bounce", which means that we are unable to send mail to this user's current email address.
Boolean	triggerByShareRecipients Notify when actions are performed by a share recipient?
String[]	triggeringFilenames Array of filenames (possibly with wildcards) to scope trigger
Long[]	triggeringGroupIds If set, will only notify on actions made by a member of one of the specified groups
Long[]	triggeringUserIds If set, will only notify on actions made one of the specified users
Boolean	unsubscribed Is the user unsubscribed from this notification?
String	unsubscribedReason The reason that the user unsubscribed
Long	userId Notification user ID
String	username Notification username

Constructor Summary

Constructors

Constructor and Description
Notification()
Notification(HashMap<String,Object> parameters)
Notification(HashMap<String,Object> parameters, HashMap<String,Object> options)

Method Summary

Modifier and Type	Method and Description
static ListIterator<Notification>	all()
static ListIterator<Notification>	all(HashMap<String,Object> parameters, HashMap<String,Object> options)
static Notification	create(HashMap<String,Object> parameters) Parameters: user_id - int64 - The id of the user to notify.
static Notification	create(HashMap<String,Object> parameters, HashMap<String,Object> options)
void	delete()
static void	delete(HashMap<String,Object> parameters, HashMap<String,Object> options)
static void	delete(Long id, HashMap<String,Object> parameters)
static void	delete(Long id, HashMap<String,Object> parameters, HashMap<String,Object> options)
static void	destroy()
void	destroy(HashMap<String,Object> parameters)
static void	destroy(Long id, HashMap<String,Object> parameters, HashMap<String,Object> options)
static Notification	find(HashMap<String,Object> parameters, HashMap<String,Object> options)
static Notification	find(Long id, HashMap<String,Object> parameters) Parameters: id (required) - int64 - Notification ID.
static Notification	find(Long id, HashMap<String,Object> parameters, HashMap<String,Object> options)
static Notification	get()
static Notification	get(Long id, HashMap<String,Object> parameters, HashMap<String,Object> options)
static ListIterator<Notification>	list() Parameters: cursor - string - Used for pagination.
static ListIterator<Notification>	list(HashMap<String,Object> parameters)
static ListIterator<Notification>	list(HashMap<String,Object> parameters, HashMap<String,Object> options)
void	save()
Notification	update() Parameters: notify_on_copy - boolean - If `true`, copying or moving resources into this path will trigger a notification, in addition to just uploads.
static Notification	update(HashMap<String,Object> parameters, HashMap<String,Object> options)
static Notification	update(Long id, HashMap<String,Object> parameters) Parameters: notify_on_copy - boolean - If `true`, copying or moving resources into this path will trigger a notification, in addition to just uploads.
static Notification	update(Long id, HashMap<String,Object> parameters, HashMap<String,Object> options)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.files.models.ModelInterface

setOptions

Field Detail

id

public Long id

Notification ID

path

public String path

Folder path to notify on. This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.

groupId

public Long groupId

ID of Group to receive notifications

groupName

public String groupName

Group name, if a Group ID is set

triggeringGroupIds

public Long[] triggeringGroupIds

If set, will only notify on actions made by a member of one of the specified groups

triggeringUserIds

public Long[] triggeringUserIds

If set, will only notify on actions made one of the specified users

triggerByShareRecipients

public Boolean triggerByShareRecipients

Notify when actions are performed by a share recipient?

notifyUserActions

public Boolean notifyUserActions

If true, will send notifications about a user's own activity to that user. If false, only activity performed by other users (or anonymous users) will be sent in notifications.

notifyOnCopy

public Boolean notifyOnCopy

Trigger on files copied to this path?

notifyOnDelete

public Boolean notifyOnDelete

Trigger on files deleted in this path?

notifyOnDownload

public Boolean notifyOnDownload

Trigger on files downloaded in this path?

notifyOnMove

public Boolean notifyOnMove

Trigger on files moved to this path?

notifyOnUpload

public Boolean notifyOnUpload

Trigger on files created/uploaded/updated/changed in this path?

recursive

public Boolean recursive

Apply notification recursively? This will enable notifications for each subfolder.

sendInterval

public String sendInterval

The time interval that notifications are aggregated to

message

public String message

Custom message to include in notification emails

triggeringFilenames

public String[] triggeringFilenames

Array of filenames (possibly with wildcards) to scope trigger

unsubscribed

public Boolean unsubscribed

Is the user unsubscribed from this notification?

unsubscribedReason

public String unsubscribedReason

The reason that the user unsubscribed

userId

public Long userId

Notification user ID

username

public String username

Notification username

suppressedEmail

public Boolean suppressedEmail

If true, it means that the recipient at this user's email address has manually unsubscribed from all emails, or had their email "hard bounce", which means that we are unable to send mail to this user's current email address. Notifications will resume if the user changes their email address.

Constructor Detail

Notification

public Notification()

Notification

public Notification(HashMap<String,Object> parameters)

Notification

public Notification(HashMap<String,Object> parameters,
                    HashMap<String,Object> options)

Method Detail

update

public Notification update()
                    throws IOException

Parameters: notify_on_copy - boolean - If `true`, copying or moving resources into this path will trigger a notification, in addition to just uploads. notify_on_delete - boolean - Trigger on files deleted in this path? notify_on_download - boolean - Trigger on files downloaded in this path? notify_on_move - boolean - Trigger on files moved to this path? notify_on_upload - boolean - Trigger on files created/uploaded/updated/changed in this path? notify_user_actions - boolean - If `true` actions initiated by the user will still result in a notification recursive - boolean - If `true`, enable notifications for each subfolder in this path send_interval - string - The time interval that notifications are aggregated by. Can be `five_minutes`, `fifteen_minutes`, `hourly`, or `daily`. message - string - Custom message to include in notification emails triggering_filenames - array(string) - Array of filenames (possibly with wildcards) to scope trigger triggering_group_ids - array(int64) - If set, will only notify on actions made by a member of one of the specified groups triggering_user_ids - array(int64) - If set, will only notify on actions made one of the specified users trigger_by_share_recipients - boolean - Notify when actions are performed by a share recipient?

Throws:

IOException

delete

public void delete()
            throws IOException

Throws:

IOException

destroy

public void destroy(HashMap<String,Object> parameters)
             throws IOException

Throws:

IOException

save

public void save()
          throws IOException

Throws:

IOException

list

public static ListIterator<Notification> list()
                                       throws RuntimeException

Parameters: cursor - string - Used for pagination. When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination. per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended). sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `path`, `user_id` or `group_id`. filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `path`, `user_id` or `group_id`. filter_prefix - object - If set, return records where the specified field is prefixed by the supplied value. Valid fields are `path`. path - string - Show notifications for this Path. include_ancestors - boolean - If `include_ancestors` is `true` and `path` is specified, include notifications for any parent paths. Ignored if `path` is not specified. group_id - string

Throws:

RuntimeException

list

public static ListIterator<Notification> list(HashMap<String,Object> parameters)
                                       throws RuntimeException

Throws:

RuntimeException

list

public static ListIterator<Notification> list(HashMap<String,Object> parameters,
                                              HashMap<String,Object> options)
                                       throws RuntimeException

Throws:

RuntimeException

all

public static ListIterator<Notification> all()
                                      throws RuntimeException

Throws:

RuntimeException

all

public static ListIterator<Notification> all(HashMap<String,Object> parameters,
                                             HashMap<String,Object> options)
                                      throws RuntimeException

Throws:

RuntimeException

find

public static Notification find(Long id,
                                HashMap<String,Object> parameters)
                         throws RuntimeException

Parameters: id (required) - int64 - Notification ID.

Throws:

RuntimeException

find

public static Notification find(HashMap<String,Object> parameters,
                                HashMap<String,Object> options)
                         throws RuntimeException

Throws:

RuntimeException

find

public static Notification find(Long id,
                                HashMap<String,Object> parameters,
                                HashMap<String,Object> options)
                         throws RuntimeException

Throws:

RuntimeException

get

public static Notification get()
                        throws RuntimeException

Throws:

RuntimeException

get

public static Notification get(Long id,
                               HashMap<String,Object> parameters,
                               HashMap<String,Object> options)
                        throws RuntimeException

Throws:

RuntimeException

create

public static Notification create(HashMap<String,Object> parameters)
                           throws RuntimeException

Parameters: user_id - int64 - The id of the user to notify. Provide `user_id`, `username` or `group_id`. notify_on_copy - boolean - If `true`, copying or moving resources into this path will trigger a notification, in addition to just uploads. notify_on_delete - boolean - Trigger on files deleted in this path? notify_on_download - boolean - Trigger on files downloaded in this path? notify_on_move - boolean - Trigger on files moved to this path? notify_on_upload - boolean - Trigger on files created/uploaded/updated/changed in this path? notify_user_actions - boolean - If `true` actions initiated by the user will still result in a notification recursive - boolean - If `true`, enable notifications for each subfolder in this path send_interval - string - The time interval that notifications are aggregated by. Can be `five_minutes`, `fifteen_minutes`, `hourly`, or `daily`. message - string - Custom message to include in notification emails triggering_filenames - array(string) - Array of filenames (possibly with wildcards) to scope trigger triggering_group_ids - array(int64) - If set, will only notify on actions made by a member of one of the specified groups triggering_user_ids - array(int64) - If set, will only notify on actions made one of the specified users trigger_by_share_recipients - boolean - Notify when actions are performed by a share recipient? group_id - int64 - The ID of the group to notify. Provide `user_id`, `username` or `group_id`. path - string - Path username - string - The username of the user to notify. Provide `user_id`, `username` or `group_id`.

Throws:

RuntimeException

create

public static Notification create(HashMap<String,Object> parameters,
                                  HashMap<String,Object> options)
                           throws RuntimeException

Throws:

RuntimeException

update

public static Notification update(Long id,
                                  HashMap<String,Object> parameters)
                           throws RuntimeException

Parameters: notify_on_copy - boolean - If `true`, copying or moving resources into this path will trigger a notification, in addition to just uploads. notify_on_delete - boolean - Trigger on files deleted in this path? notify_on_download - boolean - Trigger on files downloaded in this path? notify_on_move - boolean - Trigger on files moved to this path? notify_on_upload - boolean - Trigger on files created/uploaded/updated/changed in this path? notify_user_actions - boolean - If `true` actions initiated by the user will still result in a notification recursive - boolean - If `true`, enable notifications for each subfolder in this path send_interval - string - The time interval that notifications are aggregated by. Can be `five_minutes`, `fifteen_minutes`, `hourly`, or `daily`. message - string - Custom message to include in notification emails triggering_filenames - array(string) - Array of filenames (possibly with wildcards) to scope trigger triggering_group_ids - array(int64) - If set, will only notify on actions made by a member of one of the specified groups triggering_user_ids - array(int64) - If set, will only notify on actions made one of the specified users trigger_by_share_recipients - boolean - Notify when actions are performed by a share recipient?

Throws:

RuntimeException

update

public static Notification update(HashMap<String,Object> parameters,
                                  HashMap<String,Object> options)
                           throws RuntimeException

Throws:

RuntimeException

update

public static Notification update(Long id,
                                  HashMap<String,Object> parameters,
                                  HashMap<String,Object> options)
                           throws RuntimeException

Throws:

RuntimeException

delete

public static void delete(Long id,
                          HashMap<String,Object> parameters)
                   throws RuntimeException

Throws:

RuntimeException

delete

public static void delete(HashMap<String,Object> parameters,
                          HashMap<String,Object> options)
                   throws RuntimeException

Throws:

RuntimeException

delete

public static void delete(Long id,
                          HashMap<String,Object> parameters,
                          HashMap<String,Object> options)
                   throws RuntimeException

Throws:

RuntimeException

destroy

public static void destroy()
                    throws RuntimeException

Throws:

RuntimeException

destroy

public static void destroy(Long id,
                           HashMap<String,Object> parameters,
                           HashMap<String,Object> options)
                    throws RuntimeException

Throws:

RuntimeException