Changes between Version 13 and Version 14 of Plugin_Hooks

Timestamp:

May 1, 2009 3:04:59 PM (4 years ago)

Author:

thomasb

Comment:

--

Plugin_Hooks

@@ -78 +78 @@
   * user_name
   * user_email
+  * alias
 
 
@@ -235 +236 @@
 
 
+=== create_contact ===
+
+Triggered when an address book record is saved.[[BR]]
+A plugin can prevent the contact to be created by setting the {{{abort}}} field to true. The user is then rejected back to the input form.
+
+''Arguments:''
+  * record: ''Hash array with record fields''
+  * source: ''Address book identifier''
+
+''Return values:''
+  * record
+  * abort
+
+
+=== save_contact ===
+
+Triggered when an address book record is saved.[[BR]]
+As in the ''create_contact'' hook this action can be aborted by setting the {{{abort}}} field to true.
+
+''Arguments:''
+  * id
+  * record: ''Hash array with record fields''
+  * source: ''Address book identifier''
+
+''Return values:''
+  * record
+  * abort
+
+
+=== delete_contact ===
+
+Triggered when an address book record is to be deleted.[[BR]]
+To abort the deletion a plugin can set the {{{abort}}} field to true.
+
+''Arguments:''
+  * id
+  * source: ''Address book identifier''
+
+''Return values:''
+  * abort
+
+
+
 
 ----
@@ -276 +320 @@
 
 
+=== create_identity ===
+
+Triggered when a user attempts to create a new sender identity.[[BR]]
+A plugin can prevent the record to be created by setting the {{{abort}}} field to true. The user is then rejected back to the input form.
+
+''Arguments:''
+  * record: ''Hash array with identity record fields''
+
+''Return values:''
+  * record
+  * abort
+
+
+=== save_identity ===
+
+Triggered when a user changes one of his sender identities.[[BR]]
+As in the ''create_identity'' hook this action can be aborted by setting the {{{abort}}} field to true.
+
+''Arguments:''
+  * id
+  * record: ''Hash array with identity record fields''
+
+''Return values:''
+  * record
+  * abort
+
+
+=== delete_identity ===
+
+Triggered when a sender identity is to be deleted.[[BR]]
+To abort the deletion a plugin can set the {{{abort}}} field to true.
+
+''Arguments:''
+  * id
+
+''Return values:''
+  * abort
+
+
 ----