Notifications API - Revision history

Sinisakrisan: /* Adding Language String and Use Params */

2013-10-26T12:01:54Z

‎Adding Language String and Use Params

2013-10-26T12:01:33Z

‎Adding Language String and Use Params

2013-10-26T11:55:23Z

‎What About Custom Params

2013-10-26T11:53:18Z

‎Putting Your Own Params Into Practice

2013-10-26T11:49:55Z

‎Putting Your Own Params Into Practice

2013-10-26T11:45:58Z

‎What About Custom Params

2013-10-26T11:36:06Z

‎What About Custom Params

2013-10-26T11:34:03Z

‎What About Custom Params

2013-10-26T11:33:28Z

‎Using Params

2013-10-26T11:32:06Z

‎Adding Language String and Use Params

@@ Line 124: / Line 124: @@
 # '''{url}''' - Is not mandatory, but you should always have it in your notification. It is the main url where action that we are notified about happened.
 Similarly, you can define '
-* ''{target}''' - if you need it
+* '''{target}''' - if you need it
 * '''{target_url}''' if you need it in your notification.
 * '''(title)''' - Commonly used to refer to an object that generated notification. Example: "User X posted new photo in '''Album Y'''." Album Y is title here

@@ Line 123: / Line 123: @@
 # '''{actor_url}''' - Gives the <a href=""> attribute to the {actor}
 # '''{url}''' - Is not mandatory, but you should always have it in your notification. It is the main url where action that we are notified about happened.
-Similarly, you can define '''{target}''' and '''{target_url}''' if you need it in your notification.
+Similarly, you can define '
 ==See Also==
 * [[Integrating Your Component]]
 * [[Stream API v2]]

@@ Line 124: / Line 124: @@
 # '''{url}''' - Is not mandatory, but you should always have it in your notification. It is the main url where action that we are notified about happened.
 Similarly, you can define '''{target}''' and '''{target_url}''' if you need it in your notification.
 ==See Also==
 * [[Integrating Your Component]]
 * [[Stream API v2]]

@@ Line 152: / Line 152: @@
 # '''custom''' - which have text string set as its value, but you can really set anything
 # '''custom_url''' - which points to Yahoo site
 :::[[File:Finalnotification.png]]

@@ Line 143: / Line 143: @@
 $params->set('actor_url', 'index.php?option=com_community&view=profile&userid=' . $actor->id); // Link for the {actor} tag
 $params->set('url', $link); //url of the whole activity. Used when hovering over avatar in notification window. Can be used as {url} tag in outgoing emails too. Make sure that you have defined $link variable :)
-$params->set('custom', 'This is my custom param');
+$params->set('custom', 'Yahoo!');
 $params->set('custom_url', $customLink);
 CNotificationLibrary::add( 'system_messaging' , $actor->id , '965' , JText::sprintf('PLG_COMMUNITY_EXAMPLE_SUBJECT') , JText::sprintf('PLG_COMMUNITY_EXAMPLE_BODY') , '' , $params );
@@ Line 149: / Line 149: @@
 <br />
 Whats changed?<br/>
-There are two new params
+There are two new params and one new $customLink variable
 # '''custom''' - which have text string set as its value, but you can really set anything
 # '''custom_url''' - which points to Yahoo site

@@ Line 126: / Line 126: @@
 ===What About Custom Params===
-If you go back to [[Notifications_API#Custom_Notification_Parameters|this section]] you will notice that is named '''Custom Notification Parameters''' and further it explains how to use them
+If you go back to [[Notifications_API#Custom_Notification_Parameters|this section]] you will notice that is named '''Custom Notification Parameters''' and further it explains how to use them<br/>
 :::[[File:Finalnotification.png]]

← Older revision		Revision as of 11:36, 26 October 2013
Line 126:		Line 126:

	===What About Custom Params===		===What About Custom Params===
−	If you go back to	+	If you go back to [[Notifications_API#Custom_Notification_Parameters\|this section]] you will notice that is named '''Custom Notification Parameters''' and further it explains how to use them

@@ Line 76: / Line 76: @@
 This is much cleaner and easier to follow while basically doing absolutely same thing as a code shown above.
-==Using Params==
+==Custom Notification Parameters==
 A notification API can be extended with any param you would like to add.<br/>
 These params can be passed to either email template, notification, and of course, language file.<br/>

← Older revision		Revision as of 11:32, 26 October 2013
Line 115:		Line 115:
	Lets see what happens in the email queue		Lets see what happens in the email queue
	:::[[File:Mailqueue.png]]		:::[[File:Mailqueue.png]]
		+	And finally, the actual email that is sent to end user
		+	:::[[File:Email.png]]

		+	'''Success''' <br/>
		+	Till now, we created three (3) parameters that are successfully used in notification window, and emails.<br/>
		+	# '''(actor)''' - Returns the username of the user which carries the action
		+	# '''{actor_url}''' - Gives the <a href=""> attribute to the {actor}
		+	# '''{url}''' - Is not mandatory, but you should always have it in your notification. It is the main url where action that we are notified about happened.
		+	Similarly, you can define '''{target}''' and '''{target_url}''' if you need it in your notification.
		+
		+	===What About Custom Params===