Introduction

This package allows the Flutter app to integrate the UAE pass.

Features

• Sign-in with UAE Pass
• Login, Sign-in and logo buttons according to UAE Pass guidelines
• Support for english and arabic language
• Button supports dark mode, disable state and other customizations

Flutter Compatibility

Package version	Dart version	Flutter version
0.0.1+1 - 0.0.7+7	>=3.2.6 <4.0.0	>=1.17.0

Getting Started

To integrate the package into your Flutter project, follow these steps:

Add Dependency

Add the following dependency to your pubspec.yaml file:

    dependencies:
      ft_uaepass: ^0.0.7+7

Then run:

    flutter pub get

Android Setup

• Update android:launchMode="singleTask" to AndroidManifest.xml file

    <activity
       ..... 
       android:launchMode="singleTask"
       .....
    </activity>

• Add Permission and intent filter in AndroidManifest.xml file

    <uses-permission android:name="android.permission.QUERY_ALL_PACKAGES" />
    <uses-permission android:name="android.permission.INTERNET" />

    <intent-filter>
       <action android:name="android.intent.action.VIEW" />
       <category android:name="android.intent.category.DEFAULT"/>
       <category android:name="android.intent.category.BROWSABLE"/>
       <data
           android:host="${redirectUrl without http or https}"
           android:scheme="https" />
    </intent-filter>

iOS Setup

• Add CFBundleURLTypes and LSApplicationQueriesSchemes in info.plist file

    <key>CFBundleURLTypes</key>
    <array>
    	<dict>
    		<key>CFBundleTypeRole</key>
    		<string>Editor</string>
    		<key>CFBundleURLName</key>
    		<string>com.example</string>
    		<key>CFBundleURLSchemes</key>
    		<array>
    			<string>example</string>
    		</array>
    	</dict>
    </array>

    <key>LSApplicationQueriesSchemes</key>
    <array>
    	<string>uaepass</string>
    	<string>uaepassstg</string>
    </array>

Scope

• For now urn:uae:digitalid:profile:general scope is only supported

Usage

SignIn (Staging):

    await UaePass(
        context: context,
        redirectUrl: ${redirectUrl},
        state: ${State},
        isProduction: false,
      ).signIn();

Note:

• For Android testing follow below steps
  • Go to App info
  • Tap on the "Set as default"
  • Tap on the "Supported web addresses"
  • Turn on the switch for redirect URL

SignIn (Production):

    await UaePass(
        context: context,
        clientId: ${clientId},
        clientSecret: ${clientSecret},
        redirectUrl: ${redirectUrl},
        state: ${State},
      ).signIn();

Buttons

• Login button

    LoginWithUaePassButton(
      onPressed: () async {
        UAEPassWebViewResultModel? uaePassWebViewResultModel =
          await UaePass(
          context: context,
          clientId: ${clientId},
          clientSecret: ${clientSecret},
          redirectUrl: ${redirectUrl},
          state: ${State},
        ).signIn();
      },
    )

• Sign-in button

    SignInWithUaePassButton(
      onPressed: () async {
        UAEPassWebViewResultModel? uaePassWebViewResultModel =
          await UaePass(
          context: context,
          clientId: ${clientId},
          clientSecret: ${clientSecret},
          redirectUrl: ${redirectUrl},
          state: ${State},
        ).signIn();
      },
    )

• Logo button

    LogoButton(
      onPressed: () async {
        UAEPassWebViewResultModel? uaePassWebViewResultModel =
          await UaePass(
          context: context,
          clientId: ${clientId},
          clientSecret: ${clientSecret},
          redirectUrl: ${redirectUrl},
          state: ${State},
        ).signIn();
      },
    )

Custom Error codes (Status code)

Custom Error code	Description	Message
0	When any unknown error occur	Something went wrong. Please try again after sometime
-1	When user is SOP1	Your account is unverified, please visit the nearest UAE PASS
-2	When user cancel the request	Request canceled by user

Properties:

• Login and Sign-in Button properties

Property	Type	Default value	Other Values
onPressed	VoidCallback	Null	VoidCallback Function
buttonShape	ButtonShape	ButtonShape.defaultCornerRadius	ButtonShape.minCornerRadius ButtonShape.maxCornerRadius ButtonShape.customRadius
customBorderRadius	double	4	double - Any double value
isDarkMode	bool	false	true
isDisable	bool	false	true
isBorder	bool	true	false
isButtonMaxWidth	bool	false	true
padding	EdgeInsetsDirectional	EdgeInsetsDirectional.symmetric( horizontal: 30.0, vertical: 10.0, )	true

• Logo Button properties

Property	Type	Default value	Other Values
onPressed	VoidCallback	Null	VoidCallback Function
buttonShape	ButtonShape	ButtonShape.defaultCornerRadius	ButtonShape.minCornerRadius ButtonShape.maxCornerRadius ButtonShape.customRadius
customBorderRadius	double	4	double - Any double value
isDarkMode	bool	false	true
isDisable	bool	false	true
isBorder	bool	true	false
padding	EdgeInsetsDirectional	EdgeInsetsDirectional.symmetric( horizontal: 30.0, vertical: 10.0, )	true

Example App demo:

• Android
  
  
  

• iOS
  
  
  

UAE Pass References:

• Documentation
• Staging Apps