tipo de recurso de atividade

Namespace: microsoft.graph

Representa uma única atividade dentro de um aplicativo - por exemplo, um programa de TV, um documento ou uma campanha atual em um videogame. Quando um usuário se envolve com essa atividade, o compromisso é capturado como um item de histórico que indica a hora de início e término dessa atividade. À medida que o usuário se envolve novamente com essa atividade ao longo do tempo, vários itens de histórico são registrados para uma única atividade de usuário.

Você pode usar atividades no Microsoft Graph para permitir que os usuários voltem ao que estavam fazendo em seu aplicativo, em vários dispositivos. As atividades que seu aplicativo cria aparecem nos dispositivos de todos os usuários e são expostas aos usuários como links profundos para conteúdo específico em seu aplicativo. Você pode expressar conteúdo específico em seu aplicativo como um destino exibido no Windows e acessível em dispositivos iOS e Android por meio de notificações da Cortana.

Como cada aplicativo é diferente, cabe a você entender a melhor maneira de mapear ações em seu aplicativo para atividades de usuário que serão exibidas na Cortana e na Linha do Tempo. Por exemplo, os jogos podem criar uma atividade para cada campanha, aplicativos de criação de documentos podem criar uma atividade para cada documento exclusivo e aplicativos de linha de negócios podem criar uma atividade para cada fluxo de trabalho.

Suas atividades de usuário serão exibidas em experiências de usuário da Cortana e do Windows Timeline, que estão focadas em aumentar a produtividade e a eficiência dos usuários, ajudando-os a voltar ao conteúdo em que trabalharam no passado.

Métodos

Método	Tipo de retorno	Descrição
Criar ou substituir atividade	atividade	Cria ou substitui uma atividade existente (upsert). O appActivityId precisa ser seguro para URL (todos os caracteres, exceto os caracteres rfc 2396 sem reservas, devem ser convertidos em sua representação hexadecimal), mas o app originalActivityId não precisa ser seguro para URL.
Excluir uma atividade	Sem Conteúdo	Exclui a atividade especificada para esse usuário do seu aplicativo.
Obter atividades	Coleção de atividades	Obtém as atividades do aplicativo para um determinado usuário.
Obter atividades recentes	Coleção de atividades	Obtém as atividades mais recentes para seu aplicativo para um determinado usuário, classificadas e com base nos historyItems criados ou atualizados mais recentemente.

Propriedades

Nome	Tipo	Descrição
ativaçãoUrl	Cadeia de caracteres	Obrigatório. URL usada para iniciar a atividade na melhor experiência nativa representada pelo appId. Pode iniciar um aplicativo baseado na Web se nenhum aplicativo nativo existir.
activitySourceHost	Cadeia de caracteres	Obrigatório. URL para o domínio que representa o mapeamento de identidade entre plataformas para o aplicativo. O mapeamento é armazenado como um arquivo JSON hospedado no domínio ou configurável por meio do Centro de Desenvolvimento do Windows. O arquivo JSON é chamado de identificadores entre plataformas e aplicativos e está hospedado na raiz do domínio HTTPS, no domínio de nível superior ou inclui um sub domínio. Por exemplo: https://contoso.com ou https://myapp.contoso.com, mas NÃO https://myapp.contoso.com/somepath. Você deve ter um arquivo e um domínio exclusivos (ou sub domínio) por identidade de aplicativo entre plataformas. Por exemplo, um arquivo e um domínio separados são necessários para Word vs. PowerPoint.
appActivityId	Cadeia de caracteres	Obrigatório. A ID de atividade exclusiva no contexto do aplicativo – fornecida pelo chamador e imutável posteriormente.
appDisplayName	String	Opcional. Descrição de texto curto do aplicativo usado para gerar a atividade para uso em casos em que o aplicativo não está instalado no dispositivo local do usuário.
Contentinfo	Objeto JSON não tipado	Opcional. Um pedaço de dados personalizado – descrição extensível JSON-LD do conteúdo de acordo com schema.org sintaxe.
contentUrl	String	Opcional. Usado no caso de o conteúdo ser renderizado fora de uma experiência de aplicativo nativa ou baseada na Web (por exemplo, um ponteiro para um item em um feed do RSS).
createdDateTime	DateTimeOffset	Definido pelo servidor. DateTime no UTC quando o objeto foi criado no servidor.
expirationDateTime	DateTimeOffset	Definido pelo servidor. DateTime no UTC quando o objeto expirou no servidor.
fallbackUrl	String	Opcional. URL usada para iniciar a atividade em um aplicativo baseado na Web, se disponível.
id	Cadeia de caracteres	ID gerada pelo servidor usada para endereçamento de URL.
lastModifiedDateTime	DateTimeOffset	Definido pelo servidor. DateTime no UTC quando o objeto foi modificado no servidor.
status	status	Definido pelo servidor. Um código status usado para identificar objetos válidos. Valores: ativo, atualizado, excluído, ignorado.
userTimezone	String	Opcional. O fuso horário no qual o dispositivo do usuário usado para gerar a atividade estava localizado no momento da criação da atividade; valores fornecidos como IDs Olson para dar suporte à representação entre plataformas.
visualElements	visualInfo	Obrigatório. O objeto que contém informações para renderizar a atividade no UX.

Relações

Relação	Tipo	Descrição
historyItems	coleção activityHistoryItem	Opcional. NavigationProperty/Containment; propriedade navigation para historyItems da atividade.

Representação JSON

A representação JSON a seguir mostra o tipo de recurso.

{
    "appActivityId": "String",
    "activitySourceHost": "String (host name/domain/URL)",
    "userTimezone": "String",
    "appDisplayName": "String",
    "activationUrl": "String (URL)",
    "contentUrl": "String (URL)",
    "fallbackUrl": "String (URL)",
    "createdDateTime": "DateTimeOffset",
    "lastModifiedDateTime": "DateTimeOffset",
    "expirationDateTime": "DateTimeOffset",
    "id": "String",
    "status": "active | updated | deleted | ignored",
    "contentInfo": { "@odata.type": "microsoft.graph.Json" },
    "visualElements": { "@odata.type": "microsoft.graph.visualInfo" },
    "historyItems": [{ "@odata.type": "microsoft.graph.activityHistoryItem" }]
}