Index
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
A
- AcceptInvitationRequest - Class in com.vortexsoftware.sdk.types
-
Request payload for accepting invitations Supports both new User format (preferred) and legacy target format (deprecated)
- AcceptInvitationRequest() - Constructor for class com.vortexsoftware.sdk.types.AcceptInvitationRequest
- AcceptInvitationRequest(List<String>, AcceptUser) - Constructor for class com.vortexsoftware.sdk.types.AcceptInvitationRequest
-
Create request with new User format (preferred)
- acceptInvitations(AcceptInvitationRequest) - Method in class com.vortexsoftware.sdk.spring.VortexController
-
Accept invitations POST /invitations/accept
- acceptInvitations(List<String>, AcceptUser) - Method in class com.vortexsoftware.sdk.VortexClient
-
Accept multiple invitations using the new User format (preferred)
- acceptInvitations(List<String>, InvitationTarget) - Method in class com.vortexsoftware.sdk.VortexClient
-
Deprecated.
- acceptInvitations(List<String>, List<InvitationTarget>) - Method in class com.vortexsoftware.sdk.VortexClient
-
Deprecated.Use
VortexClient.acceptInvitations(List, AcceptUser)instead and call once per user. This method calls the API once per target and is maintained only for backward compatibility.Example migration:
// Old way (deprecated): List<InvitationTarget> targets = Arrays.asList( new InvitationTarget("email", "user1@example.com"), new InvitationTarget("email", "user2@example.com") ); InvitationResult result = client.acceptInvitations(invitationIds, targets); // New way (preferred) - call once per user: for (InvitationTarget target : targets) { AcceptUser user = new AcceptUser(target.getValue()); InvitationResult result = client.acceptInvitations(invitationIds, user); } - AcceptUser - Class in com.vortexsoftware.sdk.types
-
User data for accepting invitations Required fields: At least one of email or phone must be provided Optional fields: - email: User's email address - phone: User's phone number - name: User's display name Example:
- AcceptUser() - Constructor for class com.vortexsoftware.sdk.types.AcceptUser
-
Default constructor for Jackson deserialization
- AcceptUser(String) - Constructor for class com.vortexsoftware.sdk.types.AcceptUser
-
Create a new AcceptUser with email
- AcceptUser(String, String) - Constructor for class com.vortexsoftware.sdk.types.AcceptUser
-
Create a new AcceptUser with email and name
- AcceptUser(String, String, String) - Constructor for class com.vortexsoftware.sdk.types.AcceptUser
-
Create a new AcceptUser with all fields
- authenticateUser() - Method in interface com.vortexsoftware.sdk.spring.VortexConfig
-
Convert the current request context to a Vortex user This should extract user information from the current HTTP request and return it in the format expected by Vortex JWT generation.
- authorizeOperation(String, VortexConfig.VortexUser) - Method in interface com.vortexsoftware.sdk.spring.VortexConfig
-
Check if the current user can perform a specific operation
C
- close() - Method in class com.vortexsoftware.sdk.VortexClient
-
Close the HTTP client when done
- com.vortexsoftware.sdk - package com.vortexsoftware.sdk
-
Vortex Java SDK for invitation management and JWT generation.
- com.vortexsoftware.sdk.spring - package com.vortexsoftware.sdk.spring
- com.vortexsoftware.sdk.types - package com.vortexsoftware.sdk.types
- createInvitation(CreateInvitationRequest) - Method in class com.vortexsoftware.sdk.VortexClient
-
Create an invitation from your backend
- CreateInvitationGroup - Class in com.vortexsoftware.sdk.types
-
Group information for creating invitations.
- CreateInvitationGroup() - Constructor for class com.vortexsoftware.sdk.types.CreateInvitationGroup
- CreateInvitationGroup(String, String, String) - Constructor for class com.vortexsoftware.sdk.types.CreateInvitationGroup
- CreateInvitationRequest - Class in com.vortexsoftware.sdk.types
-
Request body for creating an invitation via the public API (backend SDK use).
- CreateInvitationRequest() - Constructor for class com.vortexsoftware.sdk.types.CreateInvitationRequest
- CreateInvitationRequest(String, CreateInvitationTarget, Inviter) - Constructor for class com.vortexsoftware.sdk.types.CreateInvitationRequest
- CreateInvitationResponse - Class in com.vortexsoftware.sdk.types
-
Response from creating an invitation.
- CreateInvitationResponse() - Constructor for class com.vortexsoftware.sdk.types.CreateInvitationResponse
- CreateInvitationTarget - Class in com.vortexsoftware.sdk.types
-
Target for creating an invitation.
- CreateInvitationTarget() - Constructor for class com.vortexsoftware.sdk.types.CreateInvitationTarget
- CreateInvitationTarget(String, String) - Constructor for class com.vortexsoftware.sdk.types.CreateInvitationTarget
- createVortexApiPath(String, String) - Static method in class com.vortexsoftware.sdk.spring.VortexRoutes
-
Create the full API path based on base URL
D
- deleteInvitationsByGroup(String, String) - Method in class com.vortexsoftware.sdk.spring.VortexController
-
Delete invitations by group DELETE /invitations/by-group/{groupType}/{groupId}
- deleteInvitationsByGroup(String, String) - Method in class com.vortexsoftware.sdk.VortexClient
-
Delete all invitations for a specific group
E
- email(String) - Static method in class com.vortexsoftware.sdk.types.CreateInvitationTarget
G
- generateJwt(Map<String, Object>) - Method in class com.vortexsoftware.sdk.VortexClient
-
Generate a JWT using the same algorithm as the Node.js SDK
- generateJWT() - Method in class com.vortexsoftware.sdk.spring.VortexController
-
Generate JWT for the authenticated user POST /jwt
- getAcceptedAt() - Method in class com.vortexsoftware.sdk.types.InvitationAcceptance
- getAccepts() - Method in class com.vortexsoftware.sdk.types.InvitationResult
- getAccountId() - Method in class com.vortexsoftware.sdk.types.InvitationAcceptance
- getAccountId() - Method in class com.vortexsoftware.sdk.types.InvitationGroup
- getAccountId() - Method in class com.vortexsoftware.sdk.types.InvitationResult
- getAdminScopes() - Method in class com.vortexsoftware.sdk.types.User
- getAttributes() - Method in class com.vortexsoftware.sdk.types.InvitationResult
- getAvatarUrl() - Method in class com.vortexsoftware.sdk.types.Inviter
- getAvatarUrl() - Method in class com.vortexsoftware.sdk.types.User
- getClickThroughs() - Method in class com.vortexsoftware.sdk.types.InvitationResult
- getConfigurationAttributes() - Method in class com.vortexsoftware.sdk.types.InvitationResult
- getCreatedAt() - Method in class com.vortexsoftware.sdk.types.CreateInvitationResponse
- getCreatedAt() - Method in class com.vortexsoftware.sdk.types.InvitationGroup
- getCreatedAt() - Method in class com.vortexsoftware.sdk.types.InvitationResult
- getCreatorAvatarUrl() - Method in class com.vortexsoftware.sdk.types.InvitationResult
- getCreatorName() - Method in class com.vortexsoftware.sdk.types.InvitationResult
- getDeliveryCount() - Method in class com.vortexsoftware.sdk.types.InvitationResult
- getDeliveryTypes() - Method in class com.vortexsoftware.sdk.types.InvitationResult
- getDeploymentId() - Method in class com.vortexsoftware.sdk.types.InvitationResult
- getEmail() - Method in class com.vortexsoftware.sdk.types.AcceptUser
- getEmail() - Method in class com.vortexsoftware.sdk.types.User
- getExpires() - Method in class com.vortexsoftware.sdk.types.InvitationResult
- getForeignCreatorId() - Method in class com.vortexsoftware.sdk.types.InvitationResult
- getGroupId() - Method in class com.vortexsoftware.sdk.types.CreateInvitationGroup
- getGroupId() - Method in class com.vortexsoftware.sdk.types.Group
- getGroupId() - Method in class com.vortexsoftware.sdk.types.InvitationGroup
- getGroups() - Method in class com.vortexsoftware.sdk.spring.VortexConfig.VortexUser
- getGroups() - Method in class com.vortexsoftware.sdk.types.CreateInvitationRequest
- getGroups() - Method in class com.vortexsoftware.sdk.types.InvitationResult
- getGroups() - Method in class com.vortexsoftware.sdk.types.JWTPayload
- getId() - Method in class com.vortexsoftware.sdk.types.CreateInvitationResponse
- getId() - Method in class com.vortexsoftware.sdk.types.Group
- getId() - Method in class com.vortexsoftware.sdk.types.InvitationAcceptance
- getId() - Method in class com.vortexsoftware.sdk.types.InvitationGroup
- getId() - Method in class com.vortexsoftware.sdk.types.InvitationResult
- getId() - Method in class com.vortexsoftware.sdk.types.User
- getIdentifiers() - Method in class com.vortexsoftware.sdk.spring.VortexConfig.VortexUser
- getIdentifiers() - Method in class com.vortexsoftware.sdk.types.InvitationAcceptance
- getIdentifiers() - Method in class com.vortexsoftware.sdk.types.JWTPayload
- getInvitation(String) - Method in class com.vortexsoftware.sdk.spring.VortexController
-
Get specific invitation by ID GET /invitations/{invitationId}
- getInvitation(String) - Method in class com.vortexsoftware.sdk.VortexClient
-
Get a specific invitation by ID
- getInvitationIds() - Method in class com.vortexsoftware.sdk.types.AcceptInvitationRequest
- getInvitations() - Method in class com.vortexsoftware.sdk.types.InvitationResponse
- getInvitationsByGroup(String, String) - Method in class com.vortexsoftware.sdk.spring.VortexController
-
Get invitations by group GET /invitations/by-group/{groupType}/{groupId}
- getInvitationsByGroup(String, String) - Method in class com.vortexsoftware.sdk.VortexClient
-
Get all invitations for a specific group
- getInvitationsByTarget(String, String) - Method in class com.vortexsoftware.sdk.spring.VortexController
-
Get invitations by target GET /invitations?targetType=email&targetValue=user@example.com
- getInvitationsByTarget(String, String) - Method in class com.vortexsoftware.sdk.VortexClient
-
Get invitations by target (email, username, phoneNumber)
- getInvitationType() - Method in class com.vortexsoftware.sdk.types.InvitationResult
- getInviter() - Method in class com.vortexsoftware.sdk.types.CreateInvitationRequest
- getMetadata() - Method in class com.vortexsoftware.sdk.types.CreateInvitationRequest
- getMetadata() - Method in class com.vortexsoftware.sdk.types.InvitationResult
- getModifiedAt() - Method in class com.vortexsoftware.sdk.types.InvitationResult
- getName() - Method in class com.vortexsoftware.sdk.types.AcceptUser
- getName() - Method in class com.vortexsoftware.sdk.types.CreateInvitationGroup
- getName() - Method in class com.vortexsoftware.sdk.types.Group
- getName() - Method in class com.vortexsoftware.sdk.types.InvitationGroup
- getName() - Method in class com.vortexsoftware.sdk.types.Inviter
- getName() - Method in class com.vortexsoftware.sdk.types.User
- getPassThrough() - Method in class com.vortexsoftware.sdk.types.InvitationResult
- getPhone() - Method in class com.vortexsoftware.sdk.types.AcceptUser
- getProjectId() - Method in class com.vortexsoftware.sdk.types.InvitationAcceptance
- getProjectId() - Method in class com.vortexsoftware.sdk.types.InvitationResult
- getRole() - Method in class com.vortexsoftware.sdk.spring.VortexConfig.VortexUser
- getRole() - Method in class com.vortexsoftware.sdk.types.JWTPayload
- getScope() - Method in class com.vortexsoftware.sdk.types.InvitationResult
- getScopeType() - Method in class com.vortexsoftware.sdk.types.InvitationResult
- getShortLink() - Method in class com.vortexsoftware.sdk.types.CreateInvitationResponse
- getSource() - Method in class com.vortexsoftware.sdk.types.CreateInvitationRequest
- getSource() - Method in class com.vortexsoftware.sdk.types.InvitationResult
- getStatus() - Method in class com.vortexsoftware.sdk.types.CreateInvitationResponse
- getStatus() - Method in class com.vortexsoftware.sdk.types.InvitationResult
- getTarget() - Method in class com.vortexsoftware.sdk.types.CreateInvitationRequest
- getTarget() - Method in class com.vortexsoftware.sdk.types.InvitationResult
- getTargetType() - Method in class com.vortexsoftware.sdk.types.InvitationAcceptance
- getTargetValue() - Method in class com.vortexsoftware.sdk.types.InvitationAcceptance
- getTemplateVariables() - Method in class com.vortexsoftware.sdk.types.CreateInvitationRequest
- getType() - Method in class com.vortexsoftware.sdk.types.CreateInvitationGroup
- getType() - Method in class com.vortexsoftware.sdk.types.CreateInvitationTarget
- getType() - Method in class com.vortexsoftware.sdk.types.Group
- getType() - Method in class com.vortexsoftware.sdk.types.Identifier
- getType() - Method in class com.vortexsoftware.sdk.types.InvitationGroup
- getType() - Method in class com.vortexsoftware.sdk.types.InvitationTarget
- getUser() - Method in class com.vortexsoftware.sdk.types.AcceptInvitationRequest
- getUserEmail() - Method in class com.vortexsoftware.sdk.spring.VortexConfig.VortexUser
- getUserEmail() - Method in class com.vortexsoftware.sdk.types.Inviter
- getUserEmail() - Method in class com.vortexsoftware.sdk.types.JWTPayload
- getUserId() - Method in class com.vortexsoftware.sdk.spring.VortexConfig.VortexUser
- getUserId() - Method in class com.vortexsoftware.sdk.types.Inviter
- getUserId() - Method in class com.vortexsoftware.sdk.types.JWTPayload
- getUserIsAutojoinAdmin() - Method in class com.vortexsoftware.sdk.spring.VortexConfig.VortexUser
- getUserIsAutojoinAdmin() - Method in class com.vortexsoftware.sdk.types.JWTPayload
- getValue() - Method in class com.vortexsoftware.sdk.types.CreateInvitationTarget
- getValue() - Method in class com.vortexsoftware.sdk.types.Identifier
- getValue() - Method in class com.vortexsoftware.sdk.types.InvitationTarget
- getViews() - Method in class com.vortexsoftware.sdk.types.InvitationResult
- getWidgetConfigurationId() - Method in class com.vortexsoftware.sdk.types.CreateInvitationRequest
- getWidgetConfigurationId() - Method in class com.vortexsoftware.sdk.types.InvitationResult
- Group - Class in com.vortexsoftware.sdk.types
-
Represents a group for JWT generation (input).
- Group() - Constructor for class com.vortexsoftware.sdk.types.Group
- Group(String, String) - Constructor for class com.vortexsoftware.sdk.types.Group
- Group(String, String, String, String) - Constructor for class com.vortexsoftware.sdk.types.Group
I
- Identifier - Class in com.vortexsoftware.sdk.types
-
Represents an identifier for a user (email, sms, etc.) Used for JWT generation.
- Identifier() - Constructor for class com.vortexsoftware.sdk.types.Identifier
- Identifier(String, String) - Constructor for class com.vortexsoftware.sdk.types.Identifier
- internal(String) - Static method in class com.vortexsoftware.sdk.types.CreateInvitationTarget
- INVITATION - Static variable in class com.vortexsoftware.sdk.spring.VortexRoutes
- INVITATION_REINVITE - Static variable in class com.vortexsoftware.sdk.spring.VortexRoutes
- InvitationAcceptance - Class in com.vortexsoftware.sdk.types
-
Represents an accepted invitation
- InvitationAcceptance() - Constructor for class com.vortexsoftware.sdk.types.InvitationAcceptance
- InvitationGroup - Class in com.vortexsoftware.sdk.types
-
Represents a group associated with an invitation.
- InvitationGroup() - Constructor for class com.vortexsoftware.sdk.types.InvitationGroup
- InvitationGroup(String, String, String, String, String, String) - Constructor for class com.vortexsoftware.sdk.types.InvitationGroup
- InvitationResponse - Class in com.vortexsoftware.sdk.types
-
Response wrapper for invitation API calls that return multiple invitations
- InvitationResponse() - Constructor for class com.vortexsoftware.sdk.types.InvitationResponse
- InvitationResponse(List<InvitationResult>) - Constructor for class com.vortexsoftware.sdk.types.InvitationResponse
- InvitationResult - Class in com.vortexsoftware.sdk.types
-
Complete invitation result as returned by the Vortex API
- InvitationResult() - Constructor for class com.vortexsoftware.sdk.types.InvitationResult
- INVITATIONS - Static variable in class com.vortexsoftware.sdk.spring.VortexRoutes
- INVITATIONS_ACCEPT - Static variable in class com.vortexsoftware.sdk.spring.VortexRoutes
- INVITATIONS_BY_GROUP - Static variable in class com.vortexsoftware.sdk.spring.VortexRoutes
- InvitationTarget - Class in com.vortexsoftware.sdk.types
-
Represents the target of an invitation (email, SMS, etc.)
- InvitationTarget() - Constructor for class com.vortexsoftware.sdk.types.InvitationTarget
- InvitationTarget(String, String) - Constructor for class com.vortexsoftware.sdk.types.InvitationTarget
- Inviter - Class in com.vortexsoftware.sdk.types
-
Information about the user creating the invitation (the inviter).
- Inviter() - Constructor for class com.vortexsoftware.sdk.types.Inviter
- Inviter(String) - Constructor for class com.vortexsoftware.sdk.types.Inviter
- Inviter(String, String, String, String) - Constructor for class com.vortexsoftware.sdk.types.Inviter
- isDeactivated() - Method in class com.vortexsoftware.sdk.types.InvitationResult
- isExpired() - Method in class com.vortexsoftware.sdk.types.InvitationResult
J
- JWT - Static variable in class com.vortexsoftware.sdk.spring.VortexRoutes
-
Base routes that match the React provider's API calls
- JWTPayload - Class in com.vortexsoftware.sdk.types
-
JWT payload for Vortex token generation Supports both new simplified format (userEmail, userIsAutojoinAdmin) and legacy format (identifiers, groups, role) for backward compatibility.
- JWTPayload() - Constructor for class com.vortexsoftware.sdk.types.JWTPayload
- JWTPayload(String, String, Boolean) - Constructor for class com.vortexsoftware.sdk.types.JWTPayload
-
Create a payload with new simplified format (recommended)
- JWTPayload(String, List<Identifier>, List<Group>, String) - Constructor for class com.vortexsoftware.sdk.types.JWTPayload
-
Deprecated.Use constructor with userEmail instead
R
- reinvite(String) - Method in class com.vortexsoftware.sdk.spring.VortexController
-
Reinvite user POST /invitations/{invitationId}/reinvite
- reinvite(String) - Method in class com.vortexsoftware.sdk.VortexClient
-
Reinvite a user (send invitation again)
- revokeInvitation(String) - Method in class com.vortexsoftware.sdk.spring.VortexController
-
Revoke (delete) invitation DELETE /invitations/{invitationId}
- revokeInvitation(String) - Method in class com.vortexsoftware.sdk.VortexClient
-
Revoke (delete) an invitation
S
- setAcceptedAt(String) - Method in class com.vortexsoftware.sdk.types.InvitationAcceptance
- setAccepts(List<InvitationAcceptance>) - Method in class com.vortexsoftware.sdk.types.InvitationResult
- setAccountId(String) - Method in class com.vortexsoftware.sdk.types.InvitationAcceptance
- setAccountId(String) - Method in class com.vortexsoftware.sdk.types.InvitationGroup
- setAccountId(String) - Method in class com.vortexsoftware.sdk.types.InvitationResult
- setAdminScopes(List<String>) - Method in class com.vortexsoftware.sdk.types.User
- setAttributes(Map<String, Object>) - Method in class com.vortexsoftware.sdk.types.InvitationResult
- setAvatarUrl(String) - Method in class com.vortexsoftware.sdk.types.Inviter
- setAvatarUrl(String) - Method in class com.vortexsoftware.sdk.types.User
- setClickThroughs(int) - Method in class com.vortexsoftware.sdk.types.InvitationResult
- setConfigurationAttributes(Map<String, Object>) - Method in class com.vortexsoftware.sdk.types.InvitationResult
- setCreatedAt(String) - Method in class com.vortexsoftware.sdk.types.CreateInvitationResponse
- setCreatedAt(String) - Method in class com.vortexsoftware.sdk.types.InvitationGroup
- setCreatedAt(String) - Method in class com.vortexsoftware.sdk.types.InvitationResult
- setCreatorAvatarUrl(String) - Method in class com.vortexsoftware.sdk.types.InvitationResult
- setCreatorName(String) - Method in class com.vortexsoftware.sdk.types.InvitationResult
- setDeactivated(boolean) - Method in class com.vortexsoftware.sdk.types.InvitationResult
- setDeliveryCount(int) - Method in class com.vortexsoftware.sdk.types.InvitationResult
- setDeliveryTypes(List<String>) - Method in class com.vortexsoftware.sdk.types.InvitationResult
- setDeploymentId(String) - Method in class com.vortexsoftware.sdk.types.InvitationResult
- setEmail(String) - Method in class com.vortexsoftware.sdk.types.AcceptUser
- setEmail(String) - Method in class com.vortexsoftware.sdk.types.User
- setExpired(boolean) - Method in class com.vortexsoftware.sdk.types.InvitationResult
- setExpires(String) - Method in class com.vortexsoftware.sdk.types.InvitationResult
- setForeignCreatorId(String) - Method in class com.vortexsoftware.sdk.types.InvitationResult
- setGroupId(String) - Method in class com.vortexsoftware.sdk.types.CreateInvitationGroup
- setGroupId(String) - Method in class com.vortexsoftware.sdk.types.Group
- setGroupId(String) - Method in class com.vortexsoftware.sdk.types.InvitationGroup
- setGroups(List<CreateInvitationGroup>) - Method in class com.vortexsoftware.sdk.types.CreateInvitationRequest
- setGroups(List<Group>) - Method in class com.vortexsoftware.sdk.spring.VortexConfig.VortexUser
- setGroups(List<Group>) - Method in class com.vortexsoftware.sdk.types.JWTPayload
- setGroups(List<InvitationGroup>) - Method in class com.vortexsoftware.sdk.types.InvitationResult
- setId(String) - Method in class com.vortexsoftware.sdk.types.CreateInvitationResponse
- setId(String) - Method in class com.vortexsoftware.sdk.types.Group
- setId(String) - Method in class com.vortexsoftware.sdk.types.InvitationAcceptance
- setId(String) - Method in class com.vortexsoftware.sdk.types.InvitationGroup
- setId(String) - Method in class com.vortexsoftware.sdk.types.InvitationResult
- setId(String) - Method in class com.vortexsoftware.sdk.types.User
- setIdentifiers(List<Identifier>) - Method in class com.vortexsoftware.sdk.spring.VortexConfig.VortexUser
- setIdentifiers(List<Identifier>) - Method in class com.vortexsoftware.sdk.types.JWTPayload
- setIdentifiers(Map<String, String>) - Method in class com.vortexsoftware.sdk.types.InvitationAcceptance
- setInvitationIds(List<String>) - Method in class com.vortexsoftware.sdk.types.AcceptInvitationRequest
- setInvitations(List<InvitationResult>) - Method in class com.vortexsoftware.sdk.types.InvitationResponse
- setInvitationType(String) - Method in class com.vortexsoftware.sdk.types.InvitationResult
- setInviter(Inviter) - Method in class com.vortexsoftware.sdk.types.CreateInvitationRequest
- setMetadata(Map<String, Object>) - Method in class com.vortexsoftware.sdk.types.CreateInvitationRequest
- setMetadata(Map<String, Object>) - Method in class com.vortexsoftware.sdk.types.InvitationResult
- setModifiedAt(String) - Method in class com.vortexsoftware.sdk.types.InvitationResult
- setName(String) - Method in class com.vortexsoftware.sdk.types.AcceptUser
- setName(String) - Method in class com.vortexsoftware.sdk.types.CreateInvitationGroup
- setName(String) - Method in class com.vortexsoftware.sdk.types.Group
- setName(String) - Method in class com.vortexsoftware.sdk.types.InvitationGroup
- setName(String) - Method in class com.vortexsoftware.sdk.types.Inviter
- setName(String) - Method in class com.vortexsoftware.sdk.types.User
- setPassThrough(String) - Method in class com.vortexsoftware.sdk.types.InvitationResult
- setPhone(String) - Method in class com.vortexsoftware.sdk.types.AcceptUser
- setProjectId(String) - Method in class com.vortexsoftware.sdk.types.InvitationAcceptance
- setProjectId(String) - Method in class com.vortexsoftware.sdk.types.InvitationResult
- setRole(String) - Method in class com.vortexsoftware.sdk.spring.VortexConfig.VortexUser
- setRole(String) - Method in class com.vortexsoftware.sdk.types.JWTPayload
- setScope(String) - Method in class com.vortexsoftware.sdk.types.InvitationResult
- setScopeType(String) - Method in class com.vortexsoftware.sdk.types.InvitationResult
- setShortLink(String) - Method in class com.vortexsoftware.sdk.types.CreateInvitationResponse
- setSource(String) - Method in class com.vortexsoftware.sdk.types.CreateInvitationRequest
- setSource(String) - Method in class com.vortexsoftware.sdk.types.InvitationResult
- setStatus(String) - Method in class com.vortexsoftware.sdk.types.CreateInvitationResponse
- setStatus(String) - Method in class com.vortexsoftware.sdk.types.InvitationResult
- setTarget(CreateInvitationTarget) - Method in class com.vortexsoftware.sdk.types.CreateInvitationRequest
- setTarget(List<InvitationTarget>) - Method in class com.vortexsoftware.sdk.types.InvitationResult
- setTargetType(String) - Method in class com.vortexsoftware.sdk.types.InvitationAcceptance
- setTargetValue(String) - Method in class com.vortexsoftware.sdk.types.InvitationAcceptance
- setTemplateVariables(Map<String, String>) - Method in class com.vortexsoftware.sdk.types.CreateInvitationRequest
- setType(String) - Method in class com.vortexsoftware.sdk.types.CreateInvitationGroup
- setType(String) - Method in class com.vortexsoftware.sdk.types.CreateInvitationTarget
- setType(String) - Method in class com.vortexsoftware.sdk.types.Group
- setType(String) - Method in class com.vortexsoftware.sdk.types.Identifier
- setType(String) - Method in class com.vortexsoftware.sdk.types.InvitationGroup
- setType(String) - Method in class com.vortexsoftware.sdk.types.InvitationTarget
- setUser(AcceptUser) - Method in class com.vortexsoftware.sdk.types.AcceptInvitationRequest
- setUserEmail(String) - Method in class com.vortexsoftware.sdk.spring.VortexConfig.VortexUser
- setUserEmail(String) - Method in class com.vortexsoftware.sdk.types.Inviter
- setUserEmail(String) - Method in class com.vortexsoftware.sdk.types.JWTPayload
- setUserId(String) - Method in class com.vortexsoftware.sdk.spring.VortexConfig.VortexUser
- setUserId(String) - Method in class com.vortexsoftware.sdk.types.Inviter
- setUserId(String) - Method in class com.vortexsoftware.sdk.types.JWTPayload
- setUserIsAutojoinAdmin(Boolean) - Method in class com.vortexsoftware.sdk.spring.VortexConfig.VortexUser
- setUserIsAutojoinAdmin(Boolean) - Method in class com.vortexsoftware.sdk.types.JWTPayload
- setValue(String) - Method in class com.vortexsoftware.sdk.types.CreateInvitationTarget
- setValue(String) - Method in class com.vortexsoftware.sdk.types.Identifier
- setValue(String) - Method in class com.vortexsoftware.sdk.types.InvitationTarget
- setViews(int) - Method in class com.vortexsoftware.sdk.types.InvitationResult
- setWidgetConfigurationId(String) - Method in class com.vortexsoftware.sdk.types.CreateInvitationRequest
- setWidgetConfigurationId(String) - Method in class com.vortexsoftware.sdk.types.InvitationResult
- sms(String) - Static method in class com.vortexsoftware.sdk.types.CreateInvitationTarget
T
- toString() - Method in class com.vortexsoftware.sdk.spring.VortexConfig.VortexUser
- toString() - Method in class com.vortexsoftware.sdk.types.AcceptInvitationRequest
- toString() - Method in class com.vortexsoftware.sdk.types.AcceptUser
- toString() - Method in class com.vortexsoftware.sdk.types.Group
- toString() - Method in class com.vortexsoftware.sdk.types.Identifier
- toString() - Method in class com.vortexsoftware.sdk.types.InvitationAcceptance
- toString() - Method in class com.vortexsoftware.sdk.types.InvitationGroup
- toString() - Method in class com.vortexsoftware.sdk.types.InvitationResponse
- toString() - Method in class com.vortexsoftware.sdk.types.InvitationResult
- toString() - Method in class com.vortexsoftware.sdk.types.InvitationTarget
- toString() - Method in class com.vortexsoftware.sdk.types.JWTPayload
- toString() - Method in class com.vortexsoftware.sdk.types.User
U
- User - Class in com.vortexsoftware.sdk.types
-
User data for JWT generation Required fields: - id: User's unique identifier in your system - email: User's email address Optional fields: - name: User's display name (max 200 characters) - avatarUrl: User's avatar URL (must be HTTPS, max 2000 characters) - adminScopes: List of admin scopes (e.g., ["autojoin"]) Example:
- User() - Constructor for class com.vortexsoftware.sdk.types.User
-
Default constructor for Jackson deserialization
- User(String, String) - Constructor for class com.vortexsoftware.sdk.types.User
-
Create a new User with required fields
- User(String, String, List<String>) - Constructor for class com.vortexsoftware.sdk.types.User
-
Create a new User with all fields
V
- VortexAutoConfiguration - Class in com.vortexsoftware.sdk.spring
-
Auto-configuration for Vortex Spring Boot integration This automatically sets up VortexClient and related beans when the vortex.api.key property is provided.
- VortexAutoConfiguration() - Constructor for class com.vortexsoftware.sdk.spring.VortexAutoConfiguration
- vortexClient(String, String) - Method in class com.vortexsoftware.sdk.spring.VortexAutoConfiguration
- VortexClient - Class in com.vortexsoftware.sdk
-
Main Vortex SDK client for Java applications Provides JWT generation and Vortex API integration with the same functionality as the Node.js SDK, ensuring compatibility with React providers.
- VortexClient(String) - Constructor for class com.vortexsoftware.sdk.VortexClient
-
Create a new Vortex client with the given API key
- VortexClient(String, String) - Constructor for class com.vortexsoftware.sdk.VortexClient
-
Create a new Vortex client with custom base URL
- vortexConfig() - Method in class com.vortexsoftware.sdk.spring.VortexAutoConfiguration
- VortexConfig - Interface in com.vortexsoftware.sdk.spring
-
Configuration interface for Vortex Spring integration This interface allows applications to define how users are authenticated and authorized for Vortex operations, matching the pattern from Express SDK.
- VortexConfig.VortexUser - Class in com.vortexsoftware.sdk.spring
-
Represents a user in the Vortex system Supports both new simplified format (userEmail + userIsAutojoinAdmin) and legacy format (identifiers + groups + role) for backward compatibility.
- vortexController(VortexClient, VortexConfig) - Method in class com.vortexsoftware.sdk.spring.VortexAutoConfiguration
- VortexController - Class in com.vortexsoftware.sdk.spring
-
Spring Boot controller providing Vortex API endpoints This controller provides the same route structure as the Express SDK, ensuring compatibility with React providers and other frontend frameworks.
- VortexController(VortexClient, VortexConfig) - Constructor for class com.vortexsoftware.sdk.spring.VortexController
- VortexException - Exception in com.vortexsoftware.sdk
-
Exception thrown by Vortex SDK operations
- VortexException(String) - Constructor for exception com.vortexsoftware.sdk.VortexException
- VortexException(String, Throwable) - Constructor for exception com.vortexsoftware.sdk.VortexException
- VortexException(Throwable) - Constructor for exception com.vortexsoftware.sdk.VortexException
- VortexRoutes - Class in com.vortexsoftware.sdk.spring
-
Constants defining the Vortex API route structure These routes match exactly with the Express SDK and React provider to ensure complete compatibility across different backend implementations.
- VortexUser() - Constructor for class com.vortexsoftware.sdk.spring.VortexConfig.VortexUser
- VortexUser(String, String, Boolean) - Constructor for class com.vortexsoftware.sdk.spring.VortexConfig.VortexUser
-
Create a VortexUser with new simplified format (recommended)
- VortexUser(String, List<Identifier>, List<Group>, String) - Constructor for class com.vortexsoftware.sdk.spring.VortexConfig.VortexUser
-
Deprecated.Use constructor with userEmail instead
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
VortexClient.acceptInvitations(List, AcceptUser)instead. This method is maintained for backward compatibility but will be removed in a future version. Use the new User format which supports email, phone, and name.Example migration: