FileWatcher.Renamed
WebSocket event schema, payload, and examples
fullPath
string required
fileName
string required
oldFullPath
string
oldFileName
string
Schema
The JSON Schema for the event payload, if available.
schema.json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "FileRenamedEvent",
"type": "object",
"additionalProperties": false,
"required": [
"fullPath",
"fileName"
],
"properties": {
"fullPath": {
"type": "string"
},
"fileName": {
"type": "string"
},
"oldFullPath": {
"type": [
"null",
"string"
]
},
"oldFileName": {
"type": [
"null",
"string"
]
}
}
}
JSON Payload
An example JSON payload for the event, automatically generated using JSONSchemaFaker
example.json
{
"fileName": "veniam ut dolore eu",
"fullPath": "magna consequat dolor",
"oldFileName": "Excepteur dolor consequat",
"oldFullPath": null
}
Client Example
Example code showing how to subscribe to this event using the Streamer.bot WebSocket Client
index.js
// Initialize the Streamer.bot WebSocket Client
const client = new StreamerbotClient();
// Subscribe to "FileWatcher.Renamed" events and register a callback
client.on('FileWatcher.Renamed', ({ event, data }) => {
// Code here will run every time the event is received!
console.log('Received event:', event.source, event.type);
console.log('Event data:', data);
});