com.vk.sdk.api.model

Class VKApiMessage

java.lang.Object

com.vk.sdk.api.model.VKApiModel

com.vk.sdk.api.model.VKApiMessage

All Implemented Interfaces:

android.os.Parcelable, Identifiable

public class VKApiMessage
extends VKApiModel
implements Identifiable, android.os.Parcelable

A message object describes a private message

Nested Class Summary

Nested classes/interfaces inherited from interface android.os.Parcelable

android.os.Parcelable.ClassLoaderCreator<T>, android.os.Parcelable.Creator<T>

Field Summary

Fields

Modifier and Type	Field and Description
VKAttachments	attachments List of media-attachments;
java.lang.String	body Body of the message.
static android.os.Parcelable.Creator<VKApiMessage>	CREATOR
long	date Date (in Unix time) when the message was sent.
boolean	deleted Whether the message is deleted (false — no, true — yes).
boolean	emoji Whether the message contains smiles (false — no, true — yes).
VKList<VKApiMessage>	fwd_messages Array of forwarded messages (if any).
int	id Message ID.
boolean	out Message type (false — received, true — sent).
boolean	read_state Message status (false — not read, true — read).
java.lang.String	title Title of message or chat.
int	user_id For an incoming message, the user ID of the author.

Fields inherited from class com.vk.sdk.api.model.VKApiModel

fields

Fields inherited from interface android.os.Parcelable

CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

Constructor Summary

Constructors

Constructor and Description
VKApiMessage() Creates empty Country instance.
VKApiMessage(org.json.JSONObject from)
VKApiMessage(android.os.Parcel in) Creates a Message instance from Parcel.

Method Summary

Modifier and Type	Method and Description
int	describeContents()
int	getId() Returns unique identifier of this object(usually it's value of JSON field "id").
VKApiMessage	parse(org.json.JSONObject source) Fills a Message instance from JSONObject.
void	writeToParcel(android.os.Parcel dest, int flags)

Methods inherited from class com.vk.sdk.api.model.VKApiModel

getTag, getTag, setTag, setTag

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

id

public int id

Message ID. (Not returned for forwarded messages), positive number

user_id

public int user_id

For an incoming message, the user ID of the author. For an outgoing message, the user ID of the receiver.

date

public long date

Date (in Unix time) when the message was sent.

read_state

public boolean read_state

Message status (false — not read, true — read). (Not returned for forwarded messages.)

out

public boolean out

Message type (false — received, true — sent). (Not returned for forwarded messages.)

title

public java.lang.String title

Title of message or chat.

body

public java.lang.String body

Body of the message.

attachments

public VKAttachments attachments

List of media-attachments;

fwd_messages

public VKList<VKApiMessage> fwd_messages

Array of forwarded messages (if any).

emoji

public boolean emoji

Whether the message contains smiles (false — no, true — yes).

deleted

public boolean deleted

Whether the message is deleted (false — no, true — yes).

CREATOR

public static android.os.Parcelable.Creator<VKApiMessage> CREATOR

Constructor Detail

VKApiMessage

public VKApiMessage(org.json.JSONObject from)
             throws org.json.JSONException

Throws:

org.json.JSONException

VKApiMessage

public VKApiMessage(android.os.Parcel in)

Creates a Message instance from Parcel.

VKApiMessage

public VKApiMessage()

Creates empty Country instance.

Method Detail

parse

public VKApiMessage parse(org.json.JSONObject source)
                   throws org.json.JSONException

Fills a Message instance from JSONObject.

Overrides:

parse in class VKApiModel

Parameters:

source - server API object.

Returns:

this object.

Throws:

org.json.JSONException - if any critical error occurred while parsing.

getId

public int getId()

Description copied from interface: Identifiable

Returns unique identifier of this object(usually it's value of JSON field "id").

Specified by:

getId in interface Identifiable

describeContents

public int describeContents()

Specified by:

describeContents in interface android.os.Parcelable

writeToParcel

public void writeToParcel(android.os.Parcel dest,
                          int flags)

Specified by:

writeToParcel in interface android.os.Parcelable