A method to get all child files and folders #1211
-
|
I am attempting to get all files and folders for a given folder that gets passed in. My goal is to iterate over the returned list items, and update the metadata fields ( How can I update this method so it returns the files and folders (currently returns empty collection) and also load the relevant fields for updating metadata on each file and folder? public async Task<IEnumerable<IListItem>> GetChildFilesAndFolders(IFolder folder)
{
var list = await _sharePointContext.Web.Lists.GetByServerRelativeUrlAsync(folder.ServerRelativeUrl,
p => p.Fields.QueryProperties(p => p.InternalName, p => p.FieldTypeKind, p => p.TypeAsString,
p => p.Title));
var camlQuery = new CamlQueryOptions
{
FolderServerRelativeUrl = folder.ServerRelativeUrl,
ViewXml = $@"
<View Scope=""RecursiveAll"">
<Query>
<Or>
<Eq>
<FieldRef Name=""FSObjType"" />
<Value Type=""Integer"">0</Value>
</Eq>
<Eq>
<FieldRef Name=""FSObjType"" />
<Value Type=""Integer"">1</Value>
</Eq>
</Or>
</Query>
</View>"
};
await list.LoadItemsByCamlQueryAsync(camlQuery,
p => p.Title, p => p.FileSystemObjectType,
p => p.Folder.QueryProperties(f => f.Name, f => f.ListItemAllFields.QueryProperties(li => li.All,
li => li.ParentList.QueryProperties(p => p.Title,
p => p.Fields.QueryProperties(p => p.InternalName, p => p.FieldTypeKind,
p => p.TypeAsString, p => p.Title)))),
p => p.File.QueryProperties(f => f.Name, f => f.ListItemAllFields.QueryProperties(li => li.All,
li => li.ParentList.QueryProperties(p => p.Title,
p => p.Fields.QueryProperties(p => p.InternalName, p => p.FieldTypeKind,
p => p.TypeAsString, p => p.Title)))));
return list.Items.AsRequested();
} |
Beta Was this translation helpful? Give feedback.
Replies: 4 comments 13 replies
-
|
I was able to find a request. It was made when getting the list. Very strange the way this SDK works. Request: Response: |
Beta Was this translation helpful? Give feedback.
-
|
@adamfisher : you need to specify the fields you need in the CAML query, see https://pnp.github.io/pnpcore/using-the-sdk/listitems-intro.html#c-getting-list-items-via-the-loaditemsbycamlquery-approach for some samples. Also note that there's a limitation when folder names contain # or & characters, best to filter via |
Beta Was this translation helpful? Give feedback.
-
|
Thanks for the heads up on those characters. My folders don't contain those values. 👍 |
Beta Was this translation helpful? Give feedback.
-
Why is there duplication in specifying fields in the CAML query with |
Beta Was this translation helpful? Give feedback.
-
|
I got this working so far: public static async Task<IEnumerable<IListItem>> GetChildFilesAndFoldersAsync(this IFolder folder)
{
var list = await folder.PnPContext.Web.Lists.GetByServerRelativeUrlAsync(folder.ServerRelativeUrl,
p => p.Fields.QueryProperties(p => p.InternalName, p => p.FieldTypeKind, p => p.TypeAsString,
p => p.Title));
var camlQuery = new CamlQueryOptions
{
FolderServerRelativeUrl = folder.ServerRelativeUrl,
// FSObjType = 0 (folder) // FSObjType = 1 (file)
ViewXml = $@"
<View Scope=""RecursiveAll"">
<ViewFields>
<FieldRef Name='Title' />
<FieldRef Name='FileLeafRef' />
<FieldRef Name='FileRef' />
<FieldRef Name='FileDirRef' />
<FieldRef Name='ParentList' />
</ViewFields>
<Query>
<Or>
<Eq><FieldRef Name=""FSObjType"" /><Value Type=""Integer"">0</Value></Eq>
<Eq><FieldRef Name=""FSObjType"" /><Value Type=""Integer"">1</Value></Eq>
</Or>
</Query>
</View>"
};
return list.Items.AsRequested();
}Then later I call this method like this to update metadata column values: var columnValues = await GetColumnValuesAsync(targetFolder, myData);
var items = (await targetFolder.GetChildFilesAndFoldersAsync()).ToList();
items.Add(targetFolder.ListItemAllFields); // Add targetFolder too
foreach (var item in items)
{
var isFolder = await item.IsFolderAsync();
var listItem = isFolder ? item.Folder.ListItemAllFields : item.File.ListItemAllFields;
foreach (var columnValue in columnValues)
{
listItem[columnValue.FieldInternalName] = columnValue.DefaultValue;
}
await listItem.UpdateOverwriteVersionAsync();
}However the crit: Microsoft.Extensions.Hosting.Internal.Host[10]
The HostOptions.BackgroundServiceExceptionBehavior is configured to StopHost. A BackgroundService has thrown an unhandled exception, and the IHost instance is stopping. To avoid this behavior, configure this to Ignore; however the BackgroundService will not be restarted.
HttpResponseCode: 200
Message: Guid should contain 32 digits with 4 dashes (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx).
ClientRequestId: d2c8bea0-509f-3000-c192-b88843354257
ErrorTypeName: "System.FormatException"
PnP.Core.CsomServiceException: CSOM service exception
at PnP.Core.Services.BatchClient.ProcessCsomBatchResponse(CsomBatch csomBatch, String batchResponse, HttpStatusCode statusCode)
at PnP.Core.Services.BatchClient.ExecuteCsomBatchAsync(Batch batch)
at PnP.Core.Services.BatchClient.ExecuteBatch(Batch batch)
at PnP.Core.Model.BaseDataModel`1.RequestAsync(ApiCall apiCall, HttpMethod method, String operationName)
at PnP.Core.Model.BaseDataModel`1.RawRequestAsync(ApiCall apiCall, HttpMethod method, String operationName)
at PnP.Core.Model.SharePoint.ListItem.UpdateOverwriteVersionAsync() |
Beta Was this translation helpful? Give feedback.
-
Another approach I tried...I tried doing something like this to get the proper metadata loaded so I can later update those column values on the files/folders: // ... camlQuery executed above
await list.LoadItemsByCamlQueryAsync(camlQuery);
await list.Items.LoadAsync(li => li.All,
li => li.Title,
li => li.File.QueryProperties(p => p.All,
f => f.Name,
f => f.ListItemAllFields.QueryProperties(li => li.All,
li => li.ParentList.QueryProperties(p => p.Title,
p => p.Fields.QueryProperties(p => p.InternalName, p => p.FieldTypeKind,
p => p.TypeAsString, p => p.Title)))),
li => li.Folder.QueryProperties(p => p.All,
f => f.Name,
f => f.ListItemAllFields.QueryProperties(li => li.All,
li => li.ParentList.QueryProperties(p => p.Title,
p => p.Fields.QueryProperties(p => p.InternalName, p => p.FieldTypeKind,
p => p.TypeAsString, p => p.Title)))));
return list.Items.AsRequested();But this gives this error even though I already loaded the list earlier in the method but it acts like it doesn't contain a crit: Microsoft.Extensions.Hosting.Internal.Host[10]
The HostOptions.BackgroundServiceExceptionBehavior is configured to StopHost. A BackgroundService has thrown an unhandled exception, and the IHost instance is stopping. To avoid this behavior, configure this to Ignore; however the BackgroundService will not be restarted.
PnP.Core.ClientError
PnP.Core.ClientException: Unresolved tokens found in API call https://demo.sharepoint.com/sites/FileStructureSandbox/_api/Web/Lists(guid'{List.Id}')/Items(1)/Folder?$select=UniqueId%2cListItemAllFields%2f*%2cListItemAllFields%2fId%2cListItemAllFields%2fParentList%2fTitle%2cListItemAllFields%2fParentList%2fId%2cListItemAllFields%2fParentList%2fFields%2fInternalName%2cListItemAllFields%2fParentList%2fFields%2fFieldTypeKind%2cListItemAllFields%2fParentList%2fFields%2fTypeAsString%2cListItemAllFields%2fParentList%2fFields%2fTitle%2cListItemAllFields%2fParentList%2fFields%2fId&$expand=ListItemAllFields%2cListItemAllFields%2fParentList%2cListItemAllFields%2fParentList%2fFields
at PnP.Core.Services.BatchClient.CheckForUnresolvedTokens(Batch batch)
at PnP.Core.Services.BatchClient.ExecuteBatch(Batch batch)
at PnP.Core.Model.BaseDataModel`1.BaseRetrieveAsync(ApiCall apiOverride, Func`2 fromJsonCasting, Action`1 postMappingJson, Expression`1[] expressions) |
Beta Was this translation helpful? Give feedback.
-
|
@adamfisher : The "Guid should contain 32 digits with 4 dashes" error suggests your pushing in a non guid somewhere were a guid is expected. The error comes the server call response. I would suggest to test field by field to find the one that's wrong. What also makes sense is to request the fields you want to set as part of your CAML query, this way you can inspect the current value of the field you want to set. The last approach you've put here is not needed as you're loading items twice, once via CAML, once via the regular item enumeration. |
Beta Was this translation helpful? Give feedback.
-
|
This appears to be a bug in the SDK. When you call |
Beta Was this translation helpful? Give feedback.
-
|
Ah ok. I forgot that field was marked internal so the issue is actually slightly different than what I described to your point. I'll have to update the issue. Looks like it needs a |
Beta Was this translation helpful? Give feedback.
-
|
Changed to use |
Beta Was this translation helpful? Give feedback.
-
|
I've fixed #1213 , so you can use those methods as well from the next nightly. Looking at your repro code you seem to be handling the metadata updates via the respective IFile and IFolder ListItemAllFields collection. As you're anyhow doing a query to first get these list items it's more efficient to immediately update them: // read the added items via a CAML query
string viewXml = @"<View>
<ViewFields>
<FieldRef Name='Title' />
<FieldRef Name='FileRef' />
<FieldRef Name='ContentTypeId' />
<FieldRef Name='MyField' />
</ViewFields>
<OrderBy Override='TRUE'><FieldRef Name= 'ID' Ascending= 'FALSE' /></OrderBy>
</View>";
// Execute the query
await documentLibrary.LoadItemsByCamlQueryAsync(new CamlQueryOptions()
{
ViewXml = viewXml,
DatesInUtc = true
});
// get first item and do a system update
var first = documentLibrary.Items.AsRequested().First();
if (first.Values["ContentTypeId"].ToString().StartsWith("0x0120", StringComparison.InvariantCultureIgnoreCase))
{
//Folder
first.Values["MyField"] = "blabla";
}
else
{
//File
} |
Beta Was this translation helpful? Give feedback.
-
|
So I don't need to use ListItemAllFields property on files and folders? I can just use it on the root list item? Why do you need the if/else statement? It looks like I'll have to check this out because I've had to start looking at the batch API and figure out how to make it work with this because it's taking way too long with about 137 items to update. If I can somehow do this all in one go that would be preferable. |
Beta Was this translation helpful? Give feedback.
-
|
My final methods (working): public static async Task<IEnumerable<IListItem>> GetChildFilesAndFoldersAsync(this IFolder folder)
{
var list = await folder.PnPContext.Web.Lists.GetByServerRelativeUrlAsync(folder.ServerRelativeUrl,
p => p.Fields.QueryProperties(p => p.InternalName, p => p.FieldTypeKind, p => p.TypeAsString,
p => p.Title));
var camlQuery = new CamlQueryOptions
{
FolderServerRelativeUrl = folder.ServerRelativeUrl,
// FSObjType = 0 (folder) // FSObjType = 1 (file)
ViewXml = @"
<View Scope=""RecursiveAll"">
<ViewFields>
<FieldRef Name='Title' />
<FieldRef Name='FileLeafRef' />
<FieldRef Name='FileRef' />
<FieldRef Name='FileDirRef' />
<FieldRef Name='ParentList' />
</ViewFields>
<Query>
<Or>
<Eq><FieldRef Name=""FSObjType"" /><Value Type=""Integer"">0</Value></Eq>
<Eq><FieldRef Name=""FSObjType"" /><Value Type=""Integer"">1</Value></Eq>
</Or>
</Query>
</View>"
};
await list.LoadItemsByCamlQueryAsync(camlQuery);
return list.Items.AsRequested();
}Followed by: private async Task SetFieldMetaData(IFolder targetFolder, MyData myData)
{
var columnValues = await GetColumnValuesAsync(targetFolder, myData);
var items = (await targetFolder.GetChildFilesAndFoldersAsync()).ToList();
items.Add(targetFolder.ListItemAllFields);
_logger.LogInformation("Setting metadata for {ItemCount} items in \"{FolderName}\"...", items.Count, targetFolder.Name);
foreach (var item in items)
{
var isFolder = await item.IsFolderAsync();
var listItem = isFolder ? item.Folder.ListItemAllFields : item.File.ListItemAllFields;
await listItem.EnsurePropertiesAsync(li => li.All,
li => li.UniqueId,
li => li.Title,
li => li.File.QueryProperties(p => p.All,
f => f.UniqueId,
f => f.Name,
f => f.ListItemAllFields.QueryProperties(li => li.All,
li => li.ParentList.QueryProperties(p => p.Title,
p => p.Fields.QueryProperties(p => p.InternalName, p => p.FieldTypeKind,
p => p.TypeAsString, p => p.Title)))),
li => li.Folder.QueryProperties(p => p.All,
f => f.UniqueId,
f => f.Name,
f => f.ListItemAllFields.QueryProperties(li => li.All,
li => li.ParentList.QueryProperties(p => p.Title,
p => p.Fields.QueryProperties(p => p.InternalName, p => p.FieldTypeKind,
p => p.TypeAsString, p => p.Title)))));
foreach (var columnValue in columnValues)
{
listItem[columnValue.FieldInternalName] = columnValue.DefaultValue;
}
await listItem.UpdateAsync();
}
} |
Beta Was this translation helpful? Give feedback.
I've fixed #1213 , so you can use those methods as well from the next nightly. Looking at your repro code you seem to be handling the metadata updates via the respective IFile and IFolder ListItemAllFields collection. As you're anyhow doing a query to first get these list items it's more efficient to immediately update them: