Interface IVivaDashboard

Represents Viva Dashboard page

Namespace: PnP.Core.Model.SharePoint
Assembly: PnP.Core.dll
Syntax
public interface IVivaDashboard

Properties

ACEs

Returns list of ACEs added to the Dashboard

Declaration
List<AdaptiveCardExtension> ACEs { get; }
Property Value
PnP.Core.Model.SharePoint.List<AdaptiveCardExtension>

Methods

AddACE(AdaptiveCardExtension)

Adds new ACE

Declaration
void AddACE(AdaptiveCardExtension ace)
Parameters
AdaptiveCardExtension ace

ACE to add

AddACE(AdaptiveCardExtension, Int32)

Adds new ACE

Declaration
void AddACE(AdaptiveCardExtension ace, int order)
Parameters
AdaptiveCardExtension ace

ACE to add
System.Int32 order

Order of the ACE in the dashboard

NewACE(Guid, CardSize)

Creates a new ACE for adding on the dashboard based upon the default settings of the

Declaration
AdaptiveCardExtension NewACE(Guid aceId, CardSize cardSize = default(CardSize))
Parameters
Guid aceId

ID of the ace to instantiate
CardSize cardSize

Card to use when the ACE is added to the dashboard
Returns
AdaptiveCardExtension

Configured ACE, ready for customization and adding

NewACE(DefaultACE, CardSize)

Creates a new ACE for adding on the dashboard based upon the default settings of the

Declaration
AdaptiveCardExtension NewACE(DefaultACE defaultACE, CardSize cardSize = default(CardSize))
Parameters
DefaultACE defaultACE

OOB ace to instantiate
CardSize cardSize

Card to use when the ACE is added to the dashboard
Returns
AdaptiveCardExtension

Configured ACE, ready for customization and adding

RegisterCustomACEFactory(ACEFactory)

Allows Dashboard to read custom Adaptive Card Extension as a custom ACE with custom properties. Once used You can access custom ACEs by dashboard.ACEs.OfTypeT();

Declaration
void RegisterCustomACEFactory(ACEFactory aceFactory)
Parameters
ACEFactory aceFactory

An implementation of ACEFactory for your custom ACE

RemoveACE(Guid)

Removes ACE with provided Guid from the Dashboard

Declaration
void RemoveACE(Guid instanceId)
Parameters
Guid instanceId

Save()

Saves changes made to ACEs by persisting the dashboard

Declaration
void Save()

SaveAsync()

Saves changes made to ACEs by persisting the dashboard

Declaration
Task SaveAsync()
Returns
Task

UpdateACE(AdaptiveCardExtension)

Updates an existing dashboard ACE

Declaration
void UpdateACE(AdaptiveCardExtension ace)
Parameters
AdaptiveCardExtension ace

ACE to update

UpdateACE(AdaptiveCardExtension, Int32)

Updates an existing dashboard ACE

Declaration
void UpdateACE(AdaptiveCardExtension ace, int order)
Parameters
AdaptiveCardExtension ace

ACE to update
System.Int32 order

Order of the ACE in the dashboard