SetScreenshot

Description

The SetScreenshot method specifies the current screenshot to use for the current page.

Parameters

• Image (required): the image data to use for the screenshot. Any supported format can be used: BMP, JPG, PNG, JPEG, WBMP, GIF, etc.
• ApiKey (optional): To authenticate the command. Required if enabled on the Controller.

REST example

Binary images have to be encoded using Base64 format.

POST http://localhost:7400/Design/v1/Service.svc/SetScreenshot HTTP/1.1

Accept: application/json

Content-Type:application/json

Cache-Control:nocache

Pragma: nocache

User-Agent:Java/1.7.0_10

Host: localhost:7400

Connection: keepalive

Content-Length:207

{"d": {

     "Image": "iVBORw0KGgoAAAANSUhEUgAAAHgAAAAbCAIAAAA4ZtxxAAAAGXRFWHRTb2Z0d2FyZQBBZG9iZSBJbWFnZVJlYWR5ccllPAAACMBJREFUeNrsWX9wFNUd3729zV2Sy10wkAAhyRkCJWMgWNQqOPLDaZzQTklwOsYpQmwdix1b4yD+5UDofxU70mkppXVsLHa0fxRibWWgmtJCGHEkAmYwkIAXKJCLkHiXu9zt7b63fnZfsrfc7V0uCbT+cS8vN3u7b9++93mf9/l+vnu8qqpcBuXsuQFO5dCWqirqfG+RK9/BZUvGhU8P9Pm+wQ/+0/vx2SuEqgqhMiGSTCMKichkpstRv3xBU8PdBa4s4tMGOhKRf/PasUv+ANVQpjEFQCtRmYyixpRQTMkRbB/++Wme57NQpi82y7PXAj3sIDdXfPapB8uK3bkOe57Dnptjd4p2h11wCDat2oWwTHr7rlNKs1CmL/bkU/1Dp84PHJ3jWWRgvemxe3f/8RhEQ98BHIFMUxDcJhIq2vhQSFI5XlGoINgmZPaR05fZgXe221visWxz6sLglyFp6fziQpeDHafqDQ3QjB2jGRrr7aPjV524yvoxPzpNwajQD2qa4bEH4cAYoW8gwM6wsqq2PPn2RKB9N7q6Lr8z111tPllSUlD30Df+efS8OgaxIAvUrlXebuM5/PFapIxFgqLI2UR3mpmsfuFtdlBbWXxq7ybLNi2/7fj3mcv/eqVpVW0ZO07V28olZUd+2cRu+dWBk6mabX9ieevGFcaj0xS0xOeOfcc9+Q7fmz8utAo/zTvfe+d4X0WJ+28/X79qy3unLw4mNMDt+NxUV9O2td4a6LA0/Mnld4GeYBMSbn5weWVP3+Dn/x2SFRvwFXSI8YeqKb0u93LwQuSLjsLFWzLZShjfrv0nW9Yvy6QxBu0tcVsRUGNN2+FuhvK65VUGwY0NhHXCzHGegWgU3NXvDyb0DDKiJbsEQNt3NCY8sb2zFyhrt29d+7PdH2AWWJLmuhrzkvj8wTcOd6OiK2OCNwHddaldoTGosTt3TvKsvr+udvfrndGYAoFgVeA51G8uncciqjhjcbBro6vycXv+3PTAAREMt/VPnQ0rqlLt0JtIVFcDdqe62nao26Bt8tWG7QfwLGCXgBrWQEPTqmeACPrjLrQxX4VotOzpwMFzjcsAIttq2JfJUyjMd2DtsSoG0PFgGJKGfMNn2LEoWGwZjyd37cPVE4IS7Nk9YZuW9fdg1wfCErb89OMMmzDImOpZGssGgpl3CHBBBaYS5ggBZmBtIBpYUSbKoLMlURpWLEjpOs5efX88HdGq5QiWLim9b3EZ1TIXVrh4hXk4rztElUTxbBr1H8xkMrt+sgafjDW3JKynoTxTqkn1BlIDRMC6a//Hxg5gArXrmTWFE6UO4DtiDJtjItBXAp9RlRKVEFVxigWpuvje2prSWW4tf0FV1dkzXDrIetIY8eNIJYMR/4kJZ4KhYAMy1nwN3RigZDBB3xl52eYD0xlbGdbYlD5/wPJ2LLw5YMQ1emDkAtSZ8HaF2s1AK+Er9vxS4yvc3pOP3bvt1UPDVALcC8qLNJx1dmtCrRL8x4Y/yy351oSTwQZsP94L1mBLWsqr2fClcmOZSPzUCuQb6g9dan75IGIJi3tgukEUfAXQDdvaWx5dZgzD7Dit7R2IrFDZBjdBBM4kHZL/mKSqed5Gfly4y8oKtz/37R+1tiMpr/LOZJEQn8rwJ1o3KpLIYKaseWZNY2s7WNP8SE0ayJ7f05HGt90+Xre9WH/nht8DYqY8sGtm0cDX5p0HcenJnYlqiTUA8c0iEwdaprExu8bzlDNpNJXl0MVQb5trQbOBtbfijj9sW/fCL/5RVTlLEw2q6tJxFSiD1Jm9pxoLGsyBgDXMEU/K3qUKgLeqYO2xlswXG6JhHryvthybEgmLkWfp9i7Qrzs8thgWQPOaKeZ1BYhDJYc+R5hTQhdHevYULNrMC052vvLOov2/26inMGORkQS7IRucKk9qMpBC5nZhhpKDdSb27rYW7BgGNHMvyZsSY7OY1P6T2IXA2gA6HgwFXoyRqESiMTJKNakdJ3RsWCURYC2HLoyc25vQI9XpTKkmHXL4hKqjLOTPmxRrmNnENkyTbX/dCoYKfqQKHsmJWBzoEldFjEjAOkqiZnun0ihQVqnEAevh06Hzr8dlneopuQa0Kg+d0ehMYzjvmFE9WdYgI0dgQVSczsz/l0ADYiQ1mecBcaAXznoAXJZIJEYi1KyyJMqqBjeRItcOQUPGUdbMIJMOEuxRdZQ5+0znHdWTHTfzUjCqqTiSpnj0nyBS3cjeMWEhbxPckwZ6SWl9lIzqNaxycenQdINGqUZqVO04cvXdkXOvAWBCxuisvWkaOsHU2Tln09TSDWarp5ArMvk2MotkudTcWNUtBhrOkvloS6zZQz2mH6HiwdApuh4qaDri20dUcXj0amnhXePSEWHuDSTmtKRR4VQl3N/GO8uF4tUMaLBbvr5PV/pZnkU/nHLYaTvcbfmuDuhbJmNwrNgKCFPwLajeDXuh+N7ZHlgUnz8IM8AMgKVoTt+QrFxShtHevfkNHCSIGLOD5jh400ulhxduPtr/dlQJXx+5BPi095/gvLNMCZ/Tkz+qAw24kRIqI2dfdIaetZdv0LLEwaOshzzvT0VTdjOFZCzZk06YQIPRB1obWvZ0AFPUhKWqKHHDz1omEdMs7TsaW3RrYUkObFCzx0/8Kavv2kevHHv8/nnf+cE9r+pv8flA11b5yxOM25rLGAMaNk6CKIvFG8SFL0mfblGG3rJ76mevfuv/6ATA34SXR8Zb/9sdGM2h2DI5tPjN8MOev/69+9cvffd97TLPhc5si904rKOs6okfpEPWP2PQa0i4kL+ChDuF/AeKV/5FyHFz2WJVLH7Kun/Ro0Sh3WggN0d742HLq1S/COkpDGGJ3zjQY4kJUM6Z2VR038tZlNOUlL+CQ6MlSZEVQq53jnZv1OOhjrIeEuP3O6oLFm51z1+fhXKKQJvhDnSuU0LHEy6JRU3OuXWeLMS3BGjTm6VA9EYPa2p3uCeb+2XLVwIMAD8HSVqGuof+AAAAAElFTkSuQmCC"

}} 

Use case with Command Line Designer

• Note: The Image argument is the absolute path of the image.

  java -cp "api/Common/java/*;api/Design API Client/java/*" com.neotys.rest.design.client.CommandLineDesigner -designAPIURL http://localhost:7400/Design/v1/Service.svc/ -command SetScreenshot -Image C:\tmp\image.jpg

Use case with Java Client Designer

import java.io.File;

import javax.imageio.ImageIO;

import com.neotys.rest.design.client.DesignAPIClient;

import com.neotys.rest.design.client.DesignAPIClientFactory;

import com.neotys.rest.design.model.SetScreenshotParams;

public class Main {

	public static void main(String[] args) throws Exception {

		final String url = "http://localhost:7400/Design/v1/Service.svc";

		final DesignAPIClient client = DesignAPIClientFactory.newClient(url);

		final String imagePath = "imagePath";

		final File imageFile = new File(imagePath);

		final SetScreenshotParams setScreenshot = new SetScreenshotParams(ImageIO.read(imageFile));

		client.setScreenshot(setScreenshot);

	}

}

Use case with C#Client

using Neotys.DesignAPI.Client;

using Neotys.DesignAPI.Model;

using System.Drawing;

using System.IO;

namespace Design

{

    class SetScreenshot

    {

        static void Main(string[] args)

        {

            string url = "http://localhost:7400/Design/v1/Service.svc/";

            IDesignAPIClient client = DesignAPIClientFactory.NewClient(url);

            Image img = Image.FromFile(@"imagePath");

            byte[] array;

            using (MemoryStream ms = new MemoryStream())

            {

                img.Save(ms, System.Drawing.Imaging.ImageFormat.Png);

                array = ms.ToArray();

            }

            client.SetScreenshot(new SetScreenshotParams(array));

        }

    }

}

Home