com.box.sdkgen.managers.invites

Class InvitesManager

Object

InvitesManager

public class InvitesManager
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	InvitesManager.Builder

Field Summary

Fields

Modifier and Type	Field and Description
Authentication	auth
NetworkSession	networkSession

Constructor Summary

Constructors

Modifier	Constructor and Description
	InvitesManager()
protected	InvitesManager(InvitesManager.Builder builder)

Method Summary

Modifier and Type	Method and Description
Invite	createInvite(CreateInviteRequestBody requestBody) Invites an existing external user to join an enterprise.
Invite	createInvite(CreateInviteRequestBody requestBody, CreateInviteHeaders headers) Invites an existing external user to join an enterprise.
Invite	createInvite(CreateInviteRequestBody requestBody, CreateInviteQueryParams queryParams) Invites an existing external user to join an enterprise.
Invite	createInvite(CreateInviteRequestBody requestBody, CreateInviteQueryParams queryParams, CreateInviteHeaders headers) Invites an existing external user to join an enterprise.
Authentication	getAuth()
Invite	getInviteById(String inviteId) Returns the status of a user invite.
Invite	getInviteById(String inviteId, GetInviteByIdHeaders headers) Returns the status of a user invite.
Invite	getInviteById(String inviteId, GetInviteByIdQueryParams queryParams) Returns the status of a user invite.
Invite	getInviteById(String inviteId, GetInviteByIdQueryParams queryParams, GetInviteByIdHeaders headers) Returns the status of a user invite.
NetworkSession	getNetworkSession()

Methods inherited from class Object

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

Field Detail

auth

public Authentication auth

networkSession

public NetworkSession networkSession

Constructor Detail

InvitesManager

public InvitesManager()

InvitesManager

protected InvitesManager(InvitesManager.Builder builder)

Method Detail

createInvite

public Invite createInvite(CreateInviteRequestBody requestBody)

Invites an existing external user to join an enterprise.

The existing user can not be part of another enterprise and must already have a Box account. Once invited, the user will receive an email and are prompted to accept the invitation within the Box web application.

This method requires the "Manage An Enterprise" scope enabled for the application, which can be enabled within the developer console.

Parameters:

requestBody - Request body of createInvite method

createInvite

public Invite createInvite(CreateInviteRequestBody requestBody,
                           CreateInviteQueryParams queryParams)

Invites an existing external user to join an enterprise.

The existing user can not be part of another enterprise and must already have a Box account. Once invited, the user will receive an email and are prompted to accept the invitation within the Box web application.

This method requires the "Manage An Enterprise" scope enabled for the application, which can be enabled within the developer console.

Parameters:

requestBody - Request body of createInvite method

queryParams - Query parameters of createInvite method

createInvite

public Invite createInvite(CreateInviteRequestBody requestBody,
                           CreateInviteHeaders headers)

Invites an existing external user to join an enterprise.

The existing user can not be part of another enterprise and must already have a Box account. Once invited, the user will receive an email and are prompted to accept the invitation within the Box web application.

This method requires the "Manage An Enterprise" scope enabled for the application, which can be enabled within the developer console.

Parameters:

requestBody - Request body of createInvite method

headers - Headers of createInvite method

createInvite

public Invite createInvite(CreateInviteRequestBody requestBody,
                           CreateInviteQueryParams queryParams,
                           CreateInviteHeaders headers)

Invites an existing external user to join an enterprise.

The existing user can not be part of another enterprise and must already have a Box account. Once invited, the user will receive an email and are prompted to accept the invitation within the Box web application.

This method requires the "Manage An Enterprise" scope enabled for the application, which can be enabled within the developer console.

Parameters:

requestBody - Request body of createInvite method

queryParams - Query parameters of createInvite method

headers - Headers of createInvite method

getInviteById

public Invite getInviteById(String inviteId)

Returns the status of a user invite.

Parameters:

inviteId - The ID of an invite. Example: "213723"

getInviteById

public Invite getInviteById(String inviteId,
                            GetInviteByIdQueryParams queryParams)

Returns the status of a user invite.

Parameters:

inviteId - The ID of an invite. Example: "213723"

queryParams - Query parameters of getInviteById method

getInviteById

public Invite getInviteById(String inviteId,
                            GetInviteByIdHeaders headers)

Returns the status of a user invite.

Parameters:

inviteId - The ID of an invite. Example: "213723"

headers - Headers of getInviteById method

getInviteById

public Invite getInviteById(String inviteId,
                            GetInviteByIdQueryParams queryParams,
                            GetInviteByIdHeaders headers)

Returns the status of a user invite.

Parameters:

inviteId - The ID of an invite. Example: "213723"

queryParams - Query parameters of getInviteById method

headers - Headers of getInviteById method

getAuth

public Authentication getAuth()

getNetworkSession

public NetworkSession getNetworkSession()