MTurkR (version 0.5)

GenerateNotification: Generate Notification

Description

Generate a HITType Notification data structure for use in SetHITTypeNotification.

Usage

GenerateNotification(destination, transport = "Email", event.type, 
                    version = "2006-05-05", event.number = "1", format = "REST")

Arguments

destination

Currently, a character string containing a complete email address (if transport="Email" or the SQS URL (if transport="SQS".

transport

Currently only “Email” and “SQS” are supported. AWS recommends the use of the SQS transport.

event.type

A character string containing one of: AssignmentAccepted, AssignmentAbandoned, AssignmentReturned, AssignmentSubmitted, HITReviewable, HITExpired, or Ping.

version

Version of the HITType Notification API to use. Intended only for advanced users.

event.number

Intended only for advanced users to construct custom Notifications.

format

Format of QualificationRequirement (SOAP or REST). Currently only REST is supported (as is the default).

Value

A character string containing a URL query parameter-formatted Notification data structure.

Details

Generate a Notification data structure for use in the notification option of SetHITTypeNotification.

References

API Reference

See Also

SetHITTypeNotification

SendTestEventNotification

Examples

# NOT RUN {
a <- GenerateNotification("[e-mail]",event.type="HITExpired")
# }