Community articleIBM Connections Event Reference - Moderation - Files
Added by IBM contributorIBM | Edited by IBM contributordeveloperWorks Lotus Team on July 8, 2014
Rate this article 1 starsRate this article 2 starsRate this article 3 starsRate this article 4 starsRate this article 5 stars

A list of event references for Files moderation.

Event References - Moderation - Files

Note: All the events below including the synchronous events will only be fired if pre/post-moderation is enabled. There are asynchronous events that are not documented here (as they are not moderation-specific) that will always be fired: files.comment.created, files.comment.updated, files.file.created, files.file.updated.



Event data is provided using the following conventions. Refer to the Event SPI JavaDoc for details about these event data objects, how to retrieve them from the event object, and how to get additional information from these objects themselves.

Pre-Moderation

LCEvent
Invocation Point
Event Type
Synch vs. Asynch
Event Fields
Comment
files.file.comment.created
Pre-commit
create
Synch
actor
[content: Comment]
contentType: Text

ModerationData.actorRole: User's library role
ModerationData.globalModerator
[ModerationData.moderationState]
* There is no need to set as many fields as that of the created event; it is enough to set just the ones for moderation.

* To be sent before the comment is saved to the database.

* The content is different from that of the asynchronous version.

*[] means the field can be changed by the synch handler.

files.file.comment.create.pended
Post-commit
pending
Asynch
actor
Item: Comment
Content: Comment
CorrelationData: File
relatedCommunity (CF)
TargetPeople: {creator, last updater}

@lastUpdater.externalId

ModerationData.comment: Reason set by the synch handler
* No need to set moderationState, as the event type stands for it.

* Item's htmlURL is null, atomURL is for moderator only.

files.file.comment.create.approved
Post-commit
approve
Asynch
actor
Item: Comment
Content: Comment
CorrelationData: File
relatedCommunity (CF)
TargetPeople: {creator, last updater}

@lastUpdater.externalId

ModerationData.comment: Reason set by the synch handler or via API

* Indicate approval of creating a comment.

* A files.comment.created event is also sent with this one.

* Item's htmlURL and atomURL are for normal user.

* Used by the create/update operation.

files.file.comment.create.rejected
Post-commit
reject
Asynch
actor
Item: Comment
Content: Comment
CorrelationData: File
relatedCommunity (CF)
TargetPeople: {creator, last updater}

@lastUpdater.externalId

ModerationData.comment: Reason set by the synch handler or via API

* Indicate rejection of creating a comment.

* Item's htmlURL is null, atomURL is for moderator only.

files.file.comment.updated
Pre-commit
update
Synch
actor
[content: Comment]
contentType: Text

ModerationData.actorRole: User's library role
ModeratonData.globalModerator
[ModerationData.moderationState]
* The content is different from that of the asynchronous version.
files.file.comment.update.pended
Post-commit
pending
Asynch
actor
Item: Comment
Content: Comment
CorrelationData: File
relatedCommunity (CF)
TargetPeople: {creator, last updater}

@lastUpdater.externalId

ModerationData.comment: Reason set by the synch handler

* Item's htmlURL is null, atomURL is for moderator only.
files.file.comment.update.approved
Post-commit
approve
Asynch
actor
Item: Comment
Content: Comment
CorrelationData: File
relatedCommunity (CF)
TargetPeople: {creator, last updater}

@lastUpdater.externalId

ModerationData.comment: Reason set by the synch handler or via API

* Indicate approval of updating a comment.

* A files.comment.updated event is also sent with this one.

* Item's htmlURL and atomURL are for normal user.

files.file.comment.update.rejected
Post-commit
reject
Asynch
actor
Item: Comment
Content: Comment
CorrelationData: File
relatedCommunity (CF)
TargetPeople: {creator, last updater}

@lastUpdater.externalId

ModerationData.comment: Reason set by the sync handler or via API

* Indicate rejection of updating a comment.

* Item's htmlURL is null, atomURL is for moderator only.

files.file.created
Pre-commit
create
Synch
actor
[content: Media summary]
contentType: Text
relativeFilePath:

[@label]

ModerationData.actorRole: User's library role
ModerationData.globalModerator
[ModerationData.moderationState]
* The content is different from that of the asynchronous version.

* Label today dictates the title/label for the file; they cannot be set independently.

files.file.create.pended
Post-commit
pending
Asynch
actor
Item: File
Content: Media summary
relativeFilePath:
relatedCommunity (CF)
TargetPeople: {creator, last updater}

@lastUpdater.externalId

ModerationData.comment: Reason set by the synch handler

* Item's htmlURL is null, atomURL is for moderator only.

* Events of all the associated resources are not sent. When the file is approved, events of all the associated resources are sent with file's create event and approve event.

files.file.create.approved
Post-commit
approve
Asynch
actor
Item: File
Content: Media summary
relatedCommunity (CF)
TargetPeople: {creator, last updater}

@lastUpdater.externalId

ModerationData.comment: Reason set by the synch handler or via API

* Indicate approval of creating a file.

* A files.file.created event is also sent.

* Item's htmlURL and atomURL are for normal users.

files.file.create.rejected
Post-commit
reject
Asynch
actor
Item: File
Content: Media summary
relatedCommunity (CF)
TargetPeople: {creator, last updater}

@lastUpdater.externalId

ModerationData.comment: Reason set by the synch handler or via API

* Indicate rejection of creating a file.

* Item's htmlURL is null, atomURL is for moderator only.

files.file.updated
Pre-commit
update
Synch
actor
[content: Revision summary]
contentType: Text
relativeFilePath:

@content.changed:true/false
[@label]

ModerationData.actorRole: User's library role
ModerationData.globalModerator
[ModerationData.moderationState]
* Need to add changeType to files.file.updated event.

* content.changed property is not set if only metadata changes.

* The content is different from that of the asynchronous version.

* Label today indicates the title/label pair; they cannot be set independently.

files.file.update.pended
Post-commit
pending
Asynch
actor
Item: File
Content: Revision summary
relativeFilePath:
relatedCommunity (CF)
TargetPeople: {creator, last updater}

@lastUpdater.externalId
@content.changed:true/false

ModerationData.comment: Reason set by the synch handler
* Item's htmlURL is null, atomURL is for moderator only.

* content.changed property is not set if only metadata changes.

* When a file is edited and pended automatically, events of all the associated resources are sent.

files.file.update.approved
Post-commit
approve
Asynch
actor
Item: File
Content: Media summary
relatedCommunity (CF)
TargetPeople: {creator, last updater}

@lastUpdater.externalId

ModerationData.comment: Reason set by the synch handler or via API
* Indicate approval of updating a file.

* A files.file.updated event is also sent.

* Item's htmlURL and atomURL are for normal users.

files.file.update.rejected
Post-commit
reject
Asynch
actor
Item: File
Content: Media summary
relatedCommunity (CF)
TargetPeople: {creator, last updater}

@lastUpdater.externalId

ModerationData.comment: Reason set by the synch handler or via API
* Indicate rejection of updating a file.

* Item's htmlURL is null, atomURL is for moderator only.


Post-Moderation
LCEvent
Invocation Point
Event Type
Synch vs. Asynch
Event Fields
Comment
files.file.comment.flagged
Post-commit
flag
Asynch
actor
Item: Comment
CorrelationData: File
relatedCommunity (CF)
TargetPeople: {creator, last updater}

@lastUpdater.externalId

ModerationData.comment: Reason set via API

* Item's htmlURL is null, atomURL is for moderator only.
files.file.comment.quarantined
Post-commit
quarantine
Asynch
actor:
Item: Comment
CorrelationData: File
relatedCommunity (CF)
TargetPeople: {creator, last updater}

@lastUpdater.externalId

ModerationData.comment: Reason set via API
* Item's htmlURL is null, atomURL is for moderator only.
files.file.comment.dismissed
Post-commit
dismiss
Asynch
actor:
Item: Comment
CorrelationData: File
relatedCommunity (CF)
TargetPeople: {creator, last updater}

@lastUpdater.externalId

ModerationData.comment: Reason set via API
* Item's htmlURL and atomURL are for normal users.

* To be sent when flags are removed.

files.file.comment.restored
Post-commit
restore
Asynch
actor:
Item: Comment
CorrelationData: File
relatedCommunity (CF)
TargetPeople: {creator, last updater}

@lastUpdater.externalId

ModerationData.comment: Reason set via API

* Item's htmlURL and atomURL are for normal users.

* To be sent when comment is changed from quarantined to active state.

files.file.flagged
Post-commit
flag
Asynch
actor:
Item: File
relatedCommunity (CF)
TargetPeople: {creator, last updater}

@lastUpdater.externalId

ModerationData.comment: Reason set via API
* Item's htmlURL is null, atomURL is for moderator only.
files.file.quarantined
Post-commit
quarantine
Asynch
actor:
Item: File
relatedCommunity (CF)

ModerationData.comment: Reason set via API
* Item's htmlURL is null, atomURL is for moderator only.
files.file.dismissed
Post-commit
dismiss
Asynch
actor:
Item: File
relatedCommunity (CF)
moderation-comment:
TargetPeople: {creator, last updater}

@lastUpdater.externalId
* Item's htmlURL and atomURL are for normal users.

* To be sent when flags are removed.

files.file.restored
Post-commit
restore
Asynch
actor:
Item: File
relatedCommunity (CF)
moderation-comment:
TargetPeople: {creator, last updater}

@lastUpdater.externalId
* Item's htmlURL and atomURL are for normal users.

* To be sent when flags are removed.