Table of Contents

Interface ISharePointAddIn

Namespace
PnP.Core.Admin.Model.SharePoint
Assembly
PnP.Core.Admin.dll

Describes the properties of a SharePoint AddIn when installed in a site

public interface ISharePointAddIn : ILegacyPrincipal
Inherited Members

Properties

AppInstanceId

Instance ID of this app

Guid AppInstanceId { get; }

Property Value

Guid

AppSource

The source of this addin

SharePointAddInSource AppSource { get; }

Property Value

SharePointAddInSource

AppWebFullUrl

The full URL of the app web created by the addin

string AppWebFullUrl { get; }

Property Value

string

AppWebId

Id of the app web created by the addin

Guid AppWebId { get; }

Property Value

Guid

AssetId

The id of the app in the office store, this will be empty for user uploaded apps

string AssetId { get; }

Property Value

string

CreationTime

Date and time when the addin was installed

DateTime CreationTime { get; }

Property Value

DateTime

CurrentSiteId

Id of the site collection where the addin actually is listed for

Guid CurrentSiteId { get; }

Property Value

Guid

CurrentWebFullUrl

Fully qualified URL of the web where the addin actually is listed for

string CurrentWebFullUrl { get; }

Property Value

string

CurrentWebId

Id of the web where the addin actually is listed for

Guid CurrentWebId { get; }

Property Value

Guid

CurrentWebName

Name of the web where the addin actually is listed for

string CurrentWebName { get; }

Property Value

string

InstalledBy

Name of the user who installed the addin

string InstalledBy { get; }

Property Value

string

InstalledSiteId

Id of the site collection where the addin actually is installed. This can be different from the site collection where the addin was listed as being available

Guid InstalledSiteId { get; }

Property Value

Guid

InstalledWebFullUrl

Fully qualified URL of the web where the addin actually is installed. This can be different from the web where the addin was listed as being available

string InstalledWebFullUrl { get; }

Property Value

string

InstalledWebId

Id of the web where the addin actually is installed. This can be different from the web where the addin was listed as being available

Guid InstalledWebId { get; }

Property Value

Guid

InstalledWebName

Name of the web where the addin actually is installed. This can be different from the web where the addin was listed as being available

string InstalledWebName { get; }

Property Value

string

LaunchUrl

Where to redirect after clicking on the add-in (e.g. ~appWebUrl/Pages/Default.aspx?{StandardTokens})

string LaunchUrl { get; }

Property Value

string

LicensePurchaseTime

When was the app license purchased

DateTime LicensePurchaseTime { get; }

Property Value

DateTime

Locale

Locale used by the web where the add-in is installed

string Locale { get; }

Property Value

string

ProductId

The global unique id of the add-in. It is same for all tenants

Guid ProductId { get; }

Property Value

Guid

PurchaserIdentity

Identity of the user that purchased the app

string PurchaserIdentity { get; }

Property Value

string

Status

Status of the addin

SharePointAddInStatus Status { get; }

Property Value

SharePointAddInStatus

TenantAppData

After the add-in installed in the tenant app catalog site. It could enable tenant level usage. This data indicates the tenant the conditions how to filter the webs. See https://learn.microsoft.com/en-us/sharepoint/dev/sp-add-ins/tenancies-and-deployment-scopes-for-sharepoint-add-ins for more details

string TenantAppData { get; }

Property Value

string

TenantAppDataUpdateTime

When was the TenantAppData last updated?

DateTime TenantAppDataUpdateTime { get; }

Property Value

DateTime
Edit this page