Interface IAppManager<T>

App Admin features

Inherited Members
Namespace: PnP.Core.Admin.Model.SharePoint
Assembly: PnP.Core.Admin.dll
Syntax
public interface IAppManager<T> : IAppOperations where T : IApp
Type Parameters
T

Properties

ServicePrincipal

Get the SharePoint Apps Service Principal enabling you to approve/reject permissions requests

Declaration
IServicePrincipal ServicePrincipal { get; }
Property Value
IServicePrincipal

Methods

Add(Byte[], String, Boolean)

Uploads a file to the app catalog.

Declaration
T Add(byte[] file, string fileName, bool overwrite = false)
Parameters
System.Byte[] file

A byte array containing the file.
System.String fileName

The filename (e.g. myapp.sppkg) of the file to upload.
System.Boolean overwrite

If true will overwrite an existing entry.
Returns
T

An instance of the app.

Add(String, Boolean)

Uploads an app file to the app catalog.

Declaration
T Add(string path, bool overwrite = false)
Parameters
System.String path

System.Boolean overwrite

If true will overwrite an existing entry.
Returns
T

An instance of the app.

AddAsync(Byte[], String, Boolean)

Uploads a file to the app catalog.

Declaration
Task<T> AddAsync(byte[] file, string fileName, bool overwrite = false)
Parameters
System.Byte[] file

A byte array containing the file.
System.String fileName

The filename (e.g. myapp.sppkg) of the file to upload.
System.Boolean overwrite

If true will overwrite an existing entry.
Returns
Task<T>

An instance of the app.

AddAsync(String, Boolean)

Uploads an app file to the app catalog.

Declaration
Task<T> AddAsync(string path, bool overwrite = false)
Parameters
System.String path

System.Boolean overwrite

If true will overwrite an existing entry.
Returns
Task<T>

An instance of the app.

GetAvailable()

Gets all available apps from the app catalog.

Declaration
IList<T> GetAvailable()
Returns
IList<T>

A collection of apps.

GetAvailable(Guid)

Gets available app by it's unique id.

Declaration
T GetAvailable(Guid id)
Parameters
Guid id

The unique id of the app. Notice that this is not the product id as listed in the app catalog.
Returns
T

An instance of the app.

GetAvailable(String)

Gets available app by it's title.

Declaration
T GetAvailable(string title)
Parameters
System.String title

An app's title.
Returns
T

An instance of the app.

GetAvailableAsync()

Gets all available apps from the app catalog.

Declaration
Task<IList<T>> GetAvailableAsync()
Returns
Task<IList<T>>

A collection of apps.

GetAvailableAsync(Guid)

Gets available app by it's unique id.

Declaration
Task<T> GetAvailableAsync(Guid id)
Parameters
Guid id

The unique id of the app. Notice that this is not the product id as listed in the app catalog.
Returns
Task<T>

An instance of the app.

GetAvailableAsync(String)

Gets available app by it's title.

Declaration
Task<T> GetAvailableAsync(string title)
Parameters
System.String title

An app's title.
Returns
Task<T>

An instance of the app.