Add items to portal
This sample demonstrates how to add and delete items (in this case a local .csv file) in a user's portal.
Use case
Portals allow you to share and publish data with others. For example, you may create or collect some data on your device and want to upload that to a cloud storage location to share with others or simply save for later use. In this case, a CSV file is created and uploaded to ArcGIS Online.
How to use the sample
- Press the Authenticate Portal button and sign into your ArcGIS Online account.
- Press the Add Item button, and this will add the CSV to your
Portal. - Press the Delete Item button, and this will delete that same item from your
Portal.
How it works
- A
Portalis created with aCredentialusingOAuthModeUser. - A
PortalItemof type CSV is created using this portal. - When the "Autheticate" button is clicked, the portal is loaded and the
AuthenticationViewis displayed to request credentials. - When the portal is successfully loaded, the
PortalUserobject is obtained from the portal. - When the "Add Item" button is clicked, the item is added via the portalUser's
addPortalItemWithUrlmethod. The portalItem and the local Url of the CSV file are supplied as parameters. - When the item has been succesfully added, it is loaded in order to retrieve online properties such as the
itemId.' - When the "Delete Item" button is clicked, the item is passed as a parameter for the portalUser's
deleteItemmethod.
Relevant API
- AuthenticationView
- Portal
- PortalItem
- PortalUser
- PortalUser.addPortalItemWithUrl
- PortalUser.deleteItem
Tags
add item, cloud, portal
Sample Code
AddItemsToPortal.qml
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
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
// [WriteFile Name=AddItemsToPortal, Category=CloudAndPortal]
// [Legal]
// Copyright 2016 Esri.
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
// http://www.apache.org/licenses/LICENSE-2.0
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
// [Legal]
import QtQuick
import QtQuick.Controls
import Esri.ArcGISRuntime
import Esri.ArcGISRuntime.Toolkit
Rectangle {
id: rootRectangle
clip: true
width: 800
height: 600
property bool alreadyExisted: false
PortalItem {
id: itemToAdd
portal: portal
type: Enums.PortalItemTypeCSV
title: "Add Items Sample"
onLoadStatusChanged: {
if (loadStatus !== Enums.LoadStatusLoaded)
return;
if (alreadyExisted)
statusBar.text = "Item already exists; using existing item instead. " + itemToAdd.itemId
else
statusBar.text = "Succesfully loaded item from portal. " + itemToAdd.itemId
}
onItemIdChanged: {
portalItemModel.setProperty(1, "value", itemToAdd.itemId);
}
}
PortalUser {
id: myUser
portal: portal
username: portal.portalUser ? portal.portalUser.username : ""
onLoadStatusChanged: {
if (loadStatus === Enums.LoadStatusFailedToLoad)
return;
if (loadStatus !== Enums.LoadStatusLoaded)
return;
statusBar.text = "Connected as " + username
}
onUsernameChanged: {
if (loadStatus === Enums.LoadStatusLoaded)
return;
// If the username is valid and the portal has been loaded, we are ready to load the user
if (username.length > 0 && portal.loadStatus === Enums.LoadStatusLoaded)
load();
}
onErrorChanged: {
statusBar.text = error.message + ": " + error.additionalMessage;
// Check for service error 409 "Conflict" - item already exists
const additionalInfo = error.additionalInformation;
if (ErrorInformationKeys.serviceError in additionalInfo &&
additionalInfo[ErrorInformationKeys.serviceError] === 409)
{
alreadyExisted = true;
myUser.fetchContent();
}
}
onFetchContentStatusChanged: {
if (myUser.fetchContentStatus !== Enums.TaskStatusCompleted)
return;
myUser.items.forEach(item => {
if (item.title === "Add Items Sample") {
itemToAdd.itemId = item.itemId;
itemToAdd.load();
return;
}
});
}
//! [PortalUser addPortalItemCompleted]
onAddPortalItemStatusChanged: {
if (addPortalItemStatus !== Enums.TaskStatusCompleted)
return;
itemToAdd.load();
//! [PortalUser addPortalItemCompleted]
statusBar.text = "Successfully added item.";
addItemButton.border.width = 2;
}
onDeletePortalItemStatusChanged: {
if (deletePortalItemStatus !== Enums.TaskStatusCompleted)
return;
statusBar.text = "Successfully deleted item " + itemToAdd.itemId;
deleteItemButton.enabled = false;
portalItemModel.clear();
}
}
Portal {
id: portal
loginRequired: true
credential: Credential {
oAuthClientInfo: OAuthClientInfo {
oAuthMode: Enums.OAuthModeUser
clientId: "iLkGIj0nX8A4EJda"
}
}
onLoadStatusChanged: {
if (loadStatus === Enums.LoadStatusFailedToLoad)
return;
if (loadStatus !== Enums.LoadStatusLoaded)
return;
authenticationButton.border.width = 2;
// The user cannot be loaded until it has been notified of the name change
if (myUser.username.length > 0)
myUser.load();
}
}
Flickable {
anchors.fill: parent
interactive: true
boundsBehavior: Flickable.StopAtBounds
contentHeight: parent.height * 1.5
contentWidth: parent.width
Column {
id: contentCol
anchors {
fill: parent
margins: 16
}
spacing: 16
Rectangle {
id: authenticationButton
anchors.horizontalCenter: parent.horizontalCenter
height: 64
width: Math.min(256, parent.width)
color: enabled ? "darkblue" : "darkgrey"
border {
color: "lightgrey"
width: 2
}
radius: 8
enabled: portal.loadStatus !== Enums.LoadStatusLoaded
Row {
anchors.fill: parent
spacing: 16
Image {
anchors.verticalCenter: parent.verticalCenter
source: portal.loadStatus !== Enums.LoadStatusLoaded ?
"qrc:/Samples/CloudAndPortal/AddItemsToPortal/ic_menu_account_dark.png" :
"qrc:/Samples/CloudAndPortal/AddItemsToPortal/ic_menu_checkedcircled_dark.png"
fillMode: Image.PreserveAspectFit
height: 64
width: height
}
Text {
anchors.verticalCenter: parent.verticalCenter
text: "Authenticate Portal"
font.bold: true
color: "white"
}
}
MouseArea {
anchors.fill: parent
onClicked: {
portal.load();
authenticationButton.border.width = 4;
}
}
}
Rectangle {
id: addItemButton
anchors.horizontalCenter: parent.horizontalCenter
height: authenticationButton.height
width: authenticationButton.width
color: enabled ? "darkblue" : "darkgrey"
border {
color: authenticationButton.border.color
width: 2
}
radius: authenticationButton.radius
enabled: itemToAdd.loadStatus !== Enums.LoadStatusLoaded && portal.loadStatus === Enums.LoadStatusLoaded
Row {
anchors.fill: parent
spacing: 16
Image {
anchors.verticalCenter: parent.verticalCenter
source: itemToAdd.loadStatus === Enums.LoadStatusLoaded ?
"qrc:/Samples/CloudAndPortal/AddItemsToPortal/ic_menu_checkedcircled_dark.png" :
"qrc:/Samples/CloudAndPortal/AddItemsToPortal/ic_menu_addencircled_dark.png"
fillMode: Image.PreserveAspectFit
height: 64
width: height
}
Text {
anchors.verticalCenter: parent.verticalCenter
text: "Add Item"
font.bold: true
color: "white"
}
}
MouseArea {
anchors.fill: parent
onClicked: {
addItemButton.border.width = 4;
//! [PortalUser addItemWithUrl]
const localCSVFile = "qrc:/Samples/CloudAndPortal/AddItemsToPortal/add_item_sample.csv";
myUser.addPortalItemWithUrl(itemToAdd, localCSVFile, "add_item_sample.csv");
//! [PortalUser addItemWithUrl]
}
}
}
Rectangle {
id: deleteItemButton
anchors.horizontalCenter: parent.horizontalCenter
height: authenticationButton.height
width: authenticationButton.width
color: enabled ? "darkblue" : "darkgrey"
border {
color: authenticationButton.border.color
width: 2
}
radius: authenticationButton.radius
enabled: itemToAdd.loadStatus === Enums.LoadStatusLoaded
Row {
anchors.fill: parent
spacing: 16
Image {
anchors.verticalCenter: parent.verticalCenter
source: myUser.deletePortalItemStatus !== Enums.TaskStatusCompleted ?
"qrc:/Samples/CloudAndPortal/AddItemsToPortal/ic_menu_trash_dark.png" :
"qrc:/Samples/CloudAndPortal/AddItemsToPortal/ic_menu_checkedcircled_dark.png"
fillMode: Image.PreserveAspectFit
height: 64
width: height
}
Text {
anchors.verticalCenter: parent.verticalCenter
text: "Delete Item"
font.bold: true
color: "white"
}
}
MouseArea {
anchors.fill: parent
onClicked: {
deleteItemButton.border.width = 2;
myUser.deletePortalItem(itemToAdd);
}
}
}
Rectangle {
anchors {
left: parent.left
right: parent.right
}
height: 4
color: "lightgrey"
}
Rectangle {
id: itemView
anchors {
left: parent.left
right: parent.right
}
height: 100
color: "lightsteelblue"
border {
color: "darkgrey"
width: 4
}
radius: 32
clip: true
Text {
id: portalItemLabel
anchors{
top: parent.top
horizontalCenter: parent.horizontalCenter
margins: 4
}
color: "white"
font.bold: true
text: "PortalItem"
font.underline: true
horizontalAlignment: Text.AlignHCenter
}
ListModel {
id: portalItemModel
Component.onCompleted: {
append({"label": "title", "value": itemToAdd.title });
append({"label": "itemId", "value": itemToAdd.itemId});
append({"label": "type", "value": itemToAdd.typeName});
}
}
ListView {
anchors {
top: portalItemLabel.bottom
left: parent.left
right: parent.right
bottom: parent.bottom
margins: 16
}
clip: true
model: portalItemModel
delegate: Text {
color: "white"
text: label + ":\t" + value
wrapMode: Text.Wrap
elide: Text.ElideRight
}
}
}
Text {
id: statusBar
anchors{
left: parent.left
right: parent.right
}
wrapMode: Text.Wrap
elide: Text.ElideRight
}
}
}
// Declare AuthenticationView to handle any authentication challenges
AuthenticationView {
anchors.fill: parent
}
BusyIndicator {
anchors.centerIn: parent
running: portal.loadStatus === Enums.TaskStatusInProgress ||
myUser.loadStatus === Enums.TaskStatusInProgress ||
myUser.addPortalItemStatus === Enums.TaskStatusInProgress ||
myUser.deletePortalItemStatus === Enums.TaskStatusInProgress
}
}