com.ibasco.agql.protocols.valve.steam.webapi.SteamWebApiInterface Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of agql-steam-webapi Show documentation

An implementation for the Steam Web API Interfaces

There is a newer version: 1.2.2

/*
 * Copyright (c) 2022 Asynchronous Game Query Library
 *
 * Licensed 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 CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.ibasco.agql.protocols.valve.steam.webapi;

import com.google.gson.JsonObject;
import com.ibasco.agql.core.AbstractWebApiInterface;

/**
 * Represents a Steam Web API Interface
 *
 * @author Rafael Luis Ibasco
 * @see Steam Interfaces and
 * Methods
 */
abstract public class SteamWebApiInterface
        extends AbstractWebApiInterface {

    /**
     * Default Constructor
     *
     * @param client
     *         A {@link com.ibasco.agql.protocols.valve.steam.webapi.SteamWebApiClient} instance
     */
    public SteamWebApiInterface(SteamWebApiClient client) {
        super(client);
    }

    /**
     * getSteamResult.
     *
     * @param root
     *         a {@link com.google.gson.JsonObject} object
     *
     * @return a {@link com.google.gson.JsonObject} object
     */
    protected JsonObject getSteamResult(JsonObject root) {
        if (root.has("result")) {
            return root.getAsJsonObject("result");
        }
        return null;
    }
}