Interface IVivaDashboard

Namespace

PnP.Core.Model.SharePoint

Assembly

PnP.Core.dll

Represents Viva Dashboard page

public interface IVivaDashboard

Properties

ACEs

Returns list of ACEs added to the Dashboard

List<AdaptiveCardExtension> ACEs { get; }

Property Value

List<AdaptiveCardExtension>

Methods

AddACE(AdaptiveCardExtension)

Adds new ACE

void AddACE(AdaptiveCardExtension ace)

Parameters

ace AdaptiveCardExtension

ACE to add

AddACE(AdaptiveCardExtension, int)

Adds new ACE

void AddACE(AdaptiveCardExtension ace, int order)

Parameters

ace AdaptiveCardExtension

ACE to add

order int

Order of the ACE in the dashboard

NewACE(DefaultACE, CardSize)

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

AdaptiveCardExtension NewACE(DefaultACE defaultACE, CardSize cardSize = CardSize.Medium)

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

NewACE(Guid, CardSize)

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

AdaptiveCardExtension NewACE(Guid aceId, CardSize cardSize = CardSize.Medium)

Parameters

aceId Guid

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

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();

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

void RemoveACE(Guid instanceId)

Parameters

instanceId Guid

Save()

Saves changes made to ACEs by persisting the dashboard

void Save()

SaveAsync()

Saves changes made to ACEs by persisting the dashboard

Task SaveAsync()

Returns

Task

UpdateACE(AdaptiveCardExtension)

Updates an existing dashboard ACE

void UpdateACE(AdaptiveCardExtension ace)

Parameters

ace AdaptiveCardExtension

ACE to update

UpdateACE(AdaptiveCardExtension, int)

Updates an existing dashboard ACE

void UpdateACE(AdaptiveCardExtension ace, int order)

Parameters

ace AdaptiveCardExtension

ACE to update

order int

Order of the ACE in the dashboard