Elemento StartPage (PropertiesDefinition complexType)

Artigo
04/08/2023

(Manifesto de suplemento do SharePoint)

Aplica-se a: Suplementos do SharePoint | SharePoint Foundation 2013 | SharePoint Server 2013

Normalmente, a URL da página visitada quando o Suplemento do SharePoint é iniciado. No entanto, também pode ser a URL de um método de controlador ou um método de serviço Web que é invocado quando o suplemento é iniciado.

Observação

A cadeia de caracteres app aparece como parte ou de todos os nomes de elemento, atributo e arquivo porque os suplementos do SharePoint eram originalmente chamados de "aplicativos para SharePoint". Para garantir a compatibilidade com atraso, os esquemas não foram alterados.

Quando o elemento filho do elemento AppPrincipal não é Interno, a página especificada no elemento StartPage deve ser de um tipo de arquivo que dá suporte ao verbo POST (além de GET) para que o token de contexto OAuth possa ser enviado no corpo da solicitação.

Tipos de arquivo comuns que normalmente são configurados em servidores Web para dar suporte ao POST são aspx, php e outros tipos que dão suporte ao código do lado do servidor. Os suplementos que têm uma entidade de suplemento interno não usam o OAuth e, consequentemente, a página inicial desses suplementos pode ser um tipo que não está configurado no servidor Web de destino para dar suporte ao POST. Arquivos HTML, por exemplo, frequentemente não dão suporte a POST.

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

Se o servidor Web remoto associar o componente remoto a uma porta diferente de 80 quando o protocolo for HTTP ou 443 quando o protocolo for HTTPS, a porta deverá ser incluída explicitamente como no exemplo a seguir.

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

O valor desse elemento pode conter determinados tokens para representar informações que não são conhecidas no momento do desenvolvimento. O "{StandardTokens}" acima é um exemplo. Para obter mais informações, consulte As cadeias de caracteres da URL e tokens SharePoint Add-ins.

Quando você estiver depurando no Visual Studio, as Ferramentas de Desenvolvedor do Microsoft Office para Visual Studio usam o token ~remoteWebUrl' no lugar do protocolo e do domínio, como no exemplo a seguir.

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

O token é substituído automaticamente pelo protocolo real e pelo domínio (e porta, se necessário) pelas Ferramentas de Desenvolvedor do Office para Visual Studio quando o suplemento é empacotado usando a opção Publicar no menu de contexto do projeto suplemento do SharePoint no Visual Studio. Se você não usa o Assistente de Publicação (ou usa, mas o componente remoto está sendo implantado no Azure), você precisa substituir manualmente o token antes de empacotar o Suplemento do SharePoint.

Se o suplemento usar o OAuth, a parte de domínio do valor StartPage deverá corresponder exatamente ao Domínio de Suplemento especificado quando o Suplemento do SharePoint foi registrado no ACS (Serviço de Controle de Acesso do Microsoft Azure). Para obter mais informações, confira Registrar suplementos do SharePoint.

Importante

O Controle de Acesso do Azure (ACS), um serviço do Azure Active Directory (Azure AD) será desativado em 7 de novembro de 2018. Essa desativação não afeta o modele do Suplemento do SharePoint que usa o nome de host https://accounts.accesscontrol.windows.net (que não é afetado por ela). Para saber mais, confira Impacto da desativação do Controle de Acesso do Azure para Suplementos do SharePoint.

Elemento de informações

Informações	Local
Tipo de elemento	UrlElementDefinition
Namespace	`http://schemas.microsoft.com/sharepoint/2012/app/manifest`
Arquivo de esquema	appmanifest.xsd

Definição

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

Elementos e atributos

Se o esquema definir requisitos específicos, como sequence, minOccurs,maxOccurs e choice, confira a seção de definição.

Elementos pai

Elemento	Tipo	Descrição
Propriedades	PropertiesDefinition	Contém informações globais para o suplemento.

Elementos filho

Nenhum.

Atributos

Nenhum

Compartilhar via