Interface INavigationNodeCollection

Namespace

PnP.Core.Model.SharePoint

Assembly

PnP.Core.dll

Represents the Navigation

public interface INavigationNodeCollection : IQueryable<INavigationNode>, IQueryable, IDataModelCollection<INavigationNode>, IEnumerable<INavigationNode>, IEnumerable, IDataModelParent, IDataModelWithContext, IRequestableCollection, ISupportModules<INavigationNodeCollection>

Inherited Members

IQueryable.ElementType

IQueryable.Expression

IQueryable.Provider

IEnumerable<INavigationNode>.GetEnumerator()

IDataModelParent.Parent

IDataModelWithContext.PnPContext

IRequestableCollection.Requested

IRequestableCollection.Length

IRequestableCollection.RequestedItems

IRequestableCollection.Clear()

Extension Methods

QueryableExtensions.AsRequested<TSource>(IDataModelCollection<TSource>)

RequestModuleExtensions.WithHeaders<TModel>(ISupportModules<TModel>, Dictionary<string, string>, Action<Dictionary<string, string>>)

RequestModuleExtensions.WithResponseHeaders<TModel>(ISupportModules<TModel>, Action<Dictionary<string, string>>)

QueryableExtensions.AsAsyncEnumerable<TSource>(IQueryable<TSource>)

QueryableExtensions.AsBatchAsync<TSource>(IQueryable<TSource>)

QueryableExtensions.AsBatchAsync<TSource>(IQueryable<TSource>, Batch)

QueryableExtensions.AsBatch<TSource>(IQueryable<TSource>)

QueryableExtensions.AsBatch<TSource>(IQueryable<TSource>, Batch)

QueryableExtensions.FirstAsync<TSource>(IQueryable<TSource>, Expression<Func<TSource, bool>>, CancellationToken)

QueryableExtensions.FirstAsync<TSource>(IQueryable<TSource>, CancellationToken)

QueryableExtensions.FirstOrDefaultAsync<TSource>(IQueryable<TSource>, Expression<Func<TSource, bool>>, CancellationToken)

QueryableExtensions.FirstOrDefaultAsync<TSource>(IQueryable<TSource>, CancellationToken)

QueryableExtensions.ForEachAsync<T>(IQueryable<T>, Action<T>, CancellationToken)

QueryableExtensions.QueryProperties<TResult>(IQueryable<TResult>, params Expression<Func<TResult, object>>[])

QueryableExtensions.ToArrayAsync<TSource>(IQueryable<TSource>, CancellationToken)

QueryableExtensions.ToDictionaryAsync<TSource, TKey>(IQueryable<TSource>, Func<TSource, TKey>, IEqualityComparer<TKey>, CancellationToken)

QueryableExtensions.ToDictionaryAsync<TSource, TKey>(IQueryable<TSource>, Func<TSource, TKey>, CancellationToken)

QueryableExtensions.ToDictionaryAsync<TSource, TKey, TElement>(IQueryable<TSource>, Func<TSource, TKey>, Func<TSource, TElement>, IEqualityComparer<TKey>, CancellationToken)

QueryableExtensions.ToDictionaryAsync<TSource, TKey, TElement>(IQueryable<TSource>, Func<TSource, TKey>, Func<TSource, TElement>, CancellationToken)

QueryableExtensions.ToListAsync<TSource>(IQueryable<TSource>, CancellationToken)

Properties

NavigationType

This variable will define whether we will be using the top navigation or the quick launch for our API calls

NavigationType NavigationType { get; }

Property Value

NavigationType

Methods

Add(NavigationNodeOptions)

Method to add a Navigation Node

INavigationNode Add(NavigationNodeOptions navigationNodeOptions)

Parameters

navigationNodeOptions NavigationNodeOptions

The options for the navigation node

Returns

INavigationNode

The navigation node

AddAsync(NavigationNodeOptions)

Method to add a Navigation Node

Task<INavigationNode> AddAsync(NavigationNodeOptions navigationNodeOptions)

Parameters

navigationNodeOptions NavigationNodeOptions

The options for the navigation node

Returns

Task<INavigationNode>

The navigation node

DeleteAllNodes()

Method to delete all navigation nodes from a specific navigation type

void DeleteAllNodes()

DeleteAllNodesAsync()

Method to delete all navigation nodes from a specific navigation type

Task DeleteAllNodesAsync()

Returns

Task

DeleteAllNodesBatch()

Method to delete all navigation nodes from a specific navigation type in a batch

void DeleteAllNodesBatch()

DeleteAllNodesBatch(Batch)

Method to delete all navigation nodes from a specific navigation type in a batch

void DeleteAllNodesBatch(Batch batch)

Parameters

batch Batch

The batch to add this reques to

DeleteAllNodesBatchAsync()

Method to delete all navigation nodes from a specific navigation type in a batch

Task DeleteAllNodesBatchAsync()

Returns

Task

DeleteAllNodesBatchAsync(Batch)

Method to delete all navigation nodes from a specific navigation type in a batch

Task DeleteAllNodesBatchAsync(Batch batch)

Parameters

batch Batch

The batch to add this reques to

Returns

Task

GetById(int, params Expression<Func<INavigationNode, object>>[])

Method to select a specific Navigation Node

INavigationNode GetById(int id, params Expression<Func<INavigationNode, object>>[] selectors)

Parameters

id int

The Id to search for

selectors Expression<Func<INavigationNode, object>>[]

The expressions declaring the fields to select

Returns

INavigationNode

The navigation node, if any

GetByIdAsync(int, params Expression<Func<INavigationNode, object>>[])

Method to select a specific Navigation Node

Task<INavigationNode> GetByIdAsync(int id, params Expression<Func<INavigationNode, object>>[] selectors)

Parameters

id int

The Id to search for

selectors Expression<Func<INavigationNode, object>>[]

The expressions declaring the fields to select

Returns

Task<INavigationNode>

The navigation node, if any

MoveNodeAfter(INavigationNode, INavigationNode)

Function to move a node after another navigation node

void MoveNodeAfter(INavigationNode nodeToMove, INavigationNode nodeToMoveAfter)

Parameters

nodeToMove INavigationNode

nodeToMoveAfter INavigationNode

MoveNodeAfterAsync(INavigationNode, INavigationNode)

Function to move a node after another navigation node

Task MoveNodeAfterAsync(INavigationNode nodeToMove, INavigationNode nodeToMoveAfter)

Parameters

nodeToMove INavigationNode

nodeToMoveAfter INavigationNode

Returns

Task