com.box.sdk

Class BoxInvite.Info

Object

BoxJSONObject

BoxResource.Info

BoxInvite.Info

Enclosing class:

BoxInvite

public class BoxInvite.Info
extends BoxResource.Info

Contains information about a BoxInvite.

Constructor Summary

Constructors

Constructor and Description
Info() Constructs an empty Info object.
Info(String json) Constructs an Info object by parsing information from a JSON string.

Method Summary

Modifier and Type	Method and Description
BoxUser.Info	getActionableBy() Gets the user that was invited to the enterprise.
Date	getCreatedAt() Gets the time the invite was created.
BoxUser.Info	getInvitedBy() Gets the user that made the invitation.
BoxEnterprise	getInvitedTo() Gets the enterprise the user was invited to.
Date	getModifiedAt() Gets the time the invite was last modified.
BoxInvite	getResource() Gets the resource associated with this Info.
String	getStatus() Gets the status of the invitation.
protected void	parseJSONMember(JsonObject.Member member) Invoked with a JSON member whenever this object is updated or created from a JSON object.

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 empty Info object.

Info

public Info(String json)

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

Parameters:

json - the JSON string to parse.

Method Detail

getInvitedTo

public BoxEnterprise getInvitedTo()

Gets the enterprise the user was invited to.

Returns:

the enterprise the user was invited to.

getActionableBy

public BoxUser.Info getActionableBy()

Gets the user that was invited to the enterprise.

Note: the BoxUser.Info returned by this method will only have the ID, name, and login fields populated.

Returns:

the invited user.

getInvitedBy

public BoxUser.Info getInvitedBy()

Gets the user that made the invitation.

Note: the BoxUser.Info returned by this method will only have the ID, name, and login fields populated.

Returns:

the user that created the invitation.

getStatus

public String getStatus()

Gets the status of the invitation.

Returns:

the invite status.

getCreatedAt

public Date getCreatedAt()

Gets the time the invite was created.

Returns:

the time the invite was created.

getModifiedAt

public Date getModifiedAt()

Gets the time the invite was last modified.

Returns:

the time the invite was last modified.

getResource

public BoxInvite getResource()

Gets the resource associated with this Info.

Specified by:

getResource in class BoxResource.Info

Returns:

the associated resource.

parseJSONMember

protected void parseJSONMember(JsonObject.Member member)

Invoked with a JSON member whenever this object is updated or created from a JSON object.

Subclasses should override this method in order to parse any JSON members it knows about. This method is a no-op by default.

Parameters:

member - the JSON member to be parsed.