Asset Amway ID Refresh Token 1.0.1

Downloadable Asset:

com.alticor.refreshtoken.zip

Developer Guide Documentation:

refresh_token_marketplace_component_template.docx

Asset Version:

1.0.1

External Links:

Confluence Page

Asset Description:

Amway ID supports Refresh Token as a component to integrate anywhere in your app, to refresh the access_token without prompting the login screen every time by using the refresh_token. This component helps developers easy to integrate and refresh the access_token before making any service call and avoids lots of business logic to handle access_token and refresh_token every time.

Details:

Component documentation fix
 1 Overview

Access tokens are short-lived - they normally only work for 1 hour. In order to get a new access token, you use the refresh token. Authorization servers SHOULD issue access tokens with a limited lifetime and require clients to refresh them by requesting a new access token using the same assertion if it is still valid. Otherwise, the client MUST obtain a new valid assertion.

Amway ID supports Refresh Token as a component to integrate anywhere in your app, to refresh the access_token without prompting the login screen every time by using the refresh_token.

This component helps developers easy to integrate and refresh the access_token before making any service call and avoids lots of business logic to handle access_token and refresh_token every time.

2 Getting Started with the AmwayID RefreshToken component

This is a Getting Started section for the AmwayID Refresh Token. It contains information about importing and running the component.

For information about the Dynamic Usage, Properties, Events, and APIs of the component, you can visit the Reference Section.

Before you start using the Amway ID Refresh Token component, make sure that you meet all the requirements in the Prerequisites.

3 Prerequisites

<ul>
<li>A <a href="https://manage.kony.com/">Kony account</a></li>
<li>Kony Visualizer V8 SP4, or higher</li>
<li>Work with a member of the Amway ID team to discuss & determine how long your refresh token should be configured, based upon the criticality of data in your app.</li>
</ul>

3.1 Source Code

The component source can be found at <a href="https://github.com/AmwayACS/AmwayIDNativeLogin">https://github.com/Amway...

4 Importing the Component

Before you start importing the component to Kony Visualizer, you must download the component from the Amway Marketplace website. You can import the marketplace components only into the apps that are of the Kony Reference Architecture type.

To import the AmwayID RefreshToken component, do the following:

<ol>
<li>Open your app project in Kony Visualizer.</li>
<li>On the File menu, point to Import, and click Component to Library. The Open dialog appears.</li>
<li>Navigate to the location where you downloaded the component (zip file) on your computer, select the component, and click Open. After Visualizer downloads the component, it opens a window that asks you to enter the metadata for the component.</li>
</ol>

Enter a Library Name, a Collection Name, and a Description if you require one.

<ul>
<li>Library Name - A Library contains component collections and skins. The Library Name specifies the library that you want to import the component into. If the library does not exist, Visualizer will create a new one. 
As an example, let us name the Library as AmwayID.</li>
<li>Collection Name - A collection contains multiple components. The Collection Name specifies the collection that you want to import the component into. If the collection does not exist in the specified library, Visualizer will create a new one. 
As an example, let us name the Collection as RefreshToken.</li>
<li>Component Name - This name specifies the display name you want to use for the component in Visualizer. 
By default, the component name is com.alticor.RefreshToken.</li>
<li>After you import the component, you can drag and drop it from the Collection Library onto your form.</li>
<li>Save the form now.</li>
</ul>

After you add the component to a form, you need to configure the native settings of your project. You can refer to the following sections for more information.

4.1 Configuring Component Properties

You can use a component's Properties to customize and configure the elements. These elements can be UI elements, service parameters, and so on. For more information about properties, you can refer to the <a href="https://docs.kony.com/konylibrary/visualizer/visualizer_user_guide/Defau... target="_blank">Components Overview</a> section of the Visualizer User Guide.

You can set the properties from the Properties panel on the right side of the Visualizer. You can also configure these properties using JavaScript code.

4.2 Setting Properties

Login Tokens

Description:

Login success response object which we have received in the login success callback.

Syntax: loginResponse

Type: String

Read/Write: Write

Example:

this.view.RefreshToken.loginResponse = response;

Identity Service Name

Description:

The Identity service name which we have defined in MF App.

Syntax: identityServiceID

Type: String

Read/Write: Write

Example:

this.view.RefreshToken.identityServiceID = "QAAmwayIDAuthService";

Loading Indicator Skin

Description:

Loading Indicator Skin to match with app loading indicator skin.

Syntax: loadingIndSkin

Type: String

Read/Write: Write

Example:

this.view.RefreshToken.loadingIndSkin = "sknLoadingIndicator";

4.3 <a href="javascript:void(0);">Building and Running your app</a>

After performing all the above steps, you can perform either of the following tasks:

Build and Publish your app (Visualizer Enterprise)

For more information, you can refer to the <a href="http://docs.kony.com/konylibrary/visualizer/visualizer_user_guide/Defaul... target="_blank">Building and Viewing an Application</a> section of the Visualizer User Guide.

5 APIs

5.1 RefreshToken Events

5.1.1 getRefreshToken

Description:

API method to refresh the access_token using refresh_token.

Syntax: getRefreshToken()

Parameters: None.

Return Value: None.

Example:

this.view.RefreshToken.getRefreshToken();

Ex: this.view.btnRefreshToken.onClick = this.onClickRefreshToken;

onClickRefreshToken : function(){

this.view.RefreshToken.getRefreshToken();

},

5.1.2 refreshTokenCallback

Description:

Its RefreshToken success callback event to define business logic

Syntax: refreshTokenCallback()

Parameters: response.

Return Value: None.

Example:

this.view.RefreshToken.refreshTokenCallback = this.refreshTokenCallback;

Ex: refreshTokenCallback : function(response){

this.view.lblAccessToken.text = response.access_token;

this.view.lblIDTokenValue.text = response.id_token;

},

5.1.3 errorMessageCallback

Description:

Its RefreshToken Failure callback event to define business logic.

Syntax: errorMessageCallback()

Parameters: message.

Return Value: None.

Example:

this.view.RefreshToken.errorMessageCallback = this.errorMessageCallback;

Ex: errorMessageCallback : function(message){

this.view.lblErrorDesc.text = message;

this.view.flxErrorMain.isVisible = true;

},

6 External Links

Please find the Confluence link <a href="https://jira.amway.com:8444/display/GIW/Refresh+Token+Component">here</a...

Supported App Types:

Supported Devices:

Supported Platforms:

Platform Version:

Asset Requirements:

Visualizer Enterprise

MobileFabric

Status:

Approved

Title Approved:

Title Review:

Body Approved:

Body Review:

Asset Display View Approved:

Asset Display View Review:

Detail View Images/Video Approved:

Detail View Images/Video Review:

Developers Guide Documentation Approved:

Developers Guide Documentation Review:

External Links Approved:

External Links Review:

Additional Notes:

Asset Review Status:

Approved

Item Logo:

Use iPhone Wrapper:

Supporting Document Link:

Use iFrame:

Item Guid:

c0e7f7479288430e9821c19b8b284bfe

Tour Link:

Item Kuid:

u4af4b26c567465eac90c48276399eec

Github Repository URL:

https://github.com/AmwayACS/AmwayIDNativeLogin/releases

Is NFI: