ImsAuthProps
ImsAuthProps
屬性定義Asset Selector用來取得imsToken
的驗證資訊和流程。 藉由設定這些屬性,您可以控制驗證流程應該如何行為並註冊各種驗證事件的接聽程式。
屬性名稱 | 描述 |
---|---|
imsClientId | 代表用於驗證目的之IMS使用者端ID的字串值。 此值由Adobe提供,且為您的Adobe AEM CS組織專用。 |
imsScope | 說明用於驗證的範圍。 範圍會決定應用程式對貴組織資源的存取層級。 多個範圍可以用逗號分隔。 |
redirectUrl | 代表驗證後重新導向使用者的URL。 此值通常設定為應用程式目前的URL。 如果未提供redirectUrl ,ImsAuthService 會使用用來登入imsClientId 的redirectUrl |
modalMode | 表示驗證流程是否應該顯示在強制回應視窗(快顯視窗)中的布林值。 如果設為true ,驗證流程會以快顯視窗顯示。 如果設為false ,則驗證流程會以全頁重新載入顯示。 注意: 若要獲得較好的UX,您可以在使用者停用瀏覽器快顯視窗時動態控制此值。 |
onImsServiceInitialized | Adobe IMS驗證服務初始化時呼叫的回呼函式。 此函式接受一個引數service ,此引數是代表Adobe IMS服務的物件。 如需詳細資訊,請參閱ImsAuthService 。 |
onAccessTokenReceived | 從Adobe IMS驗證服務收到imsToken 時所呼叫的回呼函式。 此函式接受一個引數imsToken ,該引數是代表存取權杖的字串。 |
onAccessTokenExpired | 當存取權杖過期時所呼叫的回呼函式。 此函式通常用於觸發新的驗證流程,以取得新的存取權杖。 |
onErrorReceived | 驗證期間發生錯誤時所呼叫的回呼函式。 此函式採用兩個引數:錯誤型別和錯誤訊息。 錯誤型別是代表錯誤型別的字串,而錯誤訊息是代表錯誤訊息的字串。 |
ImsAuthService
ImsAuthService
類別會處理Asset Selector的驗證流程。 其負責從Adobe IMS驗證服務取得imsToken
。 imsToken
可用來驗證使用者,並授權以Cloud Service Assets存放庫身分存取Adobe Experience Manager。 ImsAuthService使用ImsAuthProps
屬性來控制驗證流程並註冊各種驗證事件的接聽程式。 您可以使用方便的registerAssetsSelectorsAuthService
函式,以資產選擇器註冊 ImsAuthService 執行個體。 ImsAuthService
類別上有以下可用函式。 不過,如果您使用 registerAssetsSelectorsAuthService 函式,則不需要直接呼叫這些函式。
函式名稱 | 描述 |
---|---|
isSignedInUser | 判斷使用者目前是否已登入服務並據此傳回布林值。 |
getImsToken | 擷取目前登入使用者的驗證imsToken ,此驗證可用於驗證其他服務的要求,例如產生資產_rendition。 |
signIn | 起始使用者的登入程式。 此函式使用ImsAuthProps 在快顯視窗或整頁重新載入中顯示驗證 |
signOut | 將使用者登出服務,讓其驗證Token失效,並要求他們再次登入以存取受保護的資源。 叫用此函式將會重新載入目前頁面。 |
refreshToken | 重新整理目前登入使用者的驗證Token,避免其到期並確保受保護資源的存取不中斷。 傳回可用於後續請求的新驗證Token。 |