NotificationType

Enumeration of the possible notification types for requests from Scotty.

Enums
START

Such requests signals the start of a request containing media upload. Only the media field(s) in the inserted/updated resource are set.

The response should either return an error or succeed. On success, responses don't need to contain anything.

PROGRESS

Such requests signals that the upload has progressed and that the backend might want to access the media file specified in relevant fields in the resource. Only the media field(s) in the inserted/updated resource are set.

The response should either return an error or succeed. On success, responses don't need to contain anything.

END

Such requests signals the end of a request containing media upload. END should be handled just like normal Insert/Upload requests, that is, they should process the request and return a complete resource in the response.

Pointers to media data (a GFS path usually) appear in the relevant fields in the inserted/updated resource. See gdata.Media in data.proto.

RESPONSE_SENT

Such requests occur after an END and signal that the response has been sent back to the client. RESPONSE_SENT is only sent to the backend if it is configured to receive them.

The response does not need to contain anything.

ERROR

Such requests indicate that an error occurred while processing the request. ERROR is only sent to the backend if it is configured to receive them. It is not guaranteed that all errors will result in this notification to the backend, even if the backend requests them.

Since these requests are just for informational purposes, the response does not need to contain anything.