applicazza / whatsapp_stickers

A Flutter plugin for adding stickers to WhatsApp.

whatsapp_stickers

A Flutter plugin for adding stickers to WhatsApp.

Notes

• trayImageFileName uses PNG data whereas stickers use WebP data.

Usage

To use this plugin, add whatsapp_stickers as a dependency in your pubspec.yaml file.

Android

Add the following option to your app\build.gradle file. This will prevent all WebP files from being compressed.

android {
    aaptOptions {
        noCompress "webp"
    }
}

iOS

Do not forget to add following entry to Info.plist with Runner target.

<key>LSApplicationQueriesSchemes</key>
	<array>
		<string>whatsapp</string>
	</array>

Examples

Local assets

Put your stickers in any folder, for example, assets. Do not forget to add this folder to pubspec.yaml.

const stickers = {
  '01_Cuppy_smile.webp': ['☕', '🙂'],
  '02_Cuppy_lol.webp': ['😄', '😀'],
  '03_Cuppy_rofl.webp': ['😆', '😂'],
  '04_Cuppy_sad.webp': ['😃', '😍'],
  '05_Cuppy_cry.webp': ['😭', '💧'],
  '06_Cuppy_love.webp': ['😍', '♥'],
  '07_Cuppy_hate.webp': ['💔', '👎'],
  '08_Cuppy_lovewithmug.webp': ['😍', '💑'],
  '09_Cuppy_lovewithcookie.webp': ['😘', '🍪'],
  '10_Cuppy_hmm.webp': ['🤔', '😐'],
  '11_Cuppy_upset.webp': ['😱', '😵'],
  '12_Cuppy_angry.webp': ['😡', '😠'],
  '13_Cuppy_curious.webp': ['❓', '🤔'],
  '14_Cuppy_weird.webp': ['🌈', '😜'],
  '15_Cuppy_bluescreen.webp': ['💻', '😩'],
  '16_Cuppy_angry.webp': ['😡', '😤'],
  '17_Cuppy_tired.webp': ['😩', '😨'],
  '18_Cuppy_workhard.webp': ['😔', '😨'],
  '19_Cuppy_shine.webp': ['🎉', '✨'],
  '20_Cuppy_disgusting.webp': ['🤮', '👎'],
  '21_Cuppy_hi.webp': ['🖐', '🙋'],
  '22_Cuppy_bye.webp': ['🖐', '👋'],
};

Future installFromAssets() async {
  var stickerPack = WhatsappStickers(
    identifier: 'cuppyFlutterWhatsAppStickers',
    name: 'Cuppy Flutter WhatsApp Stickers',
    publisher: 'John Doe',
    trayImageFileName: WhatsappStickerImage.fromAsset('assets/tray_Cuppy.png'),
    publisherWebsite: '',
    privacyPolicyWebsite: '',
    licenseAgreementWebsite: '',
  );

  stickers.forEach((sticker, emojis) {
    stickerPack.addSticker(WhatsappStickerImage.fromAsset('assets/$sticker'), emojis);
  });

  try {
    await stickerPack.sendToWhatsApp();
  } on WhatsappStickersException catch (e) {
    print(e.cause);
  }
}

Remote assets

const stickers = {
  '01_Cuppy_smile.webp': ['☕', '🙂'],
  '02_Cuppy_lol.webp': ['😄', '😀'],
  '03_Cuppy_rofl.webp': ['😆', '😂'],
  '04_Cuppy_sad.webp': ['😃', '😍'],
  '05_Cuppy_cry.webp': ['😭', '💧'],
  '06_Cuppy_love.webp': ['😍', '♥'],
  '07_Cuppy_hate.webp': ['💔', '👎'],
  '08_Cuppy_lovewithmug.webp': ['😍', '💑'],
  '09_Cuppy_lovewithcookie.webp': ['😘', '🍪'],
  '10_Cuppy_hmm.webp': ['🤔', '😐'],
  '11_Cuppy_upset.webp': ['😱', '😵'],
  '12_Cuppy_angry.webp': ['😡', '😠'],
  '13_Cuppy_curious.webp': ['❓', '🤔'],
  '14_Cuppy_weird.webp': ['🌈', '😜'],
  '15_Cuppy_bluescreen.webp': ['💻', '😩'],
  '16_Cuppy_angry.webp': ['😡', '😤'],
  '17_Cuppy_tired.webp': ['😩', '😨'],
  '18_Cuppy_workhard.webp': ['😔', '😨'],
  '19_Cuppy_shine.webp': ['🎉', '✨'],
  '20_Cuppy_disgusting.webp': ['🤮', '👎'],
  '21_Cuppy_hi.webp': ['🖐', '🙋'],
  '22_Cuppy_bye.webp': ['🖐', '👋'],
};

Future installFromRemote() async {
  var applicationDocumentsDirectory = await getApplicationDocumentsDirectory();
  var stickersDirectory = Directory('${applicationDocumentsDirectory.path}/stickers');
  await stickersDirectory.create(recursive: true);

  final dio = Dio();
  final downloads = <Future>[];

  stickers.forEach((sticker, emojis) {
    downloads.add(
      dio.download(
        'https://github.com/applicazza/whatsapp_stickers/raw/master/example/assets/$sticker',
        '${stickersDirectory.path}/$sticker',
      ),
    );
  });

  await Future.wait(downloads);

  var stickerPack = WhatsappStickers(
    identifier: 'cuppyFlutterWhatsAppStickers',
    name: 'Cuppy Flutter WhatsApp Stickers',
    publisher: 'John Doe',
    trayImageFileName: WhatsappStickerImage.fromAsset('assets/tray_Cuppy.png'),
    publisherWebsite: '',
    privacyPolicyWebsite: '',
    licenseAgreementWebsite: '',
  );

  stickers.forEach((sticker, emojis) {
    stickerPack.addSticker(WhatsappStickerImage.fromFile('${stickersDirectory.path}/$sticker'), emojis);
  });

  try {
    await stickerPack.sendToWhatsApp();
  } on WhatsappStickersException catch (e) {
    print(e.cause);
  }
}

whatsapp_stickers's Issues

App Crashing after using some time

App crashing after installing the app on android mobile.
And I'm unable to add stickers to whatsapp even in debug mode. It is raising an Java IO Exception : Can't load the file although all files are included correctly.

currently support andiod?

Please add animated sticker support

The "WhatsApp is not installed" exception doesn't throw on iOS

On Android, when WhatsApp is not installed, the WhatsappStickers.sendToWhatsApp() method throws WhatsappStickersException with WhatsappStickersException.cause "WhatsApp is not installed on target device!".
This makes it fairly easy to show a dialog to users prompting them to install WhatsApp.

Unfortunately, on iOS, no exception is thrown.
Instead, the following message appears 3 times in the console:
-canOpenURL: failed for URL: "whatsapp://" - error: "The operation couldn’t be completed. (OSStatus error -10814.)"

It would be great if iOS had the same behavior as Android.

whatsapp_stickers: 0.0.4
iOS: 14.4

For those looking for a fix, I created a new package

First, thank you @applicazza for POC and code base.

However, this package is broken and seems no longer being maintained.

I create a new package here: https://pub.dev/packages/whatsapp_stickers_exporter , which is freshly drafted and tested on both iOS and Android and confirmed working, some codes are borrowed from this project.

The one I made also supports animated stickers on both platforms, and addressed the sticker order issue.

Repo is here: https://github.com/star-39/whatsapp_stickers_exporter

How can i verify weather a sticker is already added to whats app or not?

We are sending the Sticker pack to what's app but how can i verify weather a particular sticker is already added or not to whats app...

I would like to show a plus icon if its not added and if it is already added then i would like to show a check mark...
Can any one tell the necessary stuff to do for the verification of this thing..

Keep trying add to whatsapp

Hi. Thanks about this library. It helps a lot.
Version 0.0.4 is much better. But still one bug:

Steps:

1. Add package to WA
2. Exit form WA. Doesn't matter if package added or not.
3. Back to my app
4. My app trying to add the package again and again
5. Sometimes after that, WA crashing, or error message: "operation couldn't be completed(com.third-party-sticker 1000)"

My code:

  var stickerPack = WhatsappStickers(
        identifier: category.identifier,
        name: category.title,
        publisher: pack.publisher,
        trayImageFileName: WhatsappStickerImage.fromFile(
            '${category.directoryPath}/${category.trayImageFile}'),
        publisherWebsite: pack.publisherWebsite,
        privacyPolicyWebsite: pack.privacyPolicyWebsite,
        licenseAgreementWebsite: pack.licenseAgreementWebsite,
      );

      category.stickers.forEach((sticker) {
        stickerPack.addSticker(
            WhatsappStickerImage.fromFile(
                '${category.directoryPath}/${sticker.imageFile}'),
            sticker.emojis);
      });

      stickerPack
          .sendToWhatsApp()
          .then((value) => analytics.logEvent(name: 'SuccessfullyAddedPackage'))
          .catchError((err) {
        print(err);
        analytics.logEvent(name: 'FailedAddedPackage');
      });

Link for video of the problem:

I need your help about stickers, Whatsapp and Xcode

I do like to learn how to add my own stickers for Whatsapp from Xcode. If you can make print screens or tutorial video for me. It is easy for me to understand better tutorial video or print screens.

I would be appreciate.

Crash on app exit

Please Upgrade This Package not Working with Latest Flutter Version

Please Upgrade This Package not Working with Latest Flutter Version

operation couldn't be completed(com.third-party-sticker 1000)

I use your plugin successful,but there is a bug exist,the following error often occurs:
operation couldn't be completed(com.third-party-sticker 1000)
hpoe to get your reply and solution,thanks

Unhandled Exception: MissingPluginException(No implementation found for method sendToWhatsApp on channel whatsapp_stickers)

Hi, Nice plugin, But i always get this error only.

Unhandled Exception: MissingPluginException(No implementation found for method sendToWhatsApp on channel whatsapp_stickers)

Even i tried all the ways flutter clean and also delete plugin and reinstall always getting same error. Can you please guide me.
my flutter version 1.17.4
plugin: whatsapp_stickers: ^0.0.2

Thanks.

Deprecated Package: Please Upgrade Thi Package because this package is totally deprecated

I am too much frustrated with this package, everything is deprecated not working, please upgrade this package or remove from package manager and from git also 😡😠😤🤯

There's a problem with this sticker pack

I have been trying to make this work however I keep getting There's a problem with this sticker pack and it can't be added to WhatsApp
I verified all stickers match the specification too.
sticker_pack.json: https://del.dog/allingista.txt
stickers.zip attached
stickers.zip

Missing Plugin Exception

Whenever I launch the app on my android phone an try to add the stickers pack I run into Missing Plugin Exception error.I googled for the reason and tried flutter clean command but the issue still occurred

I would like to know whether the sticker package has been added before, so as to avoid adding the same sticker package. Can I provide API

@applicazza
I would like to know whether the sticker package has been added before, so as to avoid adding the same sticker package. Can you provide API.

assets://sticker_packs/6/1.webp: (512.0, 512.0) is not compliant with sticker images dimensions, (512.0, 512.0)

Even though I'm using the example repos stickers, it shows me this error even when the dimentions are 512x512.

Please upgrade the package

The package is outdated and not compatible with flutter SDK 3.0, even conflicts with the package (video_editor 1.4.3)

"There's a problem with this sticker pack and it cant be added to Whatsapp" on android for remote assets

On android when trayImageFileName is used from remote and identifier is not "cuppyFlutterWhatsAppStickers" gives this error from whatsapp

working code

  var stickerPack = WhatsappStickers(
    name: 'Vinil test',
    publisher: 'Vinil Prabhu',
    identifier: 'cuppyFlutterWhatsAppStickers',
    trayImageFileName: WhatsappStickerImage.fromFile(
        '${stickersDirectory.path}/tray_Cuppy.png'),
    publisherWebsite: '',
    privacyPolicyWebsite: '',
    licenseAgreementWebsite: '',
  );

this throws error

  var stickerPack = WhatsappStickers(
  name: 'Vinil test',
  publisher: 'Vinil Prabhu',
  identifier: 'viniltestOne',
  trayImageFileName: WhatsappStickerImage.fromFile(
      '${stickersDirectory.path}/tray_Cuppy.png'),
  publisherWebsite: '',
  privacyPolicyWebsite: '',
  licenseAgreementWebsite: '',
);

whatsapp_stickers: 0.0.4
android: 11
whatsapp: [phone]

Keep prompting wants to open WhatsApp dialog

I have prepared a sticker package with 6 stickers.

But it keeps prompting My App wants to open WhatsApp dialog when clicking the "Add Sticker" button

I failed to use this plugin，Is the plugin finished,Can it be used successful

1.Please provide a detailed instruction.
2.Is the local and dynamic usage the same?，local：Put the picture on the asset.dynamic:Download from the network.
3.no other configuration?
4.now,I tried to use assets.but failed,and no exception,dynamic,It show thats not found picture.
5.If it is not finished,please talk to me.
thanks
@applicazza

Always get FILE_NOT_FOUND Exception

my sticker are stored in server so first user download stickers and i store those sticker into Application Documents Directory with help of getApplicationDocumentsDirectory() method and after that i call the " await stickerPack.sendToWhatsApp();" but always get FILE_NOT_FOUND Exception.