com.box.androidsdk.content

Class BoxApiShare

java.lang.Object

com.box.androidsdk.content.BoxApi

com.box.androidsdk.content.BoxApiShare

public class BoxApiShare
extends BoxApi

Represents the API of the share endpoint on Box. This class can be used to generate request objects for each of the APIs exposed endpoints

Field Summary

Fields inherited from class com.box.androidsdk.content.BoxApi

mBaseUploadUri, mBaseUri, mSession

Constructor Summary

Constructors

Constructor and Description
BoxApiShare(BoxSession session) Constructs a BoxApiShare with the provided BoxSession

Method Summary

Modifier and Type	Method and Description
protected java.lang.String	getSharedItemsUrl()
BoxRequestsShare.GetSharedLink	getSharedLinkRequest(java.lang.String sharedLink) Returns a request to get a BoxItem from a shared link.
BoxRequestsShare.GetSharedLink	getSharedLinkRequest(java.lang.String sharedLink, java.lang.String password) Returns a request to get a BoxItem from a shared link.

Methods inherited from class com.box.androidsdk.content.BoxApi

getBaseUploadUri, getBaseUri

Methods inherited from class java.lang.Object

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

Constructor Detail

BoxApiShare

public BoxApiShare(BoxSession session)

Constructs a BoxApiShare with the provided BoxSession

Parameters:

session - authenticated session to use with the BoxApiShare

Method Detail

getSharedItemsUrl

protected java.lang.String getSharedItemsUrl()

getSharedLinkRequest

public BoxRequestsShare.GetSharedLink getSharedLinkRequest(java.lang.String sharedLink)

Returns a request to get a BoxItem from a shared link.

Parameters:

sharedLink - shared link of the item to retrieve.

Returns:

request to get a BoxItem from a shared link.

getSharedLinkRequest

public BoxRequestsShare.GetSharedLink getSharedLinkRequest(java.lang.String sharedLink,
                                                           java.lang.String password)

Returns a request to get a BoxItem from a shared link.

Parameters:

sharedLink - shared link of the item to retrieve.

password - password for shared link

Returns:

request to get a BoxItem from a shared link.