com.box.androidsdk.content.models

Class BoxCollaboration

java.lang.Object

com.box.androidsdk.content.models.BoxObject

com.box.androidsdk.content.models.BoxJsonObject

com.box.androidsdk.content.models.BoxEntity

com.box.androidsdk.content.models.BoxCollaboration

All Implemented Interfaces:

java.io.Serializable

public class BoxCollaboration
extends BoxEntity

Class that represents a collaboration on Box.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BoxCollaboration.Role Enumerates the possible access levels that a collaborator can have.
static class	BoxCollaboration.Status Enumerates the possible statuses that a collaboration can have.

Nested classes/interfaces inherited from class com.box.androidsdk.content.models.BoxEntity

BoxEntity.BoxEntityCreator

Nested classes/interfaces inherited from class com.box.androidsdk.content.models.BoxJsonObject

BoxJsonObject.BoxJsonObjectCreator<E extends BoxJsonObject>

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String[]	ALL_FIELDS
static java.lang.String	FIELD_ACCESSIBLE_BY
static java.lang.String	FIELD_ACKNOWLEDGED_AT
static java.lang.String	FIELD_CREATED_AT
static java.lang.String	FIELD_CREATED_BY
static java.lang.String	FIELD_EXPIRES_AT
static java.lang.String	FIELD_ITEM
static java.lang.String	FIELD_MODIFIED_AT
static java.lang.String	FIELD_ROLE
static java.lang.String	FIELD_STATUS
static java.lang.String	TYPE

Fields inherited from class com.box.androidsdk.content.models.BoxEntity

FIELD_ID, FIELD_ITEM_ID, FIELD_ITEM_TYPE, FIELD_TYPE

Constructor Summary

Constructors

Constructor and Description
BoxCollaboration() Constructs an empty BoxCollaboration object.
BoxCollaboration(com.eclipsesource.json.JsonObject jsonObject) Constructs a BoxCollaboration with the provided JsonObject

Method Summary

Modifier and Type	Method and Description
BoxCollaborator	getAccessibleBy() Gets the collaborator who this collaboration applies to.
java.util.Date	getAcknowledgedAt() Gets the time the collaboration's status was changed.
java.util.Date	getCreatedAt() Gets the time the collaboration was created.
BoxCollaborator	getCreatedBy() Gets the user who created the collaboration.
java.util.Date	getExpiresAt() Gets the time the collaboration will expire.
BoxCollaborationItem	getItem() Gets the collaborative item the collaboration is related to.
java.util.Date	getModifiedAt() Gets the time the collaboration was last modified.
BoxCollaboration.Role	getRole() Gets the level of access the collaborator has.
BoxCollaboration.Status	getStatus() Gets the status of the collaboration.

Methods inherited from class com.box.androidsdk.content.models.BoxEntity

addEntityType, createEntityFromJson, createEntityFromJson, getBoxJsonObjectCreator, getId, getType

Methods inherited from class com.box.androidsdk.content.models.BoxJsonObject

addInJsonArray, addInJsonArray, createFromJson, createFromJson, equals, getBoxJsonObjectCreator, getPropertiesKeySet, getPropertyAsBoolean, getPropertyAsDate, getPropertyAsDouble, getPropertyAsFloat, getPropertyAsInt, getPropertyAsJsonArray, getPropertyAsJsonObject, getPropertyAsJsonObjectArray, getPropertyAsLong, getPropertyAsString, getPropertyAsStringArray, getPropertyAsStringHashSet, getPropertyValue, hashCode, parseJSONMember, remove, set, set, set, set, set, set, set, set, set, toJson, toJsonObject

Methods inherited from class java.lang.Object

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

Field Detail

TYPE

public static final java.lang.String TYPE

See Also:

Constant Field Values

FIELD_CREATED_BY

public static final java.lang.String FIELD_CREATED_BY

See Also:

Constant Field Values

FIELD_CREATED_AT

public static final java.lang.String FIELD_CREATED_AT

See Also:

Constant Field Values

FIELD_MODIFIED_AT

public static final java.lang.String FIELD_MODIFIED_AT

See Also:

Constant Field Values

FIELD_EXPIRES_AT

public static final java.lang.String FIELD_EXPIRES_AT

See Also:

Constant Field Values

FIELD_STATUS

public static final java.lang.String FIELD_STATUS

See Also:

Constant Field Values

FIELD_ACCESSIBLE_BY

public static final java.lang.String FIELD_ACCESSIBLE_BY

See Also:

Constant Field Values

FIELD_ROLE

public static final java.lang.String FIELD_ROLE

See Also:

Constant Field Values

FIELD_ACKNOWLEDGED_AT

public static final java.lang.String FIELD_ACKNOWLEDGED_AT

See Also:

Constant Field Values

FIELD_ITEM

public static final java.lang.String FIELD_ITEM

See Also:

Constant Field Values

ALL_FIELDS

public static final java.lang.String[] ALL_FIELDS

Constructor Detail

BoxCollaboration

public BoxCollaboration()

Constructs an empty BoxCollaboration object.

BoxCollaboration

public BoxCollaboration(com.eclipsesource.json.JsonObject jsonObject)

Constructs a BoxCollaboration with the provided JsonObject

Parameters:

jsonObject - jsonObject to use to create an instance of this class.

Method Detail

getCreatedBy

public BoxCollaborator getCreatedBy()

Gets the user who created the collaboration.

Returns:

the user who created the collaboration.

getCreatedAt

public java.util.Date getCreatedAt()

Gets the time the collaboration was created.

Returns:

the time the collaboration was created.

getModifiedAt

public java.util.Date getModifiedAt()

Gets the time the collaboration was last modified.

Returns:

the time the collaboration was last modified.

getExpiresAt

public java.util.Date getExpiresAt()

Gets the time the collaboration will expire.

Returns:

the time the collaboration will expire.

getStatus

public BoxCollaboration.Status getStatus()

Gets the status of the collaboration.

Returns:

the status of the collaboration.

getAccessibleBy

public BoxCollaborator getAccessibleBy()

Gets the collaborator who this collaboration applies to.

Returns:

the collaborator who this collaboration applies to.

getRole

public BoxCollaboration.Role getRole()

Gets the level of access the collaborator has.

Returns:

the level of access the collaborator has.

getAcknowledgedAt

public java.util.Date getAcknowledgedAt()

Gets the time the collaboration's status was changed.

Returns:

the time the collaboration's status was changed.

getItem

public BoxCollaborationItem getItem()

Gets the collaborative item the collaboration is related to.

Returns:

the item the collaboration is related to.