Google Phone Number Hint (Android)

A Flutter plugin to easily fetch the user's mobile number using the Google Play Services Phone Number Hint API on Android.

Features

Fetches the user's mobile number via the Google Phone Number Hint API.
Simplifies the process of prompting users to select a phone number linked to their Google account.

Demo

Supported Platforms

Android (requires Google Play Services).

Installation

Add the following to your pubspec.yaml:

dependencies:
  google_phone_number_hint: ^0.0.3

Run the following command to install the package:

flutter pub get

Android Setup

Add the following dependency in your android/app/build.gradle file:

dependencies {
    implementation 'com.google.android.gms:play-services-auth:21.2.0'
}

Ensure your minSdkVersion is set to 21 or higher in android/app/build.gradle:

android {
    defaultConfig {
        minSdkVersion 21
    }
}

Make sure to enable AndroidX support in gradle.properties:

android.useAndroidX=true
android.enableJetifier=true

Usage

Import the package in your Dart code:

import 'package:google_phone_number_hint/google_phone_number_hint.dart';

Example

Use the GooglePhoneNumberHint plugin to get the user's mobile number:

import 'package:flutter/material.dart';
import 'package:google_phone_number_hint/google_phone_number_hint.dart';

void main() => runApp(MyApp());

class MyApp extends StatefulWidget {
  @override
  _MyAppState createState() => _MyAppState();
}

class _MyAppState extends State<MyApp> {
  String? _mobileNumber;

  Future<void> _getMobileNumber() async {
    try {
      final number = await GooglePhoneNumberHint().getMobileNumber();
      setState(() {
        _mobileNumber = number;
      });
    } catch (e) {
      print('Error getting mobile number: $e');
    }
  }

  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(title: Text('Google Phone Number Hint Example')),
        body: Center(
          child: Column(
            mainAxisAlignment: MainAxisAlignment.center,
            children: <Widget>[
              Text(_mobileNumber ?? 'No number selected'),
              SizedBox(height: 20),
              ElevatedButton(
                onPressed: _getMobileNumber,
                child: Text('Get Mobile Number'),
              ),
            ],
          ),
        ),
      ),
    );
  }
}

Explanation

GooglePhoneNumberHint().getMobileNumber(): Prompts the user to select a phone number from their Google account and returns it as a String.

API Reference