backup module API ( require “backup” )

subscribe(script_name[, events_filter])

Edit

Subscribe a script for backup events, optionally specifying event filter rules. After subscribing the script will be launched for each event happens on a backup service and information about this event will be passed as a parameter.

Edit

backup.subscribe()

Edit

script name (string), events_filter (table)

Edit

subscriber_id (string).

Edit

				
					require "backup"

backup.subscribe( "HUB:my_plugin/scripts/events_handling" )

set_subscription_filters(subscriber_id, filter_rules)

Edit

Change events filter rules for a subscription subscriber_id. (set_subscription_filters)

Edit

subscriber_id: string
filter_rules: table (array)

Edit

				
					require "backup"

backup.subscribe("HUB:my_plugin/scripts/events_handling")
backup.set_subscription_filters("HUB:my_plugin/scripts/events_handling", { { event = "backup_creating_started" } } )

unsubscribe()

Edit

Unsubscribe a script from backup events.

Edit

backup.unsubscribe()

Edit

subscriber_id (string).

Edit

none.

Edit

				
					require "backup"

backup.unsubscribe( "HUB:my_plugin/scripts/events_handling" )