twitter4j.DirectMessage 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;

import java.util.Date;

/**
 * A data interface representing sent/received direct message.
 *
 * @author Yusuke Yamamoto - yusuke at mac.com
 */
public interface DirectMessage extends TwitterResponse, EntitySupport, java.io.Serializable {

    long getId();

    String getText();

    long getSenderId();

    long getRecipientId();

    /**
     * @return created_at
     * @since Twitter4J 1.1.0
     */
    Date getCreatedAt();

    /**
     *
     * @deprecated use {@link #getSenderId()} instead
     * @return sender screen name
     */
    String getSenderScreenName();

    /**
     *
     * @deprecated use {@link #getRecipientId()} instead
     * @return recipient screen name
     */
    String getRecipientScreenName();


    /**
     *
     * @deprecated use {@link #getSenderId()} instead
     * @return sender user
     */
    User getSender();


    /**
     *
     * @deprecated use {@link #getRecipientId()} instead
     * @return sender recipient
     */
    User getRecipient();

    // currently type is always "message_create". So we're not providing a getter for that.
}