< Summary

Class:Microsoft.Azure.CognitiveServices.Search.ImageSearch.Models.ImageObject
Assembly:Microsoft.Azure.CognitiveServices.Search.BingImageSearch
File(s):C:\Git\azure-sdk-for-net\sdk\cognitiveservices\Search.BingImageSearch\src\Generated\ImageSearch\Models\ImageObject.cs
Covered lines:3
Uncovered lines:13
Coverable lines:16
Total lines:149
Line coverage:18.7% (3 of 16)
Covered branches:0
Total branches:0

Metrics

MethodCyclomatic complexity Line coverage Branch coverage
.ctor()-100%100%
.ctor(...)-0%100%
get_Thumbnail()-0%100%
get_ImageInsightsToken()-100%100%
get_InsightsMetadata()-0%100%
get_ImageId()-0%100%
get_AccentColor()-0%100%
get_VisualWords()-0%100%

File(s)

C:\Git\azure-sdk-for-net\sdk\cognitiveservices\Search.BingImageSearch\src\Generated\ImageSearch\Models\ImageObject.cs

#LineLine coverage
 1// <auto-generated>
 2// Code generated by Microsoft (R) AutoRest Code Generator.
 3// Changes may cause incorrect behavior and will be lost if the code is
 4// regenerated.
 5// </auto-generated>
 6
 7namespace Microsoft.Azure.CognitiveServices.Search.ImageSearch.Models
 8{
 9    using Newtonsoft.Json;
 10    using System.Collections;
 11    using System.Collections.Generic;
 12    using System.Linq;
 13
 14    /// <summary>
 15    /// Defines an image
 16    /// </summary>
 17    public partial class ImageObject : MediaObject
 18    {
 19        /// <summary>
 20        /// Initializes a new instance of the ImageObject class.
 21        /// </summary>
 114422        public ImageObject()
 23        {
 24            CustomInit();
 114425        }
 26
 27        /// <summary>
 28        /// Initializes a new instance of the ImageObject class.
 29        /// </summary>
 30        /// <param name="id">A String identifier.</param>
 31        /// <param name="readLink">The URL that returns this resource.</param>
 32        /// <param name="webSearchUrl">The URL To Bing's search result for this
 33        /// item.</param>
 34        /// <param name="name">The name of the thing represented by this
 35        /// object.</param>
 36        /// <param name="url">The URL to get more information about the thing
 37        /// represented by this object.</param>
 38        /// <param name="image">An image of the item.</param>
 39        /// <param name="description">A short description of the item.</param>
 40        /// <param name="alternateName">An alias for the item</param>
 41        /// <param name="bingId">An ID that uniquely identifies this
 42        /// item.</param>
 43        /// <param name="thumbnailUrl">The URL to a thumbnail of the
 44        /// item.</param>
 45        /// <param name="provider">The source of the creative work.</param>
 46        /// <param name="datePublished">The date on which the CreativeWork was
 47        /// published.</param>
 48        /// <param name="text">Text content of this creative work</param>
 49        /// <param name="contentUrl">Original URL to retrieve the source (file)
 50        /// for the media object (e.g the source URL for the image).</param>
 51        /// <param name="hostPageUrl">URL of the page that hosts the media
 52        /// object.</param>
 53        /// <param name="contentSize">Size of the media object content (use
 54        /// format "value unit" e.g "1024 B").</param>
 55        /// <param name="encodingFormat">Encoding format (e.g mp3, mp4, jpeg,
 56        /// etc).</param>
 57        /// <param name="hostPageDisplayUrl">Display URL of the page that hosts
 58        /// the media object.</param>
 59        /// <param name="width">The width of the source media object, in
 60        /// pixels.</param>
 61        /// <param name="height">The height of the source media object, in
 62        /// pixels.</param>
 63        /// <param name="thumbnail">The URL to a thumbnail of the image</param>
 64        /// <param name="imageInsightsToken">The token that you use in a
 65        /// subsequent call to the Image Search API to get additional
 66        /// information about the image. For information about using this
 67        /// token, see the insightsToken query parameter.</param>
 68        /// <param name="insightsMetadata">A count of the number of websites
 69        /// where you can shop or perform other actions related to the image.
 70        /// For example, if the image is of an apple pie, this object includes
 71        /// a count of the number of websites where you can buy an apple pie.
 72        /// To indicate the number of offers in your UX, include badging such
 73        /// as a shopping cart icon that contains the count. When the user
 74        /// clicks on the icon, use imageInisghtsToken to get the list of
 75        /// websites.</param>
 76        /// <param name="imageId">Unique Id for the image</param>
 77        /// <param name="accentColor">A three-byte hexadecimal number that
 78        /// represents the color that dominates the image. Use the color as the
 79        /// temporary background in your client until the image is
 80        /// loaded.</param>
 81        /// <param name="visualWords">Visual representation of the image. Used
 82        /// for getting more sizes</param>
 83        public ImageObject(string id = default(string), string readLink = default(string), string webSearchUrl = default
 084            : base(id, readLink, webSearchUrl, name, url, image, description, alternateName, bingId, thumbnailUrl, provi
 85        {
 086            Thumbnail = thumbnail;
 087            ImageInsightsToken = imageInsightsToken;
 088            InsightsMetadata = insightsMetadata;
 089            ImageId = imageId;
 090            AccentColor = accentColor;
 091            VisualWords = visualWords;
 92            CustomInit();
 093        }
 94
 95        /// <summary>
 96        /// An initialization method that performs custom operations like setting defaults
 97        /// </summary>
 98        partial void CustomInit();
 99
 100        /// <summary>
 101        /// Gets the URL to a thumbnail of the image
 102        /// </summary>
 103        [JsonProperty(PropertyName = "thumbnail")]
 0104        public ImageObject Thumbnail { get; private set; }
 105
 106        /// <summary>
 107        /// Gets the token that you use in a subsequent call to the Image
 108        /// Search API to get additional information about the image. For
 109        /// information about using this token, see the insightsToken query
 110        /// parameter.
 111        /// </summary>
 112        [JsonProperty(PropertyName = "imageInsightsToken")]
 296113        public string ImageInsightsToken { get; private set; }
 114
 115        /// <summary>
 116        /// Gets a count of the number of websites where you can shop or
 117        /// perform other actions related to the image. For example, if the
 118        /// image is of an apple pie, this object includes a count of the
 119        /// number of websites where you can buy an apple pie. To indicate the
 120        /// number of offers in your UX, include badging such as a shopping
 121        /// cart icon that contains the count. When the user clicks on the
 122        /// icon, use imageInisghtsToken to get the list of websites.
 123        /// </summary>
 124        [JsonProperty(PropertyName = "insightsMetadata")]
 0125        public ImagesImageMetadata InsightsMetadata { get; private set; }
 126
 127        /// <summary>
 128        /// Gets unique Id for the image
 129        /// </summary>
 130        [JsonProperty(PropertyName = "imageId")]
 0131        public string ImageId { get; private set; }
 132
 133        /// <summary>
 134        /// Gets a three-byte hexadecimal number that represents the color that
 135        /// dominates the image. Use the color as the temporary background in
 136        /// your client until the image is loaded.
 137        /// </summary>
 138        [JsonProperty(PropertyName = "accentColor")]
 0139        public string AccentColor { get; private set; }
 140
 141        /// <summary>
 142        /// Gets visual representation of the image. Used for getting more
 143        /// sizes
 144        /// </summary>
 145        [JsonProperty(PropertyName = "visualWords")]
 0146        public string VisualWords { get; private set; }
 147
 148    }
 149}
Generated by: ReportGenerator 4.6.4.0
8/12/2020 - 3:47:14 PM
GitHub | www.palmmedia.de

Methods/Properties

.ctor()
.ctor(...)
get_Thumbnail()
get_ImageInsightsToken()
get_InsightsMetadata()
get_ImageId()
get_AccentColor()
get_VisualWords()