Instant Messaging Plugin Template - Revision history

Mcefan at 02:32, 20 October 2012

2012-10-20T02:32:38Z

←Older revision		Revision as of 02:32, 20 October 2012
Line 1:		Line 1:
			[[Category:software]]

	Opening the web admin, and going to Advanced > Configuration > Device Templates, We pick my manufacturer, LOCALE\|Concept, and pick the Pluto General Plugins category, and click Add Device Template.		Opening the web admin, and going to Advanced > Configuration > Device Templates, We pick my manufacturer, LOCALE\|Concept, and pick the Pluto General Plugins category, and click Add Device Template.

			{{p}}

	== Adding our Command Group - Instant Messaging Commands ==		== Adding our Command Group - Instant Messaging Commands ==
Line 26:		Line 30:

	[[Image:Instant_Messaging_commandgroupadded.jpg\|The Command Group is now added]]		[[Image:Instant_Messaging_commandgroupadded.jpg\|The Command Group is now added]]

			{{p}}

	== Adding Commands to the Command Group ==		== Adding Commands to the Command Group ==
Line 37:		Line 43:

	'''You may have noticed that both of these commands were specified in the [[Instant Messaging in LinuxMCE]] page for both the Plugin and players. They are indeed defined in both, however the scope of both are different. Whereas with the plugin, it affects all accounts of a specific user, with each device, it only affects a given transport for a given user. So even though that a given command will be used in two different groups, they differ in scope, and thus the code for them is different. Typically, the orbiter will interact with the Plugin, and the Plugin will send the necessary commands to the individual devices.'''		'''You may have noticed that both of these commands were specified in the [[Instant Messaging in LinuxMCE]] page for both the Plugin and players. They are indeed defined in both, however the scope of both are different. Whereas with the plugin, it affects all accounts of a specific user, with each device, it only affects a given transport for a given user. So even though that a given command will be used in two different groups, they differ in scope, and thus the code for them is different. Typically, the orbiter will interact with the Plugin, and the Plugin will send the necessary commands to the individual devices.'''
			{{p}}

	=== Send Instant Message ===		=== Send Instant Message ===
Line 55:		Line 62:

	Saving this parameter, This command is now complete.		Saving this parameter, This command is now complete.
			{{p}}

	=== Set Presence ===		=== Set Presence ===
Line 68:		Line 76:

	And with this, the first pass of the Instant Messaging Plugin is now complete.		And with this, the first pass of the Instant Messaging Plugin is now complete.

			{{p}}

	== A Note About events ==		== A Note About events ==
Line 76:		Line 86:

	-Thom		-Thom
	~~[[Category: Tutorials]]~~

Itsmeok at 11:36, 22 January 2009

2009-01-22T11:36:39Z

←Older revision		Revision as of 11:36, 22 January 2009
Line 76:		Line 76:

	-Thom		-Thom
			[[Category: Tutorials]]

Tschak909: Adding content for the Instant Messaging Plugin Template, the rest of it.

2008-09-22T02:16:11Z

Adding content for the Instant Messaging Plugin Template, the rest of it.

@@ Line 1: / Line 1: @@
 Opening the web admin, and going to Advanced > Configuration > Device Templates, We pick my manufacturer, LOCALE|Concept, and pick the Pluto General Plugins category, and click Add Device Template.
 After this is done, I specify that this is a device that will be implemented by C++ code.
@@ Line 24: / Line 26: @@
 [[Image:Instant_Messaging_commandgroupadded.jpg|The Command Group is now added]]

Tschak909: Added command group mojo.

2008-09-22T00:01:34Z

Added command group mojo.

←Older revision		Revision as of 00:01, 22 September 2008
Line 14:		Line 14:

	Scrolling down, notice there is a link for Create Command Group, this needs to be clicked, as the above three command groups do not contain relevant commands that we want to implement in our template.		Scrolling down, notice there is a link for Create Command Group, this needs to be clicked, as the above three command groups do not contain relevant commands that we want to implement in our template.

			[[Image:Instant_Messaging_commandgroup.jpg\|A New command group for the IM Template]]

			Notice here the Category drop down. All this signifies is where this command group will be automatically presented as a possible group of commands to add to a particular device. I have selected the '''Pluto General Plugins''' device so that any device that is in this category AND its descendents will see this command group added. This is used by various system parts too to do intelligent database queries to see which plugins to iterate over, etc. I could have just as easily made a new category here.. and I may in the future, but I didn't this time around.. so.. I select, enter a meaningful name for this group of commands, and go back.

			'''A command group, to reiterate, is nothing more than a group of commands together. It allows you to quickly define groups of common commands that a device may implement.'''

			Once this is done. Take a look at the resulting difference in the command group checkboxes. Our command group is now here, but for now, it's empty.

			[[Image:Instant_Messaging_commandgroupadded.jpg\|The Command Group is now added]]

Tschak909: Initial content for the Instant Messaging Plugin template.

2008-09-21T23:40:23Z

Initial content for the Instant Messaging Plugin template.

New page

Opening the web admin, and going to Advanced > Configuration > Device Templates, We pick my manufacturer, LOCALE|Concept, and pick the Pluto General Plugins category, and click Add Device Template.

After this is done, I specify that this is a device that will be implemented by C++ code.

That fills in the blanks, and brings up the following display, of which, the following screen snippet is most relevant:

[[Image:Instant_Messaging_Template.jpg|The Instant Messaging Template]]

Note that I have checked the "Is a Plugin" and once I did this, it automatically added a Controlled by Category:DCERouter entry. This happens the moment that you check this box, and goes away when you uncheck it. There is no need to manually add it.

Also note that the Implements DCE box is checked, and there is nothing in the command line box. If this is checked, and there is nothing in the command line box, the system assumes that the DCE Device command name is the same as the name of the plugin, with any spaces substituted by underscores. (_)

I hit save at this point, to get the device template into the system, but I now need to define the commands that this plugin will need.

Scrolling down, notice there is a link for Create Command Group, this needs to be clicked, as the above three command groups do not contain relevant commands that we want to implement in our template.