要求

必备知识

  • 了解 AEM Mobile
  • 有关通过点播门户创建和发布内容的知识
  • JavaScript 的相关知识

必要的产品

  • AEM Mobile

简介

特定于 Experience Manager Mobile 的支持 Cordova 的插件是一组 JavaScript API,这些 API 提供了对与应用程序和要查看的当前文章相关的特定数据的访问权。要利用 AEM Mobile Cordova 插件,文章必须在点播服务门户上选中文章属性中的“启用可扩展性功能”选项或通过 On-Demand Services API 将文章实体元数据中的 isTrustedContent 参数设置为 true。

特定于 AEM Mobile 的支持 Cordova 的插件使用命名空间 cq.mobile 以避免与其他 Cordova 支持的插件发生冲突。此 API 包含多个模块,其中每个模块为具有一定数量的方法和属性的单一实例。

有关使用核心 Cordova API 的信息,请参阅使用 AEM Mobile 中的 Cordova 插件

支持 Cordova 的插件分为上下文、设备、应用程序和用户。

 

Cordova 示例

GetEntity API 视频

GetEntity API 视频

上下文 API

属性 – 上下文

此上下文模块提供了对给定上下文中的实体信息的访问权。

可用性

此插件定义全局 cq.mobile.context 对象。它在 deviceready 事件之后才可用。

名称 类型 可变 注释
cq.mobile.context.collection 实体1 如果当前上下文是孤立的上下文,则可为空 (null)。
cq.mobile.context.entity 实体1

返回范围内的实体。

范围:

  • 内容 WebView - WebView 中显示的内容。
  • 叠加 WebView - 叠加所属的内容。
  • 动态横幅 WebView – webview 所属的动态横幅。
cq.mobile.context.nextEntity 实体1

如果这是最后一个实体,则可为空 (null)。

注意:动态横幅的 next 实体是浏览视图中后接动态横幅的实体,可能不同于父集合的元素数组中的 next 实体。这不同于通过文章调用 nextEntity(将返回父集合的子元素数组中的顺序)时将发生的情况。

cq.mobile.context.previousEntity 实体1

如果这是第一个实体,则可为空 (null)。

有关动态横幅,请参阅 nextEntity 的上述注释。

cq.mobile.context.type 字符串 可能的值:“article”、“overlay”、“dynamicBanner”

1 实体包含下列字段,如下一部分中所述:idmetadatarootPathtype

属性 – 实体

名称 类型 注释
id 字符串  
metadata 对象2 特定于实体类型的元数据
rootPath 字符串 仅适用于文章和动态横幅。表示在当前上下文中运行的实体的根路径。可用作对其他插件的参考以构建实体中所包含资源的路径。(仅限 iOS 和 Android)。
type 字符串 可能的值:“collection”、“article”、“banner”、“dynamicBanner”

2 Metadata 对象将根据实体类型包含一组不同的字段,如下一部分中所述。

属性 – 元数据

名称 类型 支持实体 注释
abstract
字符串 文章、集合、横幅、动态横幅  
accessState 字符串 文章
可能的值:“free”、“metered”和“protected”
adCategory 字符串 文章、动态横幅
 
adType 字符串 文章、动态横幅
可能的值:“static”、“EFT”
allowDownload 布尔值 集合  
articleText 字符串 文章
 
author 字符串 文章
 
authorURL 字符串 文章
 
availabilityDate 字符串 文章、集合、横幅、动态横幅  
advertiser 字符串 文章、动态横幅
 
category 字符串 文章、集合、横幅、动态横幅  
created 字符串 文章、集合、横幅、动态横幅  
department 字符串 文章、集合、横幅、动态横幅  
entityName 字符串 文章、集合、横幅、动态横幅  
hideFromBrowsePage 布尔值 文章
 
importance 字符串 文章、集合、横幅、动态横幅 可能的值:“low”、“normal”、“high”
isAd 布尔值 文章、动态横幅
 
isIssue 布尔值 文章
 
keywords 字符串数组 文章、集合、横幅、动态横幅  
lateralNavigation 布尔值 集合  
modified 字符串 文章、集合、横幅、动态横幅  
openTo 字符串 集合 可能的值:“browsePage”、“contentView”
productIds 字符串数组 集合  
published 字符串 文章、集合、横幅、动态横幅  
readingPosition 字符串 集合 可能的值:“reset”、“retain”
shortAbstract 字符串 文章、集合、横幅、动态横幅  
shortTitle 字符串 文章、集合、横幅、动态横幅  
socialShareUrl 字符串 文章、集合、横幅、动态横幅  
tapAction 字符串 横幅  
title 字符串 文章、集合、横幅、动态横幅  
url 字符串 文章、集合、横幅、动态横幅  
version 字符串 文章、集合、横幅、动态横幅  

方法

名称 参数 响应 注释
getEntity
(entityName,
entityType, forceUpdate,
success, error)

entityName
:字符串 - 实体的名称

entityType
:字符串 - 实体的类型

forceUpdate
:布尔值 - 如果为“true”,则总是在服务器中查询最新版本

success
:函数 - 成功回调

error
:函数 - 错误回调

成功时:一个 Entity 对象

注意:null 是动态横幅的允许返回值(因为这不是此实体类型的必需属性)

失败时:包含已填充代码属性的 cq.mobile.contextError 对象

支持文章、横幅、集合、动态横幅

entityName 必须与点播服务中找到的名称(非标题)匹配。

entityType 必须与 Entity.type 中找到的值匹配

如果 forceUpdate 为 false 并且已缓存实体,则返回该实体。它可能不是该实体的最新版本。

如果 forceUpdate 为 true 但无法连接到服务器,则返回现有实体(如果在缓存中可用)。如果缓存中不存在任何内容,则返回网络错误。

如果无法连接到服务器但找不到请求的实体(或该实体受到限制并且用户未获得授权),则返回“找不到实体”错误。

getEntitlementInfo
(entityOrEntityList,
success, error)

entityOrEntityList
:Entity 或 EntityList 对象 - 要为其检索授权信息的实体

success
:函数 - 成功回调

error
:函数 - 错误回调

成功时:

[
{
“entityName” : <entityName1>,
“isEntitled” : true or false
},
{
“entityName” : <entityName2>,
“isEntitled” : true or false
},
]

失败时:包含已填充代码属性的 cq.mobile.contextError 对象

支持集合

getEntitlementInfo() 只会返回集合的授权信息。如果传递了非集合 Entity 对象,则会返回“错误的实体类型”错误。

如果传递了 EntityList 对象,则只会返回集合对象的 entitlementInfo。如果没有集合,则返回的数组将为空。

在一分钟的时间内发送到此 API 的第 26 个请求(以及所有后续请求)将返回“超出网络速率限制”错误。

如果设备处于脱机状态,则会返回任何缓存的权限信息。

如果设备网络处于联机状态但无法连接授权服务,则会返回网络错误。

getEntityStatus
(entity, success, error)

entity:集合下载状态。

success:函数 - 成功回调

error:函数 - 错误回调

成功时:
{ "entityName" : "isSavable" : "progressPercent" :  "downloadState" : }

失败时:包含已填充代码属性的 cq.mobile.contextError 对象

支持集合

getEntityStatus() 将检索集合实体的下载状态信息。

状态信息:

“entityName”:集合实体的名称。

“isSavable”:集合必须标记为集合属性中允许的下载(保存),并且具备返回 true 所需的相应授权。

“progressPercent”:目前已下载的集合量,从 0% 到 100%。注意:由于信息可能已从内存中清除,故而此值可能并不是一直准确。请参阅下文中的下载状态。

错误:getEntityStatus() 只会返回集合的授权状态信息。如果传递、未找到或尚未初始化非集合实体对象,则会返回一个错误。请参阅下文中的错误列表。

saveEntity(entity, isSilent, success, error)

entity:要下载和保存的集合。

isSilent: BOOL - (仅限 Android),如果为 true,实体将在不提供通知的情况下在后台进行保存。

success:函数 - 成功回调。

error:函数 - 错误回调。

成功时: { "rawEntity" : "downloadPercent" : "downloadState" }

失败时:包含已填充代码属性的错误

支持集合

saveEntity() 将下载并保存给定的集合实体。这等同于在 UI 中点击下载按钮。

成功回调:成功回调会返回正在保存的实体对象。此外,成功回调将在每次出现下载进度更新时进行调用。进度可通过“downloadPercent”和“downloadState”返回值进行跟踪。启动保存/下载后,集合下载会成为当前有效下载。如果启动另一个集合下载,则该集合将成为有效下载,而第一个集合则会暂停。当第二个集合完成下载后,第一个集合会恢复下载且状态会变为有效。

错误:saveEntity() 只会下载集合。如果传递非集合实体对象、未找到该集合或取消下载,则会返回一个错误。请参阅下文中的错误列表。

archiveEntity(entity, success, error)

entity:实体对象 - 要存档(不保存)的实体

success:函数 - 成功回调

error:函数 - 错误回调

成功时:一个实体对象

失败时:一个包含已填充代码属性的错误

支持集合

archiveEntity() 将存档(与 saveEntity() 相反的操作)给定的集合实体。这等同于在 UI 中点击复选标记按钮。如果集合已下载完毕且已保存,archiveEntity 会将集合标记为“非永久”并且可以清除。如果集合是主动下载或排队下载,则将取消下载,而且已下载的内容会被标记为“可清除”。

成功:返回已存档的实体对象。

错误:archiveEntity() 只会存档集合。如果传递非集合实体对象或未找到该集合,则会返回一个错误。

getSavedEntities(success, error)

success:函数 - 成功回调

error:函数 - 错误回调

成功时:实体对象的数组

失败时:包含已填充代码属性的错误

支持集合

getSavedEntities() 将返回已下载完毕或排队下载的实体对象的数组,并将进行保存。

getBackgroundImage
(width, height, success, error)

width:数字 - 请求的宽度

height:数字 - 请求的高度

success:函数 - 成功回调

error:函数 - 错误回调

成功时:背景图像的文件 URL(作为 success 回调的参数)

失败时:包含已填充代码属性的 cq.mobile.contextError 对象

支持集合

运行时查看器不会缩放图像,而是返回最接近指定大小的图像大小。

如果未在设备上缓存背景图像,则将从点播服务请求背景图像。大多数情况下,图像随后将在缓存中保留一段时间。

如果尝试调用集合之外的类型的实体,则将调用错误回调。

getThumbnailImage
(width, height, success, error)

width:数字 - 请求的宽度

height:数字 - 请求的高度

success:函数 - 成功回调

error:函数 - 错误回调

成功时:缩览图图像的文件 URL(作为 success 回调的参数)

失败时:包含已填充代码属性的 cq.mobile.contextError 对象

支持文章、横幅、集合、动态横幅

运行时查看器不会缩放图像,而是返回最接近指定大小的图像大小。

如果未在设备上缓存缩览图图像,则将从点播服务请求缩览图图像。大多数情况下,图像随后将在缓存中保留一段时间。

 

getSocialSharingImage
(width, height, success, error)

width:数字 - 请求的宽度

height:数字 - 请求的高度

success:函数 - 成功回调

error:函数 - 错误回调

成功时:社交共享图像的文件 URL(作为 success 回调的参数)

失败时:包含已填充代码属性的 cq.mobile.contextError 对象

支持文章

运行时查看器不会缩放图像,而是返回最接近指定大小的图像大小。

如果未在设备上缓存社交共享图像,则将从点播服务请求社交共享图像。大多数情况下,图像随后将在缓存中保留一段时间。

如果尝试调用集合之外的类型的实体,则将调用错误回调。

getChildren(success, error)

success
:函数 - 成功回调

error
:函数 - 错误回调

成功时:一个 EntityList 对象

失败时:包含已填充代码属性的 cq.mobile.contextError 对象

支持集合

EntityList 将包含位于缓存中的此集合的所有非受限子实体。如果这些实体都不存在,系统将尝试下载子级的第一个服务器页面。

getContentLocation(success, error)

success:函数 - 成功回调

error:函数 - 错误回调

成功时:返回 ContentLocation 对象

支持文章

ContentLocation 对象包含 pageNumber 和 totalPageCount。
pageNumber 从零开始,因此 0 是文章的第一页。这些值反映内容在文章中的实际位置。对于 HTML 文章,totalPageCount 为 1,pageNumber 将为 0。

有关这些元数据属性的附加详细信息,请参阅将第三方系统与 AEM Mobile 集成

属性 - EntityList

名称 类型 注释
entities 数组 实体的列表。可能的实体:“文章”、“集合”、“横幅”。
hasNextPage 布尔值 如果为“true”,则列表中存在更多实体。使用方法 getNextPage() 可从列表中检索实体的下一个页面。

方法

名称 参数 响应 支持实体 注释
getNextPage
(success, error)

success
:函数 - 成功回调

error
:函数 - 错误回调

成功时:entities 属性将包含其他 Entity 项,并将更新 hasNextPage 属性

失败时:包含已填充代码属性的 cq.mobile.contextError 对象

集合

如果在 hasNextPage 为 false 时调用了 getNextPage(),则会返回“没有更多实体页”错误。

返回的实体不会受到限制。受限信息可能自上次调用 getNextPage() 以来已更改。如果是这样,则会返回“实体页已过时”错误。您必须对该集合调用 getEntity() 以拉取已更新集合并使用此已更新集合调用 getChildren()。

属性 - 上下文错误

cq.mobile.contextError 是一个枚举对象,其作用是为上下文方法定义所有受支持的错误代码。

名称
cq.mobile.contextError.UNKNOWN_ERROR
0
cq.mobile.contextError.INVALID_ARGUMENT_ERROR
10
cq.mobile.contextError.ENTITY_IMAGE_TYPE_NOT_SUPPORTED_FOR_ENTITY_ERROR
11
cq.mobile.contextError.NETWORK_ERROR
20
cq.mobile.contextError.NETWORK_RATE_LIMIT_EXCEEDED_ERROR
21
cq.mobile.contextError.ENTITY_IMAGE_ENTITY_NOT_FOUND_ERROR
40
cq.mobile.contextError.ENTITY_IMAGE_NETWORK_ERROR
41
cq.mobile.contextError.ENTITY_IMAGE_NOT_FOUND_ERROR
50
cq.mobile.contextError.ENTITY_NOT_FOUND_ERROR
61
cq.mobile.contextError.WRONG_ENTITY_TYPE_ERROR
71
cq.mobile.contextError.NO_MORE_ENTITY_PAGES_ERROR
72
cq.mobile.contextError.ENTITY_PAGE_OUT_OF_DATE_ERROR
73
cq.mobile.contextError.ENTITY_OUT_OF_DATE_ERROR 74
cq.mobile.contextError.ENTITY_SAVE_FAILURE 80
cq.mobile.contextError.ENTITY_SAVE_CANCELLED 80

 

属性 - 下载状态

cq.mobile.downloadState 是一个枚举对象,其作用是为集合下载方法定义所有受支持的错误代码。

名称
cq.mobile.downloadState.NONE
0
cq.mobile.downloadState.DOWNLOAD_PAUSED
1
cq.mobile.downloadState.DOWNLOAD_ACTIVE
2
cq.mobile.downloadState.DOWNLOAD_COMPLETE
3

 

设备 API

设备模块提供了本机代码中的值。请注意,这些属性驻留在 Cordova 设备插件中的其他命名空间中(window.cq.mobile.devicewindow.device)。

可用性

除了 Cordova 设备插件之外,还将添加下列属性。

属性 - 设备

名称 类型 可变
注释
cq.mobile.device.class 字符串 可能的值:Phone、Tablet(Windows 仅返回 Tablet,因为不支持手机)
cq.mobile.device.vendorId 字符串 仅限 iOS(请参阅 iOS 开发人员指南中的 IdentifierForVendor

应用程序 API

可用性

此插件可定义全局 cq.mobile.application 对象。它在 deviceready 事件之后才可用。

属性 – 应用程序

名称 类型 可变 注释
cq.mobile.application.id 字符串 示例:com.adobe.create
cq.mobile.application.pushNotificationToken 字符串 设备的推送通知令牌(iOS 上的设备令牌、Android 上的注册 ID,Windows 查看器尚未实现推送通知,因此该值在此之前将是“未定义的”)
cq.mobile.application.runtimeVersion 字符串 示例:2015.5.1
cq.mobile.application.version 字符串 应用程序版本的形式,如 1.0.4
cq.mobile.application.isAppSearchEnabled 布尔值
检查是否已启用搜索功能
cq.mobile.application.isSocialSharingEnabled 布尔值 检查是否已启用社交共享功能

用户 API

可用性

此插件定义全局 cq.mobile.user 对象。它在 deviceready 事件之后才可用。

事件

名称 注释
isauthenticatedchanged 当用户更改身份验证状态时,将触发事件。客户端应查询用户对象以了解最新状态。
authtokenchanged 当用户身份验证令牌更改时,将触发事件。客户端应查询用户对象以了解最新状态。

属性 – 应用程序

名称 类型 可变 注释
cq.mobile.user.authToken 字符串  
cq.mobile.user.isAuthenticated 布尔值  

方法

名称 参数 响应 注释
setAuthToken(authToken, success, error)

authToken:字符串 - 请求的 authToken 的值

success:函数 - 成功回调

error:函数 - 错误回调

成功时:不使用参数调用成功回调

失败时:用 cq.mobile.userError 代码集调用错误回调

此调用仅在设置了通用标识提供者或只有一个直接授权提供者(无标识提供者)的项目上成功执行。否则,当调用此 API 时,将返回身份验证支持错误。

如果出于某种原因 setAuthToken 调用失败(系统返回 502、503 或 504),理想情况下查看器将会重试一次。如果重试失败或未执行重试,将返回网络错误。
当前一请求处于预检状态时,对此 API 发出的任何请求都将返回“超出网络速率限制”错误,直到所有以前的请求返回成功或失败。

在一分钟内对此 API 发出的第 11 次请求将返回“超出网络速率限制”错误,第 11 次后的每个请求也是如此,直到自第一次请求后过了一分钟。

launchSignInUX(error) error:函数 - 错误回调 失败时:用 cq.mobile.userError 代码集调用错误回调

如果身份验证通过授权服务器发生,则会显示原生的登录对话框。

如果身份验证通过标识提供者发生,则会在设备查看器上的 Web 视图中显示身份验证 URL,或重定向到桌面 Web 查看器上的身份验证 URL。

如果项目中未指定身份验证,调用此 API 将返回“身份验证支持”错误。

如果用户已通过身份验证,则会返回“身份验证状态无效”错误。

如果 Web 查看器无法检索身份验证设置,则会返回“网络”错误。

在脱机状态下,用户仍然可以从设备查看器中注销。

signOut(error) error:函数 - 错误回调 失败时:用 cq.mobile.userError 代码集调用错误回调

注销用户,并刷新注销状态以在 UI 中反映出来。

如果项目中未指定身份验证,调用此 API 将返回“身份验证支持”错误。

如果用户已通过身份验证,则会返回“身份验证状态无效”错误。

如果 Web 查看器无法注销,则会返回网络错误。

如果无法检索身份验证设置,设备查看器将使用缓存的身份验证设置。

refreshSignIn(success, error)

success:函数 - 成功回调

error:函数 - 错误回调

成功时:不使用参数调用成功回调

失败时:用 cq.mobile.userError 代码集调用错误回调

仅当您确定当前会话不再有效时,使用此 API 尝试刷新用户登录状态。此 API 只会在两种情况下刷新登录状态:

1) 项目设置了授权服务,但没有自定义身份验证。调用此 API 将导致对授权服务进行 renewAuthToken 调用。

2) 项目设置了提供刷新令牌的 OAuth 标识提供者。调用此 API 将尝试使用刷新令牌刷新登录会话。

在这两种情况下,刷新都有可能不会成功。如果发生这种情况,用户将被注销。

在其他所有情况下(包括对设置了不支持刷新的 SAML 或 OAuth 标识提供者的项目调用此 API 的情况),此刷新将失败,并会将用户注销,然后返回用户主页。

如果项目中未指定身份验证,调用此 API 将返回“身份验证支持”错误。

如果用户未通过身份验证,则会返回“身份验证状态无效”错误。

如果查看器处于脱机状态且无法刷新登录,则会返回网络错误。

如果无法检索身份验证设置,设备查看器将使用缓存的身份验证设置。

注意:

当任何这些 API 调用发生意外错误时,错误回调中将返回“UNKNOWN_ERROR”代码。

 

属性 - 用户错误

cq.mobile.userError 是一个枚举对象,其作用是为用户方法定义所有受支持的错误代码。

名称
cq.mobile.userError.UNKNOWN_ERROR
0
cq.mobile.userError.INVALID_ARGUMENT_ERROR
10
cq.mobile.userError.AUTHENTICATION_SUPPORT_ERROR
11
cq.mobile.userError.INVALID_AUTHENTICATION_STATE
12
cq.mobile.userError.NETWORK_ERROR
41
cq.mobile.userError.NETWORK_RATE_LIMIT_EXCEEDED_ERROR
42
cq.mobile.userError.UNAUTHORIZED
43

Entitlement API

可用性

此插件可定义全局 entitlement 对象,从而提供与授权和购买相关的方法。它在 deviceready 事件之后才可用。

属性 - 产品

名称 类型 注释
productId 字符串 在门户的“产品和订阅”部分中显示的产品/订阅 ID。
label 字符串 在门户的“产品和订阅”部分中显示的产品/订阅名称。如果用户未设置此项,则它为 null。
description 字符串 在门户的“产品和订阅”部分中显示的产品/订阅说明。如果用户未设置此项,则它为 null。
price 字符串 从相应的商店返回的价格。如果产品免费,则此项为 Null。
offerType 字符串 可为“订阅”或“产品”。

属性 - 订阅信息

名称 类型 注释
subscriptionOffers 数组 产品对象的数组。如果用户具有有效订阅,则此项为空。
subscriptionState 对象 一个 subscriptionState 对象。

属性 - 订阅状态

名称 类型 注释
isSubscriber
布尔值 如果用户在任何时候一直是订阅者,则此项为 true。请注意,subscriptionState.isSubscriber 等同于 subscriptionState.store.isSubscribersubscriptionState.integrator.isSubscriber
isActiveSubscriber
布尔值 如果用户具有有效订单,则此项为 true。
store 对象 包含产品商店的订阅状态的商店对象。
integrator 对象 包含授权集成商订阅状态的集成商对象。

属性 - 商店

名称 类型 注释
isSubscriber
布尔值 如果用户在任何时候一直是订阅者,则此项为 true。
isActiveSubscriber
布尔值 如果用户具有有效订单,则此项为 true。
expirationDate 数字 到期日期后的时间戳(以毫秒为单位)。如果订阅(来自商店或授权集成商)没有到期日期,则此值可为 null。
subscriptionType 字符串 可为“allAccess”或“standard”。仅在 isSubscriber 为 true 时有效。
id 字符串 商店中订阅产品的产品 ID。

属性 - 集成商

名称 类型 注释
isSubscriber
布尔值 如果用户在任何时候一直是订阅者,则此项为 true。
isActiveSubscriber
布尔值 如果用户具有有效订单,则此项为 true。
expirationDate 数字 到期日期后的时间戳(以毫秒为单位)。如果订阅(来自商店或授权集成商)没有到期日期,则此值可为 null。
customData 字符串 如果同辈 isSubscriber 为 false,则将不会设置 customData。如果 isSubscriber 为 true,则可能设置了该项,也可能未设置该项。customData 可由集成商返回。其旨在包含对 Adobe 透明且仅对客户有意义的数据。

方法

名称 参数 响应 注释
getSubscriptionInfo(success, error)

success:成功回调

error:错误回调

成功时:一个 SubscriptionInfo 对象。

此方法返回当前出版物和设备的订阅信息。在一分钟内发出 60 个 API 请求后,对此 API 发出的任何后续请求均会返回一个错误,直到自发出第一个请求起已经经过一分钟。

桌面 Web 查看器不支持此 API 并始终返回错误。

getOffers(collectionName, success, error)

collectionName:字符串 - 集合的名称

success:函数 - 成功回调

error:函数 - 错误回调

成功时:产品对象的数组

失败时:一个包含已填充代码属性的错误

collectionName 必须与在门户中找到的名称匹配。

如果无法找到所请求的实体,或其受限且无法显示,则会返回一个错误。

返回为所请求实体缓存的产品(如果可用)。否则,将对授权服务发出网络请求,以获取产品。

在一分钟内对授权服务发出 60 个网络请求后,对此 API 发出的任何后续请求均会导致一个错误,直到自发出第一个请求起已经经过一分钟。

桌面 Web 查看器不支持此 API 并始终返回错误。

purchaseOffer(productId, success, error)

productId:字符串 - 要购买的产品的 productId

success:函数 - 成功回调

error:函数 - 错误回调

成功时:启动购买请求

失败时:调用错误代码

此方法会启动购买请求。
restorePurchases(successCallback, errorCallback)

success:函数 - 成功回调

error:函数 - 错误回调

成功时:启动恢复购买请求

失败时:调用错误代码

此方法会为用户启动恢复以前购买。

在一分钟内发出 5 个 API 请求后,对此 API 发出的任何后续请求均会返回一个错误,直到自发出第一个请求起已经经过一分钟。

错误 - 授权

cq.mobile.entitlementError 是一个枚举对象,其作用是为授权方法定义所有受支持的错误代码。

名称
cq.mobile.entitlementError.UNKNOWN_ERROR 0
cq.mobile.entitlementError.INVALID_ARGUMENT_ERROR
10
cq.mobile.entitlementError.ENTITY_IMAGE_TYPE_NOT_SUPPORTED_FOR_ENTITY_ERROR 11
cq.mobile.entitlementError.INVALID_AUTHENTICATION_STATE 12
cq.mobile.entitlementError.NETWORK_ERROR 20
cq.mobile.entitlementError.NETWORK_RATE_LIMIT_EXCEEDED_ERROR 21
cq.mobile.entitlementError.ENTITY_IMAGE_ENTITY_NOT_FOUND_ERROR
40
cq.mobile.entitlementError.ENTITY_IMAGE_NETWORK_ERROR 41
cq.mobile.entitlementError.ENTITY_IMAGE_NOT_FOUND_ERROR 50
cq.mobile.entitlementError.ENTITY_NOT_FOUND_ERROR 61
cq.mobile.entitlementError.WRONG_ENTITY_TYPE_ERROR 71
cq.mobile.entitlementError.NO_MORE_ENTITY_PAGES_ERROR 72
cq.mobile.entitlementError.ENTITY_PAGE_OUT_OF_DATE_ERROR 73
cq.mobile.entitlementError.ENTITY_OUT_OF_DATE_ERROR 74
cq.mobile.entitlementError.ENTITY_SAVE_FAILURE 80
cq.mobile.entitlementError.ENTITY_SAVE_CANCELLED 81

更改日志

2017 年 3 月 16 日

添加了用于下载集合实体的 API 信息。

添加了用于购买和授权的 API 信息。

2017 年 1 月 10 日

Added cq.mobile.application.isAppSearchEnabled 和 cq.mobile.application.isSocialSharingEnabled(请参阅“应用程序”部分)

2016 年 8 月 9 日

添加了 getLocationContent(请参阅“上下文”部分)

2016 年 6 月 30 日

添加了 setAuthToken(请参阅“用户”部分)

2016 年 6 月 23 日

添加了遍历点播服务集合结构的功能:

  • 更新实体元数据以支持横幅(请参阅“上下文”选项卡)。
  • 添加了 getEntity() 以请求文章/横幅/集合实体(请参阅“上下文”选项卡)。
  • 添加了 getEntitlementInfo() 以请求集合的授权信息(请参阅“上下文”选项卡)。
  • 添加了 getChildren() 以请求集合的直接子实体的列表(请参阅“上下文”选项卡)。
  • 添加了 getNextPage() 以从返回自 getChildren() 的列表请求实体的下一页(请参阅“上下文”选项卡)。
  • 添加了枚举对象以为 cq.mobile.context 和 cq.mobile.user 中使用的方法定义错误代码(请参阅“上下文”和“用户”选项卡)。

 

本产品经 Creative Commons Attribution-Noncommercial-Share Alike 3.0 Unported License 许可  Twitter™ 与 Facebook 中的内容不在 Creative Commons 的条款约束之下。

法律声明   |   在线隐私策略