twitter4j.api.SpamReportingResource 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.api;

import twitter4j.TwitterException;
import twitter4j.User;

/**
 * @author Joern Huxhorn - jhuxhorn at googlemail.com
 */
public interface SpamReportingResource {

    /**
     * The user specified in the id is blocked by the authenticated user and reported as a spammer.
     * 
This method calls https://api.twitter.com/1.1/report_spam.json
     *
     * @param userId The ID of the user you want to report as a spammer.
     * @return The User reported as a spammer.
     * @throws TwitterException when Twitter service or network is unavailable
     * @see POST report_spam | Twitter Developers
     * @since Twitter4J 2.1.0
     */
    User reportSpam(long userId) throws TwitterException;

    /**
     * The user specified in the id is blocked by the authenticated user and reported as a spammer.
     * 
This method calls https://api.twitter.com/1.1/report_spam.json
     *
     * @param screenName The screen name of the user you want to report as a spammer.
     * @return The User reported as a spammer.
     * @throws TwitterException when Twitter service or network is unavailable
     * @see POST report_spam | Twitter Developers
     * @since Twitter4J 2.1.0
     */
    User reportSpam(String screenName) throws TwitterException;
}