com.box.sdk

Class BoxSignTemplate

Object

BoxResource

BoxSignTemplate

@BoxResourceType(value="sign_template")
public class BoxSignTemplate
extends BoxResource

Represents a Sign Template used in the Box Sign API.

See Also:

Box Sign Templates

Unless otherwise noted, the methods in this class can throw an unchecked {@link BoxAPIException} (unchecked meaning that the compiler won't force you to handle it) if an error occurs. If you wish to implement custom error handling for errors related to the Box REST API, you should capture this exception explicitly.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	BoxSignTemplate.Info Contains information about a BoxSignTemplate.

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_LIMIT The default limit of entries per response.
static URLTemplate	SIGN_TEMPLATE_URL_TEMPLATE The URL template for Sign Templates operations with a given ID.
static URLTemplate	SIGN_TEMPLATES_URL_TEMPLATE The URL template for Sign Templates.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
static Iterable<BoxSignTemplate.Info>	getAll(BoxAPIConnection api) Return all Sign Templates.
static Iterable<BoxSignTemplate.Info>	getAll(BoxAPIConnection api, int limit) Return all Sign Templates.
BoxSignTemplate.Info	getInfo() Return information about this Sign Template.

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

SIGN_TEMPLATES_URL_TEMPLATE

public static final URLTemplate SIGN_TEMPLATES_URL_TEMPLATE

The URL template for Sign Templates.

SIGN_TEMPLATE_URL_TEMPLATE

public static final URLTemplate SIGN_TEMPLATE_URL_TEMPLATE

The URL template for Sign Templates operations with a given ID.

DEFAULT_LIMIT

public static final int DEFAULT_LIMIT

The default limit of entries per response.

See Also:

Constant Field Values

Constructor Detail

BoxSignTemplate

public BoxSignTemplate(BoxAPIConnection api,
                       String id)

Constructs a BoxSignTemplate 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

getAll

public static Iterable<BoxSignTemplate.Info> getAll(BoxAPIConnection api)

Return all Sign Templates.

Parameters:

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

Returns:

an iterable with all Sign Templates.

getAll

public static Iterable<BoxSignTemplate.Info> getAll(BoxAPIConnection api,
                                                    int limit)

Return all Sign Templates.

Parameters:

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

limit - the limit of entries per response.

Returns:

an iterable with all Sign Templates.

getInfo

public BoxSignTemplate.Info getInfo()

Return information about this Sign Template.

Returns:

information about this Sign Template.