Interface FileReceiver

All Superinterfaces:
OsidReceiver
public interface FileReceiver extends OsidReceiver

The file receiver is the consumer supplied interface for receiving notifications pertaining to new, updated or deleted files.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    changedFiles(Id notificationId, IdList fileIds)
    The callback for notification of updated files.
    void
    deletedFiles(Id notificationId, IdList fileIds)
    the callback for notification of deleted files.
    void
    newFiles(Id notificationId, IdList fileIds)
    The callback for notifications of new files.

    Methods inherited from interface OsidReceiver

    down, up
    Modifier and Type
    Method
    Description
    void
    down()
    The callback for notifications that the notification bus is not operating.
    void
    up()
    The callback for notifications that the notification bus is operational.

  • Method Details

    • newFiles

      void newFiles(Id notificationId, IdList fileIds)
      The callback for notifications of new files.
      Parameters:
      notificationId - the notification Id
      fileIds - the Ids of the new files
      Compliance:
      mandatory - This method must be implemented.

    • changedFiles

      void changedFiles(Id notificationId, IdList fileIds)
      The callback for notification of updated files.
      Parameters:
      notificationId - the notification Id
      fileIds - the Ids of the changed files
      Compliance:
      mandatory - This method must be implemented.

    • deletedFiles

      void deletedFiles(Id notificationId, IdList fileIds)
      the callback for notification of deleted files.
      Parameters:
      notificationId - the notification Id
      fileIds - the Ids of the removed files
      Compliance:
      mandatory - This method must be implemented.