Function createNativeClipboardService

Parameters

• clipboardModule: {
      addListener(callback) => EmitterSubscription;
      getImage() => Promise<string>;
      getImageJPG() => Promise<string>;
      getImagePNG() => Promise<string>;
      getString() => Promise<string>;
      getStrings() => Promise<string[]>;
      hasImage() => any;
      hasNumber() => any;
      hasString() => any;
      hasURL() => any;
      hasWebURL() => any;
      removeAllListeners() => void;
      setImage(content) => void;
      setString(content) => void;
      setStrings(content) => void;
  }

  • addListener:function

    • addListener(callback): EmitterSubscription

    • (iOS and Android Only) Adds a listener to get notifications when the clipboard has changed. If this is the first listener, turns on clipboard notifications on the native side. It returns EmitterSubscription where you can call "remove" to remove listener

      const listener = () => console.log("changed!");
      Clipboard.addListener(listener);
      Copy

      Parameters

      • callback: (() => void)

        • • (): void

          • Returns void

      Returns EmitterSubscription

  • getImage:function

    • getImage(): Promise<string>

    • (Android Only) Get clipboard image in base64, this method returns a Promise, so you can use following code to get clipboard content

      async _getContent() {
        var content = await Clipboard.getImage();
      }
      Copy

      Returns Promise<string>

  • getImageJPG:function

    • getImageJPG(): Promise<string>

    • Get clipboard image as JPG in base64, this method returns a Promise, so you can use following code to get clipboard content

      async _getContent() {
        var content = await Clipboard.getImageJPG();
      }
      Copy

      Returns Promise<string>

  • getImagePNG:function

    • getImagePNG(): Promise<string>

    • Get clipboard image as PNG in base64, this method returns a Promise, so you can use following code to get clipboard content

      async _getContent() {
        var content = await Clipboard.getImagePNG();
      }
      Copy

      Returns Promise<string>

  • getString:function

    • getString(): Promise<string>

    • Get content of string type, this method returns a Promise, so you can use following code to get clipboard content

      async _getContent() {
        var content = await Clipboard.getString();
      }
      Copy

      Returns Promise<string>

  • getStrings:function

    • getStrings(): Promise<string[]>

    • (iOS Only) Get contents of string array type, this method returns a Promise, so you can use following code to get clipboard content

      async _getContent() {
        var content = await Clipboard.getStrings();
      }
      Copy

      Returns Promise<string[]>

  • hasImage:function

    • hasImage(): any

    • Returns whether the clipboard has an image or is empty. This method returns a Promise, so you can use following code to check clipboard content

      async _hasContent() {
        var hasContent = await Clipboard.hasImage();
      }
      Copy

      Returns any

  • hasNumber:function

    • hasNumber(): any

    • (iOS 14+ Only) Returns whether the clipboard has a Number(UIPasteboardDetectionPatternNumber) content. Can check if there is a Number content in clipboard without triggering PasteBoard notification for iOS 14+ This method returns a Promise, so you can use following code to check for Number content in clipboard.

      async _hasNumber() {
        var hasNumber = await Clipboard.hasNumber();
      }
      Copy

      Returns any

  • hasString:function

    • hasString(): any

    • Returns whether the clipboard has content or is empty. This method returns a Promise, so you can use following code to get clipboard content

      async _hasContent() {
        var hasContent = await Clipboard.hasString();
      }
      Copy

      Returns any

  • hasURL:function

    • hasURL(): any

    • (iOS Only) Returns whether the clipboard has a URL content. Can check if there is a URL content in clipboard without triggering PasteBoard notification for iOS 14+ This method returns a Promise, so you can use following code to check for url content in clipboard.

      async _hasURL() {
        var hasURL = await Clipboard.hasURL();
      }
      Copy

      Returns any

  • hasWebURL:function

    • hasWebURL(): any

    • (iOS 14+ Only) Returns whether the clipboard has a WebURL(UIPasteboardDetectionPatternProbableWebURL) content. Can check if there is a WebURL content in clipboard without triggering PasteBoard notification for iOS 14+ This method returns a Promise, so you can use following code to check for WebURL content in clipboard.

      async _hasWebURL() {
        var hasWebURL = await Clipboard.hasWebURL();
      }
      Copy

      Returns any

  • removeAllListeners:function

    • removeAllListeners(): void

    • (iOS and Android Only) Removes all previously registered listeners and turns off notifications on the native side.

      Clipboard.removeAllListeners();
      Copy

      Returns void

  • setImage:function

    • setImage(content): void

    • (iOS Only) Set content of base64 image type. You can use following code to set clipboard content

      _setContent() {
        Clipboard.setImage(...);
      }
      Copy

      Parameters

      • content: string

      Returns void

  • setString:function

    • setString(content): void

    • Set content of string type. You can use following code to set clipboard content

      _setContent() {
        Clipboard.setString('hello world');
      }
      Copy

      Parameters

      • content: string

      Returns void

  • setStrings:function

    • setStrings(content): void

    • Set content of string array type. You can use following code to set clipboard content

      _setContent() {
        Clipboard.setStrings(['hello world', 'second string']);
      }
      Copy

      Parameters

      • content: string[]

      Returns void