1: <?php
2: /**
3: * Maniaplanet Web Services SDK for PHP
4: *
5: * @see http://code.google.com/p/maniaplanet-ws-sdk/
6: * @copyright Copyright (c) 2009-2011 NADEO (http://www.nadeo.com)
7: * @license http://www.gnu.org/licenses/lgpl.html LGPL License 3
8: * @author $Author: melot.philippe $:
9: * @version $Revision: 136 $:
10: * @date $Date: 2012-08-03 10:30:14 +0200 (ven., 03 août 2012) $:
11: */
12:
13: namespace Maniaplanet\WebServices\ManiaHome;
14:
15: /**
16: * Container object to send notifications to ManiaHome
17: */
18: class Notification
19: {
20:
21: /**
22: * Manialink that sends the notification. You don't need to set that as
23: * the ManiaHome class will automatically set it for you when you send a
24: * notification.
25: * @var string
26: */
27: public $senderName;
28:
29: /**
30: * The receiver of the notification. It can either be a Maniaplanet login or
31: * null.
32: * @var string
33: */
34: public $receiverName;
35:
36: /**
37: * The message itself. If you send a public notification to a player, the
38: * message will be prepended with its nickname. Max length is 255 chars, you
39: * can use Maniaplanet special chars.
40: * @var string
41: */
42: public $message;
43:
44: /**
45: * (optional)
46: * Link when the player clicks on the notification. Has to be a Manialink,
47: * not a Web URL.
48: * @var string
49: */
50: public $link;
51:
52: /**
53: * (optional)
54: * Whether the Notification is private or not.
55: * @var boolean
56: */
57: public $isPrivate;
58:
59: /**
60: * (optional)
61: * Icon style (from the Manialink styles)
62: * @var string
63: */
64: public $iconStyle;
65:
66: /**
67: * (optional)
68: * Icon substyle (from the Manialink styles)
69: * @var string
70: */
71: public $iconSubStyle;
72:
73: /**
74: * (optional)
75: * String used to group notifications. You shouldn't need to use that
76: * @var string
77: */
78: public $group;
79:
80: /**
81: * (optional)
82: * Integer used to group notifications. You shouldn't need to use that
83: * @var integer
84: */
85: public $priority;
86:
87: }
88:
89: ?>