FederatedInvitationRedeemStatus
enum FederatedInvitationRedeemStatus : Enum
The status of a federated invitation redemption.
Summary
Enum Values |
|
|---|---|
PENDING_STRUCTURE_PERMISSIONS |
If permission updates fail, the invitation will still be marked as accepted but updates will need to be retried. |
SUCCESS |
The invitation was fully processed and the user was added to the structure. |
UNKNOWN |
The status is unknown or unspecified. |
Public functions |
|
|---|---|
FederatedInvitationRedeemStatus |
Returns the enum constant of this type with the specified name. |
Array<FederatedInvitationRedeemStatus> |
values()Returns an array containing the constants of this enum type, in the order they're declared. |
Public properties |
|
|---|---|
EnumEntries<FederatedInvitationRedeemStatus> |
Returns a representation of an immutable list of all enum entries, in the order they're declared. |
Enum Values
PENDING_STRUCTURE_PERMISSIONS
val FederatedInvitationRedeemStatus.PENDING_STRUCTURE_PERMISSIONS: FederatedInvitationRedeemStatus
If permission updates fail, the invitation will still be marked as accepted but updates will need to be retried.
SUCCESS
val FederatedInvitationRedeemStatus.SUCCESS: FederatedInvitationRedeemStatus
The invitation was fully processed and the user was added to the structure.
UNKNOWN
val FederatedInvitationRedeemStatus.UNKNOWN: FederatedInvitationRedeemStatus
The status is unknown or unspecified.
Public functions
valueOf
fun valueOf(value: String): FederatedInvitationRedeemStatus
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
| Throws | |
|---|---|
kotlin.IllegalArgumentException |
if this enum type has no constant with the specified name |
values
fun values(): Array<FederatedInvitationRedeemStatus>
Returns an array containing the constants of this enum type, in the order they're declared.
This method may be used to iterate over the constants.
Public properties
entries
val entries: EnumEntries<FederatedInvitationRedeemStatus>
Returns a representation of an immutable list of all enum entries, in the order they're declared.
This method may be used to iterate over the enum entries.