twitter4j.OEmbed Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of twitter4j-core Show documentation
A Java library for the Twitter API
There is a newer version: 4.1.2
/*
 * Copyright 2007 Yusuke Yamamoto
 *
 * 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 twitter4j;

/**
 * @author Yusuke Yamamoto - yusuke at mac.com
 * @since Twitter4J 3.0.2
 * @see oEmded
 */
public interface OEmbed extends TwitterResponse, java.io.Serializable {
    /**
     * The HTML required to display the resource. The HTML should have no padding or margins. Consumers may wish to load the HTML in an off-domain iframe to avoid XSS vulnerabilities. The markup should be valid XHTML 1.0 Basic.
     * @return The HTML required to display the resource.
     */
    String getHtml();

    /**
     * The name of the author/owner of the resource.
     * @return The name of the author/owner of the resource.
     */
    String getAuthorName();


// provier_url is always "http://twitter.com/"
//    String getProviderURL();

    /**
     * The url of the resource provider.

     * The source URL of the image. Consumers should be able to insert this URL into an <img> element. Only HTTP and HTTPS URLs are valid.
     * @return The url of the resource provider.
     */
    String getURL();

// provider_name is always "Twitter"
//    String getProviderName();

    /**
     * The oEmbed version number.
     * @return The oEmbed version number.
     */
    String getVersion();

// type is always "rich"
//    String getType();

    /**
     * The suggested cache lifetime for this resource, in seconds. Consumers may choose to use this value or not.
     * @return The suggested cache lifetime for this resource, in seconds. Consumers may choose to use this value or not.
     */
    long getCacheAge();

    /**
     * A URL for the author/owner of the resource.
     * @return A URL for the author/owner of the resource.
     */
    String getAuthorURL();

    /**
     * The width in pixels of the image specified in the url parameter.
     * @return The width in pixels of the image specified in the url parameter.
     */
    int getWidth();
}