twitter4j.TwitterResponse Maven / Gradle / Ivy

/*
 * 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;

import twitter4j.v1.DirectMessage;
import twitter4j.v1.RateLimitStatus;
import twitter4j.v1.Status;
import twitter4j.v1.User;

/**
 * Super interface of Twitter Response data interfaces which indicates that rate limit status is available.
 *
 * @author Yusuke Yamamoto - yusuke at mac.com
 * @see DirectMessage
 * @see Status
 * @see User
 */
public interface TwitterResponse extends java.io.Serializable {
    /**
     * Returns the current rate limit status if available.
     *
     * @return current rate limit status
     * @since Twitter4J 2.1.0
     */
    RateLimitStatus getRateLimitStatus();

    /**
     * @return application permission model
     * @see Application Permission Model FAQ - How do we know what the access level of a user token is?
     * @since Twitter4J 2.2.3
     */
    AccessLevel getAccessLevel();

    /**
     * access level
     */
    enum AccessLevel {
        /**
         * none
         */
        NONE,
        /**
         * read
         */
        READ,
        /**
         * read and write
         */
        READ_WRITE,
        /**
         * read, write and direct messages
         */
        READ_WRITE_DIRECTMESSAGES
    }


}