com.vk.sdk.api.model

Class VKApiDocument

java.lang.Object

com.vk.sdk.api.model.VKApiModel

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

com.vk.sdk.api.model.VKApiDocument

All Implemented Interfaces:

android.os.Parcelable, Identifiable

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

A document object describes a document file.

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
java.lang.String	access_key An access key using for get information about hidden objects.
static android.os.Parcelable.Creator<VKApiDocument>	CREATOR
long	date Document creation date in milliseconds (current date by default).
java.lang.String	ext Document extension.
int	id Document ID.
int	owner_id ID of the user or group who uploaded the document.
VKPhotoSizes	photo Array of all photos.
java.lang.String	photo_100 URL of the 100x75px image (if the file is graphical).
java.lang.String	photo_130 URL of the 130x100px image (if the file is graphical).
long	size Document size (in bytes).
java.lang.String	title Document title.
java.lang.String	url Document URL for downloading.

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
VKApiDocument() Creates empty Doc instance.
VKApiDocument(org.json.JSONObject from)
VKApiDocument(android.os.Parcel in) Creates a Doc 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()
boolean	isGif()
boolean	isImage()
VKApiDocument	parse(org.json.JSONObject jo) Fills a Doc instance from JSONObject.
java.lang.CharSequence	toAttachmentString() Convert attachment to special string to attach it to the post, message or comment.
java.lang.String	toString()
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, wait, wait, wait

Field Detail

id

public int id

Document ID.

owner_id

public int owner_id

ID of the user or group who uploaded the document.

title

public java.lang.String title

Document title.

size

public long size

Document size (in bytes).

ext

public java.lang.String ext

Document extension.

url

public java.lang.String url

Document URL for downloading.

photo_100

public java.lang.String photo_100

URL of the 100x75px image (if the file is graphical).

photo_130

public java.lang.String photo_130

URL of the 130x100px image (if the file is graphical).

photo

public VKPhotoSizes photo

Array of all photos.

access_key

public java.lang.String access_key

An access key using for get information about hidden objects.

date

public long date

Document creation date in milliseconds (current date by default).

CREATOR

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

Constructor Detail

VKApiDocument

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

Throws:

org.json.JSONException

VKApiDocument

public VKApiDocument(android.os.Parcel in)

Creates a Doc instance from Parcel.

VKApiDocument

public VKApiDocument()

Creates empty Doc instance.

Method Detail

parse

public VKApiDocument parse(org.json.JSONObject jo)

Fills a Doc instance from JSONObject.

Overrides:

parse in class VKApiModel

Parameters:

jo - server API object.

Returns:

this object.

isImage

public boolean isImage()

isGif

public boolean isGif()

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

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

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