Stripping CVS keywords
[project/privatemsg.git] / privatemsg_service / README.txt
1
2 Privatemsg Service
3 ------------------
4 Integrates Privatemsg functionality with the services module.
5 http://drupal.org/node/433780
6
7
8
9 Requirements
10 ------------
11 Drupal 6
12 PrivateMSG Module
13 Services Module (Privatemsg Services module is currently developed against Services 6.x-2.3)
14
15
16
17 Installation
18 ------------
19 Enable Privatemsg Service in the "Site building -> Modules" administration screen.
20
21
22
23 Services
24 --------
25 See the Services browser (admin/build/services) for details regarding the services provided by this module. Here's a brief overview:
26
27 privatemsg.get
28 Returns all messages for the current user. Defaults to just loading the message previews. This is the equivalent of loading the inbox of a user
29
30 privatemsg.unreadCount
31 Returns the number of unread messages for a user. Defaults to the current user.
32
33 privatemsg.send
34 Sends a new message from the current user.
35
36 privatemsg.reply
37 Allows the current user to reply to a message.
38
39 privatemsg.getThread
40 Gets all messages in a thread.
41
42
43
44 Privatemsg Service Variables
45 ----------------------------
46 The Privatemsg Service module currently uses three variables that define what user fields are included in the service reply. By default, Privatemsg often times returns the full user object. Since not all the fields are included (for example the user's email address), these fields can be configured by setting an array of fields. By default, Privatemsg Services returns the user id (uid) and the username.
47
48 privatemsg_service_participant_fields
49 Enhances the fields returned by the message previews in the privatemsg.get service (by default, Privatemsg only returns the uid).
50
51 privatemsg_service_thread_author_fields
52 Limits the fields of a thread author in the privatemsg.getThread service (by default, Privatemsg returns the full user object).
53
54 privatemsg_service_message_author_fields
55 Limits the fields of the message authors (for every message) in the privatemsg.getThread service (by default, Privatemsg returns the full user object for each message author).
56
57
58
59 Hooks
60 -----
61 hook_privatemsg_service_enhance_message($message)
62 Allows other modules to "enhance" the messages in a thread with additional data. Currently only implemented for the privatemsg.getThread service.
63 Each module needs to return a key and a value for every message. Here's the default hook implementation:
64 function hook_privatemsg_service_enhance_message($message) {
65   $enhancement = array(
66     'key' => 'test',
67     'value' => time(),
68   );
69   return array($enhancement);
70 }
71
72
73
74 Credits
75 -------
76 Refactored by Daniel Hanold, (haagendazs) http://drupal.org/user/339733
77 Original code by tayzlor, http://drupal.org/user/274980