com.box.sdk

Class BoxWebHook

Object

BoxResource

BoxWebHook

@BoxResourceType(value="webhook")
public class BoxWebHook
extends BoxResource

Box WebHook resource.

Since:

2.2.1

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	BoxWebHook.Info Contains information for a BoxWebHook instance.
static class	BoxWebHook.Target WebHook target - file or folder.
static class	BoxWebHook.Trigger A Box related triggers.

Field Summary

Fields

Modifier and Type	Field and Description
static URLTemplate	WEBHOOK_URL_TEMPLATE URLTemplate for single BoxWebHook resource.
static URLTemplate	WEBHOOKS_URL_TEMPLATE URLTemplate for BoxWebHooks resource.

Constructor Summary

Constructors

Constructor and Description
BoxWebHook(BoxAPIConnection api, String id) Constructor.

Method Summary

Modifier and Type	Method and Description
static Iterable<BoxWebHook.Info>	all(BoxAPIConnection api) Returns iterator over all BoxWebHook-s.
static Iterable<BoxWebHook.Info>	all(BoxAPIConnection api, String... fields) Returns iterator over all BoxWebHook-s.
static BoxWebHook.Info	create(BoxResource target, URL address, BoxWebHook.Trigger... triggers) Adds a BoxWebHook to a provided BoxResource.
static BoxWebHook.Info	create(BoxResource target, URL address, Set<BoxWebHook.Trigger> triggers) Adds a BoxWebHook to a provided BoxResource.
void	delete() Deletes this webhook.
BoxWebHook.Info	getInfo(String... fields)
void	updateInfo(BoxWebHook.Info info) Updates BoxWebHook information.
static void	validateTriggers(String targetType, Collection<BoxWebHook.Trigger> triggers) Validates that provided BoxWebHook.Trigger-s can be applied on the provided BoxResourceType.

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

WEBHOOKS_URL_TEMPLATE

public static final URLTemplate WEBHOOKS_URL_TEMPLATE

URLTemplate for BoxWebHooks resource.

WEBHOOK_URL_TEMPLATE

public static final URLTemplate WEBHOOK_URL_TEMPLATE

URLTemplate for single BoxWebHook resource.

Constructor Detail

BoxWebHook

public BoxWebHook(BoxAPIConnection api,
                  String id)

Constructor.

Parameters:

api - BoxResource.getAPI()

id - BoxResource.getID()

Method Detail

create

public static BoxWebHook.Info create(BoxResource target,
                                     URL address,
                                     BoxWebHook.Trigger... triggers)

Adds a BoxWebHook to a provided BoxResource.

Parameters:

target - BoxResource web resource

address - URL where the notification should send to

triggers - events this BoxWebHook is interested in

Returns:

created BoxWebHook

See Also:

create(BoxResource, URL, Set)

create

public static BoxWebHook.Info create(BoxResource target,
                                     URL address,
                                     Set<BoxWebHook.Trigger> triggers)

Adds a BoxWebHook to a provided BoxResource.

Parameters:

target - BoxResource web resource

address - URL where the notification should send to

triggers - events this BoxWebHook is interested in

Returns:

created BoxWebHook

See Also:

create(BoxResource, URL, Trigger...)

all

public static Iterable<BoxWebHook.Info> all(BoxAPIConnection api)

Returns iterator over all BoxWebHook-s.

Parameters:

api - the API connection to be used by the resource

Returns:

existing BoxWebHook.Info-s

all

public static Iterable<BoxWebHook.Info> all(BoxAPIConnection api,
                                            String... fields)

Returns iterator over all BoxWebHook-s.

Parameters:

api - the API connection to be used by the resource

fields - the fields to retrieve.

Returns:

existing BoxWebHook.Info-s

validateTriggers

public static void validateTriggers(String targetType,
                                    Collection<BoxWebHook.Trigger> triggers)

Validates that provided BoxWebHook.Trigger-s can be applied on the provided BoxResourceType.

Parameters:

targetType - on which target the triggers should be applied to

triggers - for check

See Also:

validateTrigger(String, Trigger)

getInfo

public BoxWebHook.Info getInfo(String... fields)

Parameters:

fields - the fields to retrieve.

Returns:

Gets information about this BoxWebHook.

updateInfo

public void updateInfo(BoxWebHook.Info info)

Updates BoxWebHook information.

Parameters:

info - new state

delete

public void delete()

Deletes this webhook.