@combeenation/custom-code-sdk
    Preparing search index...

    Function shareConfiguration

    • Creates a copy of the current configuration and opens a share window for the given platform with the resulting share URL

      Parameters

      • data: {
            embedUrl?: string;
            imageUrl?: string;
            ogAuthor?: string;
            ogDescription?: string;
            ogTitle?: string;
            platform:
                | "Facebook"
                | "Pinterest"
                | "Twitter"
                | "LinkedIn"
                | "WhatsApp"
                | "Custom"
                | "NativeShare";
        }
        • OptionalembedUrl?: string

          URL of the parent page where the configurator is embedded.

          Will be integrated into the resulting share URL, so that the share redirects to the parent page, not the standalone configurator.

        • OptionalimageUrl?: string

          URL to an image which will be used as share preview image when supported by the platform.

          It's recommended to use the URL of a file uploaded via upload tooling of the configurator.

        • OptionalogAuthor?: string
        • OptionalogDescription?: string
        • OptionalogTitle?: string
        • platform:
              | "Facebook"
              | "Pinterest"
              | "Twitter"
              | "LinkedIn"
              | "WhatsApp"
              | "Custom"
              | "NativeShare"

          If Custom, no share window will be opened

      Returns Promise<{ shareConfigurationId: string; shareUrl: string } | undefined>

    Settings

    Member Visibility