org.springframework.social.slideshare.api.impl

Class SlideshowTemplate

java.lang.Object

org.springframework.social.slideshare.api.impl.SlideshowTemplate

All Implemented Interfaces:

SlideshowOperations

public class SlideshowTemplate
extends Object
implements SlideshowOperations

Implementation of slideshow related operations.

Author:

Tadaya Tsuyukubo

Field Summary

Fields

Modifier and Type	Field and Description
static String	BASE_URL
static String	DELETE_SLIDESHOW_URL
static String	EDIT_SLIDESHOW_URL
static String	GET_SLIDESHOW_URL
static String	GET_SLIDESHOWS_BY_GROUP_URL
static String	GET_SLIDESHOWS_BY_TAG_URL
static String	GET_SLIDESHOWS_BY_USER_URL
static String	SEARCH_SLIDESHOWS_URL
static String	UPLOAD_SLIDESHOW_URL

Constructor Summary

Constructors

Constructor and Description
SlideshowTemplate(org.springframework.web.client.RestOperations restOperations)

Method Summary

Methods

Modifier and Type	Method and Description
String	deleteSlideshow(String username, String password, String slideshowId) Delete a slideshow.
String	editSlideshow(String username, String password, String slideshowId, String slideshowTitle, String slideshowDescription, Collection<String> slideshowTags, Boolean makeSlideshowPrivate, Boolean generateSecretUrl, Boolean allowEmbeds, Boolean shareWithContacts) Edit existing slideshow.
String	editSlideshow(String username, String password, String slideshowId, String slideshowTitle, String slideshowDescription, Collection<String> slideshowTags, PrivacySetting privacySetting) Edit existing slideshow with PrivacySetting.
Slideshow	getSlideshow(String slideshowId, String slideshowUrl) Get slideshow from either slideshow id or url (detailed=true).
Slideshow	getSlideshow(String slideshowId, String slideshowUrl, String username, String password) Get slideshow from either slideshow id or url (detailed=true).
Slideshow	getSlideshow(String slideshowId, String slideshowUrl, String username, String password, boolean excludeTags, boolean detailed, boolean transcript) Get slideshow from either slideshow id or url (detailed=true).
Slideshow	getSlideshowById(String slideshowId) Get slideshow by slideshow_id (detailed=true).
Slideshow	getSlideshowById(String slideshowId, String username, String password) Get slideshow by slideshow_id (detailed=true).
Slideshow	getSlideshowById(String slideshowId, String username, String password, boolean excludeTags, boolean detailed, boolean transcript) Get slideshow by slideshow_id
Slideshow	getSlideshowByUrl(String slideshowUrl) Get slideshow by slideshow url (detailed=true).
Slideshow	getSlideshowByUrl(String slideshowUrl, String username, String password) Get slideshow by slideshow url (detailed=true).
Slideshow	getSlideshowByUrl(String slideshowUrl, String username, String password, boolean excludeTags, boolean detailed, boolean transcript) Get slideshow by slideshow url.
GetSlideshowsResponse	getSlideshowsByGroup(String groupName, int limit) Get slideshows by group (detailed=true).
GetSlideshowsResponse	getSlideshowsByGroup(String groupName, int limit, int offset, boolean detailed) Get slideshows by group.
GetSlideshowsResponse	getSlideshowsByTag(String tag, int limit) Get slideshows by tag (detailed=true).
GetSlideshowsResponse	getSlideshowsByTag(String tag, int limit, int offset, boolean detailed) Get slideshows by tag.
GetSlideshowsResponse	getSlideshowsByUser(String usernameFor, int limit) Get slideshows by username (detailed=true).
GetSlideshowsResponse	getSlideshowsByUser(String usernameFor, String username, String password, int limit) Get slideshows by username (detailed=true).
GetSlideshowsResponse	getSlideshowsByUser(String usernameFor, String username, String password, int limit, int offset, boolean detailed, boolean getUnconverted) Get slideshows by username.
SearchSlideshowsResponse	searchSlideshows(String q) Returns slideshows according to the search criteria Use default page which is set to 1 Use default itemsPerPage which is set to 12
SearchSlideshowsResponse	searchSlideshows(String q, int page) Returns slideshows according to the search criteria Use default itemsPerPage which is set to 12
SearchSlideshowsResponse	searchSlideshows(String q, int page, int itemsPerPage) Returns slideshows according to the search criteria
SearchSlideshowsResponse	searchSlideshows(String q, int page, int itemsPerPage, SearchOptions.Language lang, SearchOptions.Sort sort, SearchOptions.UploadDate uploadDate, SearchOptions.SearchType searchType, boolean downloadableOnly, SearchOptions.FileFormat fileformat, SearchOptions.FileType fileType, boolean isCC, boolean isCCAdapt, boolean isCCCommercial, boolean detailed, boolean transcript) Returns slideshows according to the search criteria
String	uploadSlideshowFromContent(String username, String password, byte[] slideshowContent, String filename, String title, String description, Collection<String> tags, boolean makeSrcPublic, Boolean makeSlideshowPrivate, Boolean generateSecretUrl, Boolean allowEmbeds, Boolean shareWithContacts) Create a new slideshow from its content.
String	uploadSlideshowFromContent(String username, String password, String slideshowContent, String filename, String title, String description, Collection<String> tags, boolean makeSrcPublic, Boolean makeSlideshowPrivate, Boolean generateSecretUrl, Boolean allowEmbeds, Boolean shareWithContacts) Create a new slideshow from its content.
String	uploadSlideshowFromContent(String username, String password, String slideshowContent, String filename, String title, String description, Collection<String> tags, boolean makeSrcPublic, PrivacySetting privacySetting) Create a new slideshow from its content with PrivacySetting.
String	uploadSlideshowFromFile(String username, String password, File slideshowFile, String title, String description) Create a new slideshow from local file.
String	uploadSlideshowFromFile(String username, String password, File slideshowFile, String title, String description, Collection<String> tags, boolean makeSrcPublic, Boolean makeSlideshowPrivate, Boolean generateSecretUrl, Boolean allowEmbeds, Boolean shareWithContacts) Create a new slideshow from local file.
String	uploadSlideshowFromFile(String username, String password, File slideshowFile, String title, String description, Collection<String> tags, boolean makeSrcPublic, PrivacySetting privacySetting) Create a new slideshow from local file with PrivacySetting.
String	uploadSlideshowFromFile(String username, String password, String slideshowFilePath, String title, String description, Collection<String> tags, boolean makeSrcPublic, Boolean makeSlideshowPrivate, Boolean generateSecretUrl, Boolean allowEmbeds, Boolean shareWithContacts) Create a new slideshow from local file path.
String	uploadSlideshowFromUrl(String username, String password, String uploadUrl, String title, String description, Collection<String> tags, Boolean makeSrcPublic) Create a new slideshow from url.
String	uploadSlideshowFromUrl(String username, String password, String uploadUrl, String title, String description, Collection<String> tags, Boolean makeSrcPublic, Boolean makeSlideshowPrivate, Boolean generateSecretUrl, Boolean allowEmbeds, Boolean shareWithContacts) Create a new slideshow from url.
String	uploadSlideshowFromUrl(String username, String password, String uploadUrl, String title, String description, Collection<String> tags, Boolean makeSrcPublic, PrivacySetting privacySetting) Create a new slideshow from url with PrivacySetting.
String	uploadSlideshowResource(String username, String password, org.springframework.core.io.Resource slideshowResource, String slideshowTitle, String slideshowDescription, Collection<String> slideshowTags, boolean makeSrcPublic, Boolean makeSlideshowPrivate, Boolean generateSecretUrl, Boolean allowEmbeds, Boolean shareWithContacts) Create a new slideshow from Resource.

Methods inherited from class java.lang.Object

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

Field Detail

BASE_URL

public static final String BASE_URL

See Also:

Constant Field Values

GET_SLIDESHOW_URL

public static final String GET_SLIDESHOW_URL

See Also:

Constant Field Values

GET_SLIDESHOWS_BY_TAG_URL

public static final String GET_SLIDESHOWS_BY_TAG_URL

See Also:

Constant Field Values

GET_SLIDESHOWS_BY_GROUP_URL

public static final String GET_SLIDESHOWS_BY_GROUP_URL

See Also:

Constant Field Values

GET_SLIDESHOWS_BY_USER_URL

public static final String GET_SLIDESHOWS_BY_USER_URL

See Also:

Constant Field Values

SEARCH_SLIDESHOWS_URL

public static final String SEARCH_SLIDESHOWS_URL

See Also:

Constant Field Values

EDIT_SLIDESHOW_URL

public static final String EDIT_SLIDESHOW_URL

See Also:

Constant Field Values

DELETE_SLIDESHOW_URL

public static final String DELETE_SLIDESHOW_URL

See Also:

Constant Field Values

UPLOAD_SLIDESHOW_URL

public static final String UPLOAD_SLIDESHOW_URL

See Also:

Constant Field Values

Constructor Detail

SlideshowTemplate

public SlideshowTemplate(org.springframework.web.client.RestOperations restOperations)

Method Detail

getSlideshowById

public Slideshow getSlideshowById(String slideshowId)

Description copied from interface: SlideshowOperations

Get slideshow by slideshow_id (detailed=true).

Specified by:

getSlideshowById in interface SlideshowOperations

Parameters:

slideshowId - slideshow id

Returns:

a detailed slideshow

getSlideshowById

public Slideshow getSlideshowById(String slideshowId,
                         String username,
                         String password)

Description copied from interface: SlideshowOperations

Get slideshow by slideshow_id (detailed=true).

Specified by:

getSlideshowById in interface SlideshowOperations

Parameters:

slideshowId - slideshow id

username - username of the requesting user

password - password of the requesting user

Returns:

a detailed slideshow

getSlideshowById

public Slideshow getSlideshowById(String slideshowId,
                         String username,
                         String password,
                         boolean excludeTags,
                         boolean detailed,
                         boolean transcript)

Description copied from interface: SlideshowOperations

Get slideshow by slideshow_id

Specified by:

getSlideshowById in interface SlideshowOperations

Parameters:

slideshowId - slideshow id

username - username of the requesting user

password - password of the requesting user

excludeTags - exclude tags if set to true

detailed - get detailed info if set to true

transcript - get transcript if set to true

Returns:

a slideshow

getSlideshowByUrl

public Slideshow getSlideshowByUrl(String slideshowUrl)

Description copied from interface: SlideshowOperations

Get slideshow by slideshow url (detailed=true).

Specified by:

getSlideshowByUrl in interface SlideshowOperations

Parameters:

slideshowUrl - URL of the slideshow to be fetched

Returns:

a detailed slideshow

getSlideshowByUrl

public Slideshow getSlideshowByUrl(String slideshowUrl,
                          String username,
                          String password)

Description copied from interface: SlideshowOperations

Get slideshow by slideshow url (detailed=true).

Specified by:

getSlideshowByUrl in interface SlideshowOperations

Parameters:

slideshowUrl - URL of the slideshow to be fetched

username - username of the requesting user

password - password of the requesting user

Returns:

a detailed slideshow

getSlideshowByUrl

public Slideshow getSlideshowByUrl(String slideshowUrl,
                          String username,
                          String password,
                          boolean excludeTags,
                          boolean detailed,
                          boolean transcript)

Description copied from interface: SlideshowOperations

Get slideshow by slideshow url.

Specified by:

getSlideshowByUrl in interface SlideshowOperations

Parameters:

slideshowUrl - URL of the slideshow to be fetched

username - username of the requesting user

password - password of the requesting user

excludeTags - exclude tags if set to true

detailed - get detailed info if set to true

transcript - get transcript if set to true

Returns:

a slideshow

getSlideshow

public Slideshow getSlideshow(String slideshowId,
                     String slideshowUrl)

Description copied from interface: SlideshowOperations

Get slideshow from either slideshow id or url (detailed=true). Slideshow id has precedence over url.

Specified by:

getSlideshow in interface SlideshowOperations

Parameters:

slideshowId - slideshow id

slideshowUrl - URL of the slideshow to be fetched

Returns:

a detailed slideshow

getSlideshow

public Slideshow getSlideshow(String slideshowId,
                     String slideshowUrl,
                     String username,
                     String password)

Description copied from interface: SlideshowOperations

Get slideshow from either slideshow id or url (detailed=true). Slideshow id has precedence over url.

Specified by:

getSlideshow in interface SlideshowOperations

Parameters:

slideshowId - slideshow id

slideshowUrl - URL of the slideshow to be fetched

username - username of the requesting user

password - password of the requesting user

Returns:

a detailed slideshow

getSlideshow

public Slideshow getSlideshow(String slideshowId,
                     String slideshowUrl,
                     String username,
                     String password,
                     boolean excludeTags,
                     boolean detailed,
                     boolean transcript)

Description copied from interface: SlideshowOperations

Get slideshow from either slideshow id or url (detailed=true). Slideshow id has precedence over url.

Specified by:

getSlideshow in interface SlideshowOperations

Parameters:

slideshowId - slideshow id

slideshowUrl - URL of the slideshow to be fetched

username - username of the requesting user

password - password of the requesting user

excludeTags - exclude tags if set to true

detailed - get detailed info if set to true

transcript - get transcript if set to true

Returns:

a slideshow

getSlideshowsByTag

public GetSlideshowsResponse getSlideshowsByTag(String tag,
                                       int limit)

Description copied from interface: SlideshowOperations

Get slideshows by tag (detailed=true). use default offset

Specified by:

getSlideshowsByTag in interface SlideshowOperations

Parameters:

tag - a tag name

limit - number of items to return

Returns:

response object that contains returned slideshows

getSlideshowsByTag

public GetSlideshowsResponse getSlideshowsByTag(String tag,
                                       int limit,
                                       int offset,
                                       boolean detailed)

Description copied from interface: SlideshowOperations

Get slideshows by tag.

Specified by:

getSlideshowsByTag in interface SlideshowOperations

Parameters:

tag - a tag name

limit - number of items to return

offset - offset

detailed - get detailed info if set to true

Returns:

response object that contains returned slideshows

getSlideshowsByGroup

public GetSlideshowsResponse getSlideshowsByGroup(String groupName,
                                         int limit)

Description copied from interface: SlideshowOperations

Get slideshows by group (detailed=true). use default offset

Specified by:

getSlideshowsByGroup in interface SlideshowOperations

Parameters:

groupName - a gropu name

limit - number of items to return

Returns:

response object that contains returned slideshows

getSlideshowsByGroup

public GetSlideshowsResponse getSlideshowsByGroup(String groupName,
                                         int limit,
                                         int offset,
                                         boolean detailed)

Description copied from interface: SlideshowOperations

Get slideshows by group.

Specified by:

getSlideshowsByGroup in interface SlideshowOperations

Parameters:

groupName - a group name

limit - number of items to return

offset - offset

detailed - get detailed info if set to true

Returns:

response object that contains returned slideshows

getSlideshowsByUser

public GetSlideshowsResponse getSlideshowsByUser(String usernameFor,
                                        int limit)

Description copied from interface: SlideshowOperations

Get slideshows by username (detailed=true). use default offset

Specified by:

getSlideshowsByUser in interface SlideshowOperations

Parameters:

usernameFor - username of owner of slideshows

limit - number of items to return

Returns:

response object that contains returned slideshows

getSlideshowsByUser

public GetSlideshowsResponse getSlideshowsByUser(String usernameFor,
                                        String username,
                                        String password,
                                        int limit)

Description copied from interface: SlideshowOperations

Get slideshows by username (detailed=true). use default offset

Specified by:

getSlideshowsByUser in interface SlideshowOperations

Parameters:

usernameFor - username of owner of slideshows

username - username of the requesting user

password - password of the requesting user

limit - number of items to return

Returns:

response object that contains returned slideshows

getSlideshowsByUser

public GetSlideshowsResponse getSlideshowsByUser(String usernameFor,
                                        String username,
                                        String password,
                                        int limit,
                                        int offset,
                                        boolean detailed,
                                        boolean getUnconverted)

Description copied from interface: SlideshowOperations

Get slideshows by username.

Specified by:

getSlideshowsByUser in interface SlideshowOperations

Parameters:

usernameFor - username of owner of slideshows

username - username of the requesting user

password - password of the requesting user

limit - number of items to return

offset - offset

detailed - get detailed info if set to true

getUnconverted - include unconverted slideshows if set to true

Returns:

searchSlideshows

public SearchSlideshowsResponse searchSlideshows(String q)

Description copied from interface: SlideshowOperations

Returns slideshows according to the search criteria Use default page which is set to 1 Use default itemsPerPage which is set to 12

Specified by:

searchSlideshows in interface SlideshowOperations

Parameters:

q - search keyword

Returns:

search response object that contains returned slideshows

searchSlideshows

public SearchSlideshowsResponse searchSlideshows(String q,
                                        int page)

Description copied from interface: SlideshowOperations

Returns slideshows according to the search criteria Use default itemsPerPage which is set to 12

Specified by:

searchSlideshows in interface SlideshowOperations

Parameters:

q - search keyword

page - page number of the results

Returns:

search response object that contains returned slideshows

searchSlideshows

public SearchSlideshowsResponse searchSlideshows(String q,
                                        int page,
                                        int itemsPerPage)

Description copied from interface: SlideshowOperations

Returns slideshows according to the search criteria

Specified by:

searchSlideshows in interface SlideshowOperations

Parameters:

q - search keyword

page - page number of the results

itemsPerPage - number of results to return per page,

Returns:

search response object that contains returned slideshows

searchSlideshows

public SearchSlideshowsResponse searchSlideshows(String q,
                                        int page,
                                        int itemsPerPage,
                                        SearchOptions.Language lang,
                                        SearchOptions.Sort sort,
                                        SearchOptions.UploadDate uploadDate,
                                        SearchOptions.SearchType searchType,
                                        boolean downloadableOnly,
                                        SearchOptions.FileFormat fileformat,
                                        SearchOptions.FileType fileType,
                                        boolean isCC,
                                        boolean isCCAdapt,
                                        boolean isCCCommercial,
                                        boolean detailed,
                                        boolean transcript)

Description copied from interface: SlideshowOperations

Returns slideshows according to the search criteria

Specified by:

searchSlideshows in interface SlideshowOperations

Parameters:

q - search keyword

page - page number of the results

itemsPerPage - number of results to return per page,

lang - language of slideshows (default is English, 'en')

sort - sort order (default is relevance)

uploadDate - time period you want to restrict your search to (default is 'any')

searchType - what type of search (default is text search)

downloadableOnly - slideshows that are available to download (default is 'all')

fileformat - file format to search for (default is 'all')

fileType - file type to search for (default is 'all')

isCC - retrieve results under the Creative Commons license if set to true (default is false)

isCCAdapt - retrieve results under the Creative Commons that allow adaption, modification if set to true (default is false)

isCCCommercial - retrieve results under the Commercial Creative Commons license (default is false)

detailed - get detailed info if set to true (default is false)

transcript - get transcript if set to true (default is false)

Returns:

editSlideshow

public String editSlideshow(String username,
                   String password,
                   String slideshowId,
                   String slideshowTitle,
                   String slideshowDescription,
                   Collection<String> slideshowTags,
                   PrivacySetting privacySetting)

Description copied from interface: SlideshowOperations

Edit existing slideshow with PrivacySetting.

Specified by:

editSlideshow in interface SlideshowOperations

Parameters:

username - username of the requesting user

password - password of the requesting user

slideshowId - slideshow id

slideshowTitle - slidesow title

slideshowDescription - slideshow description

slideshowTags - slideshow tags (comma separated list of tags)

privacySetting - privacy setting object (can be null)

Returns:

edited slideshow id

editSlideshow

public String editSlideshow(String username,
                   String password,
                   String slideshowId,
                   String slideshowTitle,
                   String slideshowDescription,
                   Collection<String> slideshowTags,
                   Boolean makeSlideshowPrivate,
                   Boolean generateSecretUrl,
                   Boolean allowEmbeds,
                   Boolean shareWithContacts)

Description copied from interface: SlideshowOperations

Edit existing slideshow.

Specified by:

editSlideshow in interface SlideshowOperations

Parameters:

username - username of the requesting user

password - password of the requesting user

slideshowId - slideshow id

slideshowTitle - slidesow title

slideshowDescription - slideshow description

slideshowTags - slideshow tags (comma separated list of tags)

makeSlideshowPrivate - make slideshow private if set to true. If false is set, slideshow becomes public. (can be null)

generateSecretUrl - generate a secret URL for the slideshow if set to true. 'makeSlideshowPrivate' needs to be true. (can be null)

allowEmbeds - allow web site to embed the slideshow if set to true 'makeSlideshowPrivate' needs to be true. (can be null)

shareWithContacts - allow contacts can be viewed on slideshow if set to true 'makeSlideshowPrivate' needs to be true. (can be null)

Returns:

edited slideshow id

deleteSlideshow

public String deleteSlideshow(String username,
                     String password,
                     String slideshowId)

Description copied from interface: SlideshowOperations

Delete a slideshow.

Specified by:

deleteSlideshow in interface SlideshowOperations

Parameters:

username - username of the requesting user

password - password of the requesting user

slideshowId - slideshow id to delete

Returns:

deleted slideshow id

uploadSlideshowFromUrl

public String uploadSlideshowFromUrl(String username,
                            String password,
                            String uploadUrl,
                            String title,
                            String description,
                            Collection<String> tags,
                            Boolean makeSrcPublic)

Description copied from interface: SlideshowOperations

Create a new slideshow from url. This method requires extra permissions on your slideshare account.

Specified by:

uploadSlideshowFromUrl in interface SlideshowOperations

Parameters:

username - username of the requesting user

password - password of the requesting user

uploadUrl - url pointing to the presentation file

title - slideshow title

description - slideshow description

tags - slideshow tags

makeSrcPublic - allow user to download uploaded file if set to true. (default is true) (can be null)

Returns:

new slideshow id

uploadSlideshowFromUrl

public String uploadSlideshowFromUrl(String username,
                            String password,
                            String uploadUrl,
                            String title,
                            String description,
                            Collection<String> tags,
                            Boolean makeSrcPublic,
                            PrivacySetting privacySetting)

Description copied from interface: SlideshowOperations

Create a new slideshow from url with PrivacySetting. This method requires extra permissions on your slideshare account.

Specified by:

uploadSlideshowFromUrl in interface SlideshowOperations

Parameters:

username - username of the requesting user

password - password of the requesting user

uploadUrl - url pointing to the presentation file

title - slideshow title

description - slideshow description

tags - slideshow tags

makeSrcPublic - allow user to download uploaded file if set to true. (default is true) (can be null)

privacySetting - privacy setting object (can be null)

Returns:

new slideshow id

uploadSlideshowFromUrl

public String uploadSlideshowFromUrl(String username,
                            String password,
                            String uploadUrl,
                            String title,
                            String description,
                            Collection<String> tags,
                            Boolean makeSrcPublic,
                            Boolean makeSlideshowPrivate,
                            Boolean generateSecretUrl,
                            Boolean allowEmbeds,
                            Boolean shareWithContacts)

Description copied from interface: SlideshowOperations

Create a new slideshow from url. This method requires extra permissions on your slideshare account.

Specified by:

uploadSlideshowFromUrl in interface SlideshowOperations

Parameters:

username - username of the requesting user

password - password of the requesting user

uploadUrl - url pointing to the presentation file

title - slideshow title

description - slideshow description

tags - slideshow tags

makeSrcPublic - allow user to download uploaded file if set to true. (default is true) (can be null)

makeSlideshowPrivate - make slideshow private if set to true. If false is set, slideshow becomes public. (can be null)

generateSecretUrl - generate a secret URL for the slideshow if set to true. 'makeSlideshowPrivate' needs to be true. (can be null)

allowEmbeds - allow web site to embed the slideshow if set to true 'makeSlideshowPrivate' needs to be true. (can be null)

shareWithContacts - allow contacts can be viewed on slideshow if set to true 'makeSlideshowPrivate' needs to be true. (can be null)

Returns:

new slideshow id

uploadSlideshowFromFile

public String uploadSlideshowFromFile(String username,
                             String password,
                             File slideshowFile,
                             String title,
                             String description)

Description copied from interface: SlideshowOperations

Create a new slideshow from local file. This method requires extra permissions on your slideshare account.

Specified by:

uploadSlideshowFromFile in interface SlideshowOperations

Parameters:

username - username of the requesting user

password - password of the requesting user

slideshowFile - local presentation file

title - slideshow title

description - slideshow description

Returns:

new slideshow id

uploadSlideshowFromFile

public String uploadSlideshowFromFile(String username,
                             String password,
                             File slideshowFile,
                             String title,
                             String description,
                             Collection<String> tags,
                             boolean makeSrcPublic,
                             PrivacySetting privacySetting)

Description copied from interface: SlideshowOperations

Create a new slideshow from local file with PrivacySetting. This method requires extra permissions on your slideshare account.

Specified by:

uploadSlideshowFromFile in interface SlideshowOperations

Parameters:

username - username of the requesting user

password - password of the requesting user

slideshowFile - local presentation file

title - slideshow title

description - slideshow description

tags - slideshow tags

makeSrcPublic - allow user to download uploaded file if set to true. (default is true) (can be null)

privacySetting - privacy setting object (can be null)

Returns:

new slideshow id

uploadSlideshowFromFile

public String uploadSlideshowFromFile(String username,
                             String password,
                             File slideshowFile,
                             String title,
                             String description,
                             Collection<String> tags,
                             boolean makeSrcPublic,
                             Boolean makeSlideshowPrivate,
                             Boolean generateSecretUrl,
                             Boolean allowEmbeds,
                             Boolean shareWithContacts)

Description copied from interface: SlideshowOperations

Create a new slideshow from local file. This method requires extra permissions on your slideshare account.

Specified by:

uploadSlideshowFromFile in interface SlideshowOperations

Parameters:

username - username of the requesting user

password - password of the requesting user

slideshowFile - local presentation file

title - slideshow title

description - slideshow description

tags - slideshow tags

makeSrcPublic - allow user to download uploaded file if set to true. (default is true) (can be null)

makeSlideshowPrivate - make slideshow private if set to true. If false is set, slideshow becomes public. (can be null)

generateSecretUrl - generate a secret URL for the slideshow if set to true. 'makeSlideshowPrivate' needs to be true. (can be null)

allowEmbeds - allow web site to embed the slideshow if set to true 'makeSlideshowPrivate' needs to be true. (can be null)

shareWithContacts - allow contacts can be viewed on slideshow if set to true 'makeSlideshowPrivate' needs to be true. (can be null)

Returns:

new slideshow id

uploadSlideshowFromFile

public String uploadSlideshowFromFile(String username,
                             String password,
                             String slideshowFilePath,
                             String title,
                             String description,
                             Collection<String> tags,
                             boolean makeSrcPublic,
                             Boolean makeSlideshowPrivate,
                             Boolean generateSecretUrl,
                             Boolean allowEmbeds,
                             Boolean shareWithContacts)

Description copied from interface: SlideshowOperations

Create a new slideshow from local file path.

Specified by:

uploadSlideshowFromFile in interface SlideshowOperations

Parameters:

username - username of the requesting user

password - password of the requesting user

slideshowFilePath - path to the local presentation file

title - slideshow title

description - slideshow description

tags - slideshow tags

makeSrcPublic - allow user to download uploaded file if set to true. (default is true) (can be null)

makeSlideshowPrivate - make slideshow private if set to true. If false is set, slideshow becomes public. (can be null)

generateSecretUrl - generate a secret URL for the slideshow if set to true. 'makeSlideshowPrivate' needs to be true. (can be null)

allowEmbeds - allow web site to embed the slideshow if set to true 'makeSlideshowPrivate' needs to be true. (can be null)

shareWithContacts - allow contacts can be viewed on slideshow if set to true 'makeSlideshowPrivate' needs to be true. (can be null)

Returns:

new slideshow id

uploadSlideshowFromContent

public String uploadSlideshowFromContent(String username,
                                String password,
                                String slideshowContent,
                                String filename,
                                String title,
                                String description,
                                Collection<String> tags,
                                boolean makeSrcPublic,
                                PrivacySetting privacySetting)

Description copied from interface: SlideshowOperations

Create a new slideshow from its content with PrivacySetting.

Specified by:

uploadSlideshowFromContent in interface SlideshowOperations

Parameters:

username - username of the requesting user

password - password of the requesting user

slideshowContent - slideshow content

filename - filename (used to detect file type from extension)

title - slideshow title

description - slideshow description

tags - slideshow tags

makeSrcPublic - allow user to download uploaded file if set to true. (default is true) (can be null)

privacySetting - privacy setting object (can be null)

Returns:

new slideshow id

uploadSlideshowFromContent

public String uploadSlideshowFromContent(String username,
                                String password,
                                String slideshowContent,
                                String filename,
                                String title,
                                String description,
                                Collection<String> tags,
                                boolean makeSrcPublic,
                                Boolean makeSlideshowPrivate,
                                Boolean generateSecretUrl,
                                Boolean allowEmbeds,
                                Boolean shareWithContacts)

Description copied from interface: SlideshowOperations

Create a new slideshow from its content.

Specified by:

uploadSlideshowFromContent in interface SlideshowOperations

Parameters:

username - username of the requesting user

password - password of the requesting user

slideshowContent - slideshow content

filename - filename (used to detect file type from extension)

title - slideshow title

description - slideshow description

tags - slideshow tags

makeSrcPublic - allow user to download uploaded file if set to true. (default is true) (can be null)

makeSlideshowPrivate - make slideshow private if set to true. If false is set, slideshow becomes public. (can be null)

generateSecretUrl - generate a secret URL for the slideshow if set to true. 'makeSlideshowPrivate' needs to be true. (can be null)

allowEmbeds - allow web site to embed the slideshow if set to true 'makeSlideshowPrivate' needs to be true. (can be null)

shareWithContacts - allow contacts can be viewed on slideshow if set to true 'makeSlideshowPrivate' needs to be true. (can be null)

Returns:

new slideshow id

uploadSlideshowFromContent

public String uploadSlideshowFromContent(String username,
                                String password,
                                byte[] slideshowContent,
                                String filename,
                                String title,
                                String description,
                                Collection<String> tags,
                                boolean makeSrcPublic,
                                Boolean makeSlideshowPrivate,
                                Boolean generateSecretUrl,
                                Boolean allowEmbeds,
                                Boolean shareWithContacts)

Description copied from interface: SlideshowOperations

Create a new slideshow from its content.

Specified by:

uploadSlideshowFromContent in interface SlideshowOperations

Parameters:

username - username of the requesting user

password - password of the requesting user

slideshowContent - slideshow content

filename - filename (used to detect file type from extension)

title - slideshow title

description - slideshow description

tags - slideshow tags

makeSrcPublic - allow user to download uploaded file if set to true. (default is true) (can be null)

makeSlideshowPrivate - make slideshow private if set to true. If false is set, slideshow becomes public. (can be null)

generateSecretUrl - generate a secret URL for the slideshow if set to true. 'makeSlideshowPrivate' needs to be true. (can be null)

allowEmbeds - allow web site to embed the slideshow if set to true 'makeSlideshowPrivate' needs to be true. (can be null)

shareWithContacts - allow contacts can be viewed on slideshow if set to true 'makeSlideshowPrivate' needs to be true. (can be null)

Returns:

new slideshow id

uploadSlideshowResource

public String uploadSlideshowResource(String username,
                             String password,
                             org.springframework.core.io.Resource slideshowResource,
                             String slideshowTitle,
                             String slideshowDescription,
                             Collection<String> slideshowTags,
                             boolean makeSrcPublic,
                             Boolean makeSlideshowPrivate,
                             Boolean generateSecretUrl,
                             Boolean allowEmbeds,
                             Boolean shareWithContacts)

Description copied from interface: SlideshowOperations

Create a new slideshow from Resource.

Specified by:

uploadSlideshowResource in interface SlideshowOperations

Parameters:

username - username of the requesting user

password - password of the requesting user

slideshowResource - slideshow resource

slideshowTitle - slideshow title

slideshowDescription - slideshow description

slideshowTags - slideshow tags

makeSrcPublic - allow user to download uploaded file if set to true. (default is true) (can be null)

makeSlideshowPrivate - make slideshow private if set to true. If false is set, slideshow becomes public. (can be null)

generateSecretUrl - generate a secret URL for the slideshow if set to true. 'makeSlideshowPrivate' needs to be true. (can be null)

allowEmbeds - allow web site to embed the slideshow if set to true 'makeSlideshowPrivate' needs to be true. (can be null)

shareWithContacts - allow contacts can be viewed on slideshow if set to true 'makeSlideshowPrivate' needs to be true. (can be null)

Returns: