com.vk.sdk.api.model

Class VKApiPhotoAlbum

java.lang.Object

com.vk.sdk.api.model.VKApiModel

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

com.vk.sdk.api.model.VKApiPhotoAlbum

All Implemented Interfaces:

android.os.Parcelable, Identifiable

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

Describes a photo album

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
boolean	can_upload Whether a user can upload photos to this album(false — cannot, true — can).
static java.lang.String	COVER_M URL of empty album cover with max width at 130px
static java.lang.String	COVER_S URL for empty album cover with max width at 75px
static java.lang.String	COVER_X URL of empty album cover with max width at 604px
long	created Album creation date (in Unix time).
static android.os.Parcelable.Creator<VKApiPhotoAlbum>	CREATOR
java.lang.String	description Album description.
int	id Album ID.
int	owner_id ID of the user or community that owns the album.
VKPhotoSizes	photo Links to to cover photo.
int	privacy Privacy settings for the album.
int	size Number of photos in the album.
int	thumb_id ID of the photo which is the cover.
java.lang.String	thumb_src Link to album cover photo.
java.lang.String	title Album title.
long	updated Date (in Unix time) the album was last updated.

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
VKApiPhotoAlbum() Creates empty PhotoAlbum instance.
VKApiPhotoAlbum(org.json.JSONObject from)
VKApiPhotoAlbum(android.os.Parcel in) Creates a PhotoAlbum 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	isClosed()
VKApiPhotoAlbum	parse(org.json.JSONObject from) Creates a PhotoAlbum 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

COVER_S

public static final java.lang.String COVER_S

URL for empty album cover with max width at 75px

See Also:

Constant Field Values

COVER_M

public static final java.lang.String COVER_M

URL of empty album cover with max width at 130px

See Also:

Constant Field Values

COVER_X

public static final java.lang.String COVER_X

URL of empty album cover with max width at 604px

See Also:

Constant Field Values

id

public int id

Album ID.

title

public java.lang.String title

Album title.

size

public int size

Number of photos in the album.

privacy

public int privacy

Privacy settings for the album.

description

public java.lang.String description

Album description.

owner_id

public int owner_id

ID of the user or community that owns the album.

can_upload

public boolean can_upload

Whether a user can upload photos to this album(false — cannot, true — can).

updated

public long updated

Date (in Unix time) the album was last updated.

created

public long created

Album creation date (in Unix time).

thumb_id

public int thumb_id

ID of the photo which is the cover.

thumb_src

public java.lang.String thumb_src

Link to album cover photo.

photo

public VKPhotoSizes photo

Links to to cover photo.

CREATOR

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

Constructor Detail

VKApiPhotoAlbum

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

Throws:

org.json.JSONException

VKApiPhotoAlbum

public VKApiPhotoAlbum(android.os.Parcel in)

Creates a PhotoAlbum instance from Parcel.

VKApiPhotoAlbum

public VKApiPhotoAlbum()

Creates empty PhotoAlbum instance.

Method Detail

parse

public VKApiPhotoAlbum parse(org.json.JSONObject from)

Creates a PhotoAlbum instance from JSONObject.

Overrides:

parse in class VKApiModel

Parameters:

from - server API object.

Returns:

this object.

isClosed

public boolean isClosed()

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