com.box.sdk

Class BoxInvite

Object

BoxResource

BoxInvite

@BoxResourceType(value="invite")
public class BoxInvite
extends BoxResource

Represents an invitation for a user to join an enterprise.

Unless otherwise noted, the methods in this class can throw an unchecked 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	BoxInvite.Info Contains information about a BoxInvite.

Field Summary

Fields

Modifier and Type	Field and Description
static URLTemplate	INVITE_CREATION_URL_TEMPLATE The URL template for invite creation requests.
static URLTemplate	INVITE_URL_TEMPLATE The URL template for invite retrieval requests.

Constructor Summary

Constructors

Constructor and Description
BoxInvite(BoxAPIConnection api, String id) Constructs a BoxInvitee for an invite with a given ID.

Method Summary

Modifier and Type	Method and Description
BoxInvite.Info	getInfo() Gets information about this group membership.
static BoxInvite.Info	inviteUserToEnterprise(BoxAPIConnection api, String userLogin, String enterpriseID) Invite a user to an enterprise.

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

INVITE_CREATION_URL_TEMPLATE

public static final URLTemplate INVITE_CREATION_URL_TEMPLATE

The URL template for invite creation requests.

INVITE_URL_TEMPLATE

public static final URLTemplate INVITE_URL_TEMPLATE

The URL template for invite retrieval requests.

See Also:

getInfo()

Constructor Detail

BoxInvite

public BoxInvite(BoxAPIConnection api,
                 String id)

Constructs a BoxInvitee for an invite with a given ID.

Parameters:

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

id - the ID of the invite.

Method Detail

inviteUserToEnterprise

public static BoxInvite.Info inviteUserToEnterprise(BoxAPIConnection api,
                                                    String userLogin,
                                                    String enterpriseID)

Invite a user to an enterprise.

Parameters:

api - the API connection to use for the request.

userLogin - the login of the user to invite.

enterpriseID - the ID of the enterprise to invite the user to.

Returns:

the invite info.

getInfo

public BoxInvite.Info getInfo()

Gets information about this group membership.

Returns:

info about this group membership.