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
|
//
// Copyright (c) 2013, Ford Motor Company
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are met:
//
// Redistributions of source code must retain the above copyright notice, this
// list of conditions and the following disclaimer.
//
// Redistributions in binary form must reproduce the above copyright notice,
// this list of conditions and the following
// disclaimer in the documentation and/or other materials provided with the
// distribution.
//
// Neither the name of the Ford Motor Company nor the names of its contributors
// may be used to endorse or promote products derived from this software
// without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
// ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
// LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
// CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
// SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
// INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
// CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
// ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
// POSSIBILITY OF SUCH DAMAGE.
//
#ifndef NSSMARTDEVICELINKKRPC_REGISTERAPPINTERFACE_REQUEST_INCLUDE
#define NSSMARTDEVICELINKKRPC_REGISTERAPPINTERFACE_REQUEST_INCLUDE
#include <vector>
#include <string>
#include "Language.h"
#include "SyncMsgVersion.h"
#include "JSONHandler/SDLRPCRequest.h"
/*
interface Ford Sync RAPI
version 1.2
date 2011-05-17
generated at Thu Jan 24 06:36:21 2013
source stamp Thu Jan 24 06:35:34 2013
author RC
*/
namespace NsSmartDeviceLinkRPC
{
/**
Establishes an interface with a mobile application.
Before registerAppInterface no other commands will be accepted/executed.
*/
class RegisterAppInterface_request : public SDLRPCRequest
{
public:
RegisterAppInterface_request(const RegisterAppInterface_request& c);
RegisterAppInterface_request(void);
virtual ~RegisterAppInterface_request(void);
RegisterAppInterface_request& operator =(const RegisterAppInterface_request&);
bool checkIntegrity(void);
const SyncMsgVersion& get_syncMsgVersion(void) const;
const std::string& get_appName(void) const;
const std::string* get_ngnMediaScreenAppName(void) const;
const std::vector<std::string>* get_vrSynonyms(void) const;
const bool* get_usesVehicleData(void) const;
bool get_isMediaApplication(void) const;
const Language& get_languageDesired(void) const;
const std::string* get_autoActivateID(void) const;
bool set_syncMsgVersion(const SyncMsgVersion& syncMsgVersion_);
bool set_appName(const std::string& appName_);
void reset_ngnMediaScreenAppName(void);
bool set_ngnMediaScreenAppName(const std::string& ngnMediaScreenAppName_);
void reset_vrSynonyms(void);
bool set_vrSynonyms(const std::vector<std::string>& vrSynonyms_);
void reset_usesVehicleData(void);
bool set_usesVehicleData(bool usesVehicleData_);
bool set_isMediaApplication(bool isMediaApplication_);
bool set_languageDesired(const Language& languageDesired_);
void reset_autoActivateID(void);
bool set_autoActivateID(const std::string& autoActivateID_);
private:
friend class RegisterAppInterface_requestMarshaller;
/// See SyncMsgVersion
SyncMsgVersion syncMsgVersion;
/**
The mobile application name, e.g. "Ford Drive Green".
Needs to be unique over all applications.
May not be empty.
May not start with a new line character.
May not interfere with any name or synonym of previously registered applications and the following list of words @TODO: Create list(global commands)
Needs to be unique over all applications. Applications with the same name will be rejected.
Only characters from char set [@TODO: Create char set (character/hex value) for each ACM and refer to] are supported.
*/
std::string appName; //!< (100)
/**
Provides an abbreviated version of the app name (if needed), that will be displayed on the NGN media screen.
If not provided, the appName is used instead (and will be truncated if too long)
Only characters from char set [@TODO: Create char set (character/hex value) for each ACM and refer to] are supported.
*/
std::string* ngnMediaScreenAppName; //!< (100)
/**
Defines an additional voice recognition command.
May not interfere with any name or synonym of previously registered applications and the following list of words @TODO: Create list(global commands)
Only characters from char set [@TODO: Create char set (character/hex value) for each ACM and refer to] are supported.
*/
std::vector<std::string>* vrSynonyms; //!< [%s..%s] (40)
/**
If not provided, the default is equal to False"
Indicates if the mobile application wants to use vehicle data like GPS or speed.
*/
bool* usesVehicleData;
/**
Indicates if the application is a media or a non-media application.
Only media applications will be able to stream audio to Sync that is audible outside of the BT media source.
*/
bool isMediaApplication;
/**
See Language
If the language doesn't match the active language on Sync, it will be rejected.
If the language is changed, while an app is registered, it will get disconnected.
*/
Language languageDesired;
/**
Used to support auto activation after an initial successful registerAppInterface (for example after an ignition cycle).
The app should always provide the id that was provided by the most recent registerAppInterface response.
If this is the first call to registerAppInterface, then do not provide this parameter at all.
If not provided or not matching with the id of the last registerAppInterface response, the app will not be automatically put into foreground on startup.
*/
std::string* autoActivateID; //!< (16)
};
}
#endif
|
