/usr/include/x86_64-linux-gnu/alljoyn/AboutDataListener.h is in liballjoyn-dev-1604 16.04a-3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 | /*
* @file
* Pure Virtual class that contains the interface needed by anyone one wanting
* to use
*/
/******************************************************************************
* Copyright AllSeen Alliance. All rights reserved.
*
* Permission to use, copy, modify, and/or distribute this software for any
* purpose with or without fee is hereby granted, provided that the above
* copyright notice and this permission notice appear in all copies.
*
* THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
* WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
* MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
* ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
* WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
* ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
* OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
******************************************************************************/
#ifndef _ALLJOYN_ABOUTDATALISTENER_H
#define _ALLJOYN_ABOUTDATALISTENER_H
#include <alljoyn/MsgArg.h>
#include <alljoyn/Status.h>
namespace ajn {
/**
* Listener implemented by AllJoyn apps and called by AllJoyn.
*
* The Listener is responsible for providing a well formed MsgArg dictionary of
* type a{sv} that contain the fields specified in the About Interface.
*/
class AboutDataListener {
public:
/**
* Constructor
*/
AboutDataListener() { };
/**
* Destructor
*/
virtual ~AboutDataListener() { };
/**
* Create the MsgArg that is returned when a user calls
* org.alljoyn.About.GetAboutData. The returned MsgArg must contain the
* AboutData dictionary for the Language specified.
*
* The MsgArg will contain the signature `a{sv}`.
*
* <table>
* <tr>
* <th>Field Name</th>
* <th>Required</th>
* <th>Announced</th>
* <th>Localized</th>
* <th>Data type</th>
* <th>Description</th>
* </tr>
* <tr>
* <td><strong>AppId</strong></td>
* <td>yes</td>
* <td>yes</td>
* <td>no</td>
* <td>ay</td>
* <td>The globally unique id for the application.</td>
* </tr>
* <tr>
* <td><strong>DefaultLanguage</strong></td>
* <td>yes</td>
* <td>yes</td>
* <td>no</td>
* <td>s</td>
* <td>The default language supported by the device. IETF langauge tags
* specified by RFC 5646.</td>
* </tr>
* <tr>
* <td><strong>DeviceName</strong></td>
* <td>no</td>
* <td>yes</td>
* <td>yes</td>
* <td>s</td>
* <td>If Config service exist on the device, About instance populates
* the value as DeviceName in Config; If there is not Config, it can
* be set by the app. Device Name is optional for a third party
* apps but required for system apps. Versions of AllJoyn older than
* 14.12 this field was required. If working with older applications
* this field may be required.</td>
* </tr>
* <tr>
* <td><strong>DeviceId</strong></td>
* <td>yes</td>
* <td>yes</td>
* <td>no</td>
* <td>s</td>
* <td>A string with value generated using platform specific means.</td>
* </tr>
* <tr>
* <td><strong>AppName</strong></td>
* <td>yes</td>
* <td>yes</td>
* <td>yes</td>
* <td>s</td>
* <td>The application name assigned by the app manufacturer</td>
* </tr>
* <tr>
* <td><strong>Manufacturer</strong></td>
* <td>yes</td>
* <td>yes</td>
* <td>yes</td>
* <td>s</td>
* <td>The manufacturer's name.</td>
* </tr>
* <tr>
* <td><strong>ModelNumber</strong></td>
* <td>yes</td>
* <td>yes</td>
* <td>no</td>
* <td>s</td>
* <td>The app model number</td>
* </tr>
* <tr>
* <td><strong>SupportedLanguages</strong></td>
* <td>yes</td>
* <td>no</td>
* <td>no</td>
* <td>as</td>
* <td>A list of supported languages by the application</td>
* </tr>
* <tr>
* <td><strong>Description</strong></td>
* <td>yes</td>
* <td>no</td>
* <td>yes</td>
* <td>s</td>
* <td>Detailed description provided by the application.</td>
* </tr>
* <tr>
* <td><strong>DateOfManufacture</strong></td>
* <td>no</td>
* <td>no</td>
* <td>no</td>
* <td>s</td>
* <td>The date of manufacture. using format YYYY-MM-DD.
* (Known as XML DateTime Format)</td>
* </tr>
* <tr>
* <td><strong>SoftwareVersion</strong></td>
* <td>yes</td>
* <td>no</td>
* <td>no</td>
* <td>s</td>
* <td>The software version of the manufacturer's software</td>
* </tr>
* <tr>
* <td><strong>SoftwareVersion</strong></td>
* <td>yes</td>
* <td>no</td>
* <td>no</td>
* <td>s</td>
* <td>The current version of the AllJoyn SDK utilized by the
* application.</td>
* </tr>
* <tr>
* <td><strong>HardwareVersion</strong></td>
* <td>no</td>
* <td>no</td>
* <td>no</td>
* <td>s</td>
* <td>The device hardware version.</td>
* </tr>
* <tr>
* <td><strong>SupportUrl</strong></td>
* <td>no</td>
* <td>no</td>
* <td>no</td>
* <td>s</td>
* <td>The support URL.</td>
* </tr>
* </table>
*
* Custom fields are allowed. Since the proxy object only receives the field
* name and the MsgArg containing the contents for that field the default
* assumption is that user defined fields are:
* - are not required
* - are not announced
* - are localized if the MsgArg contains a String (not localized otherwise)
*
* Important: All implementations of GetAboutData should handle language
* specified as an empty string or NULL. In the case that the language is
* an empty string or NULL the GetAboutData is expected to return the
* default language.
*
* If the language tag given is not supported, return the best matching
* language according to RFC 4647 section 3.4. This algorithm requires
* that the "supported" languages be the least specific they can (e.g.,
* "en" in order to match both "en" and "en-US" if requested), and the
* "requested" language be the most specific it can (e.g., "en-US" in
* order to match either "en-US" or "en" if supported).
*
* If the user has not provided ALL of the required fields return the QStatus
* #ER_ABOUT_ABOUTDATA_MISSING_REQUIRED_FIELD
*
* @param[out] msgArg a dictionary containing all of the AboutData fields for
* the requested language. If language is not specified, the default
* language will be returned.
* @param[in] language IETF language tag specified by RFC 5646. If the string
* is NULL or an empty string, the MsgArg for the default
* language will be returned.
*
* @return
* - #ER_OK on successful
* - #ER_ABOUT_ABOUTDATA_MISSING_REQUIRED_FIELD if a required field is missing
* - other error indicating failure
*/
virtual QStatus GetAboutData(MsgArg* msgArg, const char* language) = 0;
/**
* Return a MsgArg pointer containing dictionary containing the Announce
* portion of the AboutData.
*
* The Announced values will always use the default language and will only
* contain the fields that are announced.
*
* The fields required to be part of the announced MsgArg are:
* - AppId
* - DefaultLanguage
* - DeviceName (Optional since v14.12)
* - DeviceId
* - AppName
* - Manufacture
* - ModelNumber
*
* To read other fields or get the localized value of a field use the
* org.alljoyn.About.GetAboutData method. This method is available using the
* AboutProxy class.
*
* @param[out] msgArg a MsgArg dictionary with the a{sv} that contains the Announce
* data.
* @return ER_OK if successful
*/
virtual QStatus GetAnnouncedAboutData(MsgArg* msgArg) = 0;
};
}
#endif /* _ALLJOYN_ABOUTDATALISTENER_H */
|