Package com.microsoft.graph.models

Class Invitation

java.lang.Object
com.microsoft.graph.models.Entity
com.microsoft.graph.models.Invitation
All Implemented Interfaces:
com.microsoft.kiota.serialization.AdditionalDataHolder, com.microsoft.kiota.serialization.Parsable, com.microsoft.kiota.store.BackedModel
@Generated("com.microsoft.kiota") public class Invitation extends Entity implements com.microsoft.kiota.serialization.Parsable

  • Constructor Details

    • Invitation

      public Invitation()
      Instantiates a new Invitation and sets the default values.

  • Method Details

    • createFromDiscriminatorValue

      @Nonnull public static Invitation createFromDiscriminatorValue(@Nonnull com.microsoft.kiota.serialization.ParseNode parseNode)
      Creates a new instance of the appropriate class based on discriminator value
      Parameters:
      parseNode - The parse node to use to read the discriminator value and create the object
      Returns:
      a Invitation

    • getFieldDeserializers

      @Nonnull public Map<String,Consumer<com.microsoft.kiota.serialization.ParseNode>> getFieldDeserializers()
      The deserialization information for the current model
      Specified by:
      getFieldDeserializers in interface com.microsoft.kiota.serialization.Parsable
      Overrides:
      getFieldDeserializers in class Entity
      Returns:
      a Map<String,Consumer<com.microsoft.kiota.serialization.ParseNode>>

    • getInvitedUser

      @Nullable public User getInvitedUser()
      Gets the invitedUser property value. The user created as part of the invitation creation. Read-only. The id property is required in the request body to reset a redemption status.
      Returns:
      a User

    • getInvitedUserDisplayName

      @Nullable public String getInvitedUserDisplayName()
      Gets the invitedUserDisplayName property value. The display name of the user being invited.
      Returns:
      a String

    • getInvitedUserEmailAddress

      @Nullable public String getInvitedUserEmailAddress()
      Gets the invitedUserEmailAddress property value. The email address of the user being invited. Required. The following special characters aren't permitted in the email address:Tilde (~)Exclamation point (!)Number sign (#)Dollar sign ($)Percent (%)Circumflex (^)Ampersand (&)Asterisk (*)Parentheses (( ))Plus sign (+)Equal sign (=)Brackets ([ ])Braces ({ })Backslash (/)Slash mark (/)Pipe (/|)Semicolon (;)Colon (:)Quotation marks (')Angle brackets (< >)Question mark (?)Comma (,)However, the following exceptions apply:A period (.) or a hyphen (-) is permitted anywhere in the user name, except at the beginning or end of the name.An underscore (_) is permitted anywhere in the user name, including at the beginning or end of the name.
      Returns:
      a String

    • getInvitedUserMessageInfo

      @Nullable public InvitedUserMessageInfo getInvitedUserMessageInfo()
      Gets the invitedUserMessageInfo property value. Contains configuration for the message being sent to the invited user, including customizing message text, language, and cc recipient list.
      Returns:
      a InvitedUserMessageInfo

    • getInvitedUserSponsors

      @Nullable public List<DirectoryObject> getInvitedUserSponsors()
      Gets the invitedUserSponsors property value. The users or groups who are sponsors of the invited user. Sponsors are users and groups that are responsible for guest users' privileges in the tenant and for keeping the guest users' information and access up to date.
      Returns:
      a List<DirectoryObject>

    • getInvitedUserType

      @Nullable public String getInvitedUserType()
      Gets the invitedUserType property value. The userType of the user being invited. By default, this is Guest. You can invite as Member if you're a company administrator.
      Returns:
      a String

    • getInviteRedeemUrl

      @Nullable public String getInviteRedeemUrl()
      Gets the inviteRedeemUrl property value. The URL the user can use to redeem their invitation. Read-only.
      Returns:
      a String

    • getInviteRedirectUrl

      @Nullable public String getInviteRedirectUrl()
      Gets the inviteRedirectUrl property value. The URL the user should be redirected to after the invitation is redeemed. Required.
      Returns:
      a String

    • getResetRedemption

      @Nullable public Boolean getResetRedemption()
      Gets the resetRedemption property value. Reset the user's redemption status and reinvite a user while retaining their user identifier, group memberships, and app assignments. This property allows you to enable a user to sign-in using a different email address from the one in the previous invitation. When true, the invitedUser/id relationship is required. For more information about using this property, see Reset redemption status for a guest user.
      Returns:
      a Boolean

    • getSendInvitationMessage

      @Nullable public Boolean getSendInvitationMessage()
      Gets the sendInvitationMessage property value. Indicates whether an email should be sent to the user being invited. The default is false.
      Returns:
      a Boolean

    • getStatus

      @Nullable public String getStatus()
      Gets the status property value. The status of the invitation. Possible values are: PendingAcceptance, Completed, InProgress, and Error.
      Returns:
      a String

    • serialize

      public void serialize(@Nonnull com.microsoft.kiota.serialization.SerializationWriter writer)
      Serializes information the current object
      Specified by:
      serialize in interface com.microsoft.kiota.serialization.Parsable
      Overrides:
      serialize in class Entity
      Parameters:
      writer - Serialization writer to use to serialize this model

    • setInvitedUser

      public void setInvitedUser(@Nullable User value)
      Sets the invitedUser property value. The user created as part of the invitation creation. Read-only. The id property is required in the request body to reset a redemption status.
      Parameters:
      value - Value to set for the invitedUser property.

    • setInvitedUserDisplayName

      public void setInvitedUserDisplayName(@Nullable String value)
      Sets the invitedUserDisplayName property value. The display name of the user being invited.
      Parameters:
      value - Value to set for the invitedUserDisplayName property.

    • setInvitedUserEmailAddress

      public void setInvitedUserEmailAddress(@Nullable String value)
      Sets the invitedUserEmailAddress property value. The email address of the user being invited. Required. The following special characters aren't permitted in the email address:Tilde (~)Exclamation point (!)Number sign (#)Dollar sign ($)Percent (%)Circumflex (^)Ampersand (&)Asterisk (*)Parentheses (( ))Plus sign (+)Equal sign (=)Brackets ([ ])Braces ({ })Backslash (/)Slash mark (/)Pipe (/|)Semicolon (;)Colon (:)Quotation marks (')Angle brackets (< >)Question mark (?)Comma (,)However, the following exceptions apply:A period (.) or a hyphen (-) is permitted anywhere in the user name, except at the beginning or end of the name.An underscore (_) is permitted anywhere in the user name, including at the beginning or end of the name.
      Parameters:
      value - Value to set for the invitedUserEmailAddress property.

    • setInvitedUserMessageInfo

      public void setInvitedUserMessageInfo(@Nullable InvitedUserMessageInfo value)
      Sets the invitedUserMessageInfo property value. Contains configuration for the message being sent to the invited user, including customizing message text, language, and cc recipient list.
      Parameters:
      value - Value to set for the invitedUserMessageInfo property.

    • setInvitedUserSponsors

      public void setInvitedUserSponsors(@Nullable List<DirectoryObject> value)
      Sets the invitedUserSponsors property value. The users or groups who are sponsors of the invited user. Sponsors are users and groups that are responsible for guest users' privileges in the tenant and for keeping the guest users' information and access up to date.
      Parameters:
      value - Value to set for the invitedUserSponsors property.

    • setInvitedUserType

      public void setInvitedUserType(@Nullable String value)
      Sets the invitedUserType property value. The userType of the user being invited. By default, this is Guest. You can invite as Member if you're a company administrator.
      Parameters:
      value - Value to set for the invitedUserType property.

    • setInviteRedeemUrl

      public void setInviteRedeemUrl(@Nullable String value)
      Sets the inviteRedeemUrl property value. The URL the user can use to redeem their invitation. Read-only.
      Parameters:
      value - Value to set for the inviteRedeemUrl property.

    • setInviteRedirectUrl

      public void setInviteRedirectUrl(@Nullable String value)
      Sets the inviteRedirectUrl property value. The URL the user should be redirected to after the invitation is redeemed. Required.
      Parameters:
      value - Value to set for the inviteRedirectUrl property.

    • setResetRedemption

      public void setResetRedemption(@Nullable Boolean value)
      Sets the resetRedemption property value. Reset the user's redemption status and reinvite a user while retaining their user identifier, group memberships, and app assignments. This property allows you to enable a user to sign-in using a different email address from the one in the previous invitation. When true, the invitedUser/id relationship is required. For more information about using this property, see Reset redemption status for a guest user.
      Parameters:
      value - Value to set for the resetRedemption property.

    • setSendInvitationMessage

      public void setSendInvitationMessage(@Nullable Boolean value)
      Sets the sendInvitationMessage property value. Indicates whether an email should be sent to the user being invited. The default is false.
      Parameters:
      value - Value to set for the sendInvitationMessage property.

    • setStatus

      public void setStatus(@Nullable String value)
      Sets the status property value. The status of the invitation. Possible values are: PendingAcceptance, Completed, InProgress, and Error.
      Parameters:
      value - Value to set for the status property.