Invocation sample

nicklas · ‎02-01-2009

Hi,

As someone asks me an Invokation sample, I share my code

bar-descriptor.xml :
====================

<your prefix> : com.domain.application.openhandler

<qnx>
      <!-- Invokation framework -->
      <invoke-target id="<your prefix>.openhandler">
      <type>APPLICATION</type>
         <filter>
            <action>bb.action.OPEN</action>
            <mime-type>*</mime-type>
            <property var="uris" value="file://"/>
         </filter>
      </invoke-target>
</qnx>

In this sample, my application can be called to OPEN any (mime-type = *) local (uris = file://) file in a new windows (APPLICATION)

Of course, you can change the filter, declare several invoke target.

And your C++ code :
===================

In your main class constructor :

MyApp:MyApp(Application &app, 
		QTranslator &translator, QString &currentLocale) {
  // Invocation framework init
  initInvokationReceiving();
}


void MyApp::initInvokationReceiving(void) {
  InvokeManager *iManager = new InvokeManager(this);

  QObject::connect(iManager, 
	SIGNAL(invoked(const bb::system::InvokeRequest&)),
	this, 
	SLOT(onHandleInvoke(const bb::system::InvokeRequest&)));

  switch (iManager->startupMode()) {
  case ApplicationStartupMode::LaunchApplication:
    // Launched from homescreen
    break;
  case ApplicationStartupMode::InvokeApplication:
  case ApplicationStartupMode::InvokeViewer:
  case ApplicationStartupMode::InvokeCard:
    // Invocation. Anticipate a call to handleInvoke() slot
    break;

  default:
    break;
  }
}

void MyApp::onHandleInvoke(const InvokeRequest& request) {
  // If the client is also a target
  // QString source = request.source();
  // If it is a bound invocation
  QString target = request.target();
  // The action to be performed
  QString action = request.action();
  // Content type of the data
  QString mime = request.mimeType();
  // Location of data – out of band
  QString uri = request.uri().toString();
  // In-band data
  QString data = QString(request.data());
  
  // qDebug() << "source: " << source;
  qDebug() << "target: " << target;
  qDebug() << "action: " << action;
  qDebug() << "mime:   " << mime;
  qDebug() << "uri:    " << uri;
  qDebug() << "data&colon;   " << data;
}

initInvokationReceiving permits to change your init behavior in function your startup mode. Sample, if your start-up mode is "Card", you don't create an application menu.

At last, in init, I register my callback SLOT to read the params sent by the application caller.

In onHandleInvoke, I read all params.

When your app is called from an other app, OS10 call your main constructor, then the onHandleInvoke will be called.

Nicolas

senimii · ‎04-27-2012

connect(m_invokeManager, SIGNAL(invoked(const bb::system::InvokeRequest&)), this, SLOT(handleInvoke(const bb::system::InvokeRequest&)));

// Initialize properties with default values
switch (m_invokeManager->startupMode()) {
case ApplicationStartupMode::LaunchApplication:
m_startupMode = tr("Launch");
break;
case ApplicationStartupMode::InvokeApplication:
m_startupMode = tr("Invoke");
break;
case ApplicationStartupMode::InvokeCard:
m_startupMode = tr("Card");
break;
}

What is the difference between using the handleInvoke and onHandleInvoke?

NFC on my mind!!

jtegen · ‎10-27-2010

It's just the name of the target method. You can have any name you like. "on" and "do" are prefix conventions from various development platforms that have no significant meaning other than it reinforces what is being done by the method. No different than having an prefix on the variables (e.g. m_) to reinforce the meaning of the variable. Not needed, just a convention left over from older development environments where the variable name enforced the variable type.

o2 interactive | FaceBook | Blog | Twitter