com.box.sdk

Class BoxWebHook.Info

Object

BoxJSONObject

BoxResource.Info

BoxWebHook.Info

Enclosing class:

BoxWebHook

public class BoxWebHook.Info
extends BoxResource.Info

Contains information for a BoxWebHook instance.

Constructor Summary

Constructors

Constructor and Description
Info() Constructs an Info object with current target.
Info(JsonObject jsonObject) Constructor.
Info(String json) Constructs an Info object by parsing information from a JSON string.

Method Summary

Modifier and Type	Method and Description
URL	getAddress()
Date	getCreatedAt()
BoxUser.Info	getCreatedBy()
BoxWebHook	getResource() Gets the resource associated with this Info.
BoxWebHook.Target	getTarget()
Set<BoxWebHook.Trigger>	getTriggers()
BoxWebHook.Info	setAddress(URL address) Setter for getAddress().
BoxWebHook.Info	setTriggers(BoxWebHook.Trigger... triggers) Sets getTriggers().
BoxWebHook.Info	setTriggers(Set<BoxWebHook.Trigger> triggers) Setter for getTriggers().

Methods inherited from class BoxResource.Info

getID

Methods inherited from class BoxJSONObject

clearPendingChanges, getJson, getPendingChanges, getPendingChangesAsJsonObject, getPendingJSONObject

Methods inherited from class Object

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

Constructor Detail

Info

public Info()

Constructs an Info object with current target.

Info

public Info(String json)

Constructs an Info object by parsing information from a JSON string.

Parameters:

json - the JSON string to parse.

Info

public Info(JsonObject jsonObject)

Constructor.

Parameters:

jsonObject - a parsed JSON object

Method Detail

getResource

public BoxWebHook getResource()

Gets the resource associated with this Info.

Specified by:

getResource in class BoxResource.Info

Returns:

the associated resource.

getTarget

public BoxWebHook.Target getTarget()

Returns:

WebHook target / BoxResource.

getAddress

public URL getAddress()

Returns:

URL where the notification should send to.

setAddress

public BoxWebHook.Info setAddress(URL address)

Setter for getAddress().

Parameters:

address - getAddress()

Returns:

itself

getTriggers

public Set<BoxWebHook.Trigger> getTriggers()

Returns:

Events this webhook is interested in.

setTriggers

public BoxWebHook.Info setTriggers(BoxWebHook.Trigger... triggers)

Sets getTriggers().

Parameters:

triggers - getTriggers()

Returns:

itself

setTriggers

public BoxWebHook.Info setTriggers(Set<BoxWebHook.Trigger> triggers)

Setter for getTriggers().

Parameters:

triggers - getTriggers()

Returns:

itself

getCreatedBy

public BoxUser.Info getCreatedBy()

Returns:

Info about the user who created this webhook.

getCreatedAt

public Date getCreatedAt()

Returns:

the time this webhook was created.