Partilhar via

driveItem: pré-visualização

  • Artigo

Namespace: microsoft.graph

Importante

As APIs na versão /beta no Microsoft Graph estão sujeitas a alterações. Não há suporte para o uso dessas APIs em aplicativos de produção. Para determinar se uma API está disponível na v1.0, use o seletor Versão.

Esta ação permite-lhe obter URLs incorporados de curta duração para um item para compor uma pré-visualização temporária.

Se quiser obter ligações incorporáveis de longa duração, utilize a API createLink .

Nota: Atualmente, a ação de pré-visualização só está disponível no SharePoint e no OneDrive para Empresas.

Esta API está disponível nas seguintes implementações de cloud nacionais.

Serviço global US Government L4 US Government L5 (DOD) China operada pela 21Vianet
✅ ✅ ✅ ✅

Permissões

Escolha a permissão ou permissões marcadas como menos privilegiadas para esta API. Utilize uma permissão ou permissões com privilégios mais elevados apenas se a sua aplicação o exigir. Para obter detalhes sobre as permissões delegadas e de aplicação, veja Tipos de permissão. Para saber mais sobre estas permissões, veja a referência de permissões.

Tipo de permissão Permissões com menos privilégios Permissões com privilégios superiores
Delegado (conta corporativa ou de estudante) Files.Read Files.Read.All, Files.ReadWrite, Files.ReadWrite.All, Sites.Read.All, Sites.ReadWrite.All
Delegado (conta pessoal da Microsoft) Sem suporte. Sem suporte.
Application Files.Read.All Files.ReadWrite.All, Sites.Read.All, Sites.ReadWrite.All

Solicitação HTTP

POST /drives/{driveId}/items/{itemId}/preview
POST /groups/{groupId}/drive/items/{itemId}/preview
POST /me/drive/items/{itemId}/preview
POST /sites/{siteId}/drive/items/{itemId}/preview
POST /users/{userId}/drive/items/{itemId}/preview
POST /shares/{shareId}/driveItem/preview

Corpo da solicitação

O corpo do pedido define as propriedades do URL incorporado que a sua aplicação está a pedir. A solicitação deve ser um objeto JSON com as seguintes propriedades.

Nome Tipo Descrição
visualizador string Opcional. Pré-visualizar aplicação a utilizar. onedrive ou office. Se for nulo, será escolhido automaticamente um visualizador adequado.
sem cromado Booleano Opcional. Se true (predefinição), a vista incorporada não incluirá quaisquer controlos.
allowEdit Booleano Opcional. Se true, o ficheiro pode ser editado a partir da IU incorporada.
page cadeia/número Opcional. Número de página do documento a iniciar, se aplicável. Especificado como cadeia para casos de utilização futuros em torno de tipos de ficheiro, como ZIP.
zoom number Opcional. Nível de zoom para começar em, se aplicável.

Resposta

{
    "getUrl": "https://www.onedrive.com/embed?foo=bar&bar=baz",
    "postParameters": "param1=value&param2=another%20value",
    "postUrl": "https://www.onedrive.com/embed_by_post"
}

A resposta será um objeto JSON que contém as seguintes propriedades:

Nome Tipo Descrição
getUrl string URL adequado para incorporação com HTTP GET (iframes, etc.)
postUrl cadeia de caracteres URL adequado para incorporação com HTTP POST (post de formulário, JS, etc.)
postParameters cadeia de caracteres Parâmetros POST a incluir se utilizar postUrl

GetUrl, postUrl ou ambos podem ser devolvidos consoante o estado atual do suporte de incorporação para as opções especificadas.

postParameters é uma cadeia formatada como application/x-www-form-urlencodede, se efetuar um POST no postUrl, o tipo de conteúdo deve ser definido em conformidade. Por exemplo:

POST https://www.onedrive.com/embed_by_post
Content-Type: application/x-www-form-urlencoded

param1=value&param2=another%20value

Visualizadores

Nota: Este parâmetro foi preterido e não será disponibilizado no ponto final v1.0.

Os seguintes valores são permitidos para o parâmetro visualizador .

Valor do tipo Descrição
(nulo) Escolhe uma aplicação adequada para compor o ficheiro. Na maioria dos casos, isto irá utilizar o pré-visualizador, mas pode variar consoante o onedrive tipo de ficheiro.
onedrive Utilize a aplicação pré-visualizador do OneDrive para compor o ficheiro.
office Utilize a versão Web do Office para compor o ficheiro. Apenas válido para documentos do Office.

Chrome vs chromeless

Nota: Este parâmetro foi preterido e não será disponibilizado no ponto final v1.0.

Se chromeless for verdadeiro, a pré-visualização será uma composição simples do ficheiro. Caso contrário, poderão ser apresentados botões/barras de ferramentas adicionais para interagir com o documento/vista.

Ver/editar

Nota: Este parâmetro foi preterido e não será disponibilizado no ponto final v1.0.

Se allowEdit for verdadeiro, o documento pode ser modificado pela interação do utilizador com a pré-visualização incorporada. Esta capacidade pode não estar disponível para todos os tipos de ficheiro ou aplicações de pré-visualização.

Página/zoom

As page opções e zoom poderão não estar disponíveis para todas as aplicações de pré-visualização, mas serão aplicadas se a aplicação de pré-visualização o suportar.