@ApiParams(apiName="groups",producerOnly=true,description="Provides operations to manage Box groups",apiMethods={@ApiMethod(methodName="addGroupMembership",description="Add a member to group with the specified role",signatures="com.box.sdk.BoxGroupMembership addGroupMembership(String groupId, String userId, com.box.sdk.BoxGroupMembership$Role role)"),@ApiMethod(methodName="createGroup",description="Create a new group with a specified name and optional additional parameters",signatures="com.box.sdk.BoxGroup createGroup(String name, String provenance, String externalSyncIdentifier, String description, String invitabilityLevel, String memberViewabilityLevel)"),@ApiMethod(methodName="deleteGroup",description="Delete group",signatures="void deleteGroup(String groupId)"),@ApiMethod(methodName="deleteGroupMembership",description="Delete group membership",signatures="void deleteGroupMembership(String groupMembershipId)"),@ApiMethod(methodName="getAllGroups",description="Get all the groups in the enterprise",signatures="java.util.Collection<com.box.sdk.BoxGroup> getAllGroups()"),@ApiMethod(methodName="getGroupInfo",description="Get group information",signatures="com.box.sdk.BoxGroup$Info getGroupInfo(String groupId)"),@ApiMethod(methodName="getGroupMembershipInfo",description="Get group membership information",signatures="com.box.sdk.BoxGroupMembership$Info getGroupMembershipInfo(String groupMembershipId)"),@ApiMethod(methodName="getGroupMemberships",description="Get information about all of the group memberships for this group",signatures="java.util.Collection<com.box.sdk.BoxGroupMembership$Info> getGroupMemberships(String groupId)"),@ApiMethod(methodName="updateGroupInfo",description="Update group information",signatures="com.box.sdk.BoxGroup updateGroupInfo(String groupId, com.box.sdk.BoxGroup$Info groupInfo)"),@ApiMethod(methodName="updateGroupMembershipInfo",description="Update group membership information",signatures="com.box.sdk.BoxGroupMembership updateGroupMembershipInfo(String groupMembershipId, com.box.sdk.BoxGroupMembership$Info info)")},aliases={"createGroup=create","deleteGroup=delete","getAllGroups=groups","getGroupInfo=info","addGroupMembership=addMembership","deleteGroupMembership=deleteMembership","getGroupMemberships=memberships","getGroupMembershipInfo=membershipInfo","updateGroupMembershipInfo=updateMembershipInfo"})
@UriParams
@Configurer(extended=true)
public final class BoxGroupsManagerEndpointConfiguration
extends BoxConfiguration
BoxGroupsManager.APP_ENTERPRISE_AUTHENTICATION, APP_USER_AUTHENTICATION, RSA_SHA_256, RSA_SHA_384, RSA_SHA_512, STANDARD_AUTHENTICATION| Constructor and Description |
|---|
BoxGroupsManagerEndpointConfiguration() |
| Modifier and Type | Method and Description |
|---|---|
String |
getDescription() |
String |
getExternalSyncIdentifier() |
String |
getGroupId() |
com.box.sdk.BoxGroup.Info |
getGroupInfo() |
String |
getGroupMembershipId() |
com.box.sdk.BoxGroupMembership.Info |
getInfo() |
String |
getInvitabilityLevel() |
String |
getMemberViewabilityLevel() |
String |
getName() |
String |
getProvenance() |
com.box.sdk.BoxGroupMembership.Role |
getRole() |
String |
getUserId()
The user ID to use for an App User.
|
void |
setDescription(String description) |
void |
setExternalSyncIdentifier(String externalSyncIdentifier) |
void |
setGroupId(String groupId) |
void |
setGroupInfo(com.box.sdk.BoxGroup.Info groupInfo) |
void |
setGroupMembershipId(String groupMembershipId) |
void |
setInfo(com.box.sdk.BoxGroupMembership.Info info) |
void |
setInvitabilityLevel(String invitabilityLevel) |
void |
setMemberViewabilityLevel(String memberViewabilityLevel) |
void |
setName(String name) |
void |
setProvenance(String provenance) |
void |
setRole(com.box.sdk.BoxGroupMembership.Role role) |
void |
setUserId(String userId)
The user ID to use for an App User.
|
equals, getAccessTokenCache, getApiName, getAuthenticationType, getClientId, getClientSecret, getEncryptionAlgorithm, getEnterpriseId, getHttpParams, getMaxCacheEntries, getMethodName, getPrivateKeyFile, getPrivateKeyPassword, getPublicKeyId, getSslContextParameters, getUserName, getUserPassword, hashCode, setAccessTokenCache, setApiName, setAuthenticationType, setClientId, setClientSecret, setEncryptionAlgorithm, setEncryptionAlgorithm, setEnterpriseId, setHttpParams, setMaxCacheEntries, setMaxCacheEntries, setMethodName, setPrivateKeyFile, setPrivateKeyPassword, setPublicKeyId, setSslContextParameters, setUserName, setUserPasswordpublic BoxGroupsManagerEndpointConfiguration()
public String getDescription()
public void setDescription(String description)
public String getExternalSyncIdentifier()
public void setExternalSyncIdentifier(String externalSyncIdentifier)
public String getGroupId()
public void setGroupId(String groupId)
public com.box.sdk.BoxGroup.Info getGroupInfo()
public void setGroupInfo(com.box.sdk.BoxGroup.Info groupInfo)
public String getGroupMembershipId()
public void setGroupMembershipId(String groupMembershipId)
public com.box.sdk.BoxGroupMembership.Info getInfo()
public void setInfo(com.box.sdk.BoxGroupMembership.Info info)
public String getInvitabilityLevel()
public void setInvitabilityLevel(String invitabilityLevel)
public String getMemberViewabilityLevel()
public void setMemberViewabilityLevel(String memberViewabilityLevel)
public String getName()
public void setName(String name)
public String getProvenance()
public void setProvenance(String provenance)
public com.box.sdk.BoxGroupMembership.Role getRole()
public void setRole(com.box.sdk.BoxGroupMembership.Role role)
public String getUserId()
BoxConfigurationgetUserId in class BoxConfigurationpublic void setUserId(String userId)
BoxConfigurationsetUserId in class BoxConfigurationuserId - the userId to setApache Camel