com.box.sdk

Class BoxTermsOfServiceUserStatus

Object

BoxResource

BoxTermsOfServiceUserStatus

@BoxResourceType(value="terms_of_service_user_status")
public class BoxTermsOfServiceUserStatus
extends BoxResource

Represents a user status on a custom Box Terms of Service object.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	BoxTermsOfServiceUserStatus.Info Contains information about the user status on a terms of service.

Field Summary

Fields

Modifier and Type	Field and Description
static URLTemplate	ALL_TERMS_OF_SERVICE_USER_STATUSES_TEMPLATE Terms of Services User Statuses URL Template.
static URLTemplate	TERMS_OF_SERVICE_USER_STATUSES_TEMPLATE All Terms of Services User Statuses URL Template.

Constructor Summary

Constructors

Constructor and Description
BoxTermsOfServiceUserStatus(BoxAPIConnection api, String id) Constructs a BoxTermsOfServiceUserStatus for a resource with a given ID.

Method Summary

Modifier and Type	Method and Description
static BoxTermsOfServiceUserStatus.Info	create(BoxAPIConnection api, String termsOfServiceID, Boolean isAccepted) Creates a User Status on a custom Terms of Service.
static BoxTermsOfServiceUserStatus.Info	create(BoxAPIConnection api, String termsOfServiceID, Boolean isAccepted, String userID) Creates a User Status on a custom Terms of Service.
static List<BoxTermsOfServiceUserStatus.Info>	getInfo(BoxAPIConnection api, String termsOfServiceID) Retrieves a list of User Status for Terms of Service as an Iterable.
static List<BoxTermsOfServiceUserStatus.Info>	getInfo(BoxAPIConnection api, String termsOfServiceID, String userID) Retrieves a list of User Status for Terms of Service as an Iterable.
void	updateInfo(BoxTermsOfServiceUserStatus.Info info) Updates the information about the user status for this terms of service with any info fields that have been modified locally.

Methods inherited from class BoxResource

equals, getAPI, getID, getResourceType, hashCode

Methods inherited from class Object

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

Field Detail

TERMS_OF_SERVICE_USER_STATUSES_TEMPLATE

public static final URLTemplate TERMS_OF_SERVICE_USER_STATUSES_TEMPLATE

All Terms of Services User Statuses URL Template.

ALL_TERMS_OF_SERVICE_USER_STATUSES_TEMPLATE

public static final URLTemplate ALL_TERMS_OF_SERVICE_USER_STATUSES_TEMPLATE

Terms of Services User Statuses URL Template.

Constructor Detail

BoxTermsOfServiceUserStatus

public BoxTermsOfServiceUserStatus(BoxAPIConnection api,
                                   String id)

Constructs a BoxTermsOfServiceUserStatus for a resource with a given ID.

Parameters:

api - the API connection to be used by the resource.

id - the ID of the resource.

Method Detail

create

public static BoxTermsOfServiceUserStatus.Info create(BoxAPIConnection api,
                                                      String termsOfServiceID,
                                                      Boolean isAccepted)

Creates a User Status on a custom Terms of Service.

Parameters:

api - the API connection to be used by the resource.

termsOfServiceID - the ID of the terms of service.

isAccepted - the indicator for whether the terms of service has been accepted.

Returns:

information about the User Status for Terms of Service created.

create

public static BoxTermsOfServiceUserStatus.Info create(BoxAPIConnection api,
                                                      String termsOfServiceID,
                                                      Boolean isAccepted,
                                                      String userID)

Creates a User Status on a custom Terms of Service.

Parameters:

api - the API connection to be used by the resource.

termsOfServiceID - the ID of the terms of service.

isAccepted - the indicator for whether the terms of service has been accepted.

userID - the ID of the user for the terms of service.

Returns:

information about the User Status for Terms of Service created.

getInfo

public static List<BoxTermsOfServiceUserStatus.Info> getInfo(BoxAPIConnection api,
                                                             String termsOfServiceID)

Retrieves a list of User Status for Terms of Service as an Iterable.

Parameters:

api - the API connection to be used by the resource.

termsOfServiceID - the ID of the terms of service.

Returns:

the Iterable of User Status for Terms of Service.

getInfo

public static List<BoxTermsOfServiceUserStatus.Info> getInfo(BoxAPIConnection api,
                                                             String termsOfServiceID,
                                                             String userID)

Retrieves a list of User Status for Terms of Service as an Iterable.

Parameters:

api - the API connection to be used by the resource.

termsOfServiceID - the ID of the terms of service.

userID - the ID of the user to retrieve terms of service for.

Returns:

the Iterable of User Status for Terms of Service.

updateInfo

public void updateInfo(BoxTermsOfServiceUserStatus.Info info)

Updates the information about the user status for this terms of service with any info fields that have been modified locally.

Parameters:

info - the updated info.