現成應用程式處理常式 out-of-the-box-app-handlers

CAUTION
AEM 6.4已結束延伸支援,本檔案不再更新。 如需詳細資訊,請參閱 技術支援期. 尋找支援的版本 此處.
NOTE
Adobe建議針對需要單頁應用程式架構用戶端轉譯(例如React)的專案使用SPA編輯器。 深入了解.

請參閱以下開發內容同步處理常式的准則:

  • 處理常式必須實作 com.day.cq.contentsync.handler.ContentUpdateHandler (直接或延伸執行此操作的類)
  • 處理常式可擴充 com.adobe.cq.mobile.platform.impl.contentsync.handler.AbstractSlingResourceUpdateHandler
  • 只有在處理常式更新ContentSync快取時,它們才必須報告true。 錯誤回報true會允許AEM建立更新。
  • 只有在內容實際變更時,處理常式才應更新快取。 如果不需要白色,請勿寫入快取,並避免建立不必要的更新。

現成處理常式 out-of-the-box-handlers

下列為現成可用的應用程式處理常式:

mobileappages 轉譯應用程式頁面。

  • 類型 — 字串 - mobileappages

  • 路徑 — 字串 — 頁面路徑

  • 擴充功能 — 字串 — 請求中應使用的擴充功能。 對於頁面,這幾乎總是 html ​但其他仍有可能。

  • 選取器 — 字串 — 以點分隔的可選選取器。 常見範例包括 觸控 用於呈現頁面的行動版本。

  • deep — 布林值 — 可選布林屬性確定是否應包括子頁。 預設值為 true。

  • includeImages — 布林值 — 選用布林屬性,決定是否應包含影像。 預設值為 true.

    • 預設情況下,僅考慮包含資源類型為foundation/components/image的影像元件。
  • includeVideos — 布林值 — 選用布林值屬性決定是否應包含視訊。 預設值為 true.

  • includeModifiedPagesOnly — 布林值 — 若為false或省略,則呈現所有頁面並檢查呈現中的更新。 如果為true,則根據對lastModified頁面的更改進行更改。

  • +重寫(節點)
    - relativeParentPath — 字串 — 寫入相對於的所有其他路徑的路徑。

NOTE
受此處理常式影響的影像和視訊元件的資源類型,會透過設定 com.adobe.cq.mobile.platform.impl.contentsync.handler.MobilePagesUpdateHandler OSGi服務.

mobilepageassets 收集應用程式頁面資產。

mobilecontenlisting 列出ContentSync壓縮的內容。 裝置上的用戶端js會使用此ID執行AEM應用程式所需的初始檔案復本。

此處理常式應新增至任何AEM應用程式ContentSync設定。

  • type - String - mobilecontenlisting
  • 路徑 — 字串 — 保留空白,必須顯示為有效的處理常式,但路徑推斷為目前的ContentSync快取。 此值會被忽略。
  • targetRootDirectory - ​字串 — 要新增至路徑的前置詞,作為此處理常式內容更新的目標根。
  • 訂購 — 長 - ​ContentSync執行此處理常式的順序。 此數字應設定得比所有其他處理常式(如100)都高。 它應在傳統內容處理常式之後執行。
{
  "files": [
    "config.xml",
    "res/screens/ios/screen-ipad-portrait-2x.png",
    "res/screens/ios/screen-ipad-landscape.png",
    "res/screens/ios/screen-iphone-portrait-2x.png",
    "res/screens/ios/screen-iphone-landscape.png",
    "res/screens/ios/screen-iphone-portrait.png",
    "apps/weretail-app/components/splash-page/clientlibs.css",
    ...
    "pge-content-packages.json"
  ],
  "count": 382,
  "lastModified": 1422902754733
}

mobilecontentpackagelisting 列出指定應用程式中的AEM內容套件,以及要向其提出更新請求的serverURL。 這是用於裝置上的用戶端js,以要求內容更新

處理常式應用於AEM App Shell ContentSync設定(含pge-type=app-instance的節點)

  • type - String - mobilecontentpackageslisting
  • 路徑​-字串 — 應用程式殼層的路徑(含pge-type=app-instance的節點)。
  • targetRootDirectory — 字串 — 用於作為此處理常式內容更新的目標根添加到路徑的前置詞。
  • 訂購 — 長 - ​ContentSync執行此處理程式的順序。 此數字應設定得比所有其他處理常式(如100)都高。 它應在傳統內容處理常式之後執行。
NOTE
下列程式碼區塊並非確切的實作,應作為參考範例使用:
{
  "content": [
    {
      "name": "en",
      "title": "We Retail Mobile App - English",
      "type": "CONTENT",
      "path": "/content/phonegap/weretail-outdoors/en",
      "updatePath": "/content/phonegap/weretail/en/jcr:content/pge-app/app-config"
    },
    {
      "name": "shell",
      "title": "We Retail Mobile App",
      "type": "INSTANCE",
      "path": "/content/phonegap/weretail-outdoors/shell",
      "updatePath": "/content/phonegap/weretail/shell/jcr:content/pge-app/app-config"
    }
  ],
  "serverURL": "http://localhost:4503/"
}

widgetconfig 包含更新的config.xml,它合併通過命令中心所做的任何編輯以及提供的config.xml。 如果此處理常式未包含任何透過管理介面變更的應用程式詳細資料,則快取中不會包含這些詳細資料。

此處理常式應用於AEM App Shell ContentSync設定(具有pge-type=的節點)[app-instance])。

  • 類型 — 字串 - ​ widgetconfig
  • 路徑​-字串 — 任何應用程式殼層子節點的路徑(具有pge-type=的節點)[app-instance])。
  • targetRootDirectory — 字串 — 用於作為此處理常式內容更新的目標根添加到路徑的前置詞。
  • targetIconDirectory — 字串 — 放置應用程式圖示的目錄

mobileADBMobileConfigJSON 如果已設定AMS雲端服務,請加入ADBMobileConfig.JSON檔案。

這用於編譯時配置AMS插件以獲得分析支援。

處理常式應用於AEM App Shell ContentSync設定(含pge-type=app-instance的節點)

  • 類型 — 字串 - mobileADBMobileConfigJSON
  • 路徑 — 字串 — 應用程式殼層的路徑(含pge-type=app-instance的節點,或延伸/libs/mobileapps/core/components/instance的RT)
  • targetRootDirectory — 字串 — 用於添加到路徑的前置詞,作為此處理程式內容更新的目標根

notificationsconfig 提取設備上所需的通知配置。 屬性會從與應用程式相關聯的個別推送服務雲端服務設定中擷取。

會擷取雲端服務jcr:content節點中的非AEM屬性,並新增至 pge-notifications-config.json JSON檔案,以包含在應用程式內容的www根中。

AEM屬性是使用「cq」、「sling」或「jcr」建立命名空間的屬性。 其他屬性可使用內容同步設定節點上的「excludeProperties」屬性來排除。

  • 類型 — 字串 - notificationsconfig
  • excludeProperties — 字串[] — 要排除的屬性

contentsyncconfigcontent 從現有的ContentSync配置收集內容。

  • 類型 — 字串 - contentsyncconfigcontent

  • 路徑 — 字串 — 指向以下任一路徑的路徑:

    • 另一個ContentSync配置
    • 內容套件(將使用其phonegap-exportTemplate屬性來尋找其ContentSync設定)
    • 至行動資源(在該資源下會找到app-content的,而如果這些內容套件具有pge-includeInBuild屬性為true,則phonegap-exportTemplate將用於尋找其ContentSync設定)
  • autoCreateFirstUpdateBeforeImport — 布林值 — 如果為true,請建立初始值 更新 (若不存在,則匯入之前)

  • autoFillBeforeImport — 布林值 — 如果為true,請在匯入前更新/填入target設定

  • configSuffix — 字串 — 一個字串,可附加至app-content的「phonegap-exportTemplate」屬性上指出的路徑。 這可用來區分不同的匯出範本。 例如,此屬性可設為 "-dev" 以表示 "/…/…/…/appconfig-dev 應使用( "/…/…/./appconfig)。

app-assets 包含與應用程式例項相關聯的所有資產。 此處理常式將包含指定路徑下找到的任何資產,以及應用程式執行個體的appAssetPath屬性所參考的任何資產。

  • 類型 — 字串 - app-assets

  • 路徑​-字串 — 應用程式例項下儲存應用程式資產的位置路徑

mobileappoffers 已為個人化使用案例導入新的內容同步處理常式,以呈現目標內容。 「mobileappoffers」處理常式知道如何呈現由內容作者建立的相關目標選件。 Mobileappoffers處理常式會延伸抽象頁面更新處理常式,因此許多屬性相似。 Mobileappoffers處理常式的詳細資訊具有下列屬性。

mobileappsoffers處理常式會擴充mobileappspages處理常式,並新增下列屬性:

  • locationRoot — 字串 — 指定行動應用程式的位置
  • includePageTypes — 字串 — 預設支援cq/personalization/components/teaserpage和cq/personalization/components/offerproxy
  • 選取器 — 字串 — 應設為tandt
  • 路徑 — 字串 — 行銷活動品牌的路徑

mobileappconfig mobileappconfig內容同步處理常式提供將JSON資料插入MobileAppsConfig.json的方式。 要註冊提供程式類,開發人員將將其MobileAppsInfoProvider類添加到提供程式清單中。 處理常式會反覆查看MobileAppsInfoProviders清單,並允許提供者將資料插入產生的json檔案。 此處理程式支援的屬性清單為:

  • 路徑​-字串 — 具有pge-type=app-instance的應用程式執行個體節點的路徑,或延伸/libs/mobileapps/core/components/instance的RT
  • 提供者 — 字串 [] — 完全合格的MobileAppsInfoProviders清單
  • targetRootDirectory — 字串 — 將MobileAppsConfig.json檔案寫入的目錄。
  • fileName — 字串 — 要寫入JSON的檔案選用名稱,預設為MobileAppsConfig.json

可以有多個mobileappconfig處理常式,分別以寫入不同JSON檔案的一組唯一提供者來設定。

測試內容同步處理常式 testing-content-sync-handlers

檢查完整性的步驟 清除快取

  • 清除快取
  • 執行處理常式(已更新快取)
  • 再次運行處理程式(不應更新快取)

除錯步驟

  • 執行您的設定
  • 匯出設定或在裝置上檢閱
  • 如果呈現失敗檢查是否缺少 樣式/資產/lib 或檢查 樣式/資產/lib

記錄 在套件上透過OSGI記錄器設定啟用ContentSync除錯記錄 com.day.cq.contentsync 這可讓您追蹤哪些處理常式已執行,以及它們是否已更新快取和回報已更新快取。

其他資源 additional-resources

若要了解管理員和開發人員的角色和責任,請參閱下列資源:

NOTE
若要開始使用AEM Mobile應用程式開發,請按一下 此處.
recommendation-more-help
547b817b-14b5-4d82-aa0f-a64750e0e592