qthighway/xqservice/src/xqaiwdecl.h
changeset 19 46686fb6258c
parent 15 1f895d8a5b2b
child 24 9d760f716ca8
equal deleted inserted replaced
15:1f895d8a5b2b 19:46686fb6258c
    28 //
    28 //
    29 // All declations shall have XQ prefix
    29 // All declations shall have XQ prefix
    30 //
    30 //
    31 
    31 
    32 
    32 
    33 // Public service related constants
    33 //
       
    34 // Common Application Interworking declarations
       
    35 // ---------------------------------------------
       
    36 //
    34 
    37 
    35 /*!
    38 /*!
    36  File viewing interface and related operations
    39  File viewing interface and related operations
    37 */
    40 */
    38 #define XQI_FILE_VIEW QLatin1String("com.nokia.symbian.IFileView")
    41 #define XQI_FILE_VIEW QLatin1String("com.nokia.symbian.IFileView")
    44 */
    47 */
    45 #define XQI_URI_VIEW QLatin1String("com.nokia.symbian.IUriView")
    48 #define XQI_URI_VIEW QLatin1String("com.nokia.symbian.IUriView")
    46 #define XQOP_URI_VIEW QLatin1String("view(QString)")
    49 #define XQOP_URI_VIEW QLatin1String("view(QString)")
    47 
    50 
    48 /*!
    51 /*!
       
    52  File sharing interface and related operations
       
    53 */
       
    54 #define XQI_FILE_SHARE QLatin1String("com.nokia.symbian.IFileShare")
       
    55 #define XQOP_FILE_SHARE QLatin1String("send(QVariant)")
       
    56 
       
    57 /*!
       
    58  The scheme of the activity URI
       
    59 */
       
    60 #define XQURI_SCHEME_ACTIVITY QLatin1String("appto")
       
    61 /*!
       
    62  Activity key name in query part of the activity URI
       
    63 */
       
    64 #define XQURI_KEY_ACTIVITY_NAME QLatin1String("activityname")
       
    65 
       
    66 /*!
       
    67  Miscellaneous needed URI schemes
       
    68 */
       
    69 #define XQURI_SCHEME_HTTP QLatin1String("http")
       
    70 #define XQURI_SCHEME_HTTPS QLatin1String("https")
       
    71 #define XQURI_SCHEME_MAILTO QLatin1String("mailto")
       
    72 #define XQURI_SCHEME_FILE QLatin1String("file")
       
    73 
       
    74 
       
    75 /*!
       
    76  Service XML custom property, which contains the name of text resource file that
       
    77  contains the CUSTOM_PROP_AIW_TEXT.
       
    78  \see XQAiwRequest::createAction()
       
    79 */
       
    80 #define XQCUSTOM_PROP_AIW_TEXT_FILE QLatin1String("aiw_action_text_file")
       
    81 
       
    82 /*!
       
    83  Service XML custom property, that contains the Text Id within the
       
    84  CUSTOM_PROP_AIW_TEXT_FILE.  The localized text is attached to
       
    85  to QAction returned by the XQAiwRequest::createAction()
       
    86 */
       
    87 #define XQCUSTOM_PROP_AIW_TEXT QLatin1String("aiw_action_text")
       
    88 
       
    89 /*!
       
    90  Service XML custom property, that contains the name of the icon to be attached
       
    91  to QAction returned by the XQAiwRequest::createAction()
       
    92 */
       
    93 #define XQCUSTOM_PROP_AIW_ICON QLatin1String("aiw_action_icon")
       
    94 
       
    95 /*!
       
    96  Service XML custom property, that contains schemes the XQI_URI_VIEW can handle
       
    97 */
       
    98 #define XQCUSTOM_PROP_SCHEMES QLatin1String("schemes")
       
    99 
       
   100 /*!
       
   101  Service XML custom property, which contains the name of text key that
       
   102  contains the service status
       
   103  \see XQApplicationMgr::isEnabled()
       
   104 */
       
   105 #define XQCUSTOM_PROP_AIW_SERVICE_STATUS QLatin1String("aiw_status")
       
   106 
       
   107 /*!
       
   108  A key name for XQRequestInfo object to pass a window title
       
   109  to be shown in service application instead of the default title.
       
   110  Service application is responsible to handle the key value.
       
   111  \see XQApplicationMgr::XQRequestInfo::setInfo()
       
   112 */
       
   113 #define XQINFO_KEY_WINDOW_TITLE QLatin1String("WindowTitle")
       
   114 
       
   115 
       
   116 //
       
   117 // Media related Application Interworking declarations
       
   118 // ---------------------------------------------------
       
   119 //
       
   120 
       
   121 /*!
    49  Image fetching interface and related operations
   122  Image fetching interface and related operations
    50 */
   123 */
    51 #define XQI_IMAGE_FETCH QLatin1String("com.nokia.symbian.IImageFetch")
   124 #define XQI_IMAGE_FETCH QLatin1String("com.nokia.symbian.IImageFetch")
    52 #define XQOP_IMAGE_FETCH QLatin1String("fetch()")
   125 #define XQOP_IMAGE_FETCH QLatin1String("fetch()")
    53 
   126 
    70 #define XQOP_VIDEO_FETCH QLatin1String("fetch()")
   143 #define XQOP_VIDEO_FETCH QLatin1String("fetch()")
    71 
   144 
    72 /*!
   145 /*!
    73  Video collection browser interface and related operations
   146  Video collection browser interface and related operations
    74 */
   147 */
       
   148 namespace XQService
       
   149 {
       
   150     enum VideoBrowseSortKey
       
   151     {
       
   152         SortUndefined = 0,
       
   153         SortDateTime  = 1,
       
   154         SortTitle     = 2,
       
   155         SortSize      = 3
       
   156     };
       
   157 }
    75 #define XQI_VIDEO_BROWSE QLatin1String("com.nokia.symbian.IVideoBrowse")
   158 #define XQI_VIDEO_BROWSE QLatin1String("com.nokia.symbian.IVideoBrowse")
    76 #define XQOP_VIDEO_BROWSE QLatin1String("browseVideos(int, int)")
   159 #define XQOP_VIDEO_BROWSE QLatin1String("browseVideos(int, int)")
    77 
   160 
    78 /*!
   161 /*!
    79  Video player interface and related operations
   162  Video player interface and related operations
   100 #define XQCAMERA_QUALITY QLatin1String("Quality")
   183 #define XQCAMERA_QUALITY QLatin1String("Quality")
   101 #define XQCAMERA_MODE_SWITCH QLatin1String("AllowModeSwitch")
   184 #define XQCAMERA_MODE_SWITCH QLatin1String("AllowModeSwitch")
   102 #define XQCAMERA_INDEX_SWITCH QLatin1String("AllowCameraSwitch")
   185 #define XQCAMERA_INDEX_SWITCH QLatin1String("AllowCameraSwitch")
   103 #define XQCAMERA_QUALITY_CHANGE QLatin1String("AllowQualityChange")
   186 #define XQCAMERA_QUALITY_CHANGE QLatin1String("AllowQualityChange")
   104 
   187 
       
   188 
       
   189 //
       
   190 // Logs related Application Interworking declarations
       
   191 // ---------------------------------------------------
       
   192 //
       
   193 
       
   194 /*!
       
   195   Logs view interface and related operations constants
       
   196   Operation: XQOP_LOGS_SHOW   (show(QVariantMap))
       
   197     parameters: 
       
   198       XQLOGS_VIEW_INDEX: enum LogsViewIndex: 0 - all recent, 1 - received, 2 - called, 3 - missed
       
   199       XQLOGS_SHOW_DIALPAD: bool
       
   200       XQLOGS_DIALPAD_TEXT: QString
       
   201 */
       
   202 namespace XQService
       
   203 {  
       
   204     enum LogsViewIndex
       
   205     {
       
   206         LogsViewAll = 0,
       
   207         LogsViewReceived,
       
   208         LogsViewCalled,
       
   209         LogsViewMissed
       
   210     };
       
   211 }
       
   212 #define XQI_LOGS_VIEW QLatin1String("com.nokia.symbian.ILogsView") 
       
   213 #define XQOP_LOGS_SHOW QLatin1String("show(QVariantMap)")
       
   214 #define XQLOGS_VIEW_INDEX QLatin1String("ViewIndex")
       
   215 #define XQLOGS_SHOW_DIALPAD QLatin1String("ShowDialpad")
       
   216 #define XQLOGS_DIALPAD_TEXT QLatin1String("DialpadText")
       
   217 
       
   218 //
       
   219 // Contacts related Application Interworking declarations
       
   220 // ------------------------------------------------------
       
   221 //
       
   222 
       
   223 /*!
       
   224   Contact editing interface.
       
   225  */
       
   226 #define XQI_CONTACTS_EDIT QLatin1String("com.nokia.symbian.IContactsEdit")
       
   227 
       
   228 /*!
       
   229  Launches editor for creating a new contact with a given detail.
       
   230     Parameter1: Indicates what type of contact field is supplied.
       
   231         One of the following values:
       
   232           QContactPhoneNumber::DefinitionName
       
   233           QContactEmailAddress::DefinitionName
       
   234           QContactOnlineAccount::DefinitionName
       
   235      (you need to include qcontactdetails.h)
       
   236     Parameter2: The actual detail value, for eg. "123456" 
       
   237  \return One of these constants defined in cntservicescontact.h:
       
   238          KCntServicesReturnValueContactSaved
       
   239          KCntServicesReturnValueContactDeleted
       
   240          KCntServicesReturnValueContactNotModified
       
   241  */
       
   242 #define XQOP_CONTACTS_EDIT_CREATE_NEW QLatin1String("editCreateNew(QString,QString)")
       
   243 
       
   244 /*!
       
   245  Launches editor for creating a new contact with a given detail.
       
   246  Becomes available in wk30.
       
   247     Parameter1: Indicates what type of contact field is supplied.
       
   248         One of the following values:
       
   249           QContactPhoneNumber::DefinitionName
       
   250           QContactEmailAddress::DefinitionName
       
   251           QContactOnlineAccount::DefinitionName
       
   252       (you need to include qcontactdetails.h)
       
   253     Parameter2: The actual detail value, for eg. "123456"
       
   254     Parameter3: sub type, for eg. QContactPhoneNumber::SubTypeMobile
       
   255  \return One of these constants defined in cntservicescontact.h:
       
   256          KCntServicesReturnValueContactSaved
       
   257          KCntServicesReturnValueContactDeleted
       
   258          KCntServicesReturnValueContactNotModified
       
   259  */
       
   260 #define XQOP_CONTACTS_EDIT_CREATE_NEW_WITH_SUBTYPE QLatin1String("editCreateNew(QString,QString,QString)")
       
   261 
       
   262 /*!
       
   263  Launches editor for creating a new contact based on vCard  indicated in arg.
       
   264  The user is able to edit and save the contact. 
       
   265  Parameter1: vCard file name including the full path.
       
   266  \return One of these constants defined in cntservicescontact.h:
       
   267          KCntServicesReturnValueContactSaved
       
   268          KCntServicesReturnValueContactDeleted
       
   269          KCntServicesReturnValueContactNotModified
       
   270  */
       
   271 #define XQOP_CONTACTS_EDIT_CREATE_NEW_VCARD QLatin1String("editCreateNewFromVCard(QString)")
       
   272 
       
   273 /*!
       
   274  Launch editor for existing contact that is specified with contact ID. 
       
   275  Only the default backend storage is supported.
       
   276 Parameter1: Contact ID.
       
   277  \return One of these constants defined in cntservicescontact.h:
       
   278          KCntServicesReturnValueContactSaved
       
   279          KCntServicesReturnValueContactDeleted
       
   280          KCntServicesReturnValueContactNotModified
       
   281  */
       
   282 #define XQOP_CONTACTS_EDIT_EXISTING QLatin1String("editExisting(int)")
       
   283 
       
   284 /*!
       
   285  Launch editor for updating an existing contact with a given detail.
       
   286  A contact fetch view is opened first, where the user can choose which contact
       
   287  to update. 
       
   288     Parameter1: Indicates what type of contact field is supplied.
       
   289         One of the following values:
       
   290           QContactPhoneNumber::DefinitionName
       
   291           QContactEmailAddress::DefinitionName
       
   292           QContactOnlineAccount::DefinitionName
       
   293       (you need to include qcontactdetails.h)
       
   294     Parameter2: The actual detail value, for eg. "123456"
       
   295  \return One of these constants defined in cntservicescontact.h:
       
   296          KCntServicesReturnValueContactSaved
       
   297          KCntServicesReturnValueContactDeleted
       
   298          KCntServicesReturnValueContactNotModified
       
   299  */
       
   300 #define XQOP_CONTACTS_EDIT_UPDATE_EXISTING QLatin1String("editUpdateExisting(QString,QString)")
       
   301 
       
   302 
       
   303 /*!
       
   304  Launch editor for updating an existing contact with a given detail.
       
   305  Becomes available in wk30.
       
   306  A contact fetch view is opened first, where the user can choose which contact
       
   307  to update. 
       
   308     Parameter1: Indicates what type of contact field is supplied.
       
   309         One of the following values:
       
   310           QContactPhoneNumber::DefinitionName
       
   311           QContactEmailAddress::DefinitionName
       
   312           QContactOnlineAccount::DefinitionName
       
   313       (you need to include qcontactdetails.h)
       
   314     Parameter2: The actual detail value, for eg. "123456"
       
   315  \return One of these constants defined in cntservicescontact.h:
       
   316          KCntServicesReturnValueContactSaved
       
   317          KCntServicesReturnValueContactDeleted
       
   318          KCntServicesReturnValueContactNotModified
       
   319  */
       
   320 #define XQOP_CONTACTS_EDIT_UPDATE_EXISTING_WITH_SUBTYPE QLatin1String("editUpdateExisting(QString,QString,QString)")
       
   321 
       
   322 /*!
       
   323  Contacts fetching interface.
       
   324  */
       
   325 #define XQI_CONTACTS_FETCH QLatin1String("com.nokia.symbian.IContactsFetch")
       
   326 
       
   327 /*!
       
   328  Fetch multiple contacts
       
   329  cntservicescontact.h has some constant definitions and a class for
       
   330  transforming the result.
       
   331  Parameter1: Title string.
       
   332  Parameter2: Action type string, from cntservicescontact.h 
       
   333  \return An object of type CntServicesContactList containing the contact ID.
       
   334  */
       
   335 #define XQOP_CONTACTS_FETCH_MULTIPLE QLatin1String("multiFetch(QString,QString)")
       
   336 
       
   337 /*!
       
   338  Fetch multiple contacts
       
   339  cntservicescontact.h has some constant definitions and a class for
       
   340  transforming the result.
       
   341  Parameter1: Title string.
       
   342  Parameter2: Action type string, from cntservicescontact.h 
       
   343  \return An object of type CntServicesContactList containing the contact ID.
       
   344  */
       
   345 #define XQOP_CONTACTS_FETCH_SINGLE QLatin1String("singleFetch(QString,QString)")
       
   346 
       
   347 /*!
       
   348  Contacts viewing interface.
       
   349  */
       
   350 #define XQI_CONTACTS_VIEW QLatin1String("com.nokia.symbian.IContactsView")
       
   351 
       
   352 /*!
       
   353  Opens contact card.
       
   354  Parameter1: Contact ID.
       
   355  */
       
   356 #define XQOP_CONTACTS_VIEW_CONTACT_CARD QLatin1String("openContactCard(int)")
       
   357 
       
   358 /*!
       
   359  Open contact card for in-memory contact which is not saved yet.
       
   360  In the UI there is an option to save the contact either by updating an
       
   361  existing contact or by creating a new one. 
       
   362 
       
   363     Parameter1: Indicates what type of contact field is supplied.
       
   364         One of the following values:
       
   365           QContactPhoneNumber::DefinitionName
       
   366           QContactEmailAddress::DefinitionName
       
   367           QContactOnlineAccount::DefinitionName
       
   368       (you need to include qcontactdetails.h)
       
   369     Parameter2: The actual detail value, for eg. "123456"
       
   370  */
       
   371 #define XQOP_CONTACTS_VIEW_TEMP_CONTACT_CARD_WITH_DETAIL QLatin1String("openTemporaryContactCard(QString,QString)")
       
   372 
       
   373 /*!
       
   374  Open the group members view.
       
   375  On the flip side of the group members view, there is the "group action" view.
       
   376  Parameter: The group ID. (native ID)
       
   377             Only groups in the main Qt Mobility backend are supported.
       
   378 */
       
   379 #define XQOP_CONTACTS_VIEW_GROUP QLatin1String("openGroup(int)")
       
   380 
       
   381 //
       
   382 // Messaging related Application Interworking declarations
       
   383 // ------------------------------------------------------
       
   384 //
       
   385 #define XQI_MESSAGE_SEND QLatin1String("com.nokia.symbian.IMessageSend")
       
   386 
       
   387 
   105 /*!
   388 /*!
   106  Incomplete list of interfaces.
   389  Incomplete list of interfaces.
   107  To be completed with operation signatures and related declarations.
   390  To be completed with operation signatures and related declarations.
   108 */
   391 */
   109 #define XQI_LOG_VIEW QLatin1String("com.nokia.symbian.ILogsView")
       
   110 #define XQI_CONTACT_VIEW QLatin1String("com.nokia.symbian.IContactView")
       
   111 #define XQI_CONTACT_FETCH QLatin1String("com.nokia.symbian.IContactFetch")
       
   112 #define XQI_FILE_FETCH QLatin1String("com.nokia.symbian.IFileFetch")
   392 #define XQI_FILE_FETCH QLatin1String("com.nokia.symbian.IFileFetch")
   113 #define XQI_FILE_SHARE QLatin1String("com.nokia.symbian.IFileShare")
   393 
   114 
       
   115 // Public URI related constants
       
   116 /*!
       
   117  The scheme of the activity URI
       
   118 */
       
   119 #define XQURI_SCHEME_ACTIVITY QLatin1String("appto")
       
   120 #define XQURI_SCHEME_HTTP QLatin1String("http")
       
   121 #define XQURI_SCHEME_HTTPS QLatin1String("https")
       
   122 #define XQURI_SCHEME_MAILTO QLatin1String("mailto")
       
   123 #define XQURI_SCHEME_FILE QLatin1String("file")
       
   124 
       
   125 /*!
       
   126  Activity key name in query part of the activity URI
       
   127 */
       
   128 #define XQURI_KEY_ACTIVITY_NAME QLatin1String("activityname")
       
   129 
       
   130 
       
   131 // Common Application Interworking related constants
       
   132 
       
   133 /*!
       
   134  Service XML custom property, which contains the name of text resource file that
       
   135  contains the CUSTOM_PROP_AIW_TEXT.
       
   136  \see XQAiwRequest::createAction()
       
   137 */
       
   138 #define XQCUSTOM_PROP_AIW_TEXT_FILE QLatin1String("aiw_action_text_file")
       
   139 
       
   140 /*!
       
   141  Service XML custom property, that contains the Text Id within the
       
   142  CUSTOM_PROP_AIW_TEXT_FILE.  The localized text is attached to
       
   143  to QAction returned by the XQAiwRequest::createAction()
       
   144 */
       
   145 #define XQCUSTOM_PROP_AIW_TEXT QLatin1String("aiw_action_text")
       
   146 
       
   147 /*!
       
   148  Service XML custom property, that contains the name of the icon to be attached
       
   149  to QAction returned by the XQAiwRequest::createAction()
       
   150 */
       
   151 #define XQCUSTOM_PROP_AIW_ICON QLatin1String("aiw_action_icon")
       
   152 
       
   153 /*!
       
   154  Service XML custom property, that contains schemes the XQI_URI_VIEW can handle
       
   155 */
       
   156 #define XQCUSTOM_PROP_SCHEMES QLatin1String("schemes")
       
   157 
       
   158 /*!
       
   159  Service XML custom property, which contains the name of text key that
       
   160  contains the service status
       
   161  \see XQApplicationMgr::isEnabled()
       
   162 */
       
   163 #define XQCUSTOM_PROP_AIW_SERVICE_STATUS QLatin1String("aiw_status")
       
   164 
       
   165 /*!
       
   166  A key name for XQRequestInfo object to pass a window title
       
   167  to be shown in service application instead of the default title.
       
   168  Service application is responsible to handle the key value.
       
   169  \see XQApplicationMgr::XQRequestInfo::setInfo()
       
   170 */
       
   171 #define XQINFO_KEY_WINDOW_TITLE QLatin1String("WindowTitle")
       
   172 
   394 
   173 
   395 
   174 #endif
   396 #endif