Usar plug-ins do Cordova específicos para o AEM Mobile

entityName:
String – o nome da entidade

entityType:
String – o tipo da entidade

forceUpdate:
Booliano– se “verdadeiro”, sempre perguntar ao servidor sobre a versão mais recente

success:
função – o retorno de sucesso

error:
função – o retorno do erro

quando bem-sucedido: um objeto da Entidade

Observação: vazio é um valor de retorno permitido para banners dinâmicos (já que esta não é uma propriedade obrigatória para este tipo de entidade)

falha: objeto cq.mobile.contextError com a propriedade do código preenchida

Suporta artigo, banner, coleção e banner dinâmico

entityName deve corresponder ao nome (não ao título) encontrado nos serviços sob demanda.

entityType deve corresponder aos valores encontrados em Entity.type

Se forceUpdate for falso e a entidade estiver armazenada em cache, essa entidade será retornada. Nem sempre será a versão mais recente dessa entidade.

Se forceUpdate for verdadeiro, mas não for possível se conectar ao servidor, a entidade existente será retornada se disponível no cache. Se nada existir no cache, um erro de rede será retornado.

Se não for possível conectar-se ao servidor e a entidade solicitada não for encontrada (ou ela é restrita e o usuário não está autorizado), a mensagem de erro “Entidade não encontrada” será retornada.

entityOrEntityList:
objeto Entity ou EntityList – a entidade ou entidades para recuperar as informações de direito

success:
função – o retorno de sucesso

error:
função – o retorno do erro

quando bem-sucedido:

[
{
“entityName” : <entityName1>,
“isEntitled” : verdadeiro ou falso
},
{
“entityName” : <entityName2>,
“isEntitled” : verdadeiro ou falso
},
]

falha: objeto cq.mobile.contextError com a propriedade preenchida do código

Suporte a coleção

O getEntitlementInfo() retornará apenas informações de direito para coleções. Se um objeto Entity que não faz parte da coleção for transmitido, o erro “Tipo errado de entidade” é retornado.

Se um objeto EntityList for transmitido, apenas o entitlementInfo para objetos da coleção será retornado. Se não houver coleções, a matriz de retorno estará em branco.

A 26ª solicitação (e qualquer solicitação subsequente) a essa API dentro de um período de um minuto retornará o erro “Limite de rede excedido”.

Se o dispositivo estiver offline, todas as informações de direito armazenadas em cache serão retornadas.

Se o dispositivo estiver online e não for possível contatar o serviço de direito, um erro de rede será retornado.

entity: O status de download da coleção.

success: função - o retorno de sucesso

error: função - o retorno do erro

sucesso:
{ "entityName" : "isSavable" : "progressPercent" :  "downloadState" : }

falha: objeto cq.mobile.contextError com a propriedade do código preenchida

Suporte a coleção

O getEntityStatus() recupera as informações de status do download para a entidade da coleção.

Informações sobre status:

"entityName": o nome da entidade da coleção.

"isSavable": a coleção deve ser marcada como baixar (salvar) permitido em propriedades de coleção, e deve ter direitos suficientes para retornar um valor verdadeiro.

"progressPercent" : quantidade da coleção atualmente sendo baixada de 0 a 100 por cento. Observação: este valor pode não ser sempre preciso se a informação foi apagada da memória. Consulte os estados de download posteriormente neste documento.

Erro: o getEntityStatus() retornará apenas informações de status de direito para coleções. Se um objeto entidade que não faz parte da coleção for transmitido, não encontrado ou não tiver sido inicializado, um erro é retornado. Consulte a lista de erros posteriormente neste documento.

entity: A coleção para baixar e salvar.

isSilent: BOOL - (Apenas para Android) se verdadeiro, a entidade é salva no fundo sem nenhuma notificação.

success: função - o retorno de sucesso.

error: função - o retorno do erro.

sucesso: { "rawEntity" : "downloadPercent" : "downloadState" }

falha: erro com a propriedade do código preenchida

Suporte a coleção

O saveEntity() baixará e salvará a entidade de tal coleção. É o equivalente a clicar no botão de download na UI.

Retorno de sucesso: O retorno de sucesso retorna o objeto da entidade sendo salva. Além disso, o retorno de sucesso será chamado toda vez que houver uma atualização de progresso do download. O progresso pode ser acompanhado por meio dos valores de retorno "downloadPercent" e "downloadState". Quando o salvar/baixar for iniciado, o download da coleção deve se tornar o download ativo atual. Se outro download de coleção for iniciado, essa coleção se tornará o download ativo, e a primeira coleção será pausada. A primeira coleção voltará a ser baixada e o estado ficará ativo quando a segunda coleção terminar de baixar.

Erro: o saveEntity() baixará apenas coleções. Se um objeto entidade que não faz parte da coleção for transmitido, se a coleção não for encontrada ou se o download for cancelado, um erro é retornado. Consulte a lista de erros posteriormente neste documento.

entity: Objeto de entidade – a entidade a ser arquivada (deixar de salvar)

success: função - o retorno de sucesso

error: função - o retorno do erro

sucesso: um objeto da entidade

falha: um erro com a propriedade do código preenchida

Suporte a coleção

O archiveEntity() arquivará (o oposto do saveEntity()) a entidade de tal coleção. É o equivalente a clicar no botão de marca de seleção na UI. Se a coleção for completamente baixada e salva, o archiveEntity marcará a coleção como não persistente e passiva de remoção. Caso a coleção esteja baixando ativamente ou esteja na fila para baixar, o download será cancelado e o conteúdo que foi baixado será marcado como removível.

Sucesso: o objeto da entidade arquivado é retornado.

Erro: o archiveEntity() arquivará apenas coleções. Se um objeto entidade que não faz parte da coleção for transmitido ou se a coleção não for encontrada, um erro é retornado.

success: função - o retorno de sucesso

error: função - o retorno do erro

sucesso: gama de objetos da Entidade

falha: erro com a propriedade do código preenchida

Suporte a coleção

getSavedEntities() retornará uma gama de objetos entidade que estão completamente baixados ou na fila para serem baixados, e serão salvos.

width: número - a largura solicitada

height: número - a altura solicitada

success: função - o retorno de sucesso

error: função - o retorno do erro

quando bem-sucedido: um URL de arquivo para a imagem de fundo como argumento do retorno success

falha: objeto cq.mobile.contextError com a propriedade preenchida do código

Suporte a coleção

O visualizador do tempo de execução não dimensiona a imagem, em vez disso, ele retornará o tamanho da imagem que estiver mais próximo ao tamanho especificado.

Solicitará a imagem de fundo do serviços sob demanda, se a imagem não for armazenada em cache no dispositivo. Na maioria dos casos, a imagem permanecerá no cache para futuro imediato.

Se houver tentativa de chamada em entidades de tipo diferente de Coleção, o retorno de erro será chamado.

width: número - a largura solicitada

height: número - a altura solicitada

success: função - o retorno de sucesso

error: função - o retorno do erro

quando bem-sucedido: um URL de arquivo para a imagem em miniatura como argumento do retorno success

falha: objeto cq.mobile.contextError com a propriedade do código preenchida

Suporta artigo, banner, coleção e banner dinâmico

O visualizador do tempo de execução não dimensiona a imagem, em vez disso, ele retornará o tamanho da imagem que estiver mais próximo ao tamanho especificado.

Solicitará a imagem em miniatura do serviços sob demanda, se a imagem não for armazenada em cache no dispositivo. Na maioria dos casos, a imagem permanecerá no cache para futuro imediato.

width: número - a largura solicitada

height: número - a altura solicitada

success: função - o retorno de sucesso

error: função - o retorno do erro

quando bem-sucedido: um URL de arquivo para a imagem de compartilhamento em redes sociais como argumento do retorno success

falha: objeto cq.mobile.contextError com a propriedade preenchida do código

Suporte a artigos

O visualizador do tempo de execução não dimensiona a imagem, em vez disso, ele retornará o tamanho da imagem que estiver mais próximo ao tamanho especificado.

Solicitará a imagem de compartilhamento em redes sociais dos serviços sob demanda, se a imagem não for armazenada em cache no dispositivo. Na maioria dos casos, a imagem permanecerá no cache para futuro imediato.

Se houver tentativa de chamada em entidades de tipo diferente de Coleção, o retorno de erro será chamado.

success:
função - o retorno de sucesso

error:
função - o retorno do erro

quando bem-sucedido: um objeto EntityList

falha: objeto cq.mobile.contextError com a propriedade preenchida do código

Suporte a coleção

EntityList conterá todas as entidades-filha não restritas para esta coleção que estão no cache. Se não houver nenhuma, há a tentativa de baixar a primeira página do servidor das filhas.

success: função - o retorno de sucesso

error: função - o retorno do erro

Suporte a artigos

O objeto ContentLocation inclui pageNumber e totalPageCount.
O pageNumber tem base zero, portanto, 0 é a primeira página do artigo. Esses valores refletem a localização física do conteúdo no artigo. Em artigos HTML, totalPageCount é 1 e pageNumber será 0.

authToken: string - o valor solicitado para authToken

success: função - o retorno de sucesso

error: função - o retorno do erro

quando bem-sucedido: chama o retorno do sucesso sem parâmetros

falha: chama o retorno do erro com o conjunto de código cq.mobile.userError

Esta chamada será executada com êxito somente em projetos que tiverem uma configuração de provedor de identidade genérica ou que tiverem apenas um provedor de direito direto (sem provedor de identidade). Caso contrário, um erro de suporte de autenticação será retornado quando essa API for chamada.

Se a chamada do setAuthToken falhar por algum motivo (erro 502, 503 ou 504 é retornado), idealmente, o visualizador fará mais uma tentativa. Se a nova tentativa falhar ou não houver outra tentativa, um erro de rede será retornado.
Qualquer solicitação feita para esta API enquanto uma solicitação anterior estiver a caminho retornará um erro de limite de taxa de rede excedido até que todas as solicitações anteriores retornem com sucesso ou falha.

A 11ª solicitação para esta API dentro de um período de um minuto retornará um erro de limite de taxa de rede excedido, assim como todas as solicitações subsequentes à 11ª, até que um minuto decorra desde a primeira solicitação.

Se a autenticação ocorrer por meio de um servidor de direito, a caixa de diálogo nativa de logon será exibida.

Se a autenticação ocorrer por meio de um provedor de identidade, o URL de autenticação será exibido em uma exibição da Web nos visualizadores do dispositivo, ou ele redireciona para o URL de autenticação no visualizador da Web para desktop.

Se nenhuma autenticação for especificada no projeto, chamar essa API retornará um erro de suporte à autenticação.

Se o usuário já estiver autenticado, um erro de status de autenticação inválido será retornado.

Se o visualizador da Web não puder recuperar as configurações de autenticação, um erro de rede será retornado.

Os usuários ainda podem sair dos visualizadores do dispositivo quando estiverem offline.

Desconecta o usuário e atualiza o estado desconectado para ser refletido na interface.

Se nenhuma autenticação for especificada no projeto, chamar essa API retornará um erro de suporte à autenticação.

Se o usuário já estiver autenticado, um erro de status de autenticação inválido será retornado.

Se não puder sair do visualizador da Web, um erro de rede será retornado.

Os visualizadores do dispositivo usarão configurações de autenticação em cache se não for possível recuperar as configurações de autenticação.

success: função - o retorno de sucesso

error: função - o retorno do erro

quando bem-sucedido: chama o retorno do sucesso sem parâmetros

falha: chama o retorno do erro com o conjunto de código cq.mobile.userError

Use essa API para tentar atualizar o logon do usuário somente quando você determinar que a sessão atual não é mais válida. Essa API atualizará o logon somente em dois casos:

1) O projeto é configurado com um serviço de direito, mas sem autenticação personalizada. A chamada dessa API resultará na chamada do renewAuthToken no serviço de direito.

2) O projeto é configurado com um provedor de identidade OAuth, que fornece um token atualizado. A chamada dessa API tentará usar o token atualizado para atualizar a sessão de logon.

Em ambos os casos, a atualização pode não ser concluída com êxito. Se isso ocorrer, o usuário será desconectado.

Em todos os outros casos, incluindo se essa API for chamada em uma configuração do projeto com um provedor de identidade SAML ou OAuth que não dá suporte à atualização, esta atualização falhará, desconectará o usuário e retornará para a página inicial.

Se nenhuma autenticação for especificada no projeto, chamar essa API retornará um erro de suporte à autenticação.

Se o usuário não for autenticado, um erro de status de autenticação inválido será retornado.

Se os visualizadores estiverem offline e o logon não puder ser atualizado, um erro de rede será retornado.

Os visualizadores do dispositivo usarão configurações de autenticação em cache se não for possível recuperar as configurações de autenticação.

success: o retorno de sucesso

error: o retorno do erro

Este método retorna as informações de assinatura para a publicação e dispositivo atual. Após 60 solicitações de API feitas em um período de um minuto, qualquer solicitação subsequente a esta API retornará um erro, até que um minuto decorra desde a primeira solicitação.

O visualizador da Web para desktop não oferece suporte a esta API e sempre retorna um erro.

collectionName: string ‑ o nome da coleção

success: função - o retorno de sucesso

error: função - o retorno do erro

sucesso: gama de objetos de oferta

falha: um erro com a propriedade do código preenchida

collectionName deve corresponder ao nome encontrado no Portal.

Se a entidade solicitada não puder ser encontrada, ou se estiver restrita e não visível, um erro é retornado.

Ofertas em cache para a entidade solicitada são retornadas se disponíveis. Caso contrário, uma solicitação de rede para o serviço de direito ocorrerá para pegar as ofertas.

Após 60 solicitações de rede feitas para o serviço de direito em um período de um minuto, qualquer solicitação subsequente a esta API resultará em um erro, até que um minuto decorra desde a primeira solicitação.

O visualizador da Web para desktop não oferece suporte a esta API e sempre retorna um erro.

ID do produto: string - A ID do produto da oferta de compra

success: função - o retorno de sucesso

error: função - o retorno do erro

sucesso: uma solicitação de compra é iniciada

falha: chama o código de erro

success: função - o retorno de sucesso

error: função - o retorno do erro

sucesso: uma solicitação de compra de restauração é iniciada

falha: chama o código de erro

Este método iniciará a restauração de compras anteriores para o usuário.

Após 5 solicitações de API serem feitas em um período de um minuto, qualquer solicitação subsequente a esta API retornará um erro, até que um minuto decorra desde a primeira solicitação.