How to use RemoteObject class of PuppeteerSharp.Messaging package

Best Puppeteer-sharp code snippet using PuppeteerSharp.Messaging.RemoteObject

JSHandle.cs

Source:JSHandle.cs

...15        {16            ExecutionContext = context;17            Client = client;18            Logger = Client.Connection.LoggerFactory.CreateLogger(GetType());19            RemoteObject = remoteObject;20        }21        /// <summary>22        /// Gets the execution context.23        /// </summary>24        /// <value>The execution context.</value>25        public ExecutionContext ExecutionContext { get; }26        /// <summary>27        /// Gets or sets a value indicating whether this <see cref="JSHandle"/> is disposed.28        /// </summary>29        /// <value><c>true</c> if disposed; otherwise, <c>false</c>.</value>30        public bool Disposed { get; private set; }31        /// <summary>32        /// Gets or sets the remote object.33        /// </summary>34        /// <value>The remote object.</value>35        public JToken RemoteObject { get; }36        /// <summary>37        /// Gets the client.38        /// </summary>39        /// <value>The client.</value>40        protected CDPSession Client { get; }41        /// <summary>42        /// Gets the logger.43        /// </summary>44        /// <value>The logger.</value>45        protected ILogger Logger { get; }46        /// <summary>47        /// Fetches a single property from the referenced object48        /// </summary>49        /// <param name="propertyName">property to get</param>50        /// <returns>Task of <see cref="JSHandle"/></returns>51        public async Task<JSHandle> GetPropertyAsync(string propertyName)52        {53            var objectHandle = await ExecutionContext.EvaluateFunctionHandleAsync(@"(object, propertyName) => {54              const result = { __proto__: null};55              result[propertyName] = object[propertyName];56              return result;57            }", this, propertyName).ConfigureAwait(false);58            var properties = await objectHandle.GetPropertiesAsync().ConfigureAwait(false);59            properties.TryGetValue(propertyName, out var result);60            await objectHandle.DisposeAsync().ConfigureAwait(false);61            return result;62        }63        /// <summary>64        /// Returns a <see cref="Dictionary{TKey, TValue}"/> with property names as keys and <see cref="JSHandle"/> instances for the property values.65        /// </summary>66        /// <returns>Task which resolves to a <see cref="Dictionary{TKey, TValue}"/></returns>67        /// <example>68        /// <code>69        /// var handle = await page.EvaluateExpressionHandle("({window, document})");70        /// var properties = await handle.GetPropertiesAsync();71        /// var windowHandle = properties["window"];72        /// var documentHandle = properties["document"];73        /// await handle.DisposeAsync();74        /// </code>75        /// </example>76        public async Task<Dictionary<string, JSHandle>> GetPropertiesAsync()77        {78            var response = await Client.SendAsync("Runtime.getProperties", new79            {80                objectId = RemoteObject[MessageKeys.ObjectId].AsString(),81                ownProperties = true82            }).ConfigureAwait(false);83            var result = new Dictionary<string, JSHandle>();84            foreach (var property in response[MessageKeys.Result])85            {86                if (property[MessageKeys.Enumerable] == null)87                {88                    continue;89                }90                result.Add(property[MessageKeys.Name].AsString(), ExecutionContext.CreateJSHandle(property[MessageKeys.Value]));91            }92            return result;93        }94        /// <summary>95        /// Returns a JSON representation of the object96        /// </summary>97        /// <returns>Task</returns>98        /// <remarks>99        /// The method will return an empty JSON if the referenced object is not stringifiable. It will throw an error if the object has circular references100        /// </remarks>101        public async Task<object> JsonValueAsync() => await JsonValueAsync<object>().ConfigureAwait(false);102        /// <summary>103        /// Returns a JSON representation of the object104        /// </summary>105        /// <typeparam name="T">A strongly typed object to parse to</typeparam>106        /// <returns>Task</returns>107        /// <remarks>108        /// The method will return an empty JSON if the referenced object is not stringifiable. It will throw an error if the object has circular references109        /// </remarks>110        public async Task<T> JsonValueAsync<T>()111        {112            var objectId = RemoteObject[MessageKeys.ObjectId];113            if (objectId != null)114            {115                var response = await Client.SendAsync("Runtime.callFunctionOn", new Dictionary<string, object>116                {117                    ["functionDeclaration"] = "function() { return this; }",118                    [MessageKeys.ObjectId] = objectId,119                    ["returnByValue"] = true,120                    ["awaitPromise"] = true121                }).ConfigureAwait(false);122                return (T)RemoteObjectHelper.ValueFromRemoteObject<T>(response[MessageKeys.Result]);123            }124            return (T)RemoteObjectHelper.ValueFromRemoteObject<T>(RemoteObject);125        }126        /// <summary>127        /// Disposes the Handle. It will mark the JSHandle as disposed and release the <see cref="JSHandle.RemoteObject"/>128        /// </summary>129        /// <returns>The async.</returns>130        public async Task DisposeAsync()131        {132            if (Disposed)133            {134                return;135            }136            Disposed = true;137            await RemoteObjectHelper.ReleaseObject(Client, RemoteObject, Logger).ConfigureAwait(false);138        }139        /// <inheritdoc/>140        public override string ToString()141        {142            if ((RemoteObject)[MessageKeys.ObjectId] != null)143            {144                var type = RemoteObject[MessageKeys.Subtype] ?? RemoteObject[MessageKeys.Type];145                return "JSHandle@" + type;146            }147            return "JSHandle:" + RemoteObjectHelper.ValueFromRemoteObject<object>(RemoteObject)?.ToString();148        }149        internal object FormatArgument(ExecutionContext context)150        {151            if (ExecutionContext != context)152            {153                throw new PuppeteerException("JSHandles can be evaluated only in the context they were created!");154            }155            if (Disposed)156            {157                throw new PuppeteerException("JSHandle is disposed!");158            }159            var unserializableValue = RemoteObject[MessageKeys.UnserializableValue];160            if (unserializableValue != null)161            {162                return unserializableValue;163            }164            if (RemoteObject[MessageKeys.ObjectId] == null)165            {166                var value = RemoteObject[MessageKeys.Value];167                return new { value };168            }169            var objectId = RemoteObject[MessageKeys.ObjectId];170            return new { objectId };171        }172    }173}...

Worker.cs

Source:Worker.cs

...26        private ExecutionContext _executionContext;27        // private readonly Func<ConsoleType, JSHandle[], StackTrace, Task> _consoleAPICalled;28        private readonly Action<EvaluateExceptionResponseDetails> _exceptionThrown;29        private readonly TaskCompletionSource<ExecutionContext> _executionContextCallback;30        private Func<ExecutionContext, RemoteObject, JSHandle> _jsHandleFactory;31        internal Worker(32            CDPSession client,33            string url,34            Func<ConsoleType, JSHandle[], Task> consoleAPICalled,35            Action<EvaluateExceptionResponseDetails> exceptionThrown)36        {37            _client = client;38            Url = url;39            _exceptionThrown = exceptionThrown;40            _client.MessageReceived += OnMessageReceived;41            _executionContextCallback = new TaskCompletionSource<ExecutionContext>(TaskCreationOptions.RunContinuationsAsynchronously);42            _ = _client.SendAsync("Runtime.enable").ContinueWith(task =>43            {44            });...

RemoteObjectHelper.cs

Source:RemoteObjectHelper.cs

...6using PuppeteerSharp.Helpers.Json;7using System.Numerics;8namespace PuppeteerSharp.Helpers9{10    internal class RemoteObjectHelper11    {12        internal static object ValueFromRemoteObject<T>(RemoteObject remoteObject)13        {14            var unserializableValue = remoteObject.UnserializableValue;15            if (unserializableValue != null)16            {17                return ValueFromUnserializableValue(remoteObject, unserializableValue);18            }19            var value = remoteObject.Value;20            if (value == null)21            {22                return default(T);23            }24            return typeof(T) == typeof(JToken) ? value : ValueFromType<T>(value, remoteObject.Type);25        }26        private static object ValueFromType<T>(JToken value, RemoteObjectType objectType)27        {28            switch (objectType)29            {30                case RemoteObjectType.Object:31                    return value.ToObject<T>(true);32                case RemoteObjectType.Undefined:33                    return null;34                case RemoteObjectType.Number:35                    return value.Value<T>();36                case RemoteObjectType.Boolean:37                    return value.Value<bool>();38                case RemoteObjectType.Bigint:39                    return value.Value<double>();40                default: // string, symbol, function41                    return value.ToObject<T>();42            }43        }44        private static object ValueFromUnserializableValue(RemoteObject remoteObject, string unserializableValue)45        {46            if (remoteObject.Type == RemoteObjectType.Bigint &&47                                decimal.TryParse(remoteObject.UnserializableValue.Replace("n", ""), out var decimalValue))48            {49                return new BigInteger(decimalValue);50            }51            switch (unserializableValue)52            {53                case "-0":54                    return -0;55                case "NaN":56                    return double.NaN;57                case "Infinity":58                    return double.PositiveInfinity;59                case "-Infinity":60                    return double.NegativeInfinity;61                default:62                    throw new Exception("Unsupported unserializable value: " + unserializableValue);63            }64        }65        internal static async Task ReleaseObjectAsync(CDPSession client, RemoteObject remoteObject, ILogger logger)66        {67            if (remoteObject.ObjectId == null)68            {69                return;70            }71            try72            {73                await client.SendAsync("Runtime.releaseObject", new RuntimeReleaseObjectRequest74                {75                    ObjectId = remoteObject.ObjectId76                }).ConfigureAwait(false);77            }78            catch (Exception ex)79            {...

ElementHandle.cs

Source:ElementHandle.cs

...9    {10        internal ElementHandle(11            ExecutionContext context,12            CDPSession client,13            RemoteObject remoteObject)14            : base(context, client, remoteObject) { }15    }16}...

EvaluateHandleResponse.cs

Source:EvaluateHandleResponse.cs

...3{4    internal class EvaluateHandleResponse5    {6        public EvaluateExceptionResponseDetails ExceptionDetails { get; set; }7        public RemoteObject Result { get; set; }8    }9}...

RuntimeQueryObjectsResponse.cs

Source:RuntimeQueryObjectsResponse.cs

2namespace PuppeteerSharp.Messaging3{4    internal class RuntimeQueryObjectsResponse5    {6        public RemoteObject Objects { get; set; }7    }8}...

RuntimeCallFunctionOnResponse.cs

Source:RuntimeCallFunctionOnResponse.cs

1ï»¿namespace PuppeteerSharp.Messaging2{3    internal class RuntimeCallFunctionOnResponse4    {5        public RemoteObject Result { get; set; }6    }7}...

DomResolveNodeResponse.cs

Source:DomResolveNodeResponse.cs

1ï»¿namespace PuppeteerSharp.Messaging2{3    internal class DomResolveNodeResponse4    {5        public RemoteObject Object { get; set; }6    }7}...

RemoteObject

Using AI Code Generation

1using PuppeteerSharp.Messaging;2using System;3using System.Threading.Tasks;4{5    {6        static async Task Main(string[] args)7        {8            var browser = await Puppeteer.LaunchAsync();9            var page = await browser.NewPageAsync();10            var remoteObject = await page.EvaluateExpressionHandleAsync("document.querySelector('input')");11            var remoteObject1 = await page.EvaluateExpressionHandleAsync("document.querySelector('input')");12            Console.WriteLine("Hello World!");13        }14    }15}16using PuppeteerSharp.Messaging;17using System;18using System.Threading.Tasks;19{20    {21        static async Task Main(string[] args)22        {23            var browser = await Puppeteer.LaunchAsync();24            var page = await browser.NewPageAsync();25            var remoteObject = await page.EvaluateExpressionHandleAsync("document.querySelector('input')");26            var remoteObject1 = await page.EvaluateExpressionHandleAsync("document.querySelector('input')");27            Console.WriteLine("Hello World!");28        }29    }30}31at PuppeteerSharp.Page.EvaluateExpressionHandleAsync(String pageFunction, Object[] args) in D:\a\1\s\lib\PuppeteerSharp\Page.cs:line 755

RemoteObject

Using AI Code Generation

1using PuppeteerSharp.Messaging;2using PuppeteerSharp;3using System.Threading.Tasks;4using System;5using System.Collections.Generic;6{7    {8        public string Type { get; set; }9        public string Subtype { get; set; }10        public string ClassName { get; set; }11        public string Description { get; set; }12        public bool? UnserializableValue { get; set; }13        public object Value { get; set; }14        public object Preview { get; set; }15        public string ObjectId { get; set; }16        public string CustomPreview { get; set; }17        public string CustomPreviewObjectId { get; set; }18        public string CustomPreviewObjectSubtype { get; set; }19        public string CustomPreviewObjectDescription { get; set; }20        public string CustomPreviewObjectValue { get; set; }21        public string CustomPreviewObjectUnserializableValue { get; set; }22        public string CustomPreviewObjectPreview { get; set; }23        public string CustomPreviewObjectCustomPreview { get; set; }24        public string CustomPreviewObjectCustomPreviewObjectId { get; set; }25        public string CustomPreviewObjectCustomPreviewObjectSubtype { get; set; }26        public string CustomPreviewObjectCustomPreviewObjectDescription { get; set; }27        public string CustomPreviewObjectCustomPreviewObjectValue { get; set; }28        public string CustomPreviewObjectCustomPreviewObjectUnserializableValue { get; set; }29        public string CustomPreviewObjectCustomPreviewObjectPreview { get; set; }30        public string CustomPreviewObjectCustomPreviewObjectCustomPreview { get; set; }31        public string CustomPreviewObjectCustomPreviewObjectCustomPreviewObjectId { get; set; }32        public string CustomPreviewObjectCustomPreviewObjectCustomPreviewObjectSubtype { get; set; }33        public string CustomPreviewObjectCustomPreviewObjectCustomPreviewObjectDescription { get; set; }34        public string CustomPreviewObjectCustomPreviewObjectCustomPreviewObjectValue { get; set; }35        public string CustomPreviewObjectCustomPreviewObjectCustomPreviewObjectUnserializableValue { get; set; }36        public string CustomPreviewObjectCustomPreviewObjectCustomPreviewObjectPreview { get; set; }37        public string CustomPreviewObjectCustomPreviewObjectCustomPreviewObjectCustomPreview { get; set; }38        public string CustomPreviewObjectCustomPreviewObjectCustomPreviewObjectCustomPreviewObjectId {

RemoteObject

Using AI Code Generation

1var remoteObject = new RemoteObject();2remoteObject.Type = "string";3remoteObject.Value = "Hello World";4var message = new Message();5message.Method = "Runtime.evaluate";6message.Params = new Dictionary<string, object>();7message.Params.Add("expression", "console.log('Hello World')");8message.Params.Add("returnByValue", true);9message.Params.Add("awaitPromise", true);10message.Params.Add("contextId", 1);11message.Params.Add("objectGroup", "console");12message.Params.Add("includeCommandLineAPI", true);13message.Params.Add("userGesture", true);14message.Params.Add("awaitPromise", true);15message.Params.Add("returnByValue", true);16message.Params.Add("generatePreview", true);17message.Params.Add("silent", true);18message.Params.Add("throwOnSideEffect", true);19message.Params.Add("timeout", 1000);20message.Params.Add("disableBreaks", true);21message.Params.Add("replMode", true);22message.Params.Add("allowUnsafeEvalBlockedByCSP", true);23message.Params.Add("allowHeterogeneous", true);24message.Params.Add("allowReturnByValue", true);25message.Params.Add("doNotPauseOnExceptionsAndMuteConsole", true);26message.Params.Add("returnByValue", true);27message.Params.Add("generatePreview", true);28message.Params.Add("silent", true);29message.Params.Add("throwOnSideEffect", true);30message.Params.Add("timeout", 1000);31message.Params.Add("disableBreaks", true);32message.Params.Add("replMode", true);33message.Params.Add("allowUnsafeEvalBlockedByCSP", true);34message.Params.Add("allowHeterogeneous", true);35message.Params.Add("allowReturnByValue", true);36message.Params.Add("doNotPauseOnExceptionsAndMuteConsole", true);37message.Params.Add("returnByValue", true);38message.Params.Add("generatePreview", true);39message.Params.Add("silent", true);40message.Params.Add("throwOnSideEffect", true);41message.Params.Add("timeout", 1000);42message.Params.Add("disableBreaks", true);43message.Params.Add("replMode", true);44message.Params.Add("allowUnsafeEvalBlockedByCSP", true);45message.Params.Add("allowHeterogeneous", true);46message.Params.Add("allowReturnByValue", true);47message.Params.Add("doNotPauseOnExceptionsAndMuteConsole", true);48message.Params.Add("returnByValue", true);

RemoteObject

Using AI Code Generation

1var remoteObject = new RemoteObject();2remoteObject.Type = "string";3remoteObject.Value = "some value";4var cdpMessage = new CDPMessage();5cdpMessage.Method = "Page.navigate";6cdpMessage.Params = new Dictionary<string, object>();7var cdpRequest = new CDPRequest();8cdpRequest.Id = 1;9cdpRequest.Method = "Page.navigate";10cdpRequest.Params = new Dictionary<string, object>();11var remoteObject = new RemoteObject();12remoteObject.Type = "string";13remoteObject.Value = "some value";14var cdpMessage = new CDPMessage();15cdpMessage.Method = "Page.navigate";16cdpMessage.Params = new Dictionary<string, object>();17var cdpRequest = new CDPRequest();18cdpRequest.Id = 1;19cdpRequest.Method = "Page.navigate";20cdpRequest.Params = new Dictionary<string, object>();21var remoteObject = new RemoteObject();22remoteObject.Type = "string";23remoteObject.Value = "some value";24var cdpMessage = new CDPMessage();25cdpMessage.Method = "Page.navigate";26cdpMessage.Params = new Dictionary<string, object>();27var cdpRequest = new CDPRequest();28cdpRequest.Id = 1;29cdpRequest.Method = "Page.navigate";30cdpRequest.Params = new Dictionary<string, object>();

RemoteObject

Using AI Code Generation

1var remoteObject = new RemoteObject();2remoteObject.Type = "object";3remoteObject.Subtype = "node";4remoteObject.Value = "element";5remoteObject.UnserializableValue = "node";6remoteObject.ObjectId = "node";7remoteObject.Description = "node";8remoteObject.CustomPreview = new CustomPreview();9remoteObject.CustomPreview.Header = "node";10remoteObject.CustomPreview.HasBody = true;11remoteObject.CustomPreview.HasObjectId = true;12remoteObject.CustomPreview.BodyGetterId = "node";13remoteObject.CustomPreview.ConfigObjectId = "node";14remoteObject.CustomPreview.Footer = "node";15var remoteObject1 = new RemoteObject();16remoteObject1.Type = "object";17remoteObject1.Subtype = "node";18remoteObject1.Value = "element";19remoteObject1.UnserializableValue = "node";20remoteObject1.ObjectId = "node";21remoteObject1.Description = "node";22remoteObject1.CustomPreview = new CustomPreview();23remoteObject1.CustomPreview.Header = "node";24remoteObject1.CustomPreview.HasBody = true;25remoteObject1.CustomPreview.HasObjectId = true;26remoteObject1.CustomPreview.BodyGetterId = "node";27remoteObject1.CustomPreview.ConfigObjectId = "node";28remoteObject1.CustomPreview.Footer = "node";29var remoteObject2 = new RemoteObject();30remoteObject2.Type = "object";31remoteObject2.Subtype = "node";32remoteObject2.Value = "element";33remoteObject2.UnserializableValue = "node";34remoteObject2.ObjectId = "node";35remoteObject2.Description = "node";36remoteObject2.CustomPreview = new CustomPreview();37remoteObject2.CustomPreview.Header = "node";38remoteObject2.CustomPreview.HasBody = true;39remoteObject2.CustomPreview.HasObjectId = true;40remoteObject2.CustomPreview.BodyGetterId = "node";41remoteObject2.CustomPreview.ConfigObjectId = "node";42remoteObject2.CustomPreview.Footer = "node";43var remoteObject3 = new RemoteObject();44remoteObject3.Type = "object";45remoteObject3.Subtype = "node";46remoteObject3.Value = "element";47remoteObject3.UnserializableValue = "node";48remoteObject3.ObjectId = "node";49remoteObject3.Description = "node";50remoteObject3.CustomPreview = new CustomPreview();51remoteObject3.CustomPreview.Header = "node";52remoteObject3.CustomPreview.HasBody = true;53remoteObject3.CustomPreview.HasObjectId = true;

RemoteObject

Using AI Code Generation

1using System;2using System.Threading.Tasks;3using PuppeteerSharp.Messaging;4{5    {6        public RemoteObject(string type, string subtype, object value, string description, bool? unserializableValue, RemoteObject objectId, RemoteObject preview, RemoteObject unserializableDescription)7        {8            Type = type;9            Subtype = subtype;10            Value = value;11            Description = description;12            UnserializableValue = unserializableValue;13            ObjectId = objectId;14            Preview = preview;15            UnserializableDescription = unserializableDescription;16        }17        public string Type { get; }18        public string Subtype { get; }19        public object Value { get; }20        public string Description { get; }21        public bool? UnserializableValue { get; }22        public RemoteObject ObjectId { get; }23        public RemoteObject Preview { get; }24        public RemoteObject UnserializableDescription { get; }25        public async Task<T> GetObjectAsync<T>(CDPSession client)26        {27            var objectId = ObjectId?.ObjectId;28            if (objectId == null)29            {30                return default(T);31            }32            var response = await client.SendAsync(new RuntimeCallFunctionOnRequest33            {34                FunctionDeclaration = "function() { return this; }",35            }).ConfigureAwait(false);36            return response.Deserialize<T>();37        }38        public async Task<T> GetObjectAsync<T>(ExecutionContext context)39        {40            var objectId = ObjectId?.ObjectId;41            if (objectId == null)42            {43                return default(T);44            }45            var response = await context.Client.SendAsync(new RuntimeCallFunctionOnRequest46            {47                FunctionDeclaration = "function() { return this; }",48            }).ConfigureAwait(false);49            return response.Deserialize<T>();50        }51        public async Task<T> GetObjectAsync<T>(Frame frame)52        {53            var objectId = ObjectId?.ObjectId;54            if (objectId == null)55            {56                return default(T);57            }58            var response = await frame.EvaluateFunctionAsync<T>("function() { return this; }").ConfigureAwait(false);59            return response;60        }61        public async Task<T> GetObjectAsync<T>(Page page)62        {63            var objectId = ObjectId?.ObjectId;64            if (

Automation Testing Tutorials

Learn to execute automation testing from scratch with LambdaTest Learning Hub. Right from setting up the prerequisites to run your first automation test, to following best practices and diving deeper into advanced test scenarios. LambdaTest Learning Hubs compile a list of step-by-step guides to help you be proficient with different test automation frameworks i.e. Selenium, Cypress, TestNG etc.