com.vk.sdk.api.model

Class VKApiNote

java.lang.Object

com.vk.sdk.api.model.VKApiModel

com.vk.sdk.api.model.VKAttachments.VKApiAttachment

com.vk.sdk.api.model.VKApiNote

All Implemented Interfaces:

android.os.Parcelable, Identifiable

public class VKApiNote
extends VKAttachments.VKApiAttachment
implements Identifiable, android.os.Parcelable

A note object describes a note.

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
int	comments Number of comments.
static android.os.Parcelable.Creator<VKApiNote>	CREATOR
long	date Date (in Unix time) when the note was created.
int	id Note ID, positive number
int	read_comments Number of read comments (only if owner_id is the current user).
java.lang.String	text Note text.
java.lang.String	title Note title.
int	user_id Note owner ID.
java.lang.String	view_url Note URL.

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
VKApiNote() Creates empty Note instance.
VKApiNote(org.json.JSONObject from)
VKApiNote(android.os.Parcel in) Creates a Note 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").
java.lang.String	getType()
VKApiNote	parse(org.json.JSONObject source) Fills a Note instance from JSONObject.
java.lang.CharSequence	toAttachmentString() Convert attachment to special string to attach it to the post, message or comment.
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

Note ID, positive number

user_id

public int user_id

Note owner ID.

title

public java.lang.String title

Note title.

text

public java.lang.String text

Note text.

date

public long date

Date (in Unix time) when the note was created.

comments

public int comments

Number of comments.

read_comments

public int read_comments

Number of read comments (only if owner_id is the current user).

view_url

public java.lang.String view_url

Note URL.

CREATOR

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

Constructor Detail

VKApiNote

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

Throws:

org.json.JSONException

VKApiNote

public VKApiNote(android.os.Parcel in)

Creates a Note instance from Parcel.

VKApiNote

public VKApiNote()

Creates empty Note instance.

Method Detail

parse

public VKApiNote parse(org.json.JSONObject source)

Fills a Note instance from JSONObject.

Overrides:

parse in class VKApiModel

Parameters:

source - server API object.

Returns:

this object.

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

toAttachmentString

public java.lang.CharSequence toAttachmentString()

Description copied from class: VKAttachments.VKApiAttachment

Convert attachment to special string to attach it to the post, message or comment.

Specified by:

toAttachmentString in class VKAttachments.VKApiAttachment

getType

public java.lang.String getType()

Specified by:

getType in class VKAttachments.VKApiAttachment

Returns:

type of this attachment

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