StartPage 元素 (PropertiesDefinition complexType)

(SharePoint 外接程序清单)

适用范围:SharePoint 外接程序|SharePoint Foundation 2013 |SharePoint Server 2013

通常,启动 SharePoint 外接程序时访问的页面的 URL。 但是,它也可以是控制器方法的 URL,也可以是启动外接程序时调用的 Web 服务方法的 URL。

注意

该字符串 app 显示为某些元素、属性和文件名的一部分或全部,因为 SharePoint 外接程序最初称为“SharePoint 应用程序”。为确保向后兼容性,架构尚未更改。

AppPrincipal 元素的子元素不是 Internal 时, StartPage 元素中指定的页面必须是支持 POST 谓词 (以及 GET) 的文件类型,以便可以在请求正文上发送 OAuth 上下文令牌。

通常在 Web 服务器中配置为支持 POST 的常见文件类型包括 aspx、php 以及支持服务器端代码的其他类型。 具有内部外接程序主体的外接程序不使用 OAuth,因此,此类外接程序的起始页可以是目标 Web 服务器中未配置为支持 POST 的类型。 例如,HTML 文件通常不支持 POST。

    <StartPage>http://domain_of_remote_component/Home.aspx?{StandardTokens}</StartPage>

如果远程 Web 服务器在协议为 HTTP 时将远程组件绑定到端口 80 以外的端口;如果协议为 HTTPS,则将远程组件绑定到 443 以外的端口,则必须显式包含该端口,如以下示例所示。

    <StartPage>http://domain_of_remote_component:3333/Home.aspx?{StandardTokens}</StartPage>

此元素的值可以包含某些标记,用于表示开发时未知的信息。 上面的“{StandardTokens}”就是一个示例。 有关详细信息,请参阅 SharePoint 外接程序中的 URL 字符串和标记

在 Visual Studio 中调试时,适用于 Visual Studio 的 Microsoft Office 开发人员工具使用令牌 ~remoteWebUrl' 来代替协议和域,如以下示例所示。

    <StartPage>~remoteWebUrl/Home.aspx?{StandardTokens}</StartPage>

当使用 Visual Studio 中 SharePoint 外接程序项目的上下文菜单上的 “发布 ”选项打包加载项时,该令牌将自动替换为实际协议和域 (和端口(如果需要),) 由适用于 Visual Studio 的 Office 开发人员工具进行打包。 如果不使用发布向导 (或这样做,但远程组件正在部署到 Azure) ,则必须在打包 SharePoint 外接程序之前手动替换令牌。

如果外接程序使用 OAuth,则 StartPage 值的域部分必须与向 Microsoft Azure 访问控制 服务注册 SharePoint 外接程序时指定的外接程序域完全匹配, (ACS) 。 有关详细信息,请参阅 注册 SharePoint 外接程序

重要

作为 Azure Active Directory (Azure AD) 的一项服务,Azure 访问控制 (ACS) 将于 2018 年 11 月 7 日停用。 此停用不会影响使用 https://accounts.accesscontrol.windows.net 主机名(不受此停用影响)的 SharePoint 加载项模型。 有关详细信息,请参阅停用 Azure 访问控制对 SharePoint 加载项的影响

元素信息

信息 位置
元素类型 UrlElementDefinition
命名空间 http://schemas.microsoft.com/sharepoint/2012/app/manifest
架构文件 appmanifest.xsd

定义

    <xs:element name="StartPage" type="UrlElementDefinition" minOccurs="1" maxOccurs="1" >
         </xs:element>

元素和属性

如果架构定义了特定要求(如 sequenceminOccursmaxOccurschoice),请参阅定义部分。

父元素

元素

类型

说明

Properties

PropertiesDefinition

包含加载项的全局信息。

子元素

无。

Attributes

无。