com.adobe.cq.commerce.magento.graphql.MediaGalleryEntryQuery Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of magento-graphql Show documentation
AEM bundle for the Magento GraphQL data models and query builders
There is a newer version: 11.1.0-magento244ee
/*******************************************************************************
 *
 *    Copyright 2020 Adobe. All rights reserved.
 *    This file is licensed to you under the Apache License, Version 2.0 (the "License");
 *    you may not use this file except in compliance with the License. You may obtain a copy
 *    of the License at http://www.apache.org/licenses/LICENSE-2.0
 *
 *    Unless required by applicable law or agreed to in writing, software distributed under
 *    the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
 *    OF ANY KIND, either express or implied. See the License for the specific language
 *    governing permissions and limitations under the License.
 *
 ******************************************************************************/

package com.adobe.cq.commerce.magento.graphql;

import com.shopify.graphql.support.AbstractQuery;
import com.shopify.graphql.support.Fragment;

/**
 * MediaGalleryEntry defines characteristics about images and videos associated with a specific
 * product.
 */
public class MediaGalleryEntryQuery extends AbstractQuery {
    MediaGalleryEntryQuery(StringBuilder _queryBuilder) {
        super(_queryBuilder);
    }

    /**
     * Contains a ProductMediaGalleryEntriesContent object.
     */
    public MediaGalleryEntryQuery content(ProductMediaGalleryEntriesContentQueryDefinition queryDef) {
        startField("content");

        _queryBuilder.append('{');
        queryDef.define(new ProductMediaGalleryEntriesContentQuery(_queryBuilder));
        _queryBuilder.append('}');

        return this;
    }

    /**
     * Whether the image is hidden from view.
     */
    public MediaGalleryEntryQuery disabled() {
        startField("disabled");

        return this;
    }

    /**
     * The path of the image on the server.
     */
    public MediaGalleryEntryQuery file() {
        startField("file");

        return this;
    }

    /**
     * The identifier assigned to the object.
     */
    public MediaGalleryEntryQuery id() {
        startField("id");

        return this;
    }

    /**
     * The alt text displayed on the UI when the user points to the image.
     */
    public MediaGalleryEntryQuery label() {
        startField("label");

        return this;
    }

    /**
     * image or video.
     */
    public MediaGalleryEntryQuery mediaType() {
        startField("media_type");

        return this;
    }

    /**
     * The media item's position after it has been sorted.
     */
    public MediaGalleryEntryQuery position() {
        startField("position");

        return this;
    }

    /**
     * Array of image types. It can have the following values: image, small_image, thumbnail.
     */
    public MediaGalleryEntryQuery types() {
        startField("types");

        return this;
    }

    /**
     * Contains a ProductMediaGalleryEntriesVideoContent object.
     */
    public MediaGalleryEntryQuery videoContent(ProductMediaGalleryEntriesVideoContentQueryDefinition queryDef) {
        startField("video_content");

        _queryBuilder.append('{');
        queryDef.define(new ProductMediaGalleryEntriesVideoContentQuery(_queryBuilder));
        _queryBuilder.append('}');

        return this;
    }

    /**
     * Creates a GraphQL "named" fragment with the specified query type definition.
     * The generics nature of fragments ensures that a fragment can only be used at the right place in the GraphQL request.
     * 
     * @param name The name of the fragment, must be unique for a given GraphQL request.
     * @param queryDef The fragment definition.
     * @return The fragment of a given generics type.
     */
    public static Fragment createFragment(String name, MediaGalleryEntryQueryDefinition queryDef) {
        StringBuilder sb = new StringBuilder();
        queryDef.define(new MediaGalleryEntryQuery(sb));
        return new Fragment<>(name, "MediaGalleryEntry", sb.toString());
    }

    /**
     * Adds a MediaGalleryEntryQuery fragment reference at the current position of the query.
     * For example for a fragment named test, calling this method will add the
     * reference ...test in the query. For GraphQL types implementing an interface, there
     * will be some similar methods using the Query type of each implemented interface.
     * 
     * @param fragment The fragment to reference.
     */
    public MediaGalleryEntryQuery addFragmentReference(Fragment fragment) {
        startField("..." + fragment.getName());
        return this;
    }
}