Search Results for

    Show / Hide Table of Contents

    Interface ISharePointAddIn

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

    Inherited Members
    ILegacyPrincipal.AppIdentifier
    ILegacyPrincipal.ServerRelativeUrl
    ILegacyPrincipal.AbsoluteUrl
    ILegacyPrincipal.Title
    ILegacyPrincipal.AllowAppOnly
    ILegacyPrincipal.SiteCollectionScopedPermissions
    ILegacyPrincipal.TenantScopedPermissions
    Namespace: PnP.Core.Admin.Model.SharePoint
    Assembly: PnP.Core.Admin.dll
    Syntax
    public interface ISharePointAddIn : ILegacyPrincipal

    Properties

    AppInstanceId

    Instance ID of this app

    Declaration
    Guid AppInstanceId { get; }
    Property Value
    Guid

    AppSource

    The source of this addin

    Declaration
    SharePointAddInSource AppSource { get; }
    Property Value
    SharePointAddInSource

    AppWebFullUrl

    The full URL of the app web created by the addin

    Declaration
    string AppWebFullUrl { get; }
    Property Value
    System.String

    AppWebId

    Id of the app web created by the addin

    Declaration
    Guid AppWebId { get; }
    Property Value
    Guid

    AssetId

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

    Declaration
    string AssetId { get; }
    Property Value
    System.String

    CreationTime

    Date and time when the addin was installed

    Declaration
    DateTime CreationTime { get; }
    Property Value
    DateTime

    CurrentSiteId

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

    Declaration
    Guid CurrentSiteId { get; }
    Property Value
    Guid

    CurrentWebFullUrl

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

    Declaration
    string CurrentWebFullUrl { get; }
    Property Value
    System.String

    CurrentWebId

    Id of the web where the addin actually is listed for

    Declaration
    Guid CurrentWebId { get; }
    Property Value
    Guid

    CurrentWebName

    Name of the web where the addin actually is listed for

    Declaration
    string CurrentWebName { get; }
    Property Value
    System.String

    InstalledBy

    Name of the user who installed the addin

    Declaration
    string InstalledBy { get; }
    Property Value
    System.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

    Declaration
    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

    Declaration
    string InstalledWebFullUrl { get; }
    Property Value
    System.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

    Declaration
    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

    Declaration
    string InstalledWebName { get; }
    Property Value
    System.String

    LaunchUrl

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

    Declaration
    string LaunchUrl { get; }
    Property Value
    System.String

    LicensePurchaseTime

    When was the app license purchased

    Declaration
    DateTime LicensePurchaseTime { get; }
    Property Value
    DateTime

    Locale

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

    Declaration
    string Locale { get; }
    Property Value
    System.String

    ProductId

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

    Declaration
    Guid ProductId { get; }
    Property Value
    Guid

    PurchaserIdentity

    Identity of the user that purchased the app

    Declaration
    string PurchaserIdentity { get; }
    Property Value
    System.String

    Status

    Status of the addin

    Declaration
    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

    Declaration
    string TenantAppData { get; }
    Property Value
    System.String

    TenantAppDataUpdateTime

    When was the TenantAppData last updated?

    Declaration
    DateTime TenantAppDataUpdateTime { get; }
    Property Value
    DateTime

    Back to top PnP Core SDK
    Generated by DocFX with Material UI
    spacer