Asset Amway ID Logout 1.0.2

Downloadable Asset:

com.alticor.logout.zip

Developer Guide Documentation:

logout_marketplace_component_template.docx

Asset Version:

1.0.2

Asset Description:

Amway ID supports Logout as a component to integrate anywhere in your app, to invalidate the session.

Details:

Component documentation fix
 1 Overview

Amway ID supports Logout as a component to integrate anywhere in your app, to invalidate the session.

2 Getting Started with the AmwayID Logout component

This is a Getting Started section for the AmwayID Logout. 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 logout 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>
</ul>

Before you can begin, logout URL is required to implement this solution:

<ol>
<li>Make sure that you have proper configurations for logout at Mobile Fabric App (i.e. logout URL and revoke URL).</li>
<li>You will need to work with an Amway ID technical member to determine the correct logout URL.</li>
</ol>

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 Logout 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 Logout.</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.logout .</li>
<li>After you import the component, you can drag and drop it from the Collection Library onto your form.</li>
</ul>

Save the form now.

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 Visualizer. You can also configure these properties using JavaScript code.

4.2 Setting Properties

Logout Button isVisible

Description:

Enable/Disable Visibility of default logout button or will use your own custom button.

Syntax: logoutBtnIsVisible

Type: Boolean

Read/Write: Write

Example:

this.view.logout.logoutBtnIsVisible = true;

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.logout.identityServiceID = "QAAmwayIDAuthService ";

Client AppName

Description:

The clientapp identifier of the destination application.

Do not use the native app's clientapp here; instead, use the clientapp used by the application you are going to.

Syntax: clientAppName

Type: String

Read/Write: Write

Example:

this.view.logout.clientAppName = "konypocv2";

Loading Indicator Skin

Description:

Loading Indicator Skin to match with app loading indicator skin.

Syntax: loadingIndSkin

Type: String

Read/Write: Write

Example:

this.view.logout.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 Logout Events

5.1.1 onLogoutSuccess

Description:

Its Logout success callback where need to write business logic what to do after successful logout.

Syntax: onLogoutSuccess()

Parameters: None.

Return Value: None.

Example:

this.view.logout.onLogoutSuccess = this.onLogoutSuccess;

Ex: onLogoutSuccess : function (){

var ntf = new kony.mvc.Navigation("GCLogin");

ntf.navigate({"isReqFromLogout" : true});

kony.application.destroyForm("frmHome");

},

5.1.2 onLogoutFailure

Description:

Its Logout Failure callback where need to write business logic what to do if logout fails.

Syntax: onLogoutFailure()

Parameters: None.

Return Value: None.

Example:

this.view.logout.onLogoutFailure = this.onLogoutFailure;

Ex: onLogoutFailure : function(){

kony.print("Logout failed...");

},

6 External Links

Please find the confluence link <a href="https://jira.amway.com:8444/display/GIW/Logout+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:

d284c688f54a4ca7aadf33136b33209a

Tour Link:

Item Kuid:

u175563a0caa4786a5d788e1958272a8

Github Repository URL:

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

Is NFI: